#55 Add flag to skip the tests

simasch · simasch · commit 69c6ceda3f0b · 2021-11-19T16:55:52.000+01:00
diff --git a/README.md b/README.md
@@ -4,52 +4,54 @@
 # utPLSQL-maven-plugin
 * A maven plugin for running Unit Tests with utPLSQL v3+.
 
-### Compatibility
+## Compatibility
 * This plugin is compatible with utPLSQL 3.1.0+.
 
-### Prerequisites
+## Prerequisites
 * Java SE Runtime Environment 8
 * Maven Version 3.5+
 
-The plugin requires Oracle JDBC driver (ojdbc8) as a maven dependency. 
-In order to download the required driver, you need to configure access to Oracle's Maven Repository in your `settings.xml` file.
+The plugin requires Oracle JDBC driver (ojdbc8) as a Maven dependency. 
 
-http://docs.oracle.com/middleware/1213/core/MAVEN/config_maven_repo.htm#MAVEN9010
+```xml
+<dependency>
+    <groupId>com.oracle.database.jdbc</groupId>
+    <artifactId>ojdbc8</artifactId>
+    <version>21.3.0.0</version>
+</dependency>
+```
+
+## Usage
+
+### Skipping Tests
+
+To skip running the tests for a particular project, set the **skipUtplsqlTests** property to true.
+
+```xml
+<configuration>
+    <skipUtplsqlTests>true</skipUtplsqlTests>
+</configuration>
+```
+
+You can also skip the tests via the command line by executing the following command:
 
-Sections 6.1 and 6.5 are the more important ones, and the only ones you need if you're using the latest Maven version.
+    mvn install -DskipTests
 
-Below is an example of changes needed to your `settings.xml` file.
+#### Skipping by Default
+
+If you want to skip tests by default but want the ability to re-enable tests from the command line, you need to go via a properties section in the pom:
 
 ```xml
-<settings>
- <servers>
-    <server>
-        <id>maven.oracle.com</id>
-        <username>oracle_tech_net_user_name</username>
-        <password>oracle_tech_net_password</password>
-        <configuration>
-            <basicAuthScope>
-                <host>ANY</host>
-                <port>ANY</port>
-                <realm>OAM 11g</realm>
-            </basicAuthScope>
-            <httpConfiguration>
-                <all>
-                    <params>
-                        <property>
-                        <name>http.protocol.allow-circular-redirects</name>
-                        <value>%b,true</value>
-                        </property>
-                    </params>
-                </all>
-            </httpConfiguration>
-        </configuration>
-    </server>
- </servers>
-</settings>
+<configuration>
+    <skipUtplsqlTests>true</skipUtplsqlTests>
+</configuration>
 ```
 
-### Usage
+This will allow you to run with all tests disabled by default and to run them with this command:
+
+    mvn install -DskipTests=false
+
+### Usage Example
 
 Please refer to the following usage example for the parameters descriptions.
 
@@ -136,6 +138,10 @@ Please refer to the following usage example for the parameters descriptions.
                             <!-- Defaults to: false -->
                             <skipCompatibilityCheck>false</skipCompatibilityCheck>
 
+                            <!-- Skip the tests -->
+                            <!-- Defaults to: false -->
+                            <skipUtplsqlTests>false</skipUtplsqlTests>
+
                             <!-- A list of tags to run. -->
                             <tags>
                                 <tag>test_tag</tag>
@@ -229,7 +235,7 @@ More project samples are available in the src/test/resources directory:
 * **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.
 
-### Comparaison with the CLI
+## Comparaison with the CLI
 
 | CLI short parameter | CLI long parameter | maven XML path |
 | --- | --- | --- |
diff --git a/src/main/java/org/utplsql/maven/plugin/UtPLSQLMojo.java b/src/main/java/org/utplsql/maven/plugin/UtPLSQLMojo.java
@@ -1,13 +1,6 @@
 package org.utplsql.maven.plugin;
 
-import java.io.File;
-import java.sql.Connection;
-import java.sql.SQLException;
-import java.util.ArrayList;
-import java.util.LinkedHashSet;
-import java.util.List;
-import java.util.Set;
-
+import oracle.jdbc.pool.OracleDataSource;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.maven.model.Resource;
 import org.apache.maven.plugin.AbstractMojo;
