ReporterFactory is no longer a singleton

Made purpose of several classes more clear, updated some methods to match with core

Author: pesse

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

@@ -7,6 +7,7 @@
 import org.utplsql.api.exception.UtPLSQLNotInstalledException;
 import org.utplsql.api.reporter.DocumentationReporter;
 import org.utplsql.api.reporter.Reporter;
+import org.utplsql.api.reporter.ReporterFactory;
 import org.utplsql.api.testRunner.TestRunnerStatement;
 
 import java.sql.CallableStatement;
@@ -23,6 +24,8 @@
 public class TestRunner {
 
     private TestRunnerOptions options = new TestRunnerOptions();
+    private CompatibilityProxy compatibilityProxy;
+    private ReporterFactory reporterFactory = new ReporterFactory();
 
     public TestRunner addPath(String path) {
         options.pathList.add(path);
@@ -39,6 +42,11 @@ public TestRunner addReporter(Reporter reporter) {
         return this;
     }
 
+    public TestRunner addReporter( String reporterName ) {
+        options.reporterList.add(reporterFactory.createReporter(reporterName));
+        return this;
+    }
+
     public TestRunner colorConsole(boolean colorConsole) {
         options.colorConsole = colorConsole;
         return this;
@@ -95,9 +103,16 @@ public TestRunner skipCompatibilityCheck( boolean skipCompatibilityCheck )
         return this;
     }
 
+    public TestRunner setReporterFactory( ReporterFactory reporterFactory ) {
+        this.reporterFactory = reporterFactory;
+        return this;
+    }
+
     public void run(Connection conn) throws SomeTestsFailedException, SQLException, DatabaseNotCompatibleException, UtPLSQLNotInstalledException {
 
-        CompatibilityProxy compatibilityProxy = new CompatibilityProxy(conn, options.skipCompatibilityCheck);
+        compatibilityProxy = new CompatibilityProxy(conn, options.skipCompatibilityCheck);
+        if ( reporterFactory ==  null )
+            reporterFactory = new ReporterFactory();
 
         // First of all check version compatibility
         compatibilityProxy.failOnNotCompatible();
@@ -148,7 +163,7 @@ else if (e.getErrorCode() == UtPLSQLNotInstalledException.ERROR_CODE) {
      */
     private void validateReporter(Connection conn, Reporter reporter) throws SQLException {
         if (!reporter.isInit() || reporter.getId() == null || reporter.getId().isEmpty())
-            reporter.init(conn);
+            reporter.init(conn, compatibilityProxy, reporterFactory);
     }
 
 }

src/main/java/org/utplsql/api/compatibility/OptionalFeatures.java

@@ -6,7 +6,8 @@
 public enum OptionalFeatures {
 
     FAIL_ON_ERROR("3.0.3", null),
-    FRAMEWORK_COMPATIBILITY_CHECK("3.0.3", null);
+    FRAMEWORK_COMPATIBILITY_CHECK("3.0.3", null),
+    CUSTOM_REPORTERS("3.1.0", null);
 
     private Version minVersion;
     private Version maxVersion;

src/main/java/org/utplsql/api/outputBuffer/AbstractOutputBuffer.java

@@ -76,7 +76,6 @@ public void fetchAvailable(Connection conn, Consumer<String> onLineFetched) thro
 
         try (PreparedStatement pstmt = getLinesStatement(conn)) {
 
-            pstmt.setString(1, getReporter().getId());
             try (ResultSet resultSet = pstmt.executeQuery() ) {
                 while (resultSet.next())
                     onLineFetched.accept(resultSet.getString(1));

src/main/java/org/utplsql/api/outputBuffer/OutputBufferProvider.java

@@ -25,7 +25,7 @@ public static OutputBuffer getCompatibleOutputBuffer(Version databaseVersion, Re
        OracleConnection oraConn = conn.unwrap(OracleConnection.class);
 
        try {
-           if (new Version("3.0.4.1610").isGreaterOrEqualThan(databaseVersion)) {
+           if (databaseVersion.isGreaterOrEqualThan(new Version("3.1.0"))) {
                if ( hasOutput(reporter, oraConn) ) {
                    return new DefaultOutputBuffer(reporter);
                }
@@ -42,8 +42,9 @@ public static OutputBuffer getCompatibleOutputBuffer(Version databaseVersion, Re
 
     private static boolean hasOutput( Reporter reporter, OracleConnection oraConn ) throws SQLException {
 
-        try ( PreparedStatement stmt = oraConn.prepareStatement("select ut_runner.is_output_reporter(?) from dual")) {
-            stmt.setString(1, reporter.getTypeName());
+        String sql = "select is_output_reporter from table(ut_runner.get_reporters_list) where regexp_like(reporter_object_name, ?)";
+        try ( PreparedStatement stmt = oraConn.prepareStatement(sql)) {
+            stmt.setString(1, "[a-zA-Z0-9_]*\\.?" + reporter.getTypeName());
 
             try ( ResultSet rs = stmt.executeQuery() ) {
                 if ( rs.next() ) {

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

@@ -30,18 +30,20 @@ public Reporter( String typeName, Object[] attributes ) {
     }
 
     protected void setTypeName( String typeName ) {
-        this.selfType = typeName.replaceAll("[^0-9a-zA-Z_]", "");
+        this.selfType = typeName.replaceAll("[^0-9a-zA-Z_\\.]", "");
     }
 
 
-    public Reporter init(Connection con, CompatibilityProxy compatibilityProxy ) throws SQLException {
+    public Reporter init(Connection con, CompatibilityProxy compatibilityProxy, ReporterFactory reporterFactory ) throws SQLException {
 
         if ( compatibilityProxy == null )
             compatibilityProxy = new CompatibilityProxy(con);
+        if ( reporterFactory == null )
+            reporterFactory = new ReporterFactory();
 
         OracleConnection oraConn = con.unwrap(OracleConnection.class);
 
-        initDbReporter( oraConn );
+        initDbReporter( oraConn, reporterFactory );
 
         init = true;
 
@@ -51,7 +53,7 @@ public Reporter init(Connection con, CompatibilityProxy compatibilityProxy ) thr
     }
 
     public Reporter init(Connection con) throws SQLException {
-        return init(con, null);
+        return init(con, null, null);
     }
 
     protected abstract void initOutputBuffer( OracleConnection oraConn, CompatibilityProxy compatibilityProxy ) throws SQLException;
@@ -63,12 +65,12 @@ public Reporter init(Connection con) throws SQLException {
      * @param oraConn
      * @throws SQLException
      */
-    private void initDbReporter( OracleConnection oraConn ) throws SQLException {
+    private void initDbReporter( OracleConnection oraConn, ReporterFactory reporterFactory ) throws SQLException {
         OracleCallableStatement callableStatement = (OracleCallableStatement) oraConn.prepareCall("{? = call " + selfType + "()}");
         callableStatement.registerOutParameter(1, OracleTypes.STRUCT, "UT_REPORTER_BASE");
         callableStatement.execute();
 
-        Reporter obj = (Reporter) callableStatement.getORAData(1, ReporterFactory.getInstance());
+        Reporter obj = (Reporter) callableStatement.getORAData(1, reporterFactory);
 
         setAttributes(obj.getAttributes());
     }

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

@@ -11,7 +11,7 @@
 import java.util.Map;
 import java.util.function.BiFunction;
 
-/** This singleton-class manages the instantiation of reporters.
+/** This 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
@@ -28,10 +28,8 @@ public ReporterInfo(BiFunction<String, Object[], ? extends Reporter> factoryMeth
     }
 
     private Map<String, ReporterInfo> reportFactoryMethodMap = new HashMap<>();
-
-    private static ReporterFactory instance;
 
-    private ReporterFactory() {
+    public ReporterFactory() {
         registerDefaultReporters();
     }
 
@@ -42,24 +40,6 @@ private void registerDefaultReporters() {
                 .forEach(r -> registerReporterFactoryMethod(r.name(), r.getFactoryMethod(), r.getDescription()));
     }
 
-    /** Returns the global instance of the ReporterFactory
-     *
-     * @return ReporterFactory
-     */
-    public static ReporterFactory getInstance() {
-        if ( instance == null ) 
-            instance = new ReporterFactory();
-        return instance;
-    }
-
-    public static Reporter create( CoreReporters reporter ) {
-        return getInstance().createReporter(reporter);
-    }
-
-    public static Reporter create( String reporter ) {
-        return getInstance().createReporter(reporter);
-    }
-
     /** Registers a creation method for a specified reporter name. Overrides eventually existing creation method
      *
      * @param reporterName the reporter's name to register
@@ -68,7 +48,7 @@ public static Reporter create( String reporter ) {
      * @return Object with information about the registered reporter
      */
     public synchronized ReporterInfo registerReporterFactoryMethod( String reporterName, BiFunction<String, Object[], ? extends Reporter> factoryMethod, String description) {
-        return reportFactoryMethodMap.put(reporterName, new ReporterInfo(factoryMethod, description));
+        return reportFactoryMethodMap.put(reporterName.toUpperCase(), new ReporterInfo(factoryMethod, description));
     }
 
     /** Unregisters a specified reporter name.
@@ -77,7 +57,7 @@ public synchronized ReporterInfo registerReporterFactoryMethod( String reporterN
      * @return information about the reporter which was previously registered or null
      */
     public synchronized ReporterInfo unregisterReporterFactoryMethod( String reporterName ) {
-        return reportFactoryMethodMap.remove(reporterName);
+        return reportFactoryMethodMap.remove(reporterName.toUpperCase());
     }
 
     /** Returns a new reporter of the given name.
@@ -89,6 +69,7 @@ public synchronized ReporterInfo unregisterReporterFactoryMethod( String reporte
      */
     public Reporter createReporter(String reporterName, Object[] attributes) {
 
+        reporterName = reporterName.toUpperCase();
         BiFunction<String, Object[], ? extends Reporter> supplier = DefaultReporter::new;
 
         if ( reportFactoryMethodMap.containsKey(reporterName)) {

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

@@ -0,0 +1,10 @@
+package org.utplsql.api.reporter;
+
+/** Gives information about available reporters
+ *
+ * @author pesse
+ */
+public class ReporterInspector {
+
+
+}

src/main/java/org/utplsql/api/reporter/core/CoreReporterProvider.java

@@ -0,0 +1,5 @@
+package org.utplsql.api.reporter.core;
+
+public class CoreReporterProvider {
+
+}

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

@@ -0,0 +1,32 @@
+package org.utplsql.api;
+
+import org.junit.jupiter.api.Test;
+import org.utplsql.api.reporter.DefaultReporter;
+import org.utplsql.api.reporter.Reporter;
+import org.utplsql.api.reporter.ReporterFactory;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class RegisterCustomReporterTest {
+
+    @Test
+    public void addCustomReporter() {
+
+        ReporterFactory reporterFactory = new ReporterFactory();
+        reporterFactory.registerReporterFactoryMethod("ut_custom_reporter",
+                (type, attr) -> new DefaultReporter("UT_EXISTING_REPORTER", attr),
+                "My custom Reporter");
+
+        Reporter r = reporterFactory.createReporter("ut_custom_reporter");
+
+        assertEquals(r.getTypeName(), "UT_EXISTING_REPORTER");
+    }
+
+    @Test
+    public void createCustomDefaultReporter() {
+        ReporterFactory reporterFactory = new ReporterFactory();
+        Reporter r = reporterFactory.createReporter("ut_custom_reporter");
+
+        assertEquals(r.getTypeName(), "UT_CUSTOM_REPORTER");
+    }
+}

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

@@ -12,7 +12,7 @@ public class ReporterNameTest {
 
     @Test
     public void defaultReporterFactoryNamesList() {
-        Map<String, String> reporterDescriptions = ReporterFactory.getInstance().getRegisteredReporterInfo();
+        Map<String, String> reporterDescriptions = new ReporterFactory().getRegisteredReporterInfo();
 
         for ( CoreReporters r : CoreReporters.values() ) {
             assertTrue(reporterDescriptions.containsKey(r.name()));