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

Skip to content

Commit 34b2f48

Browse files
jgebaljgebal
committed
Updated API doc.
Removed redundant API.
1 parent 54597c5 commit 34b2f48

3 files changed

Lines changed: 21 additions & 30 deletions

File tree

‎source/api/ut.pkb‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,9 @@ create or replace package body ut is
119119
ut_runner.run(
120120
a_paths, ut_reporters(coalesce(a_reporter,ut_documentation_reporter())),
121121
ut_utils.int_to_boolean(a_color_console), a_coverage_schemes,
122-
a_source_files, a_test_files, a_include_objects, a_exclude_objects
122+
ut_file_mapper.build_file_mappings(a_source_files),
123+
ut_file_mapper.build_file_mappings(a_test_files),
124+
a_include_objects, a_exclude_objects
123125
);
124126
rollback;
125127
end;

‎source/api/ut_runner.pkb‎

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -105,20 +105,6 @@ create or replace package body ut_runner is
105105
end if;
106106
end;
107107

108-
procedure run(
109-
a_paths ut_varchar2_list, a_reporters ut_reporters, a_color_console boolean := false,
110-
a_coverage_schemes ut_varchar2_list := null, a_source_files ut_varchar2_list, a_test_files ut_varchar2_list,
111-
a_include_objects ut_varchar2_list := null, a_exclude_objects ut_varchar2_list := null, a_fail_on_errors boolean default false
112-
) is
113-
begin
114-
run(
115-
a_paths, a_reporters, a_color_console, a_coverage_schemes,
116-
ut_file_mapper.build_file_mappings(a_source_files),
117-
ut_file_mapper.build_file_mappings(a_test_files),
118-
a_include_objects, a_exclude_objects, a_fail_on_errors
119-
);
120-
end;
121-
122108
procedure rebuild_annotation_cache(a_object_owner varchar2, a_object_type varchar2) is
123109
begin
124110
ut_annotation_manager.rebuild_annotation_cache(a_object_owner, a_object_type);

‎source/api/ut_runner.pks‎

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -33,31 +33,34 @@ create or replace package ut_runner authid current_user is
3333
function version_compatibility_check( a_requested varchar2, a_current varchar2 := null ) return integer;
3434

3535
/**
36-
* Run suites/tests by path
37-
* Accepts value of the following formats:
38-
* schema - executes all suites in the schema
39-
* schema:suite1[.suite2] - executes all items of suite1 (suite2) in the schema.
36+
* Execute specified suites/tests by paths
37+
* @param a_paths list of schemes, packages, procedures or suite-paths to execute
38+
* @param a_reporters list of reporter objects (formats) to use for reporting
39+
* @param a_color_console true/false - should the console format reporters use ANSI color tags
40+
* @param a_coverage_schemes list of database schemes to include in coverage
41+
* @param a_source_file_mappings list of project source files mapped to DB objects that coverage should be reported on
42+
* @param a_test_file_mappings list of project test files mapped to DB objects that test results should be reported on
43+
* @param a_include_objects list of database objects (in format 'owner.name') that coverage should be reported on
44+
* @param a_exclude_objects list of database objects (in format 'owner.name') that coverage should be skipped for
45+
* @param a_fail_on_errors true/false - should an exception be thrown when tests are completed with failures/errors
46+
*
47+
* @example
48+
* Parameter `a_paths` accepts values of the following formats:
49+
* schema - executes all suites in the schema
50+
* schema:suite1[.suite2] - executes all items of suite1 (suite2) in the schema.
4051
* suite1.suite2 is a suitepath variable
41-
* schema:suite1[.suite2][.test1] - executes test1 in suite suite1.suite2
42-
* schema.suite1 - executes the suite package suite1 in the schema "schema"
52+
* schema:suite1[.suite2][.test1] - executes test1 in suite suite1.suite2
53+
* schema.suite1 - executes the suite package suite1 in the schema "schema"
4354
* all the parent suites in the hiearcy setups/teardown procedures as also executed
4455
* all chile items are executed
45-
* schema.suite1.test2 - executes test2 procedure of suite1 suite with execution of all
46-
* parent setup/teardown procedures
56+
* schema.suite1.test2 - executes test2 procedure of suite1 suite with execution of all parent setup/teardown procedures
4757
*/
48-
4958
procedure run(
5059
a_paths ut_varchar2_list, a_reporters ut_reporters, a_color_console boolean := false,
5160
a_coverage_schemes ut_varchar2_list := null, a_source_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
5261
a_include_objects ut_varchar2_list := null, a_exclude_objects ut_varchar2_list := null, a_fail_on_errors boolean default false
5362
);
5463

55-
procedure run(
56-
a_paths ut_varchar2_list, a_reporters ut_reporters, a_color_console boolean := false,
57-
a_coverage_schemes ut_varchar2_list := null, a_source_files ut_varchar2_list, a_test_files ut_varchar2_list,
58-
a_include_objects ut_varchar2_list := null, a_exclude_objects ut_varchar2_list := null, a_fail_on_errors boolean default false
59-
);
60-
6164
/**
6265
* Rebuilds annotation cache for a specified schema and object type.
6366
* The procedure is called internally by `get_annotated_objects` function.

0 commit comments

Comments
 (0)