Refactored ut_teamcity_reporter_printer to become ut_teamcity_reporter_helper.

jgebal · jgebal · commit 74b9d33d0a78 · 2016-11-13T11:14:12.000Z
Now it is a set of functions returning the outcomes to be printed.
This allows the reporter to keep control over the output used.
diff --git a/source/install.sql b/source/install.sql
@@ -130,8 +130,8 @@ whenever oserror exit failure rollback
 @@reporters/ut_dbms_output_suite_reporter.tps
 @@reporters/ut_dbms_output_suite_reporter.tpb
 @@reporters/ut_teamcity_reporter.tps
-@@reporters/ut_teamcity_reporter_printer.pks
-@@reporters/ut_teamcity_reporter_printer.pkb
+@@reporters/ut_teamcity_reporter_helper.pks
+@@reporters/ut_teamcity_reporter_helper.pkb
 @@reporters/ut_teamcity_reporter.tpb
 
 @@legacy/ut_assert.pks
diff --git a/source/reporters/ut_teamcity_reporter.tpb b/source/reporters/ut_teamcity_reporter.tpb
@@ -9,16 +9,21 @@ create or replace type body ut_teamcity_reporter is
   overriding member procedure before_suite(self in out nocopy ut_teamcity_reporter, a_suite in ut_object) is
     l_test_object ut_test_object := treat(a_suite as ut_test_object);
   begin
-  
-    ut_teamcity_reporter_printer.test_suite_started(a_suite_name => coalesce(replace(l_test_object.name, '.')
-                                                                            ,l_test_object.object_name));
+    self.print(
+      ut_teamcity_reporter_helper.test_suite_started(
+        a_suite_name => coalesce(replace(l_test_object.name, '.')
+        ,l_test_object.object_name))
+      );
   end before_suite;
 
   overriding member procedure after_suite(self in out nocopy ut_teamcity_reporter, a_suite in ut_object) is
     l_test_object ut_test_object := treat(a_suite as ut_test_object);
   begin
-    ut_teamcity_reporter_printer.test_suite_finished(a_suite_name => coalesce(replace(l_test_object.name, '.')
-                                                                             ,l_test_object.object_name));
+    self.print(
+      ut_teamcity_reporter_helper.test_suite_finished(
+        a_suite_name => coalesce(replace(l_test_object.name, '.')
+        ,l_test_object.object_name))
+      );
   end after_suite;
 
   overriding member procedure before_suite_item(self in out nocopy ut_teamcity_reporter, a_suite in ut_object, a_item_index pls_integer) is
@@ -34,7 +39,7 @@ create or replace type body ut_teamcity_reporter is
       l_test           := treat(l_item as ut_test);
       l_test_full_name := nvl(replace(l_suite.name, '.'), l_suite.object_name) || ':' ||
                           nvl(replace(l_test.name, '.'), l_test.object_name);
-      ut_teamcity_reporter_printer.test_started(a_test_name => l_test_full_name);
+      self.print(ut_teamcity_reporter_helper.test_started(a_test_name => l_test_full_name));
     end if;
   
   end before_suite_item;
@@ -59,7 +64,7 @@ create or replace type body ut_teamcity_reporter is
                           nvl(replace(l_item.name, '.'), l_test.object_name);
     
       if l_test.result = ut_utils.tr_ignore then
-        ut_teamcity_reporter_printer.test_ignored(l_test_full_name);
+        self.print(ut_teamcity_reporter_helper.test_ignored(l_test_full_name));
       else
       
         if l_test.items is not null and l_test.items.count > 0 then
@@ -68,22 +73,22 @@ create or replace type body ut_teamcity_reporter is
             l_assert := treat(l_test.items(i) as ut_assert_result);
           
             if nvl(l_assert.result, ut_utils.tr_error) != ut_utils.tr_success then
-              ut_teamcity_reporter_printer.test_failed(a_test_name => l_test_full_name
-                                                      ,a_msg       => l_assert.message
-                                                      ,a_expected  => l_assert.expected_value_string
-                                                      ,a_actual    => l_assert.actual_value_string);
+              self.print(ut_teamcity_reporter_helper.test_failed(a_test_name => l_test_full_name
+                                                                  ,a_msg       => l_assert.message
+                                                                  ,a_expected  => l_assert.expected_value_string
+                                                                  ,a_actual    => l_assert.actual_value_string));
               exit;
             end if;
           
           end loop;
         elsif l_test.result = ut_utils.tr_failure then
-          ut_teamcity_reporter_printer.test_failed(a_test_name => l_test_full_name, a_msg => 'Test failed');
+          self.print(ut_teamcity_reporter_helper.test_failed(a_test_name => l_test_full_name, a_msg => 'Test failed'));
         elsif l_test.result = ut_utils.tr_error then
-          ut_teamcity_reporter_printer.test_failed(a_test_name => l_test_full_name, a_msg => 'Error occured');
+          self.print(ut_teamcity_reporter_helper.test_failed(a_test_name => l_test_full_name, a_msg => 'Error occured'));
         end if;
       
-        ut_teamcity_reporter_printer.test_finished(l_test_full_name
-                                                  ,a_test_duration_milisec => trunc(l_test.execution_time * 1e3));
+        self.print(ut_teamcity_reporter_helper.test_finished(l_test_full_name
+                                                  ,a_test_duration_milisec => trunc(l_test.execution_time * 1e3)));
       
       end if;
     
diff --git a/source/reporters/ut_teamcity_reporter_helper.pkb b/source/reporters/ut_teamcity_reporter_helper.pkb
@@ -1,4 +1,4 @@
-create or replace package body ut_teamcity_reporter_printer is
+create or replace package body ut_teamcity_reporter_helper is
 
   subtype t_prop_index is varchar2(2000 char);
   type t_props is table of varchar2(32767) index by t_prop_index;
@@ -8,7 +8,7 @@ create or replace package body ut_teamcity_reporter_printer is
     return regexp_replace(a_value, '(''|"|' || chr(13) || '|' || chr(10) || '|[|])', '|\1');
   end;
 
-  procedure message(a_command in varchar2, a_props t_props default cast(null as t_props)) is
+  function message(a_command in varchar2, a_props t_props default cast(null as t_props)) return varchar2 is
     l_message varchar2(32767);
     l_index   t_prop_index;
     l_value   varchar2(32767);
@@ -25,42 +25,42 @@ create or replace package body ut_teamcity_reporter_printer is
       l_index := a_props.next(l_index);
     end loop;
     l_message := l_message || ']';
-    sys.dbms_output.put_line(l_message);
-  
+    return l_message;
+
   end message;
 
-  procedure block_opened(a_name varchar2, a_flow_id varchar2 default null) is
+  function block_opened(a_name varchar2, a_flow_id varchar2 default null) return varchar2 is
     l_props t_props;
   begin
     l_props('name') := a_name;
     l_props('flowId') := a_flow_id;
-    message('blockOpened', l_props);
+    return message('blockOpened', l_props);
   end;
 
-  procedure block_closed(a_name varchar2, a_flow_id varchar2 default null) is
+  function block_closed(a_name varchar2, a_flow_id varchar2 default null) return varchar2 is
     l_props t_props;
   begin
     l_props('name') := a_name;
     l_props('flowId') := a_flow_id;
-    message('blockClosed', l_props);
+    return message('blockClosed', l_props);
   end;
 
-  procedure test_suite_started(a_suite_name varchar2, a_flow_id varchar2 default null) is
+  function test_suite_started(a_suite_name varchar2, a_flow_id varchar2 default null) return varchar2 is
     l_props t_props;
   begin
     l_props('name') := a_suite_name;
     l_props('flowId') := a_flow_id;
-    message('testSuiteStarted', l_props);
+    return message('testSuiteStarted', l_props);
   end;
-  procedure test_suite_finished(a_suite_name varchar2, a_flow_id varchar2 default null) is
+  function test_suite_finished(a_suite_name varchar2, a_flow_id varchar2 default null) return varchar2 is
     l_props t_props;
   begin
     l_props('name') := a_suite_name;
     l_props('flowId') := a_flow_id;
-    message('testSuiteFinished', l_props);
+    return message('testSuiteFinished', l_props);
   end;
 
-  procedure test_started(a_test_name varchar2, a_capture_standard_output boolean default null, a_flow_id varchar2 default null) is
+  function test_started(a_test_name varchar2, a_capture_standard_output boolean default null, a_flow_id varchar2 default null) return varchar2 is
     l_props t_props;
   begin
     l_props('name') := a_test_name;
@@ -73,26 +73,26 @@ create or replace package body ut_teamcity_reporter_printer is
                                            null
                                         end;
     l_props('flowId') := a_flow_id;
-    message('testStarted', l_props);
+    return message('testStarted', l_props);
   end;
 
-  procedure test_finished(a_test_name varchar2, a_test_duration_milisec number default null, a_flow_id varchar2 default null) is
+  function test_finished(a_test_name varchar2, a_test_duration_milisec number default null, a_flow_id varchar2 default null) return varchar2 is
     l_props t_props;
   begin
     l_props('name') := a_test_name;
     l_props('duration') := a_test_duration_milisec;
     l_props('flowId') := a_flow_id;
-    message('testFinished', l_props);
+    return message('testFinished', l_props);
   end;
 
-  procedure test_ignored(a_test_name varchar2, a_flow_id varchar2 default null) is
+  function test_ignored(a_test_name varchar2, a_flow_id varchar2 default null) return varchar2 is
     l_props t_props;
   begin
     l_props('name') := a_test_name;
     l_props('flowId') := a_flow_id;
-    message('testIgnored', l_props);
+    return message('testIgnored', l_props);
   end;
-  procedure test_failed(a_test_name varchar2, a_msg in varchar2 default null, a_details varchar2 default null, a_flow_id varchar2 default null, a_actual varchar2 default null, a_expected varchar2 default null) is
+  function test_failed(a_test_name varchar2, a_msg in varchar2 default null, a_details varchar2 default null, a_flow_id varchar2 default null, a_actual varchar2 default null, a_expected varchar2 default null) return varchar2 is
     l_props t_props;
   begin
     l_props('name') := a_test_name;
@@ -105,34 +105,34 @@ create or replace package body ut_teamcity_reporter_printer is
       l_props('expected') := a_expected;
     end if;
     
-    message('testFailed', l_props);
+    return message('testFailed', l_props);
   end;
-  procedure test_std_out(a_test_name varchar2, a_out in varchar2, a_flow_id in varchar2 default null) is
+  function test_std_out(a_test_name varchar2, a_out in varchar2, a_flow_id in varchar2 default null) return varchar2 is
     l_props t_props;
   begin
     l_props('name') := a_test_name;
     l_props('out') := a_out;
     l_props('flowId') := a_flow_id;
-    message('testStdOut', l_props);
+    return message('testStdOut', l_props);
   end;
-  procedure test_std_err(a_test_name varchar2, a_out in varchar2, a_flow_id in varchar2 default null) is
+  function test_std_err(a_test_name varchar2, a_out in varchar2, a_flow_id in varchar2 default null) return varchar2 is
     l_props t_props;
   begin
     l_props('name') := a_test_name;
     l_props('out') := a_out;
     l_props('flowId') := a_flow_id;
-    message('testStdErr', l_props);
+    return message('testStdErr', l_props);
   end;
 
-  procedure custom_message(a_text in varchar2, a_status in varchar2, a_error_deatils in varchar2 default null, a_flow_id in varchar2 default null) is
+  function custom_message(a_text in varchar2, a_status in varchar2, a_error_deatils in varchar2 default null, a_flow_id in varchar2 default null) return varchar2 is
     l_props t_props;
   begin
     l_props('text') := a_text;
     l_props('status') := a_status;
     l_props('errorDetails') := a_error_deatils;
     l_props('flowId') := a_flow_id;
-    message('message', l_props);
+    return message('message', l_props);
   end;
 
-end ut_teamcity_reporter_printer;
+end ut_teamcity_reporter_helper;
 /
diff --git a/source/reporters/ut_teamcity_reporter_helper.pks b/source/reporters/ut_teamcity_reporter_helper.pks
@@ -0,0 +1,19 @@
+create or replace package ut_teamcity_reporter_helper is
+
+  function block_opened(a_name varchar2, a_flow_id varchar2 default null) return varchar2;
+  function block_closed(a_name varchar2, a_flow_id varchar2 default null) return varchar2;
+
+  function test_suite_started(a_suite_name varchar2, a_flow_id varchar2 default null) return varchar2;
+  function test_suite_finished(a_suite_name varchar2, a_flow_id varchar2 default null) return varchar2;
+
+  function test_started(a_test_name varchar2, a_capture_standard_output boolean default null, a_flow_id varchar2 default null) return varchar2;
+  function test_finished(a_test_name varchar2, a_test_duration_milisec number default null, a_flow_id varchar2 default null) return varchar2;
+  function test_ignored(a_test_name varchar2, a_flow_id varchar2 default null) return varchar2;
+  function test_failed(a_test_name varchar2, a_msg in varchar2 default null, a_details varchar2 default null, a_flow_id varchar2 default null, a_actual varchar2 default null, a_expected varchar2 default null) return varchar2;
+  function test_std_out(a_test_name varchar2, a_out in varchar2, a_flow_id in varchar2 default null) return varchar2;
+  function test_std_err(a_test_name varchar2, a_out in varchar2, a_flow_id in varchar2 default null) return varchar2;
+
+  function custom_message(a_text in varchar2, a_status in varchar2, a_error_deatils in varchar2 default null, a_flow_id in varchar2 default null) return varchar2;
+
+end ut_teamcity_reporter_helper;
+/
diff --git a/source/reporters/ut_teamcity_reporter_printer.pks b/source/reporters/ut_teamcity_reporter_printer.pks
diff --git a/source/uninstall.sql b/source/uninstall.sql
@@ -1,4 +1,4 @@
-drop package ut_teamcity_reporter_printer;
+drop package ut_teamcity_reporter_helper;
 
 drop package ut_suite_manager;
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-drop package ut_teamcity_reporter_printer;`
	`1`	`+drop package ut_teamcity_reporter_helper;`
`2`	`2`
`3`	`3`	`drop package ut_suite_manager;`
`4`	`4`