From ba6f46209ca61c04691fa9601ea10f9b64b7a426 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jacek=20G=C4=99bal?= Date: Mon, 15 Aug 2016 23:53:10 +0100 Subject: [PATCH] Local variables, global variables and arguments now to match naming conventions. Existing code was refactored. --- source/types/ut_composite_object.tpb | 8 +- source/types/ut_composite_reporter.tpb | 10 +- source/types/ut_composite_reporter.tps | 6 +- .../types/ut_dbms_output_suite_reporter.tpb | 2 +- .../types/ut_dbms_output_suite_reporter.tps | 2 +- source/types/ut_executable.tpb | 2 +- source/types/ut_suite_reporter.tps | 2 +- source/types/ut_test.tpb | 27 ++-- source/types/ut_test_suite.tpb | 28 ++--- source/ut_assert.pkb | 70 +++++------ source/ut_assert.pks | 8 +- source/ut_metadata.pkb | 116 +++++++++--------- source/ut_metadata.pks | 4 +- 13 files changed, 138 insertions(+), 147 deletions(-) diff --git a/source/types/ut_composite_object.tpb b/source/types/ut_composite_object.tpb index 2fe28100e..a036e93d4 100644 --- a/source/types/ut_composite_object.tpb +++ b/source/types/ut_composite_object.tpb @@ -1,12 +1,12 @@ create or replace type body ut_composite_object is member procedure calc_execution_result(self in out nocopy ut_composite_object) is - v_result integer(1) := ut_utils.tr_success; + l_result integer(1) := ut_utils.tr_success; begin for i in 1 .. self.items.count loop - v_result := greatest(self.items(i).result, v_result); - exit when v_result = ut_utils.tr_error; + l_result := greatest(self.items(i).result, l_result); + exit when l_result = ut_utils.tr_error; end loop; - self.result := v_result; + self.result := l_result; end; end; diff --git a/source/types/ut_composite_reporter.tpb b/source/types/ut_composite_reporter.tpb index 56b5590b1..30a57bd3d 100644 --- a/source/types/ut_composite_reporter.tpb +++ b/source/types/ut_composite_reporter.tpb @@ -1,6 +1,6 @@ create or replace type body ut_composite_reporter is - constructor function ut_composite_reporter(the_reporters ut_reporters_list default ut_reporters_list()) + constructor function ut_composite_reporter(a_reporters ut_reporters_list default ut_reporters_list()) return self as result is begin self.name := $$plsql_unit; @@ -12,9 +12,9 @@ create or replace type body ut_composite_reporter is self.reporters.extend(1); self.reporters(self.reporters.last) := a_reporter; end; - member procedure remove_reporter(self in out nocopy ut_composite_reporter, an_index pls_integer) is + member procedure remove_reporter(self in out nocopy ut_composite_reporter, a_index pls_integer) is begin - for i in an_index + 1 .. self.reporters.last loop + for i in a_index + 1 .. self.reporters.last loop self.reporters(i - 1) := self.reporters(i); end loop; @@ -34,10 +34,10 @@ create or replace type body ut_composite_reporter is self.reporters(i).begin_test(a_test => a_test); end loop; end; - overriding member procedure on_assert(self in out nocopy ut_composite_reporter, an_assert ut_object) is + overriding member procedure on_assert(self in out nocopy ut_composite_reporter, a_assert ut_object) is begin for i in 1 .. self.reporters.count loop - self.reporters(i).on_assert(an_assert => an_assert); + self.reporters(i).on_assert(a_assert => a_assert); end loop; end; overriding member procedure end_test(self in out nocopy ut_composite_reporter, a_test ut_object) is diff --git a/source/types/ut_composite_reporter.tps b/source/types/ut_composite_reporter.tps index 26f34f03a..4369047da 100644 --- a/source/types/ut_composite_reporter.tps +++ b/source/types/ut_composite_reporter.tps @@ -2,14 +2,14 @@ create or replace type ut_composite_reporter under ut_suite_reporter ( reporters ut_reporters_list, - constructor function ut_composite_reporter(the_reporters ut_reporters_list default ut_reporters_list()) + constructor function ut_composite_reporter(a_reporters ut_reporters_list default ut_reporters_list()) return self as result, member procedure add_reporter(self in out nocopy ut_composite_reporter, a_reporter ut_suite_reporter), - member procedure remove_reporter(self in out nocopy ut_composite_reporter, an_index pls_integer), + member procedure remove_reporter(self in out nocopy ut_composite_reporter, a_index pls_integer), overriding member procedure begin_suite(self in out nocopy ut_composite_reporter, a_suite in ut_object), overriding member procedure begin_test(self in out nocopy ut_composite_reporter, a_test ut_object), - overriding member procedure on_assert(self in out nocopy ut_composite_reporter, an_assert ut_object), + overriding member procedure on_assert(self in out nocopy ut_composite_reporter, a_assert ut_object), overriding member procedure end_test(self in out nocopy ut_composite_reporter, a_test ut_object), overriding member procedure end_suite(self in out nocopy ut_composite_reporter, a_suite ut_object) diff --git a/source/types/ut_dbms_output_suite_reporter.tpb b/source/types/ut_dbms_output_suite_reporter.tpb index 1728a66bf..5ddfdebb2 100644 --- a/source/types/ut_dbms_output_suite_reporter.tpb +++ b/source/types/ut_dbms_output_suite_reporter.tpb @@ -30,7 +30,7 @@ create or replace type body ut_dbms_output_suite_reporter is print(ut_dbms_output_suite_reporter.c_dashed_line); end; - overriding member procedure on_assert(self in out nocopy ut_dbms_output_suite_reporter, an_assert ut_object) as + overriding member procedure on_assert(self in out nocopy ut_dbms_output_suite_reporter, a_assert ut_object) as begin --todo: report total suite result here with pretty message null; diff --git a/source/types/ut_dbms_output_suite_reporter.tps b/source/types/ut_dbms_output_suite_reporter.tps index 1eaa85a8b..b6dcb63d7 100644 --- a/source/types/ut_dbms_output_suite_reporter.tps +++ b/source/types/ut_dbms_output_suite_reporter.tps @@ -8,7 +8,7 @@ create or replace type ut_dbms_output_suite_reporter force under ut_suite_report overriding member procedure begin_suite(self in out nocopy ut_dbms_output_suite_reporter, a_suite ut_object), overriding member procedure begin_test(self in out nocopy ut_dbms_output_suite_reporter, a_test ut_object), - overriding member procedure on_assert(self in out nocopy ut_dbms_output_suite_reporter, an_assert ut_object), + overriding member procedure on_assert(self in out nocopy ut_dbms_output_suite_reporter, a_assert ut_object), overriding member procedure end_test(self in out nocopy ut_dbms_output_suite_reporter, a_test ut_object), overriding member procedure end_suite(self in out nocopy ut_dbms_output_suite_reporter, a_suite ut_object) diff --git a/source/types/ut_executable.tpb b/source/types/ut_executable.tpb index ca2ff7e9f..089108196 100644 --- a/source/types/ut_executable.tpb +++ b/source/types/ut_executable.tpb @@ -11,7 +11,7 @@ create or replace type body ut_executable is begin - ut_metadata.do_resolve(the_owner => owner, the_object => object_name, a_procedure_name => procedure_name); + ut_metadata.do_resolve(a_owner => owner, a_object => object_name, a_procedure_name => procedure_name); stmt := 'begin ' || ut_metadata.form_name(owner, object_name, procedure_name) || '; end;'; diff --git a/source/types/ut_suite_reporter.tps b/source/types/ut_suite_reporter.tps index d23730886..b8e052c4e 100644 --- a/source/types/ut_suite_reporter.tps +++ b/source/types/ut_suite_reporter.tps @@ -4,7 +4,7 @@ create or replace type ut_suite_reporter force as object not instantiable member procedure begin_suite(self in out nocopy ut_suite_reporter, a_suite in ut_object), not instantiable member procedure begin_test(self in out nocopy ut_suite_reporter, a_test in ut_object), - not instantiable member procedure on_assert(self in out nocopy ut_suite_reporter, an_assert in ut_object), + not instantiable member procedure on_assert(self in out nocopy ut_suite_reporter, a_assert in ut_object), not instantiable member procedure end_test(self in out nocopy ut_suite_reporter, a_test in ut_object), not instantiable member procedure end_suite(self in out nocopy ut_suite_reporter, a_suite in ut_object) diff --git a/source/types/ut_test.tpb b/source/types/ut_test.tpb index f61f0deb2..f023805e6 100644 --- a/source/types/ut_test.tpb +++ b/source/types/ut_test.tpb @@ -24,24 +24,21 @@ create or replace type body ut_test is end ut_test; member function is_valid(self in ut_test) return boolean is - v_is_valid boolean; begin - v_is_valid := test.is_valid('test') and (setup is null or setup.is_valid('setup')) and + return test.is_valid('test') and (setup is null or setup.is_valid('setup')) and (teardown is null or teardown.is_valid('teardown')); - - return v_is_valid; end is_valid; overriding member procedure execute(self in out nocopy ut_test, a_reporter ut_suite_reporter) is - reporter ut_suite_reporter := a_reporter; + l_reporter ut_suite_reporter := a_reporter; begin - reporter := execute(reporter); + l_reporter := execute(l_reporter); end; overriding member function execute(self in out nocopy ut_test, a_reporter ut_suite_reporter) return ut_suite_reporter is - reporter ut_suite_reporter := a_reporter; + l_reporter ut_suite_reporter := a_reporter; begin - if reporter is not null then - reporter.begin_test(self); + if l_reporter is not null then + l_reporter.begin_test(self); end if; begin @@ -98,20 +95,20 @@ create or replace type body ut_test is self.calc_execution_result; - if reporter is not null then + if l_reporter is not null then for i in 1 .. self.items.count loop - reporter.on_assert(treat(self.items(i) as ut_assert_result)); + l_reporter.on_assert(treat(self.items(i) as ut_assert_result)); end loop; - reporter.end_test(self); + l_reporter.end_test(self); end if; - return reporter; + return l_reporter; end; overriding member procedure execute(self in out nocopy ut_test) is - v_null_reporter ut_suite_reporter; + l_null_reporter ut_suite_reporter; begin - self.execute(v_null_reporter); + self.execute(l_null_reporter); end execute; end; diff --git a/source/types/ut_test_suite.tpb b/source/types/ut_test_suite.tpb index 061a7cf36..462457cda 100644 --- a/source/types/ut_test_suite.tpb +++ b/source/types/ut_test_suite.tpb @@ -16,17 +16,17 @@ create or replace type body ut_test_suite is end add_item; overriding member procedure execute(self in out nocopy ut_test_suite, a_reporter ut_suite_reporter) is - reporter ut_suite_reporter := a_reporter; + l_reporter ut_suite_reporter := a_reporter; begin - reporter := execute(reporter); + l_reporter := execute(l_reporter); end; overriding member function execute(self in out nocopy ut_test_suite, a_reporter ut_suite_reporter) return ut_suite_reporter is - reporter ut_suite_reporter := a_reporter; - test_object ut_test_object; + l_reporter ut_suite_reporter := a_reporter; + l_test_object ut_test_object; begin - if reporter is not null then - reporter.begin_suite(self); + if l_reporter is not null then + l_reporter.begin_suite(self); end if; $if $$ut_trace $then @@ -36,25 +36,25 @@ create or replace type body ut_test_suite is self.start_time := current_timestamp; for i in self.items.first .. self.items.last loop - test_object := treat(self.items(i) as ut_test_object); - reporter := test_object.execute(a_reporter => reporter); - self.items(i) := test_object; + l_test_object := treat(self.items(i) as ut_test_object); + l_reporter := l_test_object.execute(a_reporter => l_reporter); + self.items(i) := l_test_object; end loop; self.end_time := current_timestamp; self.calc_execution_result; - if reporter is not null then - reporter.end_suite(self); + if l_reporter is not null then + l_reporter.end_suite(self); end if; - return reporter; + return l_reporter; end; overriding member procedure execute(self in out nocopy ut_test_suite) is - v_null_reporter ut_suite_reporter; + l_null_reporter ut_suite_reporter; begin - self.execute(v_null_reporter); + self.execute(l_null_reporter); end; end; diff --git a/source/ut_assert.pkb b/source/ut_assert.pkb index bcc85c359..f63d8220e 100644 --- a/source/ut_assert.pkb +++ b/source/ut_assert.pkb @@ -1,6 +1,6 @@ create or replace package body ut_assert is - current_asserts_called ut_objects_list := ut_objects_list(); + g_current_asserts_called ut_objects_list := ut_objects_list(); function current_assert_test_result return integer is begin @@ -8,12 +8,12 @@ create or replace package body ut_assert is dbms_output.put_line('ut_assert.current_assert_test_result'); $end - return get_assert_list_final_result(current_asserts_called); + return get_assert_list_final_result(g_current_asserts_called); end; function get_assert_list_final_result(a_assert_list in ut_objects_list) return integer is - v_result integer; - assert ut_assert_result; + l_result integer; + l_assert ut_assert_result; begin $if $$ut_trace $then dbms_output.put_line('ut_assert.get_assert_list_final_result'); @@ -21,21 +21,21 @@ create or replace package body ut_assert is if a_assert_list is not null then - v_result := ut_utils.tr_success; + l_result := ut_utils.tr_success; for i in a_assert_list.first .. a_assert_list.last loop - assert := treat(a_assert_list(i) as ut_assert_result); - if assert.result = ut_utils.tr_failure then - v_result := ut_utils.tr_failure; + l_assert := treat(a_assert_list(i) as ut_assert_result); + if l_assert.result = ut_utils.tr_failure then + l_result := ut_utils.tr_failure; end if; - if assert.result = ut_utils.tr_error then - v_result := ut_utils.tr_error; + if l_assert.result = ut_utils.tr_error then + l_result := ut_utils.tr_error; exit; end if; end loop; end if; - return v_result; + return l_result; end get_assert_list_final_result; procedure clear_asserts is @@ -44,23 +44,23 @@ create or replace package body ut_assert is dbms_output.put_line('ut_assert.clear_asserts'); $end - current_asserts_called.delete; + g_current_asserts_called.delete; end; - procedure process_asserts(newtable out ut_objects_list) is + procedure process_asserts(a_newtable out ut_objects_list) is begin $if $$ut_trace $then dbms_output.put_line('ut_assert.copy_called_asserts'); $end - newtable := ut_objects_list(); -- make sure new table is empty - newtable.extend(current_asserts_called.last); - for i in current_asserts_called.first .. current_asserts_called.last loop + a_newtable := ut_objects_list(); -- make sure new table is empty + a_newtable.extend(g_current_asserts_called.last); + for i in g_current_asserts_called.first .. g_current_asserts_called.last loop $if $$ut_trace $then dbms_output.put_line(i || '-start'); $end - newtable(i) := current_asserts_called(i); + a_newtable(i) := g_current_asserts_called(i); $if $$ut_trace $then dbms_output.put_line(i || '-end'); @@ -70,45 +70,45 @@ create or replace package body ut_assert is clear_asserts; end process_asserts; - procedure report_assert(assert_result in integer, message in varchar2) is - v_result ut_assert_result; + procedure report_assert(a_assert_result in integer, a_message in varchar2) is + l_result ut_assert_result; begin $if $$ut_trace $then - dbms_output.put_line('ut_assert.report_assert :' || assert_result || ':' || message); + dbms_output.put_line('ut_assert.report_assert :' || a_assert_result || ':' || a_message); $end - v_result := ut_assert_result(assert_result, message); - current_asserts_called.extend; - current_asserts_called(current_asserts_called.last) := v_result; + l_result := ut_assert_result(a_assert_result, a_message); + g_current_asserts_called.extend; + g_current_asserts_called(g_current_asserts_called.last) := l_result; end; - procedure report_success(message in varchar2, expected in varchar2, actual in varchar2) is + procedure report_success(a_message in varchar2, a_expected in varchar2, a_actual in varchar2) is begin report_assert(ut_utils.tr_success - ,nvl(message, '') || ' expected: ' || nvl(expected, '') || ' actual: ' || nvl(actual, '')); + ,nvl(a_message, '') || ' expected: ' || nvl(a_expected, '') || ' actual: ' || nvl(a_actual, '')); end; - procedure report_failure(message in varchar2, expected in varchar2, actual in varchar2) is + procedure report_failure(a_message in varchar2, a_expected in varchar2, a_actual in varchar2) is begin report_assert(ut_utils.tr_failure - ,nvl(message, '') || ' expected: ' || nvl(expected, '') || ' actual: ' || nvl(actual, '')); + ,nvl(a_message, '') || ' expected: ' || nvl(a_expected, '') || ' actual: ' || nvl(a_actual, '')); end; - procedure report_error(message in varchar2) is + procedure report_error(a_message in varchar2) is begin - report_assert(ut_utils.tr_error, message); + report_assert(ut_utils.tr_error, a_message); end; - procedure are_equal(expected in number, actual in number) is + procedure are_equal(a_expected in number, a_actual in number) is begin - are_equal('Equality test', expected, actual); + are_equal('Equality test', a_expected, a_actual); end; - procedure are_equal(msg in varchar2, expected in number, actual in number) is + procedure are_equal(a_msg in varchar2, a_expected in number, a_actual in number) is begin - if expected = actual then - report_success(msg, expected, actual); + if a_expected = a_actual then + report_success(a_msg, a_expected, a_actual); else - report_failure(msg, expected, actual); + report_failure(a_msg, a_expected, a_actual); end if; end; diff --git a/source/ut_assert.pks b/source/ut_assert.pks index 9f6814ff2..069842b7a 100644 --- a/source/ut_assert.pks +++ b/source/ut_assert.pks @@ -3,12 +3,12 @@ create or replace package ut_assert authid current_user as function get_assert_list_final_result(a_assert_list in ut_objects_list) return integer; function current_assert_test_result return integer; procedure clear_asserts; - procedure report_error(message in varchar2); - procedure process_asserts(newtable out ut_objects_list); + procedure report_error(a_message in varchar2); + procedure process_asserts(a_newtable out ut_objects_list); /* Just need something to play with for now */ - procedure are_equal(expected in number, actual in number); - procedure are_equal(msg in varchar2, expected in number, actual in number); + procedure are_equal(a_expected in number, a_actual in number); + procedure are_equal(a_msg in varchar2, a_expected in number, a_actual in number); end ut_assert; / diff --git a/source/ut_metadata.pkb b/source/ut_metadata.pkb index 7a24066b3..f7471a6eb 100644 --- a/source/ut_metadata.pkb +++ b/source/ut_metadata.pkb @@ -1,65 +1,62 @@ create or replace package body ut_metadata as - procedure do_resolve(the_owner in out varchar2, the_object in out varchar2, a_procedure_name in out varchar2) is - name varchar2(200); - context integer; - dblink varchar2(200); - part1_type number; - object_number number; + procedure do_resolve(a_owner in out varchar2, a_object in out varchar2, a_procedure_name in out varchar2) is + l_name varchar2(200); + l_context integer; + l_dblink varchar2(200); + l_part1_type number; + l_object_number number; begin - name := form_name(the_owner, the_object, a_procedure_name); + l_name := form_name(a_owner, a_object, a_procedure_name); - context := 1; --plsql + l_context := 1; --plsql - dbms_utility.name_resolve(name => name - ,context => context - ,schema => the_owner - ,part1 => the_object + dbms_utility.name_resolve(name => l_name + ,context => l_context + ,schema => a_owner + ,part1 => a_object ,part2 => a_procedure_name - ,dblink => dblink - ,part1_type => part1_type - ,object_number => object_number); + ,dblink => l_dblink + ,part1_type => l_part1_type + ,object_number => l_object_number); end do_resolve; function form_name(a_owner_name varchar2, a_object varchar2, a_subprogram varchar2 default null) return varchar2 is - name varchar2(200); + l_name varchar2(200); begin - name := a_object; + l_name := a_object; if trim(a_owner_name) is not null then - name := trim(a_owner_name) || '.' || name; + l_name := trim(a_owner_name) || '.' || l_name; end if; if trim(a_subprogram) is not null then - name := name || '.' || a_subprogram; + l_name := l_name || '.' || a_subprogram; end if; - return name; + return l_name; end form_name; function package_valid(a_owner_name varchar2, a_package_name in varchar2) return boolean as - v_prc number; - name varchar2(200); - schema varchar2(200); - part1 varchar2(200); - part2 varchar2(200); - dblink varchar2(200); - part1_type number; - object_number number; + l_cnt number; + l_name varchar2(200); + l_schema varchar2(200); + l_package_name varchar2(200); + l_procedure_name varchar2(200); begin - schema := a_owner_name; - part1 := a_package_name; + l_schema := a_owner_name; + l_package_name := a_package_name; - do_resolve(schema, part1, part2); + do_resolve(l_schema, l_package_name, l_procedure_name); select count(decode(status, 'VALID', 1, null)) / count(*) - into v_prc + into l_cnt from all_objects - where owner = schema - and object_name = part1 + where owner = l_schema + and object_name = l_package_name and object_type in ('PACKAGE', 'PACKAGE BODY'); -- expect both package and body to be valid - return v_prc = 1; + return l_cnt = 1; exception when others then return false; @@ -67,45 +64,42 @@ create or replace package body ut_metadata as function procedure_exists(a_owner_name varchar2, a_package_name in varchar2, a_procedure_name in varchar2) return boolean as - v_cnt number; - name varchar2(200); - schema varchar2(200); - part1 varchar2(200); - part2 varchar2(200); - dblink varchar2(200); - part1_type number; - object_number number; + l_cnt number; + l_name varchar2(200); + l_schema varchar2(200); + l_package_name varchar2(200); + l_procedure_name varchar2(200); begin - schema := a_owner_name; - part1 := a_package_name; - part2 := a_procedure_name; - - do_resolve(schema, part1, part2); + l_schema := a_owner_name; + l_package_name := a_package_name; + l_procedure_name := a_procedure_name; + + do_resolve(l_schema, l_package_name, l_procedure_name); select count(*) - into v_cnt + into l_cnt from all_procedures - where owner = schema - and object_name = part1 - and procedure_name = part2; + where owner = l_schema + and object_name = l_package_name + and procedure_name = l_procedure_name; --expect one method only for the package with that name. - return v_cnt = 1; + return l_cnt = 1; exception when others then return false; end; - function resolvable(the_owner in varchar2, the_object in varchar2, a_procedurename in varchar2) return boolean is - owner varchar2(200); - object_name varchar2(200); - procedure_name varchar2(200); + function resolvable(a_owner in varchar2, a_object in varchar2, a_procedurename in varchar2) return boolean is + l_owner varchar2(200); + l_object_name varchar2(200); + l_procedure_name varchar2(200); begin - owner := the_owner; - object_name := the_object; - procedure_name := a_procedurename; - do_resolve(owner, object_name, procedure_name); + l_owner := a_owner; + l_object_name := a_object; + l_procedure_name := a_procedurename; + do_resolve(l_owner, l_object_name, l_procedure_name); return true; exception when others then diff --git a/source/ut_metadata.pks b/source/ut_metadata.pks index 26344794b..8a6dca6d5 100644 --- a/source/ut_metadata.pks +++ b/source/ut_metadata.pks @@ -20,7 +20,7 @@ create or replace package ut_metadata as tries to resolve full subprogram name using dbms_utility.name_resolve */ - function resolvable(the_owner in varchar2, the_object in varchar2, a_procedurename in varchar2) return boolean; + function resolvable(a_owner in varchar2, a_object in varchar2, a_procedurename in varchar2) return boolean; /* function: package_valid @@ -46,7 +46,7 @@ create or replace package ut_metadata as resolves [owner.]object[.procedure] using dbms_utility.name_resolve and returnes resolved parts */ - procedure do_resolve(the_owner in out varchar2, the_object in out varchar2, a_procedure_name in out varchar2); + procedure do_resolve(a_owner in out varchar2, a_object in out varchar2, a_procedure_name in out varchar2); end ut_metadata; /