Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 6f9dda6

Browse files
jgebaljgebal
committed
Renamed parameters, updated documentation and tests.
1 parent 308fa3a commit 6f9dda6

8 files changed

Lines changed: 76 additions & 105 deletions

File tree

‎docs/userguide/coverage.md‎

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -86,20 +86,20 @@ In this situation you need to provide list of schema names that the tested code
8686

8787
Example:
8888
```sql
89-
exec ut.run('ut3_user.test_award_bonus', ut_coverage_html_reporter(), a_schema_names=>ut_varchar2_list('usr'));
89+
exec ut.run('ut3_user.test_award_bonus', ut_coverage_html_reporter(), a_coverage_schemes=>ut_varchar2_list('usr'));
9090
```
9191
Executes test `test_award_bonus` in schema `ut3_user` and gather coverage for that execution on all non `unit-test` objects from schema `usr`.
9292

9393
You can combine schema names with include/exclude parameters and all will be applied.
94-
The `a_schema_names` parameter takes precedence however, so if include list contains objects from other schemes, that will not be considered.
94+
The `a_coverage_schemes` parameter takes precedence however, so if include list contains objects from other schemes, that will not be considered.
9595

9696
Example:
9797
```sql
9898
begin
9999
ut.run(
100100
'ut3_user.test_award_bonus',
101101
ut_coverage_html_reporter(),
102-
a_schema_names => ut_varchar2_list('usr'),
102+
a_coverage_schemes => ut_varchar2_list('usr'),
103103
a_exclude_objects => ut_varchar2_list('usr.betwnstr'),
104104
a_include_objects => ut_varchar2_list('usr.award_bonus')
105105
);
@@ -126,7 +126,7 @@ begin
126126
ut.run(
127127
'usr',
128128
ut_coverage_html_reporter(),
129-
a_project_file_mappings =>
129+
a_source_file_mappings =>
130130
ut_coverage_file_mappings(
131131
ut_coverage_file_mapping(
132132
file_name => 'sources/hr/award_bonus.prc',
@@ -157,7 +157,7 @@ begin
157157
ut.run(
158158
'usr',
159159
ut_coverage_html_reporter(),
160-
a_project_files => ut_varchar2_list('sources/hr/award_bonus.prc','sources/hr/betwnstr.fnc')
160+
a_source_files => ut_varchar2_list('sources/hr/award_bonus.prc','sources/hr/betwnstr.fnc')
161161
);
162162
end;
163163
```
@@ -189,19 +189,6 @@ Examples of filename paths that will be mapped correctly using predefined rules.
189189
* `[...]directory[\subdirectory[\...]]\schema_name.object_name.(tpb|pkb|trg|fnc|prc)`
190190

191191
If file names in your project structure are not prefixed with schema name (like above), the coverage report will look for objects to match the file names in the `current schema` of the connection that was used to execute tests with coverage.
192-
If for whatever reasons you use a user and current schema that is different then schem that holds your project code, you should use `a_schema_name` parameter to inform coverage reporter about database schema to be used for object lookup.
193-
194-
Example:
195-
```sql
196-
begin
197-
ut.run(
198-
'usr',
199-
ut_coverage_html_reporter(),
200-
a_schema_names => ut_varchar2_list('hr'),
201-
a_file_paths => ut_varchar2_list('sources/hr/award_bonus.prc','sources/hr/betwnstr.fnc')
202-
);
203-
end;
204-
```
205192

206193
If your project structure is different, you may define your own mapping rule using regex.
207194

‎source/api/ut.pkb‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -96,35 +96,35 @@ create or replace package body ut is
9696

9797
procedure run_autonomous(
9898
a_paths ut_varchar2_list, a_reporter ut_reporter_base, a_color_console integer,
99-
a_schema_names ut_varchar2_list := null, a_project_file_mappings ut_file_mappings, a_test_file_mappings ut_file_mappings,
99+
a_coverage_schemes ut_varchar2_list := null, a_source_file_mappings ut_file_mappings, a_test_file_mappings ut_file_mappings,
100100
a_include_objects ut_varchar2_list, a_exclude_objects ut_varchar2_list
101101
) is
102102
pragma autonomous_transaction;
103103
begin
104104
ut_runner.run(
105-
a_paths, a_reporter, ut_utils.int_to_boolean(a_color_console), a_schema_names,
106-
a_project_file_mappings, a_test_file_mappings, a_include_objects, a_exclude_objects
105+
a_paths, a_reporter, ut_utils.int_to_boolean(a_color_console), a_coverage_schemes,
106+
a_source_file_mappings, a_test_file_mappings, a_include_objects, a_exclude_objects
107107
);
108108
rollback;
109109
end;
110110

