Clean up and documentation.

Author: simasch

CONTRIBUTING.md

@@ -3,9 +3,9 @@
 
 ### Local database with utPLSQL and utPLSQL-demo-project
 
-To usefully contribute you'll have to setup a local database with installed [latest utPLSQL v3](https://github.com/utPLSQL/utPLSQL) and [utPLSQL-demo-project](https://github.com/utPLSQL/utPLSQL-demo-project). 
+To usefully contribute you'll have to set up a local database with installed [latest utPLSQL v3](https://github.com/utPLSQL/utPLSQL) and [utPLSQL-demo-project](https://github.com/utPLSQL/utPLSQL-demo-project). 
 The demo-project will serve as your test user. See .travis.yml to see an example on how it can be installed. 
-By default tests are executed against `app/app` user of `localhost:1521/XE database`. 
+By default, tests are executed against `app/app` user of `localhost:1521/XE database`. 
 
 If you want to run tests against another database you may set `DB_URL`, `DB_USER`, `DB_PASS` environment variables.
 

README.md

@@ -87,7 +87,7 @@ It also provides a more generic approach to Reporter-handling.
 
 If you request the Reporter-Factory for a Reporter it has no specific implementation for it will just
 return an instance of a `DefaultReporter` with the given name as SQL-Type, assuming