@@ -34,11 +27,17 @@
 import org.utplsql.maven.plugin.model.ReporterParameter;
 import org.utplsql.maven.plugin.reporter.ReporterWriter;
 
-import oracle.jdbc.pool.OracleDataSource;
+import java.io.File;
+import java.sql.Connection;
+import java.sql.SQLException;
+import java.util.ArrayList;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Set;
 
 /**
  * This class expose the {@link TestRunner} interface to Maven.
- * 
+ *
  * @author Alberto Hernández
  */
 @Mojo(name = "test", defaultPhase = LifecyclePhase.TEST)
@@ -130,6 +129,9 @@ public class UtPLSQLMojo extends AbstractMojo {
     @Parameter(defaultValue = "${maven.test.failure.ignore}")
     protected boolean ignoreFailure;
 
+    @Parameter(defaultValue = "${skiptUtplsqlTests}")
+    protected boolean skiptUtplsqlTests;
+
     // Color in the console, bases on Maven logging configuration.
     private boolean colorConsole = MessageUtils.isColorEnabled();
 
@@ -142,62 +144,65 @@ public class UtPLSQLMojo extends AbstractMojo {
      */
     @Override
     public void execute() throws MojoExecutionException {
+        if (skiptUtplsqlTests) {
+            getLog().debug("utPLSQLTests are skipped.");
+        } else {
+            getLog().debug("Java Api Version = " + JavaApiVersionInfo.getVersion());
+            loadConfFromEnvironment();
 
-        getLog().debug("Java Api Version = " + JavaApiVersionInfo.getVersion());
-        loadConfFromEnvironment();
-
-        Connection connection = null;
-        try {
-            FileMapperOptions sourceMappingOptions = buildSourcesOptions();
-            FileMapperOptions testMappingOptions = buildTestsOptions();
-            OracleDataSource ds = new OracleDataSource();
-            ds.setURL(url);
-            ds.setUser(user);
-            ds.setPassword(password);
-            connection = ds.getConnection();
-
-            Version utlVersion = this.databaseInformation.getUtPlsqlFrameworkVersion(connection);
-            getLog().info("utPLSQL Version = " + utlVersion);
-
-            List<Reporter> reporterList = initReporters(connection, utlVersion, ReporterFactory.createEmpty());
-
-            logParameters(sourceMappingOptions, testMappingOptions, reporterList);
-
-            TestRunner runner = new TestRunner()
-                    .addPathList(paths)
-                    .addReporterList(reporterList)
-                    .sourceMappingOptions(sourceMappingOptions)
-                    .testMappingOptions(testMappingOptions)
-                    .skipCompatibilityCheck(skipCompatibilityCheck)
-                    .colorConsole(colorConsole)
-                    .addTags(tags)
-                    .randomTestOrder(randomTestOrder)
-                    .randomTestOrderSeed(randomTestOrderSeed)
-                    .failOnErrors(!ignoreFailure);
-
-            if (StringUtils.isNotBlank(excludeObject)) {
-                runner.excludeObject(excludeObject);
-            }
-            if (StringUtils.isNotBlank(includeObject)) {
-                runner.includeObject(includeObject);
-            }
+            Connection connection = null;
+            try {
+                FileMapperOptions sourceMappingOptions = buildSourcesOptions();
+                FileMapperOptions testMappingOptions = buildTestsOptions();
+                OracleDataSource ds = new OracleDataSource();
+                ds.setURL(url);
+                ds.setUser(user);
+                ds.setPassword(password);
+                connection = ds.getConnection();
+
+                Version utlVersion = this.databaseInformation.getUtPlsqlFrameworkVersion(connection);
+                getLog().info("utPLSQL Version = " + utlVersion);
+
+                List<Reporter> reporterList = initReporters(connection, utlVersion, ReporterFactory.createEmpty());
+
+                logParameters(sourceMappingOptions, testMappingOptions, reporterList);
+
+                TestRunner runner = new TestRunner()
+                        .addPathList(paths)
+                        .addReporterList(reporterList)
+                        .sourceMappingOptions(sourceMappingOptions)
+                        .testMappingOptions(testMappingOptions)
+                        .skipCompatibilityCheck(skipCompatibilityCheck)
+                        .colorConsole(colorConsole)
+                        .addTags(tags)
+                        .randomTestOrder(randomTestOrder)
+                        .randomTestOrderSeed(randomTestOrderSeed)
+                        .failOnErrors(!ignoreFailure);
+
+                if (StringUtils.isNotBlank(excludeObject)) {
+                    runner.excludeObject(excludeObject);
+                }
+                if (StringUtils.isNotBlank(includeObject)) {
+                    runner.includeObject(includeObject);
+                }
 
-            runner.run(connection);
+                runner.run(connection);
 
-        } catch (SomeTestsFailedException e) {
-            if (!this.ignoreFailure) {
+            } catch (SomeTestsFailedException e) {
+                if (!this.ignoreFailure) {
+                    throw new MojoExecutionException(e.getMessage(), e);
+                }
+            } catch (SQLException e) {
                 throw new MojoExecutionException(e.getMessage(), e);
-            }
-        } catch (SQLException e) {
-            throw new MojoExecutionException(e.getMessage(), e);
-        } finally {
-            try {
-                if (null != connection) {
-                    reporterWriter.writeReporters(connection);
-                    connection.close();
+            } finally {
+                try {
+                    if (null != connection) {
+                        reporterWriter.writeReporters(connection);
+                        connection.close();
+                    }
+                } catch (Exception e) {
+                    getLog().error(e.getMessage(), e);
                 }
-            } catch (Exception e) {
-                getLog().error(e.getMessage(), e);
             }
         }
     }
@@ -223,7 +228,7 @@ private FileMapperOptions buildSourcesOptions() throws MojoExecutionException {
                 if (defaultSourceDirectory.exists()) {
                     sources.add(PluginDefault.buildDefaultSource());
                 } else {
-                    return new FileMapperOptions(new ArrayList<String>());
+                    return new FileMapperOptions(new ArrayList<>());
                 }
             }
 
@@ -252,7 +257,7 @@ private FileMapperOptions buildSourcesOptions() throws MojoExecutionException {
             }
 
             if (sourcesCustomTypeMapping != null && !sourcesCustomTypeMapping.isEmpty()) {
-                fileMapperOptions.setTypeMappings(new ArrayList<KeyValuePair>());
+                fileMapperOptions.setTypeMappings(new ArrayList<>());
                 for (CustomTypeMapping typeMapping : sourcesCustomTypeMapping) {
                     fileMapperOptions.getTypeMappings()
                             .add(new KeyValuePair(typeMapping.getCustomMapping(), typeMapping.getType()));
@@ -274,7 +279,7 @@ private FileMapperOptions buildTestsOptions() throws MojoExecutionException {
                 if (defaultTestDirectory.exists()) {
                     tests.add(PluginDefault.buildDefaultTest());
                 } else {
-                    return new FileMapperOptions(new ArrayList<String>());
+                    return new FileMapperOptions(new ArrayList<>());
                 }
             }
 
@@ -303,7 +308,7 @@ private FileMapperOptions buildTestsOptions() throws MojoExecutionException {
             }
 
             if (testsCustomTypeMapping != null && !testsCustomTypeMapping.isEmpty()) {
-                fileMapperOptions.setTypeMappings(new ArrayList<KeyValuePair>());
+                fileMapperOptions.setTypeMappings(new ArrayList<>());
                 for (CustomTypeMapping typeMapping : testsCustomTypeMapping) {
                     fileMapperOptions.getTypeMappings()
                             .add(new KeyValuePair(typeMapping.getCustomMapping(), typeMapping.getType()));
@@ -352,7 +357,7 @@ private List<Reporter> initReporters(Connection connection, Version utlVersion,
     }
 
     private void logParameters(FileMapperOptions sourceMappingOptions, FileMapperOptions testMappingOptions,
-            List<Reporter> reporterList) {
+                               List<Reporter> reporterList) {
         Log log = getLog();
         log.info("Invoking TestRunner with: " + targetDir);
 
@@ -368,4 +373,4 @@ private void logParameters(FileMapperOptions sourceMappingOptions, FileMapperOpt
         log.debug("tests=");
         testMappingOptions.getFilePaths().forEach(log::debug);
     }
-}
+}