111111
procedure run_autonomous(
112112
a_paths ut_varchar2_list, a_reporter ut_reporter_base, a_color_console integer,
113-
a_schema_names ut_varchar2_list := null, a_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
113+
a_coverage_schemes ut_varchar2_list := null, a_source_files ut_varchar2_list, a_test_files ut_varchar2_list,
114114
a_include_objects ut_varchar2_list, a_exclude_objects ut_varchar2_list
115115
) is
116116
pragma autonomous_transaction;
117117
begin
118118
ut_runner.run(
119-
a_paths, a_reporter, ut_utils.int_to_boolean(a_color_console), a_schema_names,
120-
a_project_files, a_test_files, a_include_objects, a_exclude_objects
119+
a_paths, a_reporter, ut_utils.int_to_boolean(a_color_console), a_coverage_schemes,
120+
a_source_files, a_test_files, a_include_objects, a_exclude_objects
121121
);
122122
rollback;
123123
end;
124124

125125
function run(
126126
a_reporter ut_reporter_base := null, a_color_console integer := 0,
127-
a_schema_names ut_varchar2_list := null, a_project_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
127+
a_coverage_schemes ut_varchar2_list := null, a_source_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
128128
a_include_objects ut_varchar2_list := null, a_exclude_objects ut_varchar2_list := null
129129
) return ut_varchar2_rows pipelined is
130130
l_reporter ut_reporter_base := coalesce(a_reporter, ut_documentation_reporter());
@@ -134,7 +134,7 @@ create or replace package body ut is
134134
begin
135135
run_autonomous(
136136
l_paths, l_reporter, a_color_console,
137-
a_schema_names, a_project_file_mappings, a_test_file_mappings, a_include_objects, a_exclude_objects
137+
a_coverage_schemes, a_source_file_mappings, a_test_file_mappings, a_include_objects, a_exclude_objects
138138
);
139139
l_lines := ut_output_buffer.get_lines_cursor(l_reporter.reporter_id);
140140
loop
@@ -147,7 +147,7 @@ create or replace package body ut is
147147

148148
function run(
149149
a_reporter ut_reporter_base := null, a_color_console integer := 0,
150-
a_schema_names ut_varchar2_list := null, a_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
150+
a_coverage_schemes ut_varchar2_list := null, a_source_files ut_varchar2_list, a_test_files ut_varchar2_list,
151151
a_include_objects ut_varchar2_list := null, a_exclude_objects ut_varchar2_list := null
152152
) return ut_varchar2_rows pipelined is
153153
l_reporter ut_reporter_base := coalesce(a_reporter, ut_documentation_reporter());
@@ -156,7 +156,7 @@ create or replace package body ut is
156156
l_line varchar2(4000);
157157
begin
158158
run_autonomous(
159-
l_paths, l_reporter, a_color_console, a_schema_names, a_project_files, a_test_files,
159+
l_paths, l_reporter, a_color_console, a_coverage_schemes, a_source_files, a_test_files,
160160
a_include_objects, a_exclude_objects
161161
);
162162
l_lines := ut_output_buffer.get_lines_cursor(l_reporter.reporter_id);
@@ -170,15 +170,15 @@ create or replace package body ut is
170170

171171
function run(
172172
a_paths ut_varchar2_list, a_reporter ut_reporter_base := null, a_color_console integer := 0,
173-
a_schema_names ut_varchar2_list := null, a_project_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
173+
a_coverage_schemes ut_varchar2_list := null, a_source_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
174174
a_include_objects ut_varchar2_list := null, a_exclude_objects ut_varchar2_list := null
175175
) return ut_varchar2_rows pipelined is
176176
l_reporter ut_reporter_base := coalesce(a_reporter, ut_documentation_reporter());
177177
l_lines sys_refcursor;
178178
l_line varchar2(4000);
179179
begin
180180
run_autonomous(
181-
a_paths, l_reporter, a_color_console, a_schema_names, a_project_file_mappings, a_test_file_mappings,
181+
a_paths, l_reporter, a_color_console, a_coverage_schemes, a_source_file_mappings, a_test_file_mappings,
182182
a_include_objects, a_exclude_objects
183183
);
184184
l_lines := ut_output_buffer.get_lines_cursor(l_reporter.reporter_id);
@@ -192,15 +192,15 @@ create or replace package body ut is
192192