-that it exists in the database. Therefore you can address custom reporters without the need 
+that it exists in the database. Therefore, you can address custom reporters without the need 
 of a specific java-side implementation.
 
 ```java

pom.xml

@@ -24,7 +24,7 @@
     <licenses>
         <license>
             <name>Apache License, Version 2.0</name>
-            <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
+            <url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
             <distribution>repo</distribution>
         </license>
     </licenses>
@@ -70,7 +70,18 @@
     </dependencies>
 
     <build>
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>true</filtering>
+            </resource>
+        </resources>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>3.1.2</version>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-failsafe-plugin</artifactId>

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

@@ -7,7 +7,7 @@
 
 /**
  * This class is getting updated automatically by the build process.
- * Please do not update its constants manually cause they will be overwritten.
+ * Please do not update its constants manually because they will be overwritten.
  *
  * @author pesse
  */
@@ -18,10 +18,11 @@ public class JavaApiVersionInfo {
 
     static {
         try {
-
-            try (InputStream in = JavaApiVersionInfo.class.getClassLoader().getResourceAsStream("utplsql-api.version");
-                 BufferedReader reader = new BufferedReader(new InputStreamReader(in))) {
-                MAVEN_PROJECT_VERSION = reader.readLine();
+            try (InputStream in = JavaApiVersionInfo.class.getClassLoader().getResourceAsStream("utplsql-api.version")) {
+                assert in != null;
+                try (BufferedReader reader = new BufferedReader(new InputStreamReader(in))) {
+                    MAVEN_PROJECT_VERSION = reader.readLine();
+                }
             }
         } catch (IOException e) {
             System.out.println("WARNING: Could not get Version information!");

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

@@ -24,8 +24,8 @@ private ResourceUtil() {
      * @param targetDirectory If set to true it will only return files, not directories
      */
     public static void copyResources(Path resourceAsPath, Path targetDirectory) {
-        String resourceName = "/" + resourceAsPath.toString();
         try {
+            String resourceName = "/" + resourceAsPath;
             Files.createDirectories(targetDirectory);
             URI uri = ResourceUtil.class.getResource(resourceName).toURI();
             Path myPath;
@@ -46,12 +46,10 @@ public static void copyResources(Path resourceAsPath, Path targetDirectory) {
     private static void copyRecursive(Path from, Path targetDirectory) throws IOException {
         Files.walkFileTree(from, new SimpleFileVisitor<Path>() {
 
-            private Path currentTarget;
-
             @Override
             public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException {
                 super.preVisitDirectory(dir, attrs);
-                currentTarget = targetDirectory.resolve(from.relativize(dir).toString());
+                Path currentTarget = targetDirectory.resolve(from.relativize(dir).toString());
                 Files.createDirectories(currentTarget);
                 return FileVisitResult.CONTINUE;
             }
@@ -64,4 +62,4 @@ public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IO
             }
         });
     }
-}
+}

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

@@ -99,10 +99,10 @@ public TestRunner excludeObjects(List<String> obj) {
         return this;
     }
 
-   public TestRunner includeSchemaExpr(String expr) {
+    public TestRunner includeSchemaExpr(String expr) {
         options.includeSchemaExpr = expr;
         return this;
-   }
+    }
 
     public TestRunner excludeSchemaExpr(String expr) {
         options.excludeSchemaExpr = expr;
@@ -144,18 +144,18 @@ public TestRunner setReporterFactory(ReporterFactory reporterFactory) {
         return this;
     }
 
-    public TestRunner randomTestOrder(boolean randomTestOrder ) {
+    public TestRunner randomTestOrder(boolean randomTestOrder) {
         this.options.randomTestOrder = randomTestOrder;
         return this;
     }
 
-    public TestRunner randomTestOrderSeed( Integer seed ) {
+    public TestRunner randomTestOrderSeed(Integer seed) {
         this.options.randomTestOrderSeed = seed;
-        if ( seed != null ) this.options.randomTestOrder = true;
+        if (seed != null) this.options.randomTestOrder = true;
         return this;
     }
 
-    public TestRunner addTag( String tag ) {
+    public TestRunner addTag(String tag) {
         this.options.tags.add(tag);
         return this;
     }
@@ -165,12 +165,14 @@ public TestRunner addTags(Collection<String> tags) {
         return this;
     }
 
-    public TestRunner oraStuckTimeout(Integer oraStuckTimeout ) {
+    public TestRunner oraStuckTimeout(Integer oraStuckTimeout) {
         this.options.oraStuckTimeout = oraStuckTimeout;
         return this;
     }
 
-    public TestRunnerOptions getOptions() { return options; }
+    public TestRunnerOptions getOptions() {
+        return options;
+    }
 
     private void delayedAddReporters() {
         if (reporterFactory != null) {
@@ -182,10 +184,10 @@ private void delayedAddReporters() {
 
     private void handleException(Throwable e) throws SQLException {
         // Just pass exceptions already categorized
-        if ( e instanceof UtPLSQLNotInstalledException ) throw (UtPLSQLNotInstalledException)e;
-        else if ( e instanceof SomeTestsFailedException ) throw (SomeTestsFailedException)e;
-        else if ( e instanceof OracleCreateStatmenetStuckException ) throw (OracleCreateStatmenetStuckException)e;
-        // Categorize exceptions
+        if (e instanceof UtPLSQLNotInstalledException) throw (UtPLSQLNotInstalledException) e;
+        else if (e instanceof SomeTestsFailedException) throw (SomeTestsFailedException) e;
+        else if (e instanceof OracleCreateStatmenetStuckException) throw (OracleCreateStatmenetStuckException) e;
+            // Categorize exceptions
         else if (e instanceof SQLException) {
             SQLException sqlException = (SQLException) e;
             if (sqlException.getErrorCode() == SomeTestsFailedException.ERROR_CODE) {
@@ -206,7 +208,7 @@ public void run(Connection conn) throws SQLException {
 
         DatabaseInformation databaseInformation = new DefaultDatabaseInformation();
 
-        if ( options.skipCompatibilityCheck ) {
+        if (options.skipCompatibilityCheck) {
             compatibilityProxy = new CompatibilityProxy(conn, Version.LATEST, databaseInformation);
         } else {
             compatibilityProxy = new CompatibilityProxy(conn, databaseInformation);
@@ -238,7 +240,7 @@ public void run(Connection conn) throws SQLException {
 
         TestRunnerStatement testRunnerStatement = null;
         try {
-            testRunnerStatement = ( options.oraStuckTimeout > 0 ) ? initStatementWithTimeout(conn, options.oraStuckTimeout) : initStatement(conn);
+            testRunnerStatement = (options.oraStuckTimeout > 0) ? initStatementWithTimeout(conn, options.oraStuckTimeout) : initStatement(conn);
             logger.info("Running tests");
             testRunnerStatement.execute();
             logger.info("Running tests finished.");
@@ -252,17 +254,18 @@ public void run(Connection conn) throws SQLException {
         }
     }
 
-    private TestRunnerStatement initStatement( Connection conn ) throws SQLException {
+    private TestRunnerStatement initStatement(Connection conn) throws SQLException {
         return compatibilityProxy.getTestRunnerStatement(options, conn);
     }
 
-    private TestRunnerStatement initStatementWithTimeout( Connection conn, int timeout ) throws OracleCreateStatmenetStuckException, SQLException {
+    private TestRunnerStatement initStatementWithTimeout(Connection conn, int timeout) throws SQLException {
+        TestRunnerStatement testRunnerStatement;
         ExecutorService executor = Executors.newSingleThreadExecutor();
         Callable<TestRunnerStatement> callable = () -> compatibilityProxy.getTestRunnerStatement(options, conn);
         Future<TestRunnerStatement> future = executor.submit(callable);
 
         // We want to leave the statement open in case of stuck scenario
-        TestRunnerStatement testRunnerStatement = null;
+        testRunnerStatement = null;
         try {
             testRunnerStatement = future.get(timeout, TimeUnit.SECONDS);
         } catch (TimeoutException e) {

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

@@ -37,10 +37,12 @@ public class Version implements Comparable<Version> {
     public final static Version V3_1_10 = new Version("3.1.10", 3, 1, 10, 3347, true);
     public final static Version V3_1_11 = new Version("3.1.11", 3, 1, 11, 3557, true);
     public final static Version V3_1_12 = new Version("3.1.12", 3, 1, 12, 3876, true);
+    public final static Version V3_1_13 = new Version("3.1.13", 3, 1, 13, 3592, true);
+
     private final static Map<String, Version> knownVersions =
-            Stream.of(V3_0_0, V3_0_1, V3_0_2, V3_0_3, V3_0_4, V3_1_0, V3_1_1, V3_1_2, V3_1_3, V3_1_4, V3_1_5, V3_1_6, V3_1_7, V3_1_8, V3_1_9, V3_1_10, V3_1_11, V3_1_12)
+            Stream.of(V3_0_0, V3_0_1, V3_0_2, V3_0_3, V3_0_4, V3_1_0, V3_1_1, V3_1_2, V3_1_3, V3_1_4, V3_1_5, V3_1_6, V3_1_7, V3_1_8, V3_1_9, V3_1_10, V3_1_11, V3_1_13)
                     .collect(toMap(Version::toString, Function.identity()));
-    public final static Version LATEST = V3_1_12;
+    public final static Version LATEST = V3_1_13;
 
     private final String origString;
     private final Integer major;
@@ -64,7 +66,8 @@ private Version(String origString, @Nullable Integer major, @Nullable Integer mi
      */
     @Deprecated()
     public Version(String versionString) {
-        assert versionString != null;
+        Objects.requireNonNull(versionString);
+
         Version dummy = parseVersionString(versionString);
 
         this.origString = dummy.origString;
@@ -110,8 +113,7 @@ private static Version parseVersionString(String origString) {
                 // We need a valid major version as minimum requirement for a Version object to be valid
                 valid = major != null;
             }
-        } catch (NumberFormatException e) {
-            valid = false;
+        } catch (NumberFormatException ignore) {
         }
 
         return new Version(origString, major, minor, bugfix, build, valid);
@@ -149,7 +151,7 @@ public boolean isValid() {
     /**
      * Returns a normalized form of the parsed version information
      *
-     * @return
+     * @return normalized string
      */
     public String getNormalizedString() {
         if (isValid()) {
@@ -213,9 +215,8 @@ public int compareTo(Version o, boolean nullMeansEqual) {
             }
 
             curResult = compareToWithNulls(getBuild(), o.getBuild(), nullMeansEqual);
-            if (curResult != 0) {
-                return curResult;
-            }
+
+            return curResult;
         }
 
         return 0;
@@ -234,11 +235,11 @@ private void versionsAreValid(Version v) throws InvalidVersionException {
     /**
      * Compares this version to a given version and returns true if this version is greater or equal than the given one
      * If one of the version parts of the base version is null, this level is assumed equal no matter the comparing level's version part
-     * Throws an InvalidVersionException if either this or the given version are invalid
+     * Throws an {@link InvalidVersionException} if either this or the given version are invalid
      *
      * @param v Version to compare with
-     * @return
-     * @throws InvalidVersionException
+     * @return true if is greater or equal
+     * @throws InvalidVersionException If the version does not match
      */
     public boolean isGreaterOrEqualThan(Version v) throws InvalidVersionException {
 
@@ -247,7 +248,15 @@ public boolean isGreaterOrEqualThan(Version v) throws InvalidVersionException {
         return compareTo(v, true) >= 0;
     }
 
-
+    /**
+     * Compares this version to a given version and returns true if this version is greater than the given one
+     * If one of the version parts of the base version is null, this level is assumed equal no matter the comparing level's version part
+     * Throws an {@link InvalidVersionException} if either this or the given version are invalid
+     *
+     * @param v Version to compare with
+     * @return true if is greater
+     * @throws InvalidVersionException If the version does not match
+     */
     public boolean isGreaterThan(Version v) throws InvalidVersionException {
         versionsAreValid(v);
 
@@ -257,11 +266,11 @@ public boolean isGreaterThan(Version v) throws InvalidVersionException {
     /**
      * Compares this version to a given version and returns true if this version is less or equal than the given one
      * If one of the version parts of the base version is null, this level is assumed equal no matter the comparing level's version part
-     * Throws an InvalidVersionException if either this or the given version are invalid
+     * Throws an {@link InvalidVersionException} if either this or the given version are invalid
      *
      * @param v Version to compare with
-     * @return
-     * @throws InvalidVersionException
+     * @return if version is less or equal
+     * @throws InvalidVersionException If version is invalid
      */
     public boolean isLessOrEqualThan(Version v) throws InvalidVersionException {
 
@@ -270,6 +279,15 @@ public boolean isLessOrEqualThan(Version v) throws InvalidVersionException {
         return compareTo(v, true) <= 0;
     }
 
+    /**
+     * Compares this version to a given version and returns true if this version is less than the given one
+     * If one of the version parts of the base version is null, this level is assumed equal no matter the comparing level's version part
+     * Throws an {@link InvalidVersionException} if either this or the given version are invalid
+     *
+     * @param v Version to compare with
+     * @return if version is less
+     * @throws InvalidVersionException If version is invalid
+     */
     public boolean isLessThan(Version v) throws InvalidVersionException {
         versionsAreValid(v);