First attempt to refactor and improve Reporter API

ReporterFactory is now a singleton. One can register its own reporters with a given name. The name is independent from the Oracle Object-Name.

That way it is very easy to add a slightly different behaviour to an existing base reporter in java

Author: pesse

src/main/java/org/utplsql/api/CustomTypes.java

@@ -10,13 +10,6 @@ public final class CustomTypes {
     public static final String UT_VARCHAR2_LIST = "UT_VARCHAR2_LIST";
 
     public static final String UT_REPORTERS = "UT_REPORTERS";
-    public static final String UT_DOCUMENTATION_REPORTER = "UT_DOCUMENTATION_REPORTER";
-    public static final String UT_COVERAGE_HTML_REPORTER = "UT_COVERAGE_HTML_REPORTER";
-    public static final String UT_TEAMCITY_REPORTER = "UT_TEAMCITY_REPORTER";
-    public static final String UT_XUNIT_REPORTER = "UT_XUNIT_REPORTER";
-    public static final String UT_COVERALLS_REPORTER = "UT_COVERALLS_REPORTER";
-    public static final String UT_COVERAGE_SONAR_REPORTER = "UT_COVERAGE_SONAR_REPORTER";
-    public static final String UT_SONAR_TEST_REPORTER = "UT_SONAR_TEST_REPORTER";
 
     public static final String UT_FILE_MAPPING = "UT_FILE_MAPPING";
     public static final String UT_FILE_MAPPINGS = "UT_FILE_MAPPINGS";

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

@@ -35,7 +35,7 @@ public CoverageHTMLReporter(String projectName, String assetsPath) {
 
     @Override
     public String getSQLTypeName() throws SQLException {
-        return CustomTypes.UT_COVERAGE_HTML_REPORTER;
+        return DefaultReporters.UT_COVERAGE_HTML_REPORTER.name();
     }
 
     public String getProjectName() {

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

@@ -1,14 +1,12 @@
 package org.utplsql.api.reporter;
 
-import org.utplsql.api.CustomTypes;
-
 import java.sql.SQLException;
 
 public class CoverageSonarReporter extends Reporter {
 
     @Override
     public String getSQLTypeName() throws SQLException {
-        return CustomTypes.UT_COVERAGE_SONAR_REPORTER;
+        return DefaultReporters.UT_COVERAGE_SONAR_REPORTER.name();
     }
 
 }

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

@@ -1,14 +1,12 @@
 package org.utplsql.api.reporter;
 
-import org.utplsql.api.CustomTypes;
-
 import java.sql.SQLException;
 
 public class CoverallsReporter extends Reporter {
 
     @Override
     public String getSQLTypeName() throws SQLException {
-        return CustomTypes.UT_COVERALLS_REPORTER;
+        return DefaultReporters.UT_COVERALLS_REPORTER.name();
     }
 
 }

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

@@ -0,0 +1,28 @@
+package org.utplsql.api.reporter;
+
+import java.util.function.Supplier;
+
+/** This enum defines default reporters, added and maintained by the utPLSQL team, and their (default) factory method
+ *
+ * @author pesse
+ */
+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);
+
+    private Supplier<? extends Reporter> factoryMethod;
+
+    DefaultReporters(Supplier<? extends Reporter> factoryMethod ) {
+        this.factoryMethod = factoryMethod;
+    }
+
+    public Supplier<? extends Reporter> getFactoryMethod() {
+        return factoryMethod;
+    }
+}

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

@@ -1,7 +1,5 @@
 package org.utplsql.api.reporter;
 
-import org.utplsql.api.CustomTypes;
-
 import java.sql.SQLException;
 import java.sql.SQLInput;
 import java.sql.SQLOutput;
@@ -34,7 +32,7 @@ public void setFailed(int failed) {
 
     @Override
     public String getSQLTypeName() throws SQLException {
-        return CustomTypes.UT_DOCUMENTATION_REPORTER;
+        return DefaultReporters.UT_DOCUMENTATION_REPORTER.name();
     }
 
     @Override

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

@@ -2,21 +2,83 @@
 
 import org.utplsql.api.CustomTypes;
 
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Set;
+import java.util.function.Supplier;
+
+/** This singleton-class manages the instantiation of reporters.
+ * One can register a supplier method for a specific name which will then be callable via createReporter(name)
+ *
+ * @author pesse
+ */
 public final class ReporterFactory {
 
-    private ReporterFactory() {}
-
-    public static Reporter createReporter(String reporterName) {
-        switch (reporterName.toUpperCase()) {
-            case CustomTypes.UT_DOCUMENTATION_REPORTER: return new DocumentationReporter();
-            case CustomTypes.UT_COVERAGE_HTML_REPORTER: return new CoverageHTMLReporter();
-            case CustomTypes.UT_TEAMCITY_REPORTER: return new TeamCityReporter();
-            case CustomTypes.UT_XUNIT_REPORTER: return new XUnitReporter();
-            case CustomTypes.UT_COVERALLS_REPORTER: return new CoverallsReporter();
-            case CustomTypes.UT_COVERAGE_SONAR_REPORTER: return new CoverageSonarReporter();
-            case CustomTypes.UT_SONAR_TEST_REPORTER: return new SonarTestReporter();
-            default: throw new RuntimeException("Reporter " + reporterName + " not implemented.");
-        }
+    private Map<String, Supplier<? extends Reporter>> reportFactoryMethodMap = new HashMap<>();
+
+    private static ReporterFactory instance;
+    
+    private ReporterFactory() {
+        registerDefaultReporters();
+    }
+
+    /** Registers the default reporters, provided with utPLSQL core
+     */
+    private void registerDefaultReporters() {
+        Arrays.stream(DefaultReporters.values())
+                .forEach(r -> registerReporterFactoryMethod(r.name(), r.getFactoryMethod()));
     }
 
+    /** Returns the global instance of the ReporterFactory
+     *
+     * @return ReporterFactory
+     */
+    public static ReporterFactory getInstance() {
+        if ( instance == null ) 
+            instance = new ReporterFactory();
+        return instance;
+    }
+
+    /** Registers a creation method for a specified reporter name. Overrides eventually existing creation method
+     *
+     * @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
+     */
+    public synchronized Supplier<? extends Reporter> registerReporterFactoryMethod( String reporterName, Supplier<? extends Reporter> factoryMethod) {
+        return reportFactoryMethodMap.put(reporterName, factoryMethod);
+    }
+
+    /** Unregisters a specified reporter name.
+     *
+     * @param reporterName the reporter's name to unregister
+     * @return the method which was previously registered or null
+     */
+    public synchronized Supplier<? extends Reporter> unregisterReporterFactoryMethod( String reporterName ) {
+        return reportFactoryMethodMap.remove(reporterName);
+    }
+
+    /** Returns a new reporter of the given name (or should do so). In reality it just calls the registered method
+     * for the given reporterName and returns its value (which should be a subclass of Reporter).
+     * Usually you should expect a new instance of a reporter, but who knows what evil forces register themselves nowadays...
+     *
+     * @param reporterName the reporter's name to create a new instance of
+     * @return A reporter
+     */
+    public Reporter createReporter(String reporterName) {
+        Supplier<? extends Reporter> supplier = reportFactoryMethodMap.get(reporterName);
+        if ( supplier == null )
+            throw new RuntimeException("Reporter " + reporterName + " not implemented.");
+        else
+            return supplier.get();
+    }
+
+    /** Returns a set of all registered reporter's names
+     *
+     * @return Set of reporter names
+     */
+    public Set<String> getRegisteredReporterNames() {
+        return reportFactoryMethodMap.keySet();
+    }
 }

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

@@ -1,14 +1,12 @@
 package org.utplsql.api.reporter;
 
-import org.utplsql.api.CustomTypes;
-
 import java.sql.SQLException;
 
 public class SonarTestReporter extends Reporter {
 
     @Override
     public String getSQLTypeName() throws SQLException {
-        return CustomTypes.UT_SONAR_TEST_REPORTER;
+        return DefaultReporters.UT_SONAR_TEST_REPORTER.name();
     }
 
 }

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

@@ -1,14 +1,12 @@
 package org.utplsql.api.reporter;
 
-import org.utplsql.api.CustomTypes;
-
 import java.sql.SQLException;
 
 public class TeamCityReporter extends Reporter {
 
     @Override
     public String getSQLTypeName() throws SQLException {
-        return CustomTypes.UT_TEAMCITY_REPORTER;
+        return DefaultReporters.UT_TEAMCITY_REPORTER.name();
     }
 
 }

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

@@ -1,14 +1,12 @@
 package org.utplsql.api.reporter;
 
-import org.utplsql.api.CustomTypes;
-
 import java.sql.SQLException;
 
 public class XUnitReporter extends Reporter {
 
     @Override
     public String getSQLTypeName() throws SQLException {
-        return CustomTypes.UT_XUNIT_REPORTER;
+        return DefaultReporters.UT_XUNIT_REPORTER.name();
     }
 
 }