193193
function run(
194194
a_paths ut_varchar2_list, a_reporter ut_reporter_base := null, a_color_console integer := 0,
195-
a_schema_names ut_varchar2_list := null, a_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
195+
a_coverage_schemes ut_varchar2_list := null, a_source_files ut_varchar2_list, a_test_files ut_varchar2_list,
196196
a_include_objects ut_varchar2_list := null, a_exclude_objects ut_varchar2_list := null
197197
) return ut_varchar2_rows pipelined is
198198
l_reporter ut_reporter_base := coalesce(a_reporter, ut_documentation_reporter());
199199
l_lines sys_refcursor;
200200
l_line varchar2(4000);
201201
begin
202202
run_autonomous(
203-
a_paths, l_reporter, a_color_console, a_schema_names, a_project_files, a_test_files,
203+
a_paths, l_reporter, a_color_console, a_coverage_schemes, a_source_files, a_test_files,
204204
a_include_objects, a_exclude_objects
205205
);
206206
l_lines := ut_output_buffer.get_lines_cursor(l_reporter.reporter_id);
@@ -214,7 +214,7 @@ create or replace package body ut is
214214

215215
function run(
216216
a_path varchar2, a_reporter ut_reporter_base := null, a_color_console integer := 0,
217-
a_schema_names ut_varchar2_list := null, a_project_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
217+
a_coverage_schemes ut_varchar2_list := null, a_source_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
218218
a_include_objects ut_varchar2_list := null, a_exclude_objects ut_varchar2_list := null
219219
) return ut_varchar2_rows pipelined is
220220
l_reporter ut_reporter_base := coalesce(a_reporter, ut_documentation_reporter());
@@ -223,7 +223,7 @@ create or replace package body ut is
223223
l_line varchar2(4000);
224224
begin
225225
run_autonomous(
226-
l_paths, l_reporter, a_color_console, a_schema_names, a_project_file_mappings, a_test_file_mappings,
226+
l_paths, l_reporter, a_color_console, a_coverage_schemes, a_source_file_mappings, a_test_file_mappings,
227227
a_include_objects, a_exclude_objects
228228
);
229229
l_lines := ut_output_buffer.get_lines_cursor(l_reporter.reporter_id);
@@ -237,7 +237,7 @@ create or replace package body ut is
237237

238238
function run(
239239
a_path varchar2, a_reporter ut_reporter_base := null, a_color_console integer := 0,
240-
a_schema_names ut_varchar2_list := null, a_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
240+
a_coverage_schemes ut_varchar2_list := null, a_source_files ut_varchar2_list, a_test_files ut_varchar2_list,
241241
a_include_objects ut_varchar2_list := null, a_exclude_objects ut_varchar2_list := null
242242
) return ut_varchar2_rows pipelined is
243243
l_reporter ut_reporter_base := coalesce(a_reporter, ut_documentation_reporter());
@@ -246,7 +246,7 @@ create or replace package body ut is
246246
l_line varchar2(4000);
247247
begin
248248
run_autonomous(
249-
l_paths, l_reporter, a_color_console, a_schema_names, a_project_files, a_test_files,
249+
l_paths, l_reporter, a_color_console, a_coverage_schemes, a_source_files, a_test_files,
250250
a_include_objects, a_exclude_objects
251251
);
252252
l_lines := ut_output_buffer.get_lines_cursor(l_reporter.reporter_id);
@@ -260,78 +260,78 @@ create or replace package body ut is
260260

261261
procedure run(
262262
a_reporter ut_reporter_base := null, a_color_console boolean := false,
263-
a_schema_names ut_varchar2_list := null, a_project_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
263+
a_coverage_schemes ut_varchar2_list := null, a_source_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
264264
a_include_objects ut_varchar2_list := null, a_exclude_objects ut_varchar2_list := null
265265
) is
266266
begin
267267
ut.run(
268268
ut_varchar2_list(sys_context('userenv', 'current_schema')), a_reporter, a_color_console,
269-
a_schema_names, a_project_file_mappings, a_test_file_mappings, a_include_objects, a_exclude_objects
269+
a_coverage_schemes, a_source_file_mappings, a_test_file_mappings, a_include_objects, a_exclude_objects
270270
);
271271
end;
272272

