Added description to all reporters

pesse · pesse · commit 527234248ebf · 2018-03-05T09:30:18.000+01:00
With that addition to every reporter implementation we can easily create
documentation or help-functions for consuming applications like cli.
We also encourage third party reporter-providers to give a description
about their reporter.
diff --git a/source/core/types/ut_reporter_base.tpb b/source/core/types/ut_reporter_base.tpb
@@ -33,6 +33,11 @@ create or replace type body ut_reporter_base is
     return self.id;
   end;
 
+  member function get_description return varchar2 is
+  begin
+    return 'No description available';
+  end;
+
   -- run hooks
   member procedure before_calling_run(self in out nocopy ut_reporter_base, a_run in ut_run) is
   begin
diff --git a/source/core/types/ut_reporter_base.tps b/source/core/types/ut_reporter_base.tps
@@ -20,6 +20,7 @@ create or replace type ut_reporter_base authid current_user as object(
   final member procedure init(self in out nocopy ut_reporter_base, a_self_type varchar2),
   member procedure set_reporter_id(self in out nocopy ut_reporter_base, a_reporter_id raw),
   member function  get_reporter_id return raw,
+  member function  get_description return varchar2,
 
   -- run hooks
   member procedure before_calling_run(self in out nocopy ut_reporter_base, a_run in ut_run),
diff --git a/source/reporters/ut_coverage_html_reporter.tpb b/source/reporters/ut_coverage_html_reporter.tpb
@@ -39,5 +39,13 @@ create or replace type body ut_coverage_html_reporter is
     self.print_clob( ut_coverage_report_html_helper.get_index( l_coverage_data, self.assets_path, self.project_name ) );
   end;
 
+
+  overriding member function get_description return varchar2 as
+  begin
+    return 'Generates a HTML coverage report with summary and line by line information on code coverage.' || chr(10) ||
+           'Based on open-source simplecov-html coverage reporter for Ruby.' || chr(10) ||
+           'Includes source code in the report.';
+  end;
+
 end;
 /
diff --git a/source/reporters/ut_coverage_html_reporter.tps b/source/reporters/ut_coverage_html_reporter.tps
@@ -23,6 +23,8 @@ create or replace type ut_coverage_html_reporter under ut_coverage_reporter_base
     a_html_report_assets_path varchar2 := null
   ) return self as result,
 
-  overriding member procedure after_calling_run(self in out nocopy ut_coverage_html_reporter, a_run in ut_run)
+  overriding member procedure after_calling_run(self in out nocopy ut_coverage_html_reporter, a_run in ut_run),
+
+  overriding member function get_description return varchar2
 )
 /
diff --git a/source/reporters/ut_coverage_sonar_reporter.tpb b/source/reporters/ut_coverage_sonar_reporter.tpb
@@ -88,5 +88,11 @@ create or replace type body ut_coverage_sonar_reporter is
     self.print_clob( get_coverage_xml( l_coverage_data ) );
   end;
 
+  overriding member function get_description return varchar2 as
+  begin
+    return 'Generates a JSON coverage report providing information on code coverage with line numbers.' || chr(10) ||
+           'Designed for [SonarQube](https://about.sonarqube.com/) to report coverage.';
+  end;
+
 end;
 /
diff --git a/source/reporters/ut_coverage_sonar_reporter.tps b/source/reporters/ut_coverage_sonar_reporter.tps
@@ -24,6 +24,8 @@ create or replace type ut_coverage_sonar_reporter under ut_coverage_reporter_bas
     self in out nocopy ut_coverage_sonar_reporter
   ) return self as result,
 
-  overriding member procedure after_calling_run(self in out nocopy ut_coverage_sonar_reporter, a_run in ut_run)
+  overriding member procedure after_calling_run(self in out nocopy ut_coverage_sonar_reporter, a_run in ut_run),
+
+  overriding member function get_description return varchar2
 )
 /
diff --git a/source/reporters/ut_coveralls_reporter.tpb b/source/reporters/ut_coveralls_reporter.tpb
@@ -99,5 +99,11 @@ create or replace type body ut_coveralls_reporter is
     self.print_clob( get_coverage_json( l_coverage_data ) );
   end;
 
+  overriding member function get_description return varchar2 as
+  begin
+    return 'Generates a JSON coverage report providing information on code coverage with line numbers.' || chr(10) ||
+           'Designed for [Coveralls](https://coveralls.io/).';
+  end;
+
 end;
 /
diff --git a/source/reporters/ut_coveralls_reporter.tps b/source/reporters/ut_coveralls_reporter.tps
@@ -24,6 +24,8 @@ create or replace type ut_coveralls_reporter under ut_coverage_reporter_base(
     self in out nocopy ut_coveralls_reporter
   ) return self as result,
 
-  overriding member procedure after_calling_run(self in out nocopy ut_coveralls_reporter, a_run in ut_run)
+  overriding member procedure after_calling_run(self in out nocopy ut_coveralls_reporter, a_run in ut_run),
+
+  overriding member function get_description return varchar2
 )
 /
diff --git a/source/reporters/ut_documentation_reporter.tpb b/source/reporters/ut_documentation_reporter.tpb
@@ -196,5 +196,10 @@ create or replace type body ut_documentation_reporter is
     (self as ut_reporter_base).after_calling_run(a_run);
   end;
 
+  overriding member function get_description return varchar2 as
+  begin
+    return 'A textual pretty-print of unit test results (usually use for console output)';
+  end;
+
 end;
 /
diff --git a/source/reporters/ut_documentation_reporter.tps b/source/reporters/ut_documentation_reporter.tps
@@ -26,7 +26,9 @@ create or replace type ut_documentation_reporter under ut_console_reporter_base(
   overriding member procedure after_calling_after_all (self in out nocopy ut_documentation_reporter, a_suite in ut_logical_suite),
   overriding member procedure after_calling_before_all (self in out nocopy ut_documentation_reporter, a_suite in ut_logical_suite),
   overriding member procedure after_calling_suite(self in out nocopy ut_documentation_reporter, a_suite ut_logical_suite),
-  overriding member procedure after_calling_run(self in out nocopy ut_documentation_reporter, a_run in ut_run)
+  overriding member procedure after_calling_run(self in out nocopy ut_documentation_reporter, a_run in ut_run),
+
+  overriding member function get_description return varchar2
 
 )
 not final
diff --git a/source/reporters/ut_sonar_test_reporter.tpb b/source/reporters/ut_sonar_test_reporter.tpb
@@ -97,5 +97,11 @@ create or replace type body ut_sonar_test_reporter is
     self.print_text('</testExecutions>');
   end;
 
+  overriding member function get_description return varchar2 as
+  begin
+    return 'Generates a JSON report providing detailed information on test execution.' || chr(10) ||
+           'Designed for [SonarQube](https://about.sonarqube.com/) to report test execution.';
+  end;
+
 end;
 /
diff --git a/source/reporters/ut_sonar_test_reporter.tps b/source/reporters/ut_sonar_test_reporter.tps
@@ -20,7 +20,9 @@ create or replace type ut_sonar_test_reporter under ut_output_reporter_base(
     self in out nocopy ut_sonar_test_reporter
   ) return self as result,
 
-  overriding member procedure after_calling_run(self in out nocopy ut_sonar_test_reporter, a_run in ut_run)
+  overriding member procedure after_calling_run(self in out nocopy ut_sonar_test_reporter, a_run in ut_run),
+
+  overriding member function get_description return varchar2
 )
 not final
 /
diff --git a/source/reporters/ut_teamcity_reporter.tpb b/source/reporters/ut_teamcity_reporter.tpb
@@ -113,5 +113,10 @@ create or replace type body ut_teamcity_reporter is
 
   end;
 
+  overriding member function get_description return varchar2 as
+  begin
+    return 'For reporting live progress of test execution with Teamcity CI.';
+  end;
+
 end;
 /
diff --git a/source/reporters/ut_teamcity_reporter.tps b/source/reporters/ut_teamcity_reporter.tps
@@ -23,7 +23,9 @@ create or replace type ut_teamcity_reporter under ut_output_reporter_base(
 
   overriding member procedure before_calling_test(self in out nocopy ut_teamcity_reporter, a_test in ut_test),
 
-  overriding member procedure after_calling_test(self in out nocopy ut_teamcity_reporter, a_test in ut_test)
+  overriding member procedure after_calling_test(self in out nocopy ut_teamcity_reporter, a_test in ut_test),
+
+  overriding member function get_description return varchar2
 )
 not final
 /
diff --git a/source/reporters/ut_xunit_reporter.tpb b/source/reporters/ut_xunit_reporter.tpb
@@ -129,5 +129,10 @@ create or replace type body ut_xunit_reporter is
            || '" time="' || ut_utils.to_xml_number_format(a_item.execution_time()) || '" ';
   end;
 
+  overriding member function get_description return varchar2 as
+  begin
+    return 'Used for reporting test results with CI servers like Jenkins/Hudson/Teamcity.';
+  end;
+
 end;
 /
diff --git a/source/reporters/ut_xunit_reporter.tps b/source/reporters/ut_xunit_reporter.tps
@@ -23,7 +23,9 @@ create or replace type ut_xunit_reporter under ut_output_reporter_base(
   constructor function ut_xunit_reporter(self in out nocopy ut_xunit_reporter) return self as result,
 
   overriding member procedure after_calling_run(self in out nocopy ut_xunit_reporter, a_run in ut_run),
-  member function get_common_item_attributes(a_item ut_suite_item) return varchar2
+  member function get_common_item_attributes(a_item ut_suite_item) return varchar2,
+
+  overriding member function get_description return varchar2
 )
 not final
 /

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,8 @@ create or replace type ut_coverage_html_reporter under ut_coverage_reporter_base`
`23`	`23`	`a_html_report_assets_path varchar2 := null`
`24`	`24`	`) return self as result,`
`25`	`25`
`26`		`- overriding member procedure after_calling_run(self in out nocopy ut_coverage_html_reporter, a_run in ut_run)`
	`26`	`+ overriding member procedure after_calling_run(self in out nocopy ut_coverage_html_reporter, a_run in ut_run),`
	`27`	`+`
	`28`	`+ overriding member function get_description return varchar2`
`27`	`29`	`)`
`28`	`30`	`/`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,8 @@ create or replace type ut_coverage_sonar_reporter under ut_coverage_reporter_bas`
`24`	`24`	`self in out nocopy ut_coverage_sonar_reporter`
`25`	`25`	`) return self as result,`
`26`	`26`
`27`		`- overriding member procedure after_calling_run(self in out nocopy ut_coverage_sonar_reporter, a_run in ut_run)`
	`27`	`+ overriding member procedure after_calling_run(self in out nocopy ut_coverage_sonar_reporter, a_run in ut_run),`
	`28`	`+`
	`29`	`+ overriding member function get_description return varchar2`
`28`	`30`	`)`
`29`	`31`	`/`