We want to have description for all our reporters.

Because that's very valuable information. We like valuable information.
We gather them. And eat them. And grow.

Author: pesse

src/main/java/org/utplsql/api/reporter/DefaultReporters.java

@@ -8,21 +8,32 @@
  */
 public enum DefaultReporters {
 
-    UT_COVERAGE_HTML_REPORTER(CoverageHTMLReporter::new),
-    UT_DOCUMENTATION_REPORTER(DocumentationReporter::new),
-    UT_TEAMCITY_REPORTER(TeamCityReporter::new),
-    UT_XUNIT_REPORTER(XUnitReporter::new),
-    UT_COVERALLS_REPORTER(CoverallsReporter::new),
-    UT_COVERAGE_SONAR_REPORTER(CoverageSonarReporter::new),
-    UT_SONAR_TEST_REPORTER(SonarTestReporter::new);
+    UT_COVERAGE_HTML_REPORTER(CoverageHTMLReporter::new, "Generates a HTML coverage report with summary and line by line information on code coverage.\n" +
+            "Based on open-source simplecov-html coverage reporter for Ruby.\n" +
+            "Includes source code in the report."),
+    UT_DOCUMENTATION_REPORTER(DocumentationReporter::new, "A textual pretty-print of unit test results (usually use for console output)"),
+    UT_TEAMCITY_REPORTER(TeamCityReporter::new, "For reporting live progress of test execution with Teamcity CI."),
+    UT_XUNIT_REPORTER(XUnitReporter::new, "Used for reporting test results with CI servers like Jenkins/Hudson/Teamcity."),
+    UT_COVERALLS_REPORTER(CoverallsReporter::new, "Generates a JSON coverage report providing information on code coverage with line numbers.\n" +
+            "Designed for [Coveralls](https://coveralls.io/)."),
+    UT_COVERAGE_SONAR_REPORTER(CoverageSonarReporter::new, "Generates a JSON coverage report providing information on code coverage with line numbers.\n" +
+            "Designed for [SonarQube](https://about.sonarqube.com/) to report coverage."),
+    UT_SONAR_TEST_REPORTER(SonarTestReporter::new, "Generates a JSON report providing detailed information on test execution.\n" +
+            "Designed for [SonarQube](https://about.sonarqube.com/) to report test execution.");
 
     private Supplier<? extends Reporter> factoryMethod;
+    private String description;
 
-    DefaultReporters(Supplier<? extends Reporter> factoryMethod ) {
+    DefaultReporters(Supplier<? extends Reporter> factoryMethod, String description ) {
         this.factoryMethod = factoryMethod;
+        this.description = description;
     }
 
     public Supplier<? extends Reporter> getFactoryMethod() {
         return factoryMethod;
     }
+
+    public String getDescription() {
+        return description;
+    }
 }

src/main/java/org/utplsql/api/reporter/ReporterFactory.java

@@ -15,7 +15,17 @@
  */
 public final class ReporterFactory {
 
-    private Map<String, Supplier<? extends Reporter>> reportFactoryMethodMap = new HashMap<>();
+
+    public static class ReporterInfo {
+        public ReporterInfo( Supplier<? extends Reporter> factoryMethod, String description) {
+            this.factoryMethod = factoryMethod;
+            this.description = description;
+        }
+        public Supplier<? extends Reporter> factoryMethod;
+        public String description;
+    }
+
+    private Map<String, ReporterInfo> reportFactoryMethodMap = new HashMap<>();
 
     private static ReporterFactory instance;
 
@@ -27,7 +37,7 @@ private ReporterFactory() {
      */
     private void registerDefaultReporters() {
         Arrays.stream(DefaultReporters.values())
-                .forEach(r -> registerReporterFactoryMethod(r.name(), r.getFactoryMethod()));
+                .forEach(r -> registerReporterFactoryMethod(r.name(), r.getFactoryMethod(), r.getDescription()));
     }
 
     /** Returns the global instance of the ReporterFactory
@@ -44,18 +54,19 @@ public static ReporterFactory getInstance() {
      *
      * @param reporterName the reporter's name to register
      * @param factoryMethod the method which will return the reporter
-     * @return the method stored for the registered name
+     * @param description the description of the reporter
+     * @return Object with information about the registered reporter
      */
-    public synchronized Supplier<? extends Reporter> registerReporterFactoryMethod( String reporterName, Supplier<? extends Reporter> factoryMethod) {
-        return reportFactoryMethodMap.put(reporterName, factoryMethod);
+    public synchronized ReporterInfo registerReporterFactoryMethod( String reporterName, Supplier<? extends Reporter> factoryMethod, String description) {
+        return reportFactoryMethodMap.put(reporterName, new ReporterInfo(factoryMethod, description));
     }
 
     /** Unregisters a specified reporter name.
      *
      * @param reporterName the reporter's name to unregister
-     * @return the method which was previously registered or null
+     * @return information about the reporter which was previously registered or null
      */
-    public synchronized Supplier<? extends Reporter> unregisterReporterFactoryMethod( String reporterName ) {
+    public synchronized ReporterInfo unregisterReporterFactoryMethod( String reporterName ) {
         return reportFactoryMethodMap.remove(reporterName);
     }
 
@@ -67,9 +78,17 @@ public synchronized Supplier<? extends Reporter> unregisterReporterFactoryMethod
      * @return A reporter
      */
     public Reporter createReporter(String reporterName) {
-        Supplier<? extends Reporter> supplier = reportFactoryMethodMap.get(reporterName);
-        if ( supplier == null )
+
+        if ( !reportFactoryMethodMap.containsKey(reporterName))
             throw new RuntimeException("Reporter " + reporterName + " not implemented.");
+
+        ReporterInfo ri = reportFactoryMethodMap.get(reporterName);
+        if ( ri == null )
+            throw new RuntimeException("ReporterInfo for " + reporterName + " was null");
+
+        Supplier<? extends Reporter> supplier = ri.factoryMethod;
+        if ( supplier == null )
+            throw new RuntimeException("No factory method for " + reporterName);
         else
             return supplier.get();
     }
@@ -78,7 +97,13 @@ public Reporter createReporter(String reporterName) {
      *
      * @return Set of reporter names
      */
-    public Set<String> getRegisteredReporterNames() {
-        return reportFactoryMethodMap.keySet();
+    public Map<String, String> getRegisteredReporterInfo() {
+        Map<String, String> descMap = new HashMap<>(reportFactoryMethodMap.size());
+
+        for (Map.Entry<String, ReporterInfo> entry : reportFactoryMethodMap.entrySet()) {
+            descMap.put(entry.getKey(), entry.getValue().description);
+        }
+        return descMap;
     }
+
 }

src/test/java/org/utplsql/api/ReporterNameTest.java

@@ -4,7 +4,7 @@
 import org.utplsql.api.reporter.*;
 
 import java.sql.SQLException;
-import java.util.Set;
+import java.util.Map;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertTrue;
@@ -43,10 +43,10 @@ public void reporterFactory() {
 
     @Test
     public void defaultReporterFactoryNamesList() {
-        Set<String> names = ReporterFactory.getInstance().getRegisteredReporterNames();
+        Map<String, String> reporterDescriptions = ReporterFactory.getInstance().getRegisteredReporterInfo();
 
         for ( DefaultReporters r : DefaultReporters.values() ) {
-            assertTrue(names.contains(r.name()));
+            assertTrue(reporterDescriptions.containsKey(r.name()));
         }
     }