Using Maven log in ReporterWriter. Enable skipUtPlsqlTests with system property. Updated README.md

Author: simasch

README.md

@@ -2,16 +2,15 @@
 [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=org.utplsql%3Autplsql-maven-plugin&metric=alert_status)](https://sonarcloud.io/dashboard?id=org.utplsql%3Autplsql-maven-plugin)
 
 # utPLSQL-maven-plugin
-* A maven plugin for running Unit Tests with utPLSQL v3+.
+A maven plugin for running Unit Tests with utPLSQL v3+.
 
 ## Compatibility
-* This plugin is compatible with utPLSQL 3.1.0+.
+This plugin is compatible with utPLSQL 3.1.0+.
 
 ## Prerequisites
 * Java SE Runtime Environment 8
 * Maven Version 3.5+
-
-The plugin requires Oracle JDBC driver (ojdbc8) as a Maven dependency. 
+* Oracle JDBC driver 
 
 ```xml
 <dependency>
@@ -49,11 +48,11 @@ If you want to skip tests by default but want the ability to re-enable tests fro
 
 This will allow you to run with all tests disabled by default and to run them with this command:
 
-    mvn install -DskipTests=false
+    mvn install -DskipUtplsqlTests=false
 
-### Usage Example
+### Configuration
 
-Please refer to the following usage example for the parameters descriptions.
+Please refer to the following usage example for the parameters descriptions:
 
 ```xml
 <project xmlns="http://maven.apache.org/POM/4.0.0"
@@ -90,7 +89,6 @@ Please refer to the following usage example for the parameters descriptions.
                             <goal>test</goal>
                         </goals>
                         <configuration>
-                        
                             <!-- REQUIRED PARAMETERS -->
 
                             <!-- A list of tests suite paths. -->
@@ -142,6 +140,10 @@ Please refer to the following usage example for the parameters descriptions.
                             <!-- Defaults to: false -->
                             <skipUtplsqlTests>false</skipUtplsqlTests>
 
+                            <!-- Enables DBMS_OUTPUT -->
+                            <!-- Defaults to: false -->
+                            <dbmsOutput>false</dbmsOutput>
+
                             <!-- A list of tags to run. -->
                             <tags>
                                 <tag>test_tag</tag>
@@ -230,14 +232,14 @@ Please refer to the following usage example for the parameters descriptions.
 ```
 
 More project samples are available in the src/test/resources directory:
-* **simple-project:** minimalist test project with standard project directory structure.
-* **regex-project:** overrides project directory structure and use additional parameters (sourcesRegexExpression, testsRegexExpression, ...), to tell utPLSQL how project files should be mapped into database objects.
-* **type-mapping-project:** this project shows how to use regex and custom type parameters together.
-* **owner-param-project:** this project demonstrates how to use sourcesOwner and testsOwner parameters.
+* **simple-project:** Minimalist test project with standard project directory structure.
+* **regex-project:** Overrides project directory structure and use additional parameters (sourcesRegexExpression, testsRegexExpression, ...), to tell utPLSQL how project files should be mapped into database objects.
+* **type-mapping-project:** Example how to use regex and custom type parameters together.
+* **owner-param-project:** Demonstrates how to use sourcesOwner and testsOwner parameters.
 
-## Comparaison with the CLI
+## Comparison with utPLSQL CLI
 
-| CLI short parameter | CLI long parameter | maven XML path |
+| CLI short parameter | CLI long parameter | Maven XML path |
 | --- | --- | --- |
 | -c | --color | |
 | | --failure-exit-code | |
@@ -248,6 +250,7 @@ More project samples are available in the src/test/resources directory:
 | | | ignoreFailure |
 | -scc | --skip-compatibility-check | skipCompatibilityCheck |
 | | --tags | tags.tag |
+| -D | --dbms_output | dbmsOutput |
 | -r | --random-test-order | randomTestOrder |
 | -seed | --random-test-order-seed | randomTestOrderSeed |
 | -exclude | | excludeObject |

src/main/java/org/utplsql/maven/plugin/UtPLSQLMojo.java

@@ -11,6 +11,7 @@
 import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.project.MavenProject;
 import org.apache.maven.shared.utils.logging.MessageUtils;
+import org.utplsql.api.DBHelper;
 import org.utplsql.api.FileMapperOptions;
 import org.utplsql.api.JavaApiVersionInfo;
 import org.utplsql.api.KeyValuePair;
@@ -130,9 +131,12 @@ public class UtPLSQLMojo extends AbstractMojo {
     @Parameter(defaultValue = "${maven.test.failure.ignore}")
     protected boolean ignoreFailure;
 
-    @Parameter(defaultValue = "${skipUtplsqlTests}")
+    @Parameter(property = "skipUtplsqlTests", defaultValue = "false")
     protected boolean skipUtplsqlTests;
 
+    @Parameter
+    protected boolean dbmsOutput;
+
     // Color in the console, bases on Maven logging configuration.
     private final boolean colorConsole = MessageUtils.isColorEnabled();
 
@@ -146,7 +150,7 @@ public class UtPLSQLMojo extends AbstractMojo {
     @Override
     public void execute() throws MojoExecutionException {
         if (skipUtplsqlTests) {
-            getLog().debug("utPLSQLTests are skipped.");
+            getLog().info("utPLSQLTests are skipped.");
         } else {
             getLog().debug("Java Api Version = " + JavaApiVersionInfo.getVersion());
             loadConfFromEnvironment();
@@ -168,6 +172,11 @@ public void execute() throws MojoExecutionException {
 
                 logParameters(sourceMappingOptions, testMappingOptions, reporterList);
 
+                if (dbmsOutput) {
+                    DBHelper.enableDBMSOutput(connection);
+                    getLog().info("Enabled dbms_output.");
+                }
+
                 TestRunner runner = new TestRunner()
                         .addPathList(paths)
                         .addReporterList(reporterList)
@@ -199,6 +208,8 @@ public void execute() throws MojoExecutionException {
                 try {
                     if (null != connection) {
                         reporterWriter.writeReporters(connection);
+
+                        DBHelper.disableDBMSOutput(connection);
                         connection.close();
                     }
                 } catch (Exception e) {
@@ -326,7 +337,7 @@ private List<Reporter> initReporters(Connection connection, Version utlVersion,
             throws SQLException {
 
         List<Reporter> reporterList = new ArrayList<>();
-        reporterWriter = new ReporterWriter(targetDir, utlVersion);
+        reporterWriter = new ReporterWriter(targetDir, utlVersion, getLog());
 
         if (reporters.isEmpty()) {
             ReporterParameter reporterParameter = new ReporterParameter();

src/main/java/org/utplsql/maven/plugin/reporter/ReporterWriter.java

@@ -22,30 +22,31 @@
 
 public class ReporterWriter {
 
-    private static final Log LOG = new SystemStreamLog();
-
     private final List<Pair<Reporter, ReporterParameter>> listReporters;
 
     private final String outputDirectory;
 
     private final Version databaseVersion;
 
+    private final Log log;
+
     /**
      * Constructor of the reporter writer.
-     * 
+     *
      * @param outputDirectory the reporter output directory
      * @param databaseVersion the utPLSQL framework version
+     * @param log             the Maven log
      */
-    public ReporterWriter(String outputDirectory, Version databaseVersion) {
+    public ReporterWriter(String outputDirectory, Version databaseVersion, Log log) {
         this.listReporters = new ArrayList<>();
         this.outputDirectory = outputDirectory;
         this.databaseVersion = databaseVersion;
-
+        this.log = log;
     }
 
     /**
      * Adds a new reporter to the writter.
-     * 
+     *
      * @param parameter the reporter parameter
      * @param reporter  the reporter Object
      */
@@ -55,7 +56,7 @@ public void addReporter(ReporterParameter parameter, Reporter reporter) {
 
     /**
      * Writes the reporters to the output.
-     * 
+     *
      * @param connection the database connection
      * @throws MojoExecutionException if any exception happens
      */
@@ -82,19 +83,19 @@ private void writeReports(Connection connection, Reporter reporter, ReporterPara
                 }
 
                 if (!file.getParentFile().exists()) {
-                    LOG.debug("Creating directory for reporter file " + file.getAbsolutePath());
+                    log.debug("Creating directory for reporter file " + file.getAbsolutePath());
                     file.getParentFile().mkdirs();
                 }
 
                 fout = new FileOutputStream(file);
-                LOG.info(format("Writing report %s to %s", reporter.getTypeName(), file.getAbsolutePath()));
+                log.info(format("Writing report %s to %s", reporter.getTypeName(), file.getAbsolutePath()));
 
                 // Added to the Report
                 printStreams.add(new PrintStream(fout));
             }
 
             if (reporterParameter.isConsoleOutput()) {
-                LOG.info(format("Writing report %s to Console", reporter.getTypeName()));
+                log.info(format("Writing report %s to Console", reporter.getTypeName()));
                 printStreams.add(System.out);
             }
             buffer.printAvailable(connection, printStreams);
@@ -105,7 +106,7 @@ private void writeReports(Connection connection, Reporter reporter, ReporterPara
                 try {
                     fout.close();
                 } catch (IOException e) {
-                    LOG.info(format("Failed to closing the reporting %s", reporterParameter.getClass()));
+                    log.info(format("Failed to closing the reporting %s", reporterParameter.getClass()));
                 }
             }
         }