Adding JUnit reporter with refactorings for calculation of result totals.

jgebal · jgebal · commit e2e2e7aeeb27 · 2017-01-08T23:56:27.000Z
diff --git a/source/core/types/ut_results_counter.tpb b/source/core/types/ut_results_counter.tpb
@@ -0,0 +1,46 @@
+create or replace type body ut_results_counter as
+  constructor function ut_results_counter(self in out nocopy ut_results_counter) return self as result is
+  begin
+    self.ignored_count := 0;
+    self.success_count := 0;
+    self.failure_count := 0;
+    self.errored_count := 0;
+    return;
+  end;
+
+  constructor function ut_results_counter(self in out nocopy ut_results_counter, a_status integer) return self as result is
+  begin
+    self.ignored_count := case when a_status = ut_utils.tr_ignore then 1 else 0 end;
+    self.success_count := case when a_status = ut_utils.tr_success then 1 else 0 end;
+    self.failure_count := case when a_status = ut_utils.tr_failure then 1 else 0 end;
+    self.errored_count := case when a_status = ut_utils.tr_error then 1 else 0 end;
+    return;
+  end;
+
+  member procedure sum_counter_values(self in out nocopy ut_results_counter, a_item ut_results_counter) is
+  begin
+    self.ignored_count  := self.ignored_count + a_item.ignored_count;
+    self.success_count  := self.success_count + a_item.success_count;
+    self.failure_count  := self.failure_count + a_item.failure_count;
+    self.errored_count  := self.errored_count + a_item.errored_count;
+  end;
+
+  member function total_count return integer is
+  begin
+    return self.ignored_count + self.success_count + self.failure_count + self.errored_count;
+  end;
+
+  member function result_status return integer is
+  begin
+    return
+      case
+      when self.errored_count > 0 then ut_utils.tr_error
+      when self.failure_count > 0 then ut_utils.tr_failure
+      when self.success_count > 0 then ut_utils.tr_success
+      when self.ignored_count > 0 then ut_utils.tr_ignore
+      else ut_utils.tr_error
+    end;
+  end;
+
+end;
+/
diff --git a/source/core/types/ut_results_counter.tps b/source/core/types/ut_results_counter.tps
@@ -0,0 +1,12 @@
+create or replace type ut_results_counter as object(
+  ignored_count integer,
+  success_count integer,
+  failure_count integer,
+  errored_count integer,
+  constructor function ut_results_counter(self in out nocopy ut_results_counter) return self as result,
+  constructor function ut_results_counter(self in out nocopy ut_results_counter, a_status integer) return self as result,
+  member procedure sum_counter_values(self in out nocopy ut_results_counter, a_item ut_results_counter),
+  member function total_count return integer,
+  member function result_status return integer
+)
+/
diff --git a/source/core/types/ut_run.tpb b/source/core/types/ut_run.tpb
@@ -4,6 +4,7 @@ create or replace type body ut_run as
   begin
     self.self_type := $$plsql_unit;
     self.items := a_items;
+    self.results_count := ut_results_counter();
     return;
   end;
 
@@ -26,7 +27,7 @@ create or replace type body ut_run as
       l_completed_without_errors := self.items(i).do_execute(a_listener);
     end loop;
 
-    self.calc_execution_result;
+    self.calc_execution_result();
 
     self.end_time := current_timestamp;
 
@@ -35,16 +36,16 @@ create or replace type body ut_run as
     return l_completed_without_errors;
   end;
 
-  member procedure calc_execution_result(self in out nocopy ut_run) is
+  overriding member procedure calc_execution_result(self in out nocopy ut_run) is
     l_result integer(1);
   begin
     if self.items is not null and self.items.count > 0 then
-      l_result := ut_utils.tr_ignore;
       for i in 1 .. self.items.count loop
-        l_result := greatest(self.items(i).result, l_result);
-        exit when l_result = ut_utils.tr_error;
+        self.results_count.sum_counter_values( self.items(i).results_count );
       end loop;
+      l_result := self.results_count.result_status();
     else
+      --if suite is empty then it's successful (no errors)
       l_result := ut_utils.tr_success;
     end if;
 
diff --git a/source/core/types/ut_run.tps b/source/core/types/ut_run.tps
@@ -6,6 +6,6 @@ create or replace type ut_run under ut_suite_item (
   constructor function ut_run( self in out nocopy ut_run, a_items ut_suite_items ) return self as result,
   overriding member function  do_execute(self in out nocopy ut_run, a_listener in out nocopy ut_event_listener_base) return boolean,
   overriding member procedure do_execute(self in out nocopy ut_run, a_listener in out nocopy ut_event_listener_base),
-  member procedure calc_execution_result(self in out nocopy ut_run)
+  overriding member procedure calc_execution_result(self in out nocopy ut_run)
 )
 /