273273
procedure run(
274274
a_reporter ut_reporter_base := null, a_color_console boolean := false,
275-
a_schema_names ut_varchar2_list := null, a_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
275+
a_coverage_schemes ut_varchar2_list := null, a_source_files ut_varchar2_list, a_test_files ut_varchar2_list,
276276
a_include_objects ut_varchar2_list := null, a_exclude_objects ut_varchar2_list := null
277277
) is
278278
begin
279279
ut.run(
280280
ut_varchar2_list(sys_context('userenv', 'current_schema')), a_reporter, a_color_console,
281-
a_schema_names, a_project_files, a_test_files, a_include_objects, a_exclude_objects
281+
a_coverage_schemes, a_source_files, a_test_files, a_include_objects, a_exclude_objects
282282
);
283283
end;
284284

285285
procedure run(
286286
a_paths ut_varchar2_list, a_reporter ut_reporter_base := null, a_color_console boolean := false,
287-
a_schema_names ut_varchar2_list := null, a_project_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
287+
a_coverage_schemes ut_varchar2_list := null, a_source_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
288288
a_include_objects ut_varchar2_list := null, a_exclude_objects ut_varchar2_list := null
289289
) is
290290
l_reporter ut_reporter_base := coalesce(a_reporter, ut_documentation_reporter());
291291
begin
292292
ut_runner.run(
293-
a_paths, l_reporter, a_color_console, a_schema_names, a_project_file_mappings, a_test_file_mappings,
293+
a_paths, l_reporter, a_color_console, a_coverage_schemes, a_source_file_mappings, a_test_file_mappings,
294294
a_include_objects, a_exclude_objects
295295
);
296296
ut_output_buffer.lines_to_dbms_output(l_reporter.reporter_id);
297297
end;
298298

299299
procedure run(
300300
a_paths ut_varchar2_list, a_reporter ut_reporter_base := null, a_color_console boolean := false,
301-
a_schema_names ut_varchar2_list := null, a_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
301+
a_coverage_schemes ut_varchar2_list := null, a_source_files ut_varchar2_list, a_test_files ut_varchar2_list,
302302
a_include_objects ut_varchar2_list := null, a_exclude_objects ut_varchar2_list := null
303303
) is
304304
l_reporter ut_reporter_base := coalesce(a_reporter, ut_documentation_reporter());
305305
begin
306306
ut_runner.run(
307-
a_paths, l_reporter, a_color_console, a_schema_names, a_project_files, a_test_files,
307+
a_paths, l_reporter, a_color_console, a_coverage_schemes, a_source_files, a_test_files,
308308
a_include_objects, a_exclude_objects
309309
);
310310
ut_output_buffer.lines_to_dbms_output(l_reporter.reporter_id);
311311
end;
312312

313313
procedure run(
314314
a_path varchar2, a_reporter ut_reporter_base := null, a_color_console boolean := false,
315-
a_schema_names ut_varchar2_list := null, a_project_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
315+
a_coverage_schemes ut_varchar2_list := null, a_source_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
316316
a_include_objects ut_varchar2_list := null, a_exclude_objects ut_varchar2_list := null
317317
) is
318318
l_paths ut_varchar2_list := ut_varchar2_list(coalesce(a_path, sys_context('userenv', 'current_schema')));
319319
begin
320320
ut.run(
321-
l_paths, a_reporter, a_color_console, a_schema_names, a_project_file_mappings, a_test_file_mappings,
321+
l_paths, a_reporter, a_color_console, a_coverage_schemes, a_source_file_mappings, a_test_file_mappings,
322322
a_include_objects, a_exclude_objects
323323
);
324324
end;
325325

326326
procedure run(
327327
a_path varchar2, a_reporter ut_reporter_base := null, a_color_console boolean := false,
328-
a_schema_names ut_varchar2_list := null, a_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
328+
a_coverage_schemes ut_varchar2_list := null, a_source_files ut_varchar2_list, a_test_files ut_varchar2_list,
329329
a_include_objects ut_varchar2_list := null, a_exclude_objects ut_varchar2_list := null
330330
) is
331331
l_paths ut_varchar2_list := ut_varchar2_list(coalesce(a_path, sys_context('userenv', 'current_schema')));
332332
begin
333333
ut.run(
334-
l_paths, a_reporter, a_color_console, a_schema_names, a_project_files, a_test_files,
334+
l_paths, a_reporter, a_color_console, a_coverage_schemes, a_source_files, a_test_files,
335335
a_include_objects, a_exclude_objects
336336
);
337337
end;

0 commit comments

Comments
 (0)