Changes to ut_test_object - reporter is IN parameter only.

jgebal · jgebal · commit 7c6103e617db · 2016-07-22T09:51:09.000+01:00
Added install/removal of example objects in example scripts
Added printing of leading spaces in sqlplus for custom reporter example.
Split example reporter type into two files.
Minor tweaks and refactorings.
diff --git a/examples/RunExampleComplexSuiteWithCustomDBMSOutputReporter.sql b/examples/RunExampleComplexSuiteWithCustomDBMSOutputReporter.sql
@@ -2,14 +2,21 @@
 --No tables are used for this.   
 --Suite Management packages are when developed will make this easier.
 Clear Screen
-Set Serveroutput On Size Unlimited
+Set Serveroutput On Size Unlimited format truncated
+set echo off
+--install the example unit test packages
+@@ut_exampletest.pks
+@@ut_exampletest.pkb
+@@ut_exampletest2.pks
+@@ut_exampletest2.pkb
+@@ut_custom_reporter.tps
+@@ut_custom_reporter.tpb
 
 declare
   suite1        ut_test_suite;
   suite2        ut_test_suite;
   suite_complex ut_test_suite;
   testtoexecute ut_test;
-  reporter      ut_suite_reporter;
 begin
   suite1 := ut_test_suite(a_suite_name => 'Test Suite 1' /*,a_items => ut_test_objects_list()*/);
 
@@ -32,14 +39,8 @@ begin
   suite_complex := ut_test_suite(a_suite_name => 'Complex Test Suite', a_items => ut_test_objects_list(suite1, suite2));
 
   -- provide a reporter to process results
-  --reporter := ut_dbms_output_suite_reporter;
-	reporter := ut_custom_reporter(a_tab_size => 2);
-  suite_complex.execute(reporter);
+  suite_complex.execute(ut_custom_reporter(a_tab_size => 2));
 end;
 /
 
-
-
-
-
-
+drop type ut_custom_reporter;
diff --git a/examples/RunExampleTestSuite.sql b/examples/RunExampleTestSuite.sql
@@ -2,7 +2,13 @@
 --No tables are used for this.   
 --Suite Management packages are when developed will make this easier.
 Clear Screen
-Set Serveroutput On Size Unlimited
+Set Serveroutput On Size Unlimited format truncated
+set echo off
+--install the example unit test packages
+@@ut_exampletest.pks
+@@ut_exampletest.pkb
+@@ut_exampletest2.pks
+@@ut_exampletest2.pkb
 
 declare
   suite         ut_test_suite;
diff --git a/examples/RunExampleTestSuiteWithCustomDBMSOutputReporter.sql b/examples/RunExampleTestSuiteWithCustomDBMSOutputReporter.sql
@@ -2,12 +2,19 @@
 --No tables are used for this.   
 --Suite Management packages are when developed will make this easier.
 Clear Screen
-Set Serveroutput On Size Unlimited
+Set Serveroutput On Size Unlimited format truncated --http://stackoverflow.com/questions/2584492/how-to-prevent-dbms-output-put-line-from-trimming-leading-whitespace
+set echo off
+--install the example unit test packages
+@@ut_exampletest.pks
+@@ut_exampletest.pkb
+@@ut_exampletest2.pks
+@@ut_exampletest2.pkb
+@@ut_custom_reporter.tps
+@@ut_custom_reporter.tpb
 
 declare
   suite         ut_test_suite;
   testtoexecute ut_test;
-  reporter      ut_suite_reporter;
 begin
   -- Install ut_custom_reporter first from example folder	
 
@@ -28,7 +35,9 @@ begin
   suite.add_item(testtoexecute);
 
   -- provide a reporter to process results tabbing each hierarcy level by tab_size
-  reporter := ut_custom_reporter(a_tab_size => 2);
-  suite.execute(reporter);
+  suite.execute(ut_custom_reporter(a_tab_size => 2));
 end;
 /
+
+
+drop type ut_custom_reporter;
diff --git a/examples/RunExampleTestSuiteWithDBMSOutputReporter.sql b/examples/RunExampleTestSuiteWithDBMSOutputReporter.sql
@@ -2,12 +2,17 @@
 --No tables are used for this.   
 --Suite Management packages are when developed will make this easier.
 Clear Screen
-Set Serveroutput On Size Unlimited
+Set Serveroutput On Size Unlimited format truncated
+set echo off
+--install the example unit test packages
+@@ut_exampletest.pks
+@@ut_exampletest.pkb
+@@ut_exampletest2.pks
+@@ut_exampletest2.pkb
 
 declare
   suite         ut_test_suite;
   testtoexecute ut_test;
-  reporter      ut_suite_reporter;
 begin
   suite := ut_test_suite(a_suite_name => 'Test Suite Name' /*,a_items => ut_test_objects_list()*/);
 
@@ -26,13 +31,6 @@ begin
   suite.add_item(testtoexecute);
 
   -- provide a reporter to process results
-  reporter := ut_dbms_output_suite_reporter;
-  suite.execute(reporter);
+  suite.execute(ut_dbms_output_suite_reporter);
 end;
 /
-
-
-
-
-
-
diff --git a/examples/RunExampleTestThroughBaseClass.sql b/examples/RunExampleTestThroughBaseClass.sql
@@ -1,7 +1,11 @@
 --This shows how the interna test engine works to test a single package.
 --No tables are used for this and exceptions are handled better.
 Clear Screen
-Set Serveroutput On Size Unlimited
+Set Serveroutput On Size Unlimited format truncated
+set echo off
+--install the example unit test packages
+@@ut_exampletest.pks
+@@ut_exampletest.pkb
 
 declare
   simple_test ut_test;
diff --git a/examples/ut_custom_reporter.tpb b/examples/ut_custom_reporter.tpb
@@ -0,0 +1,48 @@
+create or replace type body ut_custom_reporter is
+
+  constructor function ut_custom_reporter(a_tab_size integer default 4) return self as result is
+  begin
+    self.name := $$plsql_unit;
+    self.lvl  := 0;
+    self.tab_size := a_tab_size;
+    return;
+  end;
+
+  member function tab(self in ut_custom_reporter) return varchar2 is
+	  tab_str varchar2(255);
+  begin
+		tab_str := rpad(' ', lvl * tab_size);
+    return tab_str;
+  end tab;
+
+  overriding member procedure print(msg varchar2) is
+  begin
+    (self as ut_dbms_output_suite_reporter).print(tab || msg);
+  end print;
+
+  overriding member procedure begin_suite(self in out nocopy ut_custom_reporter, a_suite_name in varchar2) as
+  begin
+    (self as ut_dbms_output_suite_reporter).begin_suite(a_suite_name);
+    lvl := lvl + 1;
+  end;
+
+  overriding member procedure end_suite(self in out nocopy ut_custom_reporter, a_suite_name in varchar2, a_suite_execution_result in ut_execution_result) as
+  begin
+    lvl := lvl - 1;
+    (self as ut_dbms_output_suite_reporter).end_suite(a_suite_name,a_suite_execution_result);
+  end;
+
+  overriding member procedure begin_test(self in out nocopy ut_custom_reporter, a_test_name in varchar2, a_test_call_params in ut_test_call_params) as
+  begin
+    (self as ut_dbms_output_suite_reporter).begin_test(a_test_name,a_test_call_params);
+    lvl := lvl + 1;
+  end;
+
+  overriding member procedure end_test(self in out nocopy ut_custom_reporter, a_test_name in varchar2, a_test_call_params in ut_test_call_params, a_execution_result in ut_execution_result, a_assert_list in ut_assert_list) as
+  begin
+    lvl := lvl - 1;
+    (self as ut_dbms_output_suite_reporter).end_test(a_test_name, a_test_call_params, a_execution_result, a_assert_list);
+  end;
+	
+end;
+/
diff --git a/examples/ut_custom_reporter.tps b/examples/ut_custom_reporter.tps
@@ -0,0 +1,16 @@
+create or replace type ut_custom_reporter under ut_dbms_output_suite_reporter
+(
+  lvl integer,
+  tab_size integer,
+
+-- Member functions and procedures
+  constructor function ut_custom_reporter(a_tab_size integer default 4) return self as result,
+  member function tab(self in ut_custom_reporter) return varchar2,
+  overriding member procedure print(msg varchar2),
+  overriding member procedure begin_suite(self in out nocopy ut_custom_reporter, a_suite_name in varchar2),
+  overriding member procedure end_suite(self in out nocopy ut_custom_reporter, a_suite_name in varchar2, a_suite_execution_result in ut_execution_result),
+  overriding member procedure begin_test(self in out nocopy ut_custom_reporter, a_test_name in varchar2, a_test_call_params in ut_test_call_params),
+  overriding member procedure end_test(self in out nocopy ut_custom_reporter, a_test_name in varchar2, a_test_call_params in ut_test_call_params, a_execution_result in ut_execution_result, a_assert_list in ut_assert_list)
+)
+not final
+/
diff --git a/examples/ut_custom_reporter.typ b/examples/ut_custom_reporter.typ
diff --git a/source/types/ut_dbms_output_suite_reporter.tpb b/source/types/ut_dbms_output_suite_reporter.tpb
@@ -2,7 +2,7 @@ create or replace type body ut_dbms_output_suite_reporter is
 
   static function c_dashed_line return varchar2 is
   begin
-    return '--------------------------------------------------------------------------------';
+    return lpad('-',80,'-');
   end;
 
   constructor function ut_dbms_output_suite_reporter return self as result is
@@ -31,11 +31,6 @@ create or replace type body ut_dbms_output_suite_reporter is
   end;
 
   overriding member procedure begin_test(self in out nocopy ut_dbms_output_suite_reporter, a_test_name in varchar2, a_test_call_params in ut_test_call_params) as
-  begin
-    null;
-  end;
-
-  overriding member procedure end_test(self in out nocopy ut_dbms_output_suite_reporter, a_test_name in varchar2, a_test_call_params in ut_test_call_params, a_execution_result in ut_execution_result, a_assert_list in ut_assert_list) as
   begin
     print(ut_dbms_output_suite_reporter.c_dashed_line);
     if a_test_name is not null then
@@ -48,7 +43,10 @@ create or replace type body ut_dbms_output_suite_reporter is
                                              ,a_test_call_params.object_name
                                              ,a_test_call_params.test_procedure));
     end if;
-  
+  end;
+
+  overriding member procedure end_test(self in out nocopy ut_dbms_output_suite_reporter, a_test_name in varchar2, a_test_call_params in ut_test_call_params, a_execution_result in ut_execution_result, a_assert_list in ut_assert_list) as
+  begin
     print('result: ' || a_execution_result.result_to_char);
     print('asserts');
     for i in a_assert_list.first .. a_assert_list.last loop
diff --git a/source/types/ut_dbms_output_suite_reporter.tps b/source/types/ut_dbms_output_suite_reporter.tps
@@ -9,9 +9,9 @@ create or replace type ut_dbms_output_suite_reporter force under ut_suite_report
 	member procedure print(msg varchar2),
 	
   overriding member procedure begin_suite(self in out nocopy ut_dbms_output_suite_reporter, a_suite_name in varchar2),
-  overriding member procedure end_suite(self in out nocopy ut_dbms_output_suite_reporter, a_suite_name in varchar2, a_suite_execution_result in ut_execution_result),
   overriding member procedure begin_test(self in out nocopy ut_dbms_output_suite_reporter, a_test_name in varchar2, a_test_call_params in ut_test_call_params),
-  overriding member procedure end_test(self in out nocopy ut_dbms_output_suite_reporter, a_test_name in varchar2, a_test_call_params in ut_test_call_params, a_execution_result in ut_execution_result, a_assert_list in ut_assert_list)
-	
+  overriding member procedure end_test(self in out nocopy ut_dbms_output_suite_reporter, a_test_name in varchar2, a_test_call_params in ut_test_call_params, a_execution_result in ut_execution_result, a_assert_list in ut_assert_list),
+  overriding member procedure end_suite(self in out nocopy ut_dbms_output_suite_reporter, a_suite_name in varchar2, a_suite_execution_result in ut_execution_result)
+
 ) not final
 /
diff --git a/source/types/ut_execution_result.tpb b/source/types/ut_execution_result.tpb
@@ -4,7 +4,7 @@ create or replace type body ut_execution_result is
     return self as result is
   begin
     self.start_time := a_start_time;
-		self.result := ut_utils.tr_success;
+    self.result := ut_utils.tr_success;
     return;
   end ut_execution_result;
 
diff --git a/source/types/ut_suite_reporter.tps b/source/types/ut_suite_reporter.tps
@@ -3,9 +3,9 @@ create or replace type ut_suite_reporter force as object
   name varchar2(250 char),
 
   not instantiable member procedure begin_suite(self in out nocopy ut_suite_reporter, a_suite_name in varchar2),
-  not instantiable member procedure end_suite(self in out nocopy ut_suite_reporter, a_suite_name in varchar2, a_suite_execution_result in ut_execution_result),
   not instantiable member procedure begin_test(self in out nocopy ut_suite_reporter, a_test_name in varchar2, a_test_call_params in ut_test_call_params),
-  not instantiable member procedure end_test(self in out nocopy ut_suite_reporter, a_test_name in varchar2, a_test_call_params in ut_test_call_params, a_execution_result in ut_execution_result, a_assert_list in ut_assert_list)
+  not instantiable member procedure end_test(self in out nocopy ut_suite_reporter, a_test_name in varchar2, a_test_call_params in ut_test_call_params, a_execution_result in ut_execution_result, a_assert_list in ut_assert_list),
+  not instantiable member procedure end_suite(self in out nocopy ut_suite_reporter, a_suite_name in varchar2, a_suite_execution_result in ut_execution_result)
 
 )
 not instantiable not final
diff --git a/source/types/ut_test.tpb b/source/types/ut_test.tpb
@@ -35,11 +35,12 @@ create or replace type body ut_test is
     return true;
   end is_valid;
 
-  overriding member procedure execute(self in out nocopy ut_test, a_reporter in out nocopy ut_suite_reporter) is
-    params_valid boolean;  
+  overriding member procedure execute(self in out nocopy ut_test, a_reporter ut_suite_reporter) is
+    params_valid boolean;
+    reporter ut_suite_reporter := a_reporter;
   begin
-    if a_reporter is not null then
-      a_reporter.begin_test(a_test_name => self.name, a_test_call_params => self.call_params);
+    if reporter is not null then
+      reporter.begin_test(a_test_name => self.name, a_test_call_params => self.call_params);
     end if;
   
     begin
@@ -75,21 +76,26 @@ create or replace type body ut_test is
     
     exception
       when others then
+        if sqlcode = -04068 then
+          --raise on ORA-04068: existing state of packages has been discarded to avoid unrecoverable session exception
+          raise;
+        end if;
         $if $$ut_trace $then
         dbms_output.put_line('ut_test.execute failed-' || sqlerrm(sqlcode) || ' ' ||
                              dbms_utility.format_error_backtrace);
         $end
         -- most likely occured in setup or teardown if here.
         ut_assert.report_error(sqlerrm(sqlcode) || ' ' || dbms_utility.format_error_stack);
         ut_assert.report_error(sqlerrm(sqlcode) || ' ' || dbms_utility.format_error_backtrace);
+        self.execution_result.end_time := current_timestamp;
         ut_assert.process_asserts(self.assert_results, self.execution_result.result);
     end;
   
-    if a_reporter is not null then
-      a_reporter.end_test(a_test_name        => self.name
-                         ,a_test_call_params => self.call_params
-                         ,a_execution_result => self.execution_result
-                         ,a_assert_list      => self.assert_results);
+    if reporter is not null then
+      reporter.end_test(a_test_name        => self.name
+                       ,a_test_call_params => self.call_params
+                       ,a_execution_result => self.execution_result
+                       ,a_assert_list      => self.assert_results);
     end if;
   end;
 
diff --git a/source/types/ut_test.tps b/source/types/ut_test.tps
@@ -16,7 +16,7 @@ create or replace type ut_test force under ut_test_object
 
   member function is_valid(self in ut_test) return boolean,
 
-  overriding member procedure execute(self in out nocopy ut_test, a_reporter in out nocopy ut_suite_reporter),
+  overriding member procedure execute(self in out nocopy ut_test, a_reporter ut_suite_reporter),
   overriding member procedure execute(self in out nocopy ut_test)
 
 )
diff --git a/source/types/ut_test_object.tps b/source/types/ut_test_object.tps
diff --git a/source/types/ut_test_suite.tpb b/source/types/ut_test_suite.tpb
diff --git a/source/types/ut_test_suite.tps b/source/types/ut_test_suite.tps
diff --git a/source/ut_utils.pks b/source/ut_utils.pks