diff --git a/source/core/types/ut_suite.tpb b/source/core/types/ut_suite.tpb
@@ -107,7 +107,7 @@ create or replace type body ut_suite as
         l_completed_without_errors := self.after_all.do_execute(self, a_listener);
       end if;
 
-      self.calc_execution_result;
+      self.calc_execution_result();
 
       self.rollback_to_savepoint(l_suite_savepoint);
 
@@ -119,21 +119,21 @@ create or replace type body ut_suite as
     return l_completed_without_errors;
   end;
 
-  member procedure calc_execution_result(self in out nocopy ut_suite) is
+  overriding member procedure calc_execution_result(self in out nocopy ut_suite) is
     l_result integer(1);
   begin
     if self.items is not null and self.items.count > 0 then
-      l_result := ut_utils.tr_ignore;
       for i in 1 .. self.items.count loop
-        l_result := greatest(self.items(i).result, l_result);
-        exit when l_result = ut_utils.tr_error;
+        self.results_count.sum_counter_values( self.items(i).results_count );
       end loop;
+      l_result := self.results_count.result_status();
     else
+      --if suite is empty then it's successful (no errors)
       l_result := ut_utils.tr_success;
     end if;
 
-    self.result := l_result;
-  end;
+      self.result := l_result;
+    end;
 
 end;
 /
diff --git a/source/core/types/ut_suite.tps b/source/core/types/ut_suite.tps
@@ -36,6 +36,6 @@ create or replace type ut_suite under ut_suite_item (
   member procedure add_item(self in out nocopy ut_suite, a_item ut_suite_item),
   overriding member function  do_execute(self in out nocopy ut_suite, a_listener in out nocopy ut_event_listener_base) return boolean,
   overriding member procedure do_execute(self in out nocopy ut_suite, a_listener in out nocopy ut_event_listener_base),
-  member procedure calc_execution_result(self in out nocopy ut_suite)
+  overriding member procedure calc_execution_result(self in out nocopy ut_suite)
 )
 /
diff --git a/source/core/types/ut_suite_item.tpb b/source/core/types/ut_suite_item.tpb
@@ -12,6 +12,7 @@ create or replace type body ut_suite_item as
     self.path := nvl(lower(trim(a_path)), self.object_name);
     self.rollback_type := a_rollback_type;
     self.ignore_flag := ut_utils.boolean_to_int(a_ignore_flag);
+    self.results_count := ut_results_counter();
   end;
 
   member procedure set_ignore_flag(self in out nocopy ut_suite_item, a_ignore_flag boolean) is
diff --git a/source/core/types/ut_suite_item.tps b/source/core/types/ut_suite_item.tps
@@ -1,5 +1,6 @@
 create or replace type ut_suite_item under ut_suite_item_base (
 
+  results_count ut_results_counter,
   member procedure init(
     self in out nocopy ut_suite_item, a_object_owner varchar2, a_object_name varchar2, a_name varchar2,
     a_description varchar2, a_path varchar2, a_rollback_type integer, a_ignore_flag boolean),
@@ -8,9 +9,10 @@ create or replace type ut_suite_item under ut_suite_item_base (
   member function create_savepoint_if_needed return varchar2,
   member procedure rollback_to_savepoint(self in ut_suite_item, a_savepoint varchar2),
   member function execution_time return number,
-  
+
   not instantiable member function  do_execute(self in out nocopy ut_suite_item, a_listener in out nocopy ut_event_listener_base) return boolean,
-  not instantiable member procedure do_execute(self in out nocopy ut_suite_item, a_listener in out nocopy ut_event_listener_base)
+  not instantiable member procedure do_execute(self in out nocopy ut_suite_item, a_listener in out nocopy ut_event_listener_base),
+  not instantiable member procedure calc_execution_result(self in out nocopy ut_suite_item)
 
 )
 not final not instantiable
diff --git a/source/core/types/ut_test.tpb b/source/core/types/ut_test.tpb
@@ -65,16 +65,21 @@ create or replace type body ut_test as
         self.rollback_to_savepoint(l_savepoint);
 
       end if;
-
+      self.calc_execution_result();
       self.end_time := current_timestamp;
-      self.result := ut_assert_processor.get_aggregate_asserts_result();
-      --expectation results need to be part of test results
-      self.results := ut_assert_processor.get_asserts_results();
       a_listener.fire_after_event(ut_utils.gc_test,self);
 
     end if;
     return l_completed_without_errors;
   end;
 
+  overriding member procedure calc_execution_result(self in out nocopy ut_test) is
+  begin
+    self.result := ut_assert_processor.get_aggregate_asserts_result();
+    --expectation results need to be part of test results
+    self.results := ut_assert_processor.get_asserts_results();
+    self.results_count := ut_results_counter(self.result);
+  end;
+
 end;
 /
diff --git a/source/core/types/ut_test.tps b/source/core/types/ut_test.tps
@@ -24,6 +24,7 @@ create or replace type ut_test under ut_suite_item (
   ) return self as result,
   member function is_valid return boolean,
   overriding member procedure do_execute(self in out nocopy ut_test, a_listener in out nocopy ut_event_listener_base),
-  overriding member function do_execute(self in out nocopy ut_test, a_listener in out nocopy ut_event_listener_base) return boolean
+  overriding member function do_execute(self in out nocopy ut_test, a_listener in out nocopy ut_event_listener_base) return boolean,
+  overriding member procedure calc_execution_result(self in out nocopy ut_test)
 )
 /
