Skip to content

Commit 308fa3a

Browse files
jgebaljgebal
committed
Renamed parameters, added missing parameter a_schema_names, added synonyms and grants for ut_coverage_option, updated documentation.
1 parent 9b1c407 commit 308fa3a

10 files changed

Lines changed: 179 additions & 152 deletions

‎docs/userguide/coverage.md‎

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,13 @@ Both of those options are meant to be used to narrow down the scope of unit test
6464

6565
Example:
6666
```sql
67-
exec ut.run('ut3_user.test_award_bonus', ut_coverage_html_reporter(a_include_object_list=>ut_varchar2_list('ut3_user.award_bonus')));
67+
exec ut.run('ut3_user.test_award_bonus', ut_coverage_html_reporter(), a_include_objects=>ut_varchar2_list('ut3_user.award_bonus'));
6868
```
6969
Executes test `test_award_bonus` and gather coverage only on object `ut3_user.award_bonus`
7070

7171
Alternatively you could run:
7272
```sql
73-
exec ut.run('ut3_user.test_award_bonus', ut_coverage_html_reporter(a_exclude_object_list=>ut_varchar2_list('ut3_user.betwnstr')));
73+
exec ut.run('ut3_user.test_award_bonus', ut_coverage_html_reporter(), a_exclude_objects=>ut_varchar2_list('ut3_user.betwnstr'));
7474
```
7575
Executes test `test_award_bonus` and gather on all objects in schema `ut3_user` except valid unit test objects and object `betwnstr` that schema.
7676

@@ -86,7 +86,7 @@ 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_schema_names=>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

@@ -98,11 +98,10 @@ Example:
9898
begin
9999
ut.run(
100100
'ut3_user.test_award_bonus',
101-
ut_coverage_html_reporter(
102-
a_schema_names => ut_varchar2_list('usr'),
103-
a_include_object_list => ut_varchar2_list('usr.award_bonus'),
104-
a_exclude_object_list => ut_varchar2_list('usr.betwnstr')
105-
)
101+
ut_coverage_html_reporter(),
102+
a_schema_names => ut_varchar2_list('usr'),
103+
a_exclude_objects => ut_varchar2_list('usr.betwnstr'),
104+
a_include_objects => ut_varchar2_list('usr.award_bonus')
106105
);
107106
end;
108107
```
@@ -126,22 +125,22 @@ Example:
126125
begin
127126
ut.run(
128127
'usr',
129-
ut_coverage_html_reporter(
130-
a_file_mappings=>ut_coverage_file_mappings(
128+
ut_coverage_html_reporter(),
129+
a_project_file_mappings =>
130+
ut_coverage_file_mappings(
131131
ut_coverage_file_mapping(
132132
file_name => 'sources/hr/award_bonus.prc',
133-
object_owner => 'usr',
134-
object_name => 'award_bonus',
135-
object_type => 'procedure'
133+
object_owner => 'USR',
134+
object_name => 'AWARD_BONUS',
135+
object_type => 'PROCEDURE'
136136
),
137137
ut_coverage_file_mapping(
138138
file_name => 'sources/hr/betwnstr.fnc',
139-
object_owner => 'usr',
140-
object_name => 'betwnstr',
141-
object_type => 'function'
139+
object_owner => 'USR',
140+
object_name => 'BETWNSTR',
141+
object_type => 'FUNCTION'
142142
)
143143
)
144-
)
145144
);
146145
end;
147146
```
@@ -157,9 +156,8 @@ Example of running with predefined regex mapping rule.
157156
begin
158157
ut.run(
159158
'usr',
160-
ut_coverage_html_reporter(
161-
a_file_paths => ut_varchar2_list('sources/hr/award_bonus.prc','sources/hr/betwnstr.fnc')
162-
)
159+
ut_coverage_html_reporter(),
160+
a_project_files => ut_varchar2_list('sources/hr/award_bonus.prc','sources/hr/betwnstr.fnc')
163161
);
164162
end;
165163
```
@@ -198,10 +196,9 @@ Example:
198196
begin
199197
ut.run(
200198
'usr',
201-
ut_coverage_html_reporter(
202-
a_schema_name => 'hr',
203-
a_file_paths => ut_varchar2_list('sources/hr/award_bonus.prc','sources/hr/betwnstr.fnc')
204-
)
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')
205202
);
206203
end;
207204
```
@@ -213,7 +210,8 @@ Example:
213210
begin
214211
ut.run(
215212
'usr',
216-
ut_coverage_html_reporter(
213+
ut_coverage_html_reporter(),
214+
ut_file_mapper.build_file_mappings(
217215
a_file_paths => ut_varchar2_list('sources/hr/procedures/award_bonus.sql','sources/hr/functions/betwnstr.sql'),
218216
a_regex_pattern => '.*(\\|\/)(\w+)\.(\w+)\.(\w{3})',
219217
a_object_owner_subexpression => 2,
@@ -222,6 +220,7 @@ begin
222220
a_file_to_object_type_mapping => ut_key_value_pairs(
223221
ut_key_value_pair('functions', 'function'),
224222
ut_key_value_pair('procedures', 'procedure')
223+
)
225224
)
226225
);
227226
end;

‎source/api/ut.pkb‎

Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -96,45 +96,45 @@ 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_project_file_mappings ut_file_mappings, a_test_file_mappings ut_file_mappings,
100-
a_include_object_list ut_varchar2_list, a_exclude_object_list ut_varchar2_list
99+
a_schema_names ut_varchar2_list := null, a_project_file_mappings ut_file_mappings, a_test_file_mappings ut_file_mappings,
100+
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),
106-
a_project_file_mappings, a_test_file_mappings, a_include_object_list, a_exclude_object_list
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
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_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
114-
a_include_object_list ut_varchar2_list, a_exclude_object_list ut_varchar2_list
113+
a_schema_names ut_varchar2_list := null, a_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
114+
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),
120-
a_project_files, a_test_files, a_include_object_list, a_exclude_object_list
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
121121
);
122122
rollback;
123123
end;
124124

125125
function run(
126126
a_reporter ut_reporter_base := null, a_color_console integer := 0,
127-
a_project_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
128-
a_include_object_list ut_varchar2_list := null, a_exclude_object_list ut_varchar2_list := null
127+
a_schema_names ut_varchar2_list := null, a_project_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
128+
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());
131131
l_paths ut_varchar2_list := ut_varchar2_list(sys_context('userenv', 'current_schema'));
132132
l_lines sys_refcursor;
133133
l_line varchar2(4000);
134134
begin
135135
run_autonomous(
136-
l_paths, l_reporter, a_color_console, a_project_file_mappings, a_test_file_mappings,
137-
a_include_object_list, a_exclude_object_list
136+
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
138138
);
139139
l_lines := ut_output_buffer.get_lines_cursor(l_reporter.reporter_id);
140140
loop
@@ -147,17 +147,17 @@ 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_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
151-
a_include_object_list ut_varchar2_list := null, a_exclude_object_list ut_varchar2_list := null
150+
a_schema_names ut_varchar2_list := null, a_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
151+
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());
154154
l_paths ut_varchar2_list := ut_varchar2_list(sys_context('userenv', 'current_schema'));
155155
l_lines sys_refcursor;
156156
l_line varchar2(4000);
157157
begin
158158
run_autonomous(
159-
l_paths, l_reporter, a_color_console, a_project_files, a_test_files,
160-
a_include_object_list, a_exclude_object_list
159+
l_paths, l_reporter, a_color_console, a_schema_names, a_project_files, a_test_files,
160+
a_include_objects, a_exclude_objects
161161
);
162162
l_lines := ut_output_buffer.get_lines_cursor(l_reporter.reporter_id);
163163
loop
@@ -170,16 +170,16 @@ 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_project_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
174-
a_include_object_list ut_varchar2_list := null, a_exclude_object_list ut_varchar2_list := null
173+
a_schema_names ut_varchar2_list := null, a_project_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
174+
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_project_file_mappings, a_test_file_mappings,
182-
a_include_object_list, a_exclude_object_list
181+
a_paths, l_reporter, a_color_console, a_schema_names, a_project_file_mappings, a_test_file_mappings,
182+
a_include_objects, a_exclude_objects
183183
);
184184
l_lines := ut_output_buffer.get_lines_cursor(l_reporter.reporter_id);
185185
loop
@@ -192,16 +192,16 @@ 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_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
196-
a_include_object_list ut_varchar2_list := null, a_exclude_object_list ut_varchar2_list := null
195+
a_schema_names ut_varchar2_list := null, a_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
196+
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_project_files, a_test_files,
204-
a_include_object_list, a_exclude_object_list
203+
a_paths, l_reporter, a_color_console, a_schema_names, a_project_files, a_test_files,
204+
a_include_objects, a_exclude_objects
205205
);
206206
l_lines := ut_output_buffer.get_lines_cursor(l_reporter.reporter_id);
207207
loop
@@ -214,17 +214,17 @@ 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_project_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
218-
a_include_object_list ut_varchar2_list := null, a_exclude_object_list ut_varchar2_list := null
217+
a_schema_names ut_varchar2_list := null, a_project_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
218+
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());
221221
l_paths ut_varchar2_list := ut_varchar2_list(coalesce(a_path, sys_context('userenv', 'current_schema')));
222222
l_lines sys_refcursor;
223223
l_line varchar2(4000);
224224
begin
225225
run_autonomous(
226-
l_paths, l_reporter, a_color_console, a_project_file_mappings, a_test_file_mappings,
227-
a_include_object_list, a_exclude_object_list
226+
l_paths, l_reporter, a_color_console, a_schema_names, a_project_file_mappings, a_test_file_mappings,
227+
a_include_objects, a_exclude_objects
228228
);
229229
l_lines := ut_output_buffer.get_lines_cursor(l_reporter.reporter_id);
230230
loop
@@ -237,17 +237,17 @@ 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_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
241-
a_include_object_list ut_varchar2_list := null, a_exclude_object_list ut_varchar2_list := null
240+
a_schema_names ut_varchar2_list := null, a_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
241+
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());
244244
l_paths ut_varchar2_list := ut_varchar2_list(coalesce(a_path, sys_context('userenv', 'current_schema')));
245245
l_lines sys_refcursor;
246246
l_line varchar2(4000);
247247
begin
248248
run_autonomous(
249-
l_paths, l_reporter, a_color_console, a_project_files, a_test_files,
250-
a_include_object_list, a_exclude_object_list
249+
l_paths, l_reporter, a_color_console, a_schema_names, a_project_files, a_test_files,
250+
a_include_objects, a_exclude_objects
251251
);
252252
l_lines := ut_output_buffer.get_lines_cursor(l_reporter.reporter_id);
253253
loop
@@ -260,79 +260,79 @@ 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_project_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
264-
a_include_object_list ut_varchar2_list := null, a_exclude_object_list ut_varchar2_list := null
263+
a_schema_names ut_varchar2_list := null, a_project_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
264+
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_project_file_mappings, a_test_file_mappings, a_include_object_list, a_exclude_object_list
269+
a_schema_names, a_project_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_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
276-
a_include_object_list ut_varchar2_list := null, a_exclude_object_list ut_varchar2_list := null
275+
a_schema_names ut_varchar2_list := null, a_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
276+
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_project_files, a_test_files, a_include_object_list, a_exclude_object_list
281+
a_schema_names, a_project_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_project_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
288-
a_include_object_list ut_varchar2_list := null, a_exclude_object_list ut_varchar2_list := null
287+
a_schema_names ut_varchar2_list := null, a_project_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
288+
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_project_file_mappings, a_test_file_mappings,
294-
a_include_object_list, a_exclude_object_list
293+
a_paths, l_reporter, a_color_console, a_schema_names, a_project_file_mappings, a_test_file_mappings,
294+
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_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
302-
a_include_object_list ut_varchar2_list := null, a_exclude_object_list ut_varchar2_list := null
301+
a_schema_names ut_varchar2_list := null, a_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
302+
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_project_files, a_test_files,
308-
a_include_object_list, a_exclude_object_list
307+
a_paths, l_reporter, a_color_console, a_schema_names, a_project_files, a_test_files,
308+
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_project_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
316-
a_include_object_list ut_varchar2_list := null, a_exclude_object_list ut_varchar2_list := null
315+
a_schema_names ut_varchar2_list := null, a_project_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
316+
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_project_file_mappings, a_test_file_mappings,
322-
a_include_object_list, a_exclude_object_list
321+
l_paths, a_reporter, a_color_console, a_schema_names, a_project_file_mappings, a_test_file_mappings,
322+
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_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
329-
a_include_object_list ut_varchar2_list := null, a_exclude_object_list ut_varchar2_list := null
328+
a_schema_names ut_varchar2_list := null, a_project_files ut_varchar2_list, a_test_files ut_varchar2_list,
329+
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_project_files, a_test_files,
335-
a_include_object_list, a_exclude_object_list
334+
l_paths, a_reporter, a_color_console, a_schema_names, a_project_files, a_test_files,
335+
a_include_objects, a_exclude_objects
336336
);
337337
end;
338338

0 commit comments

Comments
 (0)