Implement rules for printToScreen Reporters: Only one can go to screen

pesse · pesse · commit 8eec2cbdf505 · 2019-06-13T16:32:53.000+02:00
diff --git a/src/main/java/org/utplsql/cli/ReporterOptions.java b/src/main/java/org/utplsql/cli/ReporterOptions.java
@@ -14,15 +14,15 @@ public class ReporterOptions {
 
     private Reporter reporterObj = null;
 
-    public ReporterOptions(String reporterName, String outputFileName, boolean outputToScreen) {
+    public ReporterOptions(String reporterName, String outputFileName ) {
         setReporterName(reporterName);
         setOutputFileName(outputFileName);
-        this.outputToScreen = outputToScreen;
+        this.outputToScreen = (outputFileName == null); // If outputFileName is null we assume it should be sent to screen
         this.forceOutputToScreen = false;
     }
 
     public ReporterOptions(String reporterName) {
-        this(reporterName, null, true);
+        this(reporterName, null);
     }
 
     public Reporter getReporterObj() {
diff --git a/src/main/java/org/utplsql/cli/RunAction.java b/src/main/java/org/utplsql/cli/RunAction.java
@@ -1,7 +1,5 @@
 package org.utplsql.cli;
 
-import com.beust.jcommander.Parameter;
-import com.beust.jcommander.Parameters;
 import com.zaxxer.hikari.HikariDataSource;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -23,7 +21,6 @@
 import org.utplsql.cli.log.StringBlockFormatter;
 
 import javax.sql.DataSource;
-import javax.xml.crypto.dsig.keyinfo.KeyValue;
 import java.io.File;
 import java.sql.Connection;
 import java.sql.SQLException;
@@ -280,11 +277,18 @@ private ReporterManager getReporterManager() {
             ReporterConfig[] reporterConfigs = config.getReporters();
             if ( reporterConfigs != null ) {
                 ReporterOptions[] options = new ReporterOptions[reporterConfigs.length];
+                boolean printToScreen = false;
                 for (int i = 0; i<reporterConfigs.length; i++ ) {
                     options[i] = new ReporterOptions(
                             reporterConfigs[i].getName(),
-                            reporterConfigs[i].getOutput(),
-                            reporterConfigs[i].isScreen());
+                            reporterConfigs[i].getOutput());
+
+                    options[i].forceOutputToScreen(reporterConfigs[i].isForceToScreen());
+
+                    // Check printToScreen validity
+                    if ( options[i].outputToScreen() && printToScreen )
+                        throw new IllegalArgumentException("You cannot configure more than one reporter to output to screen");
+                    printToScreen = options[i].outputToScreen();
                 }
                 reporterManager = new ReporterManager(options);
             }
diff --git a/src/main/java/org/utplsql/cli/config/ReporterConfig.java b/src/main/java/org/utplsql/cli/config/ReporterConfig.java
@@ -6,13 +6,13 @@ public class ReporterConfig {
 
     private final String name;
     private final String output;
-    private boolean screen = false;
+    private boolean forceToScreen = false;
 
-    @ConstructorProperties({"name", "output", "screen"})
-    public ReporterConfig( String name, String output, Boolean screen ) {
+    @ConstructorProperties({"name", "output", "forceToScreen"})
+    public ReporterConfig( String name, String output, Boolean forceToScreen) {
         this.name = name;
         this.output = output;
-        if ( screen != null ) this.screen = screen;
+        if ( forceToScreen != null ) this.forceToScreen = forceToScreen;
     }
 
     public String getName() {
@@ -23,7 +23,7 @@ public String getOutput() {
         return output;
     }
 
-    public boolean isScreen() {
-        return screen;
+    public boolean isForceToScreen() {
+        return forceToScreen;
     }
 }
diff --git a/src/test/java/org/utplsql/cli/PicocliRunCommandTest.java b/src/test/java/org/utplsql/cli/PicocliRunCommandTest.java
@@ -1,13 +1,9 @@
 package org.utplsql.cli;
 
-import org.hamcrest.Matchers;
 import org.junit.jupiter.api.Test;
 import org.utplsql.cli.config.FileMapperConfig;
 import org.utplsql.cli.config.ReporterConfig;
 import org.utplsql.cli.config.RunCommandConfig;
-import picocli.CommandLine;
-
-import java.util.List;
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.*;
@@ -139,7 +135,7 @@ void singleReporter() throws Exception {
         ReporterConfig reporterConfig = config.getReporters()[0];
         assertEquals("ut_documentation_reporter", reporterConfig.getName());
         assertNull(reporterConfig.getOutput());
-        assertFalse(reporterConfig.isScreen());
+        assertFalse(reporterConfig.isForceToScreen());
     }
 
     @Test
@@ -157,12 +153,12 @@ void multipleReporters() throws Exception {
         ReporterConfig reporterConfig = config.getReporters()[0];
         assertEquals("ut_documentation_reporter", reporterConfig.getName());
         assertEquals("output1.txt", reporterConfig.getOutput());
-        assertFalse(reporterConfig.isScreen());
+        assertFalse(reporterConfig.isForceToScreen());
 
         reporterConfig = config.getReporters()[1];
         assertEquals("ut_coverage_html", reporterConfig.getName());
         assertEquals("output2.html", reporterConfig.getOutput());
-        assertTrue(reporterConfig.isScreen());
+        assertTrue(reporterConfig.isForceToScreen());
     }
 
     @Test
diff --git a/src/test/java/org/utplsql/cli/RunCommandTest.java b/src/test/java/org/utplsql/cli/RunCommandTest.java
@@ -1,10 +1,12 @@
 package org.utplsql.cli;
 
+import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
 import org.utplsql.api.TestRunnerOptions;
 import org.utplsql.api.reporter.CoreReporters;
 
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
 
 import static org.hamcrest.CoreMatchers.equalTo;
@@ -17,77 +19,184 @@
  */
 class RunCommandTest {
 
-    @Test
-    void reporterOptions_Default() {
-        IRunCommand runCmd = TestHelper.createRunCommand(TestHelper.getConnectionString());
-
-        List<ReporterOptions> reporterOptionsList = runCmd.getReporterOptionsList();
-
-        ReporterOptions reporterOptions1 = reporterOptionsList.get(0);
-        assertEquals(CoreReporters.UT_DOCUMENTATION_REPORTER.name(), reporterOptions1.getReporterName());
-        assertNull(reporterOptions1.getOutputFileName());
-        assertFalse(reporterOptions1.outputToFile());
-        assertTrue(reporterOptions1.outputToScreen());
-    }
-
-    @Test
-    void reporterOptions_OneReporter() {
-        IRunCommand runCmd = TestHelper.createRunCommand(TestHelper.getConnectionString(), "-f=ut_documentation_reporter", "-o=output.txt");
-
-        List<ReporterOptions> reporterOptionsList = runCmd.getReporterOptionsList();
-
-        ReporterOptions reporterOptions1 = reporterOptionsList.get(0);
-        assertEquals(CoreReporters.UT_DOCUMENTATION_REPORTER.name(), reporterOptions1.getReporterName());
-        assertEquals(reporterOptions1.getOutputFileName(), "output.txt");
-        assertTrue(reporterOptions1.outputToFile());
-        assertFalse(reporterOptions1.outputToScreen());
-    }
-
-    @Test
-    void reporterOptions_OneReporterForceScreen() {
-        IRunCommand runCmd = TestHelper.createRunCommand(TestHelper.getConnectionString(), "-f=ut_documentation_reporter", "-o=output.txt", "-s");
-
-        List<ReporterOptions> reporterOptionsList = runCmd.getReporterOptionsList();
-
-        ReporterOptions reporterOptions1 = reporterOptionsList.get(0);
-        assertEquals(CoreReporters.UT_DOCUMENTATION_REPORTER.name(), reporterOptions1.getReporterName());
-        assertEquals(reporterOptions1.getOutputFileName(), "output.txt");
-        assertTrue(reporterOptions1.outputToFile());
-        assertTrue(reporterOptions1.outputToScreen());
-    }
-
-    @Test
-    void reporterOptions_OneReporterForceScreenInverse() {
-        IRunCommand runCmd = TestHelper.createRunCommand(TestHelper.getConnectionString(), "-f=ut_documentation_reporter", "-s", "-o=output.txt");
-
-        List<ReporterOptions> reporterOptionsList = runCmd.getReporterOptionsList();
-
-        ReporterOptions reporterOptions1 = reporterOptionsList.get(0);
-        assertEquals(CoreReporters.UT_DOCUMENTATION_REPORTER.name(), reporterOptions1.getReporterName());
-        assertEquals(reporterOptions1.getOutputFileName(), "output.txt");
-        assertTrue(reporterOptions1.outputToFile());
-        assertTrue(reporterOptions1.outputToScreen());
-    }
-
-    @Test
-    void reporterOptions_TwoReporters() {
-        IRunCommand runCmd = TestHelper.createRunCommand(TestHelper.getConnectionString(),
-                "-f=ut_documentation_reporter",
-                "-f=ut_coverage_html_reporter", "-o=coverage.html", "-s");
-
-        List<ReporterOptions> reporterOptionsList = runCmd.getReporterOptionsList();
-
-        ReporterOptions reporterOptions1 = reporterOptionsList.get(0);
-        assertEquals(CoreReporters.UT_DOCUMENTATION_REPORTER.name(), reporterOptions1.getReporterName());
-        assertNull(reporterOptions1.getOutputFileName());
-        assertFalse(reporterOptions1.outputToFile());
-        assertFalse(reporterOptions1.outputToScreen());
-
-        ReporterOptions reporterOptions2 = reporterOptionsList.get(1);
-        assertEquals(CoreReporters.UT_COVERAGE_HTML_REPORTER.name(), reporterOptions2.getReporterName());
-        assertEquals(reporterOptions2.getOutputFileName(), "coverage.html");
-        assertTrue(reporterOptions2.outputToFile());
-        assertTrue(reporterOptions2.outputToScreen());
+    @Nested
+    class A_reporter {
+
+        List<ReporterOptions> getReporterOptionsWithArgs(String... args) {
+            ArrayList<String> newArgs = new ArrayList<>(args.length + 1);
+            newArgs.add(TestHelper.getConnectionString());
+            newArgs.addAll(Arrays.asList(args));
+            IRunCommand cmd = TestHelper.createRunCommand(newArgs.toArray(new String[0]));
+            return cmd.getReporterOptionsList();
+        }
+
+        @Nested
+        class Is_output_to_screen {
+
+            @Test
+            void by_default() {
+                List<ReporterOptions> options = getReporterOptionsWithArgs();
+
+                assertTrue(options.get(0).outputToScreen());
+            }
+
+            @Test
+            void when_only_reporter_without_output_specified() {
+                List<ReporterOptions> options = getReporterOptionsWithArgs("-f=ut_documentation_reporter");
+
+                assertTrue(options.get(0).outputToScreen());
+            }
+
+            @Test
+            void when_without_output_and_no_other_reporter_has_forceToScreen_flag() {
+                List<ReporterOptions> options = getReporterOptionsWithArgs(
+                        "-f=ut_coverage_sonar_reporter", "-o=output.txt",
+                        "-f=ut_coverage_html_reporter");
+
+                assertTrue(options.get(1).outputToScreen());
+            }
+
+            @Test
+            void when_only_reporter_with_forceToScreen_flag() {
+                List<ReporterOptions> options = getReporterOptionsWithArgs(
+                        "-f=ut_coverage_sonar_reporter", "-o=output.txt",
+                        "-f=ut_coverage_html_reporter", "-o=output.html", "-s",
+                        "-f=ut_coverage_cobertura_reporter", "-o=cobertura.html");
+
+                assertTrue(options.get(1).outputToScreen());
+            }
+        }
+
+        @Nested
+        class Is_not_output_to_screen {
+
+            @Test
+            void when_it_has_output_specified_but_no_forceToScreen() {
+                List<ReporterOptions> options = getReporterOptionsWithArgs(
+                        "-f=ut_documentation_reporter", "-o=output.txt",
+                        "-f=ut_coverage_html_reporter", "-o=output.html"
+                );
+
+                assertFalse(options.get(0).outputToScreen());
+                assertFalse(options.get(1).outputToScreen());
+            }
+        }
+
+        @Nested
+        class Cannot_be_run {
+
+            @Test
+            void when_more_than_one_forceToScreen_flags() {
+                assertThrows(IllegalArgumentException.class, () -> {
+                    getReporterOptionsWithArgs(
+                            "-f=ut_coverage_sonar_reporter", "-o=output.txt", "-s",
+                            "-f=ut_coverage_html_reporter", "-o=output.html", "-s");
+                });
+            }
+
+            @Test
+            void when_more_than_one_reporters_without_output() {
+                assertThrows(IllegalArgumentException.class, () -> {
+                    getReporterOptionsWithArgs(
+                            "-f=ut_coverage_sonar_reporter",
+                            "-f=ut_coverage_html_reporter");
+                });
+            }
+            @Test
+            void when_one_reporter_without_output_and_one_with_forceToScreen() {
+                assertThrows(IllegalArgumentException.class, () -> {
+                    getReporterOptionsWithArgs(
+                            "-f=ut_coverage_sonar_reporter",
+                            "-f=ut_coverage_html_reporter", "-o=output.html", "-s");
+                });
+            }
+        }
+
+        @Test
+        void reporterOptions_Default() {
+            IRunCommand runCmd = TestHelper.createRunCommand(TestHelper.getConnectionString());
+
+            List<ReporterOptions> reporterOptionsList = runCmd.getReporterOptionsList();
+
+            ReporterOptions reporterOptions1 = reporterOptionsList.get(0);
+            assertEquals(CoreReporters.UT_DOCUMENTATION_REPORTER.name(), reporterOptions1.getReporterName());
+            assertNull(reporterOptions1.getOutputFileName());
+            assertFalse(reporterOptions1.outputToFile());
+            assertTrue(reporterOptions1.outputToScreen());
+        }
+
+        @Test
+        void reporterOptions_OneReporter() {
+            IRunCommand runCmd = TestHelper.createRunCommand(TestHelper.getConnectionString(), "-f=ut_documentation_reporter", "-o=output.txt");
+
+            List<ReporterOptions> reporterOptionsList = runCmd.getReporterOptionsList();
+
+            ReporterOptions reporterOptions1 = reporterOptionsList.get(0);
+            assertEquals(CoreReporters.UT_DOCUMENTATION_REPORTER.name(), reporterOptions1.getReporterName());
+            assertEquals("output.txt", reporterOptions1.getOutputFileName());
+            assertTrue(reporterOptions1.outputToFile());
+            assertFalse(reporterOptions1.outputToScreen());
+        }
+
+        @Test
+        void reporterOptions_OneReporter_DefaultToScreen() {
+            IRunCommand runCmd = TestHelper.createRunCommand(TestHelper.getConnectionString(), "-f=ut_documentation_reporter");
+
+            List<ReporterOptions> reporterOptionsList = runCmd.getReporterOptionsList();
+
+            ReporterOptions reporterOptions1 = reporterOptionsList.get(0);
+            assertEquals(CoreReporters.UT_DOCUMENTATION_REPORTER.name(), reporterOptions1.getReporterName());
+            assertNull(reporterOptions1.getOutputFileName());
+            assertFalse(reporterOptions1.outputToFile());
+            assertTrue(reporterOptions1.outputToScreen());
+        }
+
+        @Test
+        void reporterOptions_OneReporterForceScreen() {
+            IRunCommand runCmd = TestHelper.createRunCommand(TestHelper.getConnectionString(), "-f=ut_documentation_reporter", "-o=output.txt", "-s");
+
+            List<ReporterOptions> reporterOptionsList = runCmd.getReporterOptionsList();
+
+            ReporterOptions reporterOptions1 = reporterOptionsList.get(0);
+            assertEquals(CoreReporters.UT_DOCUMENTATION_REPORTER.name(), reporterOptions1.getReporterName());
+            assertEquals("output.txt", reporterOptions1.getOutputFileName());
+            assertTrue(reporterOptions1.outputToFile());
+            assertTrue(reporterOptions1.outputToScreen());
+        }
+
+        @Test
+        void reporterOptions_OneReporterForceScreenInverse() {
+            IRunCommand runCmd = TestHelper.createRunCommand(TestHelper.getConnectionString(), "-f=ut_documentation_reporter", "-s", "-o=output.txt");
+
+            List<ReporterOptions> reporterOptionsList = runCmd.getReporterOptionsList();
+
+            ReporterOptions reporterOptions1 = reporterOptionsList.get(0);
+            assertEquals(CoreReporters.UT_DOCUMENTATION_REPORTER.name(), reporterOptions1.getReporterName());
+            assertEquals("output.txt", reporterOptions1.getOutputFileName());
+            assertTrue(reporterOptions1.outputToFile());
+            assertTrue(reporterOptions1.outputToScreen());
+        }
+
+        @Test
+        void reporterOptions_TwoReporters() {
+            IRunCommand runCmd = TestHelper.createRunCommand(TestHelper.getConnectionString(),
+                    "-f=ut_documentation_reporter", "-o=output.txt",
+                    "-f=ut_coverage_html_reporter", "-o=coverage.html", "-s");
+
+            List<ReporterOptions> reporterOptionsList = runCmd.getReporterOptionsList();
+
+            ReporterOptions reporterOptions1 = reporterOptionsList.get(0);
+            assertEquals(CoreReporters.UT_DOCUMENTATION_REPORTER.name(), reporterOptions1.getReporterName());
+            assertEquals("output.txt", reporterOptions1.getOutputFileName());
+            assertTrue(reporterOptions1.outputToFile());
+            assertFalse(reporterOptions1.outputToScreen());
+
+            ReporterOptions reporterOptions2 = reporterOptionsList.get(1);
+            assertEquals(CoreReporters.UT_COVERAGE_HTML_REPORTER.name(), reporterOptions2.getReporterName());
+            assertEquals("coverage.html", reporterOptions2.getOutputFileName());
+            assertTrue(reporterOptions2.outputToFile());
+            assertTrue(reporterOptions2.outputToScreen());
+        }
     }
 
     @Test

Original file line number	Diff line number	Diff line change
`@@ -6,13 +6,13 @@ public class ReporterConfig {`
`6`	`6`
`7`	`7`	`private final String name;`
`8`	`8`	`private final String output;`
`9`		`- private boolean screen = false;`
	`9`	`+ private boolean forceToScreen = false;`
`10`	`10`
`11`		`- @ConstructorProperties({"name", "output", "screen"})`
`12`		`- public ReporterConfig( String name, String output, Boolean screen ) {`
	`11`	`+ @ConstructorProperties({"name", "output", "forceToScreen"})`
	`12`	`+ public ReporterConfig( String name, String output, Boolean forceToScreen) {`
`13`	`13`	`this.name = name;`
`14`	`14`	`this.output = output;`
`15`		`- if ( screen != null ) this.screen = screen;`
	`15`	`+ if ( forceToScreen != null ) this.forceToScreen = forceToScreen;`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`public String getName() {`
`@@ -23,7 +23,7 @@ public String getOutput() {`
`23`	`23`	`return output;`
`24`	`24`	`}`
`25`	`25`
`26`		`- public boolean isScreen() {`
`27`		`- return screen;`
	`26`	`+ public boolean isForceToScreen() {`
	`27`	`+ return forceToScreen;`
`28`	`28`	`}`
`29`	`29`	`}`