diff --git a/source/install.sql b/source/install.sql
@@ -22,6 +22,7 @@ whenever oserror exit failure rollback
 --core types
 @@core/types/ut_assert_result.tps
 @@core/types/ut_assert_results.tps
+@@core/types/ut_results_counter.tps
 @@core/types/ut_output.tps
 @@core/types/ut_output_dbms_output.tps
 @@core/types/ut_output_stream.tps
@@ -51,6 +52,7 @@ whenever oserror exit failure rollback
 @@core/ut_assert_processor.pkb
 
 --core type bodies
+@@core/types/ut_results_counter.tpb
 @@core/types/ut_suite_item.tpb
 @@core/types/ut_test.tpb
 @@core/types/ut_suite.tpb
@@ -163,7 +165,8 @@ whenever oserror exit failure rollback
 @@reporters/ut_teamcity_reporter_helper.pks
 @@reporters/ut_teamcity_reporter_helper.pkb
 @@reporters/ut_teamcity_reporter.tpb
-
+@@reporters/ut_junit_reporter.tps
+@@reporters/ut_junit_reporter.tpb
 
 set linesize 200
 column text format a100
diff --git a/source/reporters/ut_junit_reporter.tpb b/source/reporters/ut_junit_reporter.tpb
@@ -0,0 +1,92 @@
+create or replace type body ut_junit_reporter is
+
+  constructor function ut_junit_reporter(a_output ut_output default ut_output_dbms_output()) return self as result is
+  begin
+    self.name   := $$plsql_unit;
+    self.output := a_output;
+    return;
+  end;
+
+  overriding member procedure after_calling_run(self in out nocopy ut_junit_reporter, a_run in ut_run) is
+    l_suite_id    integer := 0;
+    l_tests_count integer := a_run.results_count.ignored_count + a_run.results_count.success_count + a_run.results_count.failure_count + a_run.results_count.errored_count;
+
+    function get_path(a_path_with_name varchar2, a_name varchar2) return varchar2 is
+    begin
+      return substr(a_path_with_name, 1, instr(a_path_with_name,'.'||a_name)-1);
+    end;
+
+    procedure print_test_elements(a_test ut_test) is
+    begin
+      --     http://stackoverflow.com/questions/4922867/junit-xml-format-specification-that-hudson-supports
+      --     http://stackoverflow.com/questions/8079071/xml-format-specification-dtd-xsd-for-unit-test-reports
+      --     https://gist.github.com/kuzuha/232902acab1344d6b578
+      self.print_text(
+          '<testcase classname="'||get_path(a_test.path, a_test.name)||'" ' ||
+          ' assertions="'||a_test.results.count||'"' ||
+          self.get_common_item_attributes(a_test) ||
+          ' status="'||ut_utils.test_result_to_char(a_test.result)||'"' ||
+          '>'
+      );
+      if a_test.result = ut_utils.tr_ignore then
+        self.print_text('<skipped/>');
+      end if;
+
+      if a_test.result > ut_utils.tr_success then
+        self.print_text('<failure>');
+        self.print_text( '<![CDATA[');
+        for i in 1 .. a_test.results.count loop
+          self.print_text( a_test.results(i).get_result_clob);
+        end loop;
+        self.print_text(']]>');
+        self.print_text('</failure>');
+      end if;
+      --    TODO - separate failure messages, error messages, and dbms_output results from tests execution
+      --    TODO - decide if to use 'skipped' or 'disabled'
+      --    <error message="" type=""/>
+      --    <system-out/>
+      --    <system-err/>
+      self.print_text('</testcase>');
+    end;
+
+    procedure print_suite_elements(a_suite ut_suite, a_suite_id in out nocopy integer) is
+      l_tests_count integer := a_suite.results_count.ignored_count + a_suite.results_count.success_count + a_suite.results_count.failure_count + a_suite.results_count.errored_count;
+    begin
+      a_suite_id := a_suite_id + 1;
+      self.print_text(
+          '<testsuite tests="' || l_tests_count || '"' || ' id="' || a_suite_id || '"' ||
+          ' package="' || a_suite.path || '" ' || self.get_common_item_attributes(a_suite) || '>'
+      );
+      --    TODO - separate failure messages, error messages, and dbms_output results from tests execution
+      --    TODO - decide if to use 'skipped' or 'disabled'
+      --    <system-out/>
+      --    <system-err/>
+      for i in 1 .. a_suite.items.count loop
+        if a_suite.items(i) is of (ut_test) then
+          print_test_elements(treat(a_suite.items(i) as ut_test));
+        elsif a_suite.items(i) is of (ut_suite) then
+          print_suite_elements(treat(a_suite.items(i) as ut_suite), a_suite_id);
+        end if;
+      end loop;
+      self.print_text('</testsuite>');
+    end;
+  begin
+    l_suite_id := 0;
+    self.print_text('<testsuites tests="'||l_tests_count||'"'||self.get_common_item_attributes(a_run)||'>');
+    for i in 1 .. a_run.items.count loop
+      print_suite_elements(treat(a_run.items(i) as ut_suite), l_suite_id);
+    end loop;
+    self.print_text('</testsuites>');
+    (self as ut_reporter_base).after_calling_run(a_run);
+  end;
+
+  member function get_common_item_attributes(a_item ut_suite_item) return varchar2 is
+  begin
+    return
+      ' skipped="'||a_item.results_count.ignored_count||'" error="'||a_item.results_count.errored_count||'"'||
+      ' failure="'||a_item.results_count.failure_count||'" name="'||a_item.description||'"'||
+      ' time="'||a_item.execution_time()||'" ';
+  end;
+
+end;
+/
diff --git a/source/reporters/ut_junit_reporter.tps b/source/reporters/ut_junit_reporter.tps
@@ -0,0 +1,9 @@
+create or replace type ut_junit_reporter under ut_reporter_base
+(
+  constructor function ut_junit_reporter(a_output ut_output default ut_output_dbms_output()) return self as result,
+
+  overriding member procedure after_calling_run(self in out nocopy ut_junit_reporter, a_run in ut_run),
+  member function get_common_item_attributes(a_item ut_suite_item) return varchar2
+)
+not final
+/
diff --git a/source/uninstall.sql b/source/uninstall.sql
@@ -104,6 +104,8 @@ drop type ut_documentation_reporter;
 
 drop type ut_teamcity_reporter;
 
