Added ability to control rollback bekavior of a test-run.

jgebal · jgebal · commit 6bf2c8e39e2b · 2018-11-18T00:26:21.000Z
diff --git a/source/api/ut.pkb b/source/api/ut.pkb
@@ -18,6 +18,7 @@ create or replace package body ut is
   */
 
   g_nls_date_format varchar2(4000);
+  gc_fail_on_errors constant boolean := false;
 
   function version return varchar2 is
   begin
@@ -117,7 +118,6 @@ create or replace package body ut is
     a_client_character_set varchar2 := null
   ) is
     pragma autonomous_transaction;
-    c_fail_on_errors constant boolean := false;
   begin
     a_reporter := coalesce(a_reporter,ut_documentation_reporter());
     ut_runner.run(
@@ -129,7 +129,7 @@ create or replace package body ut is
       a_test_file_mappings,
       a_include_objects,
       a_exclude_objects,
-      c_fail_on_errors,
+      gc_fail_on_errors,
       a_client_character_set
     );
     rollback;
@@ -147,7 +147,6 @@ create or replace package body ut is
     a_client_character_set varchar2 := null
   ) is
     pragma autonomous_transaction;
-    c_fail_on_errors constant boolean := false;
   begin
     a_reporter := coalesce(a_reporter,ut_documentation_reporter());
     ut_runner.run(
@@ -159,7 +158,7 @@ create or replace package body ut is
       ut_file_mapper.build_file_mappings(a_test_files),
       a_include_objects,
       a_exclude_objects,
-      c_fail_on_errors,
+      gc_fail_on_errors,
       a_client_character_set
     );
     rollback;
@@ -406,21 +405,39 @@ create or replace package body ut is
     a_test_file_mappings ut_file_mappings := null,
     a_include_objects ut_varchar2_list := null,
     a_exclude_objects ut_varchar2_list := null,
-    a_client_character_set varchar2 := null
+    a_client_character_set varchar2 := null,
+    a_force_manual_rollback boolean := false
   ) is
     l_reporter  ut_reporter_base := a_reporter;
   begin
-    run_autonomous(
-      a_paths,
-      l_reporter,
-      ut_utils.boolean_to_int(a_color_console),
-      a_coverage_schemes,
-      a_source_file_mappings,
-      a_test_file_mappings,
-      a_include_objects,
-      a_exclude_objects,
-      a_client_character_set
-    );
+    if a_force_manual_rollback then
+      l_reporter := coalesce(l_reporter,ut_documentation_reporter());
+      ut_runner.run(
+        a_paths,
+        ut_reporters(l_reporter),
+        a_color_console,
+        a_coverage_schemes,
+        a_source_file_mappings,
+        a_test_file_mappings,
+        a_include_objects,
+        a_exclude_objects,
+        gc_fail_on_errors,
+        a_client_character_set,
+        a_force_manual_rollback
+      );
+    else
+      run_autonomous(
+        a_paths,
+        l_reporter,
+        ut_utils.boolean_to_int(a_color_console),
+        a_coverage_schemes,
+        a_source_file_mappings,
+        a_test_file_mappings,
+        a_include_objects,
+        a_exclude_objects,
+        a_client_character_set
+      );
+    end if;
     if l_reporter is of (ut_output_reporter_base) then
         treat(l_reporter as ut_output_reporter_base).lines_to_dbms_output();
     end if;
@@ -436,25 +453,23 @@ create or replace package body ut is
     a_test_files ut_varchar2_list,
     a_include_objects ut_varchar2_list := null,
     a_exclude_objects ut_varchar2_list := null,
-    a_client_character_set varchar2 := null
+    a_client_character_set varchar2 := null,
+    a_force_manual_rollback boolean := false
   ) is
     l_reporter  ut_reporter_base := a_reporter;
   begin
-    run_autonomous(
+    ut.run(
       a_paths,
       l_reporter,
-      ut_utils.boolean_to_int(a_color_console),
+      a_color_console,
       a_coverage_schemes,
-      a_source_files,
-      a_test_files,
+      ut_file_mapper.build_file_mappings(a_source_files),
+      ut_file_mapper.build_file_mappings(a_test_files),
       a_include_objects,
       a_exclude_objects,
-      a_client_character_set
+      a_client_character_set,
+      a_force_manual_rollback
     );
-    if l_reporter is of (ut_output_reporter_base) then
-      treat(l_reporter as ut_output_reporter_base).lines_to_dbms_output();
-    end if;
-    raise_if_packages_invalidated();
   end;
 
   procedure run(
@@ -465,7 +480,8 @@ create or replace package body ut is
     a_test_file_mappings ut_file_mappings := null,
     a_include_objects ut_varchar2_list := null,
     a_exclude_objects ut_varchar2_list := null,
-    a_client_character_set varchar2 := null
+    a_client_character_set varchar2 := null,
+    a_force_manual_rollback boolean := false
   ) is
   begin
     ut.run(
@@ -477,7 +493,8 @@ create or replace package body ut is
       a_test_file_mappings,
       a_include_objects,
       a_exclude_objects,
-      a_client_character_set
+      a_client_character_set,
+      a_force_manual_rollback
     );
   end;
 
@@ -489,7 +506,8 @@ create or replace package body ut is
     a_test_files ut_varchar2_list,
     a_include_objects ut_varchar2_list := null,
     a_exclude_objects ut_varchar2_list := null,
-    a_client_character_set varchar2 := null
+    a_client_character_set varchar2 := null,
+    a_force_manual_rollback boolean := false
   ) is
   begin
     ut.run(
@@ -501,7 +519,8 @@ create or replace package body ut is
       a_test_files,
       a_include_objects,
       a_exclude_objects,
-      a_client_character_set
+      a_client_character_set,
+      a_force_manual_rollback
     );
   end;
 
@@ -514,7 +533,8 @@ create or replace package body ut is
     a_test_file_mappings ut_file_mappings := null,
     a_include_objects ut_varchar2_list := null,
     a_exclude_objects ut_varchar2_list := null,
-    a_client_character_set varchar2 := null
+    a_client_character_set varchar2 := null,
+    a_force_manual_rollback boolean := false
   ) is
   begin
     ut.run(
@@ -526,7 +546,8 @@ create or replace package body ut is
       a_test_file_mappings,
       a_include_objects,
       a_exclude_objects,
-      a_client_character_set
+      a_client_character_set,
+      a_force_manual_rollback
     );
   end;
 
@@ -539,7 +560,8 @@ create or replace package body ut is
     a_test_files ut_varchar2_list,
     a_include_objects ut_varchar2_list := null,
     a_exclude_objects ut_varchar2_list := null,
-    a_client_character_set varchar2 := null
+    a_client_character_set varchar2 := null,
+    a_force_manual_rollback boolean := false
   ) is
   begin
     ut.run(
@@ -551,7 +573,8 @@ create or replace package body ut is
       a_test_files,
       a_include_objects,
       a_exclude_objects,
-      a_client_character_set
+      a_client_character_set,
+      a_force_manual_rollback
     );
   end;
 
diff --git a/source/api/ut.pks b/source/api/ut.pks
@@ -125,7 +125,8 @@ create or replace package ut authid current_user as
     a_test_file_mappings ut_file_mappings := null,
     a_include_objects ut_varchar2_list := null,
     a_exclude_objects ut_varchar2_list := null,
-    a_client_character_set varchar2 := null
+    a_client_character_set varchar2 := null,
+    a_force_manual_rollback boolean := false
   );
 
   procedure run(
@@ -136,7 +137,8 @@ create or replace package ut authid current_user as
     a_test_files ut_varchar2_list,
     a_include_objects ut_varchar2_list := null,
     a_exclude_objects ut_varchar2_list := null,
-    a_client_character_set varchar2 := null
+    a_client_character_set varchar2 := null,
+    a_force_manual_rollback boolean := false
   );
 
   procedure run(
@@ -148,7 +150,8 @@ create or replace package ut authid current_user as
     a_test_file_mappings ut_file_mappings := null,
     a_include_objects ut_varchar2_list := null,
     a_exclude_objects ut_varchar2_list := null,
-    a_client_character_set varchar2 := null
+    a_client_character_set varchar2 := null,
+    a_force_manual_rollback boolean := false
   );
 
   procedure run(
@@ -160,7 +163,8 @@ create or replace package ut authid current_user as
     a_test_files ut_varchar2_list,
     a_include_objects ut_varchar2_list := null,
     a_exclude_objects ut_varchar2_list := null,
-    a_client_character_set varchar2 := null
+    a_client_character_set varchar2 := null,
+    a_force_manual_rollback boolean := false
   );
 
   procedure run(
@@ -172,7 +176,8 @@ create or replace package ut authid current_user as
     a_test_file_mappings ut_file_mappings := null,
     a_include_objects ut_varchar2_list := null,
     a_exclude_objects ut_varchar2_list := null,
-    a_client_character_set varchar2 := null
+    a_client_character_set varchar2 := null,
+    a_force_manual_rollback boolean := false
   );
 
   procedure run(
@@ -184,7 +189,8 @@ create or replace package ut authid current_user as
     a_test_files ut_varchar2_list,
     a_include_objects ut_varchar2_list := null,
     a_exclude_objects ut_varchar2_list := null,
-    a_client_character_set varchar2 := null
+    a_client_character_set varchar2 := null,
+    a_force_manual_rollback boolean := false
   );
 
   /**
diff --git a/source/api/ut_runner.pkb b/source/api/ut_runner.pkb
@@ -42,13 +42,16 @@ create or replace package body ut_runner is
     return l_result;
   end;
 
-  procedure finish_run(a_run ut_run) is
+  procedure finish_run(a_run ut_run, a_force_manual_rollback boolean) is
   begin
     ut_utils.cleanup_temp_tables;
     ut_event_manager.trigger_event(ut_utils.gc_finalize, a_run);
     ut_metadata.reset_source_definition_cache;
     ut_utils.read_cache_to_dbms_output();
     ut_coverage_helper.cleanup_tmp_table();
+    if not a_force_manual_rollback then
+      rollback;
+    end if;
   end;
 
 
@@ -83,7 +86,8 @@ create or replace package body ut_runner is
     a_include_objects ut_varchar2_list := null,
     a_exclude_objects ut_varchar2_list := null,
     a_fail_on_errors boolean := false,
-    a_client_character_set varchar2 := null
+    a_client_character_set varchar2 := null,
+    a_force_manual_rollback boolean := false
   ) is
     l_run                   ut_run;
     l_coverage_schema_names ut_varchar2_rows;
@@ -137,16 +141,18 @@ create or replace package body ut_runner is
         set(a_test_file_mappings),
         a_client_character_set
       );
+      if a_force_manual_rollback then
+        l_run.set_rollback_type(ut_utils.gc_rollback_manual, a_force=>true);
+      end if;
+
       l_run.do_execute();
 
-      finish_run(l_run);
-      rollback;
+      finish_run(l_run, a_force_manual_rollback);
     exception
       when others then
-        finish_run(l_run);
+        finish_run(l_run, a_force_manual_rollback);
         dbms_output.put_line(dbms_utility.format_error_backtrace);
         dbms_output.put_line(dbms_utility.format_error_stack);
-        rollback;
         raise;
     end;
     if a_fail_on_errors and l_run.result in (ut_utils.gc_failure, ut_utils.gc_error) then
diff --git a/source/api/ut_runner.pks b/source/api/ut_runner.pks
@@ -43,6 +43,7 @@ create or replace package ut_runner authid current_user is
   * @param a_include_objects        list of database objects (in format 'owner.name') that coverage should be reported on
   * @param a_exclude_objects        list of database objects (in format 'owner.name') that coverage should be skipped for
   * @param a_fail_on_errors         true/false - should an exception be thrown when tests are completed with failures/errors
+  * @param a_force_manual_rollback  true/false - should the transaction control be forced to --%rollback(manual) and no rollback issued at the end of the run
   *
   * @example
   * Parameter `a_paths` accepts values of the following formats:
@@ -65,7 +66,8 @@ create or replace package ut_runner authid current_user is
     a_include_objects ut_varchar2_list := null,
     a_exclude_objects ut_varchar2_list := null,
     a_fail_on_errors boolean := false,
-    a_client_character_set varchar2 := null
+    a_client_character_set varchar2 := null,
+    a_force_manual_rollback boolean := false
   );
 
   /**
diff --git a/source/core/types/ut_logical_suite.tpb b/source/core/types/ut_logical_suite.tpb
@@ -51,11 +51,11 @@ create or replace type body ut_logical_suite as
     self.calc_execution_result();
   end;
 
-  overriding member procedure set_rollback_type(self in out nocopy ut_logical_suite, a_rollback_type integer) is
+  overriding member procedure set_rollback_type(self in out nocopy ut_logical_suite, a_rollback_type integer, a_force boolean := false) is
   begin
-    self.rollback_type := coalesce(self.rollback_type, a_rollback_type);
+    self.rollback_type := case when a_force then a_rollback_type else coalesce(self.rollback_type, a_rollback_type) end;
     for i in 1 .. self.items.count loop
-      self.items(i).set_rollback_type(self.rollback_type);
+      self.items(i).set_rollback_type(self.rollback_type, a_force);
     end loop;
   end;
 
diff --git a/source/core/types/ut_logical_suite.tps b/source/core/types/ut_logical_suite.tps
@@ -27,7 +27,7 @@ create or replace type ut_logical_suite under ut_suite_item (
   member function is_valid(self in out nocopy ut_logical_suite) return boolean,
   member procedure add_item(self in out nocopy ut_logical_suite, a_item ut_suite_item),
   overriding member procedure mark_as_skipped(self in out nocopy ut_logical_suite),
-  overriding member procedure set_rollback_type(self in out nocopy ut_logical_suite, a_rollback_type integer),
+  overriding member procedure set_rollback_type(self in out nocopy ut_logical_suite, a_rollback_type integer, a_force boolean := false),
   overriding member function  do_execute(self in out nocopy ut_logical_suite) return boolean,
   overriding member procedure calc_execution_result(self in out nocopy ut_logical_suite),
   overriding member procedure mark_as_errored(self in out nocopy ut_logical_suite, a_error_stack_trace varchar2),
diff --git a/source/core/types/ut_run.tpb b/source/core/types/ut_run.tpb
@@ -75,6 +75,14 @@ create or replace type body ut_run as
     return l_completed_without_errors;
   end;
 
+  overriding member procedure set_rollback_type(self in out nocopy ut_run, a_rollback_type integer, a_force boolean := false) is
+  begin
+    self.rollback_type := case when a_force then a_rollback_type else coalesce(self.rollback_type, a_rollback_type) end;
+    for i in 1 .. self.items.count loop
+      self.items(i).set_rollback_type(self.rollback_type, a_force);
+    end loop;
+  end;
+
   overriding member procedure calc_execution_result(self in out nocopy ut_run) is
     l_result integer(1);
   begin
diff --git a/source/core/types/ut_run.tps b/source/core/types/ut_run.tps
@@ -37,6 +37,7 @@ create or replace type ut_run under ut_suite_item (
   ) return self as result,
   overriding member procedure mark_as_skipped(self in out nocopy ut_run),
   overriding member function  do_execute(self in out nocopy ut_run) return boolean,
+  overriding member procedure set_rollback_type(self in out nocopy ut_run, a_rollback_type integer, a_force boolean := false),
   overriding member procedure calc_execution_result(self in out nocopy ut_run),
   overriding member procedure mark_as_errored(self in out nocopy ut_run, a_error_stack_trace varchar2),
   overriding member function get_error_stack_traces return ut_varchar2_list,
diff --git a/source/core/types/ut_suite_item.tpb b/source/core/types/ut_suite_item.tpb
@@ -37,9 +37,9 @@ create or replace type body ut_suite_item as
     return ut_utils.int_to_boolean(self.disabled_flag);
   end;
 
-  member procedure set_rollback_type(self in out nocopy ut_suite_item, a_rollback_type integer) is
+  member procedure set_rollback_type(self in out nocopy ut_suite_item, a_rollback_type integer, a_force boolean := false) is
   begin
-    self.rollback_type := coalesce(self.rollback_type, a_rollback_type);
+    self.rollback_type := case when a_force then a_rollback_type else coalesce(self.rollback_type, a_rollback_type) end;
   end;
 
   member function get_rollback_type return integer is
diff --git a/source/core/types/ut_suite_item.tps b/source/core/types/ut_suite_item.tps
diff --git a/test/api/test_ut_run.pkb b/test/api/test_ut_run.pkb
diff --git a/test/api/test_ut_run.pks b/test/api/test_ut_run.pks