+drop type ut_junit_reporter;
+
 drop type ut_event_listener;
 
 drop type ut_reporters;
@@ -136,6 +138,8 @@ drop type ut_output_dbms_output;
 
 drop type ut_output;
 
+drop type ut_results_counter;
+
 drop type ut_assert_results;
 
 drop type ut_assert_result;

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,6 @@ create or replace type ut_run under ut_suite_item (`
`6`	`6`	`constructor function ut_run( self in out nocopy ut_run, a_items ut_suite_items ) return self as result,`
`7`	`7`	`overriding member function do_execute(self in out nocopy ut_run, a_listener in out nocopy ut_event_listener_base) return boolean,`
`8`	`8`	`overriding member procedure do_execute(self in out nocopy ut_run, a_listener in out nocopy ut_event_listener_base),`
`9`		`- member procedure calc_execution_result(self in out nocopy ut_run)`
	`9`	`+ overriding member procedure calc_execution_result(self in out nocopy ut_run)`
`10`	`10`	`)`
`11`	`11`	`/`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,6 @@ create or replace type ut_suite under ut_suite_item (`
`36`	`36`	`member procedure add_item(self in out nocopy ut_suite, a_item ut_suite_item),`
`37`	`37`	`overriding member function do_execute(self in out nocopy ut_suite, a_listener in out nocopy ut_event_listener_base) return boolean,`
`38`	`38`	`overriding member procedure do_execute(self in out nocopy ut_suite, a_listener in out nocopy ut_event_listener_base),`
`39`		`- member procedure calc_execution_result(self in out nocopy ut_suite)`
	`39`	`+ overriding member procedure calc_execution_result(self in out nocopy ut_suite)`
`40`	`40`	`)`
`41`	`41`	`/`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ create or replace type ut_test under ut_suite_item (`
`24`	`24`	`) return self as result,`
`25`	`25`	`member function is_valid return boolean,`
`26`	`26`	`overriding member procedure do_execute(self in out nocopy ut_test, a_listener in out nocopy ut_event_listener_base),`
`27`		`- overriding member function do_execute(self in out nocopy ut_test, a_listener in out nocopy ut_event_listener_base) return boolean`
	`27`	`+ overriding member function do_execute(self in out nocopy ut_test, a_listener in out nocopy ut_event_listener_base) return boolean,`
	`28`	`+ overriding member procedure calc_execution_result(self in out nocopy ut_test)`
`28`	`29`	`)`
`29`	`30`	`/`