Simple approach towards checking version compability

Samuel Nitsche · Samuel Nitsche · commit a1113b888c2a · 2017-10-29T14:14:33.000+01:00
not sufficient though, we want to have a more specific check with fallback-mechanisms for some features
diff --git a/src/main/java/org/utplsql/api/DBHelper.java b/src/main/java/org/utplsql/api/DBHelper.java
@@ -96,4 +96,20 @@ public static boolean versionCompatibilityCheck(Connection conn)
         return versionCompatibilityCheck(conn, UTPLSQL_VERSION);
     }
 
+    /** Checks if actual API-version is compatible with utPLSQL database version and throws a RuntimeException if not
+     * Throws a RuntimeException if version compatibility can not be checked.
+     *
+     * @param conn
+     */
+    public static void failOnVersionCompatibilityCheckFailed( Connection conn )
+    {
+        try {
+            if (!versionCompatibilityCheck(conn))
+                throw new RuntimeException("API-Version " + UTPLSQL_VERSION + " not compatible with database. Aborting.");
+        }
+        catch ( SQLException e )
+        {
+            throw new RuntimeException("Compatibility-check failed with error. Aborting.", e);
+        }
+    }
 }
diff --git a/src/main/java/org/utplsql/api/TestRunner.java b/src/main/java/org/utplsql/api/TestRunner.java
@@ -85,6 +85,10 @@ public TestRunner failOnErrors(boolean failOnErrors) {
     }
 
     public void run(Connection conn) throws SomeTestsFailedException, SQLException {
+
+        // First of all check version compatibility
+        DBHelper.failOnVersionCompatibilityCheckFailed(conn);
+
         for (Reporter r : this.reporterList)
             validateReporter(conn, r);
 
diff --git a/src/main/java/org/utplsql/api/exception/DatabaseNotCompatibleException.java b/src/main/java/org/utplsql/api/exception/DatabaseNotCompatibleException.java
@@ -0,0 +1,46 @@
+package org.utplsql.api.exception;
+
+import org.utplsql.api.DBHelper;
+
+/** Custom exception to indicate API is not compatible with database framework
+ *
+ * @author pesse
+ *
+ */
+public class DatabaseNotCompatibleException extends Exception {
+
+    private String clientVersion;
+    private String databaseVersion;
+
+    public DatabaseNotCompatibleException( String message, String clientVersion, String databaseVersion, Throwable cause )
+    {
+        super(message, cause);
+
+        this.clientVersion = clientVersion;
+        this.databaseVersion = databaseVersion;
+    }
+
+    public DatabaseNotCompatibleException( String clientVersion, String databaseVersion, Throwable cause )
+    {
+        this("utPLSQL API (" + String.valueOf(clientVersion) + ") not compatible with database (" + String.valueOf(databaseVersion) + ")", clientVersion, databaseVersion, cause);
+    }
+
+    public DatabaseNotCompatibleException( String clientVersion, String databaseVersion )
+    {
+        this(clientVersion, databaseVersion, null);
+    }
+
+    public DatabaseNotCompatibleException( String databaseVersion, Throwable cause )
+    {
+        this(DBHelper.UTPLSQL_VERSION, databaseVersion, cause );
+    }
+
+    public String getClientVersion() {
+        return clientVersion;
+    }
+
+    public String getDatabaseVersion()
+    {
+        return databaseVersion;
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -85,6 +85,10 @@ public TestRunner failOnErrors(boolean failOnErrors) {`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`public void run(Connection conn) throws SomeTestsFailedException, SQLException {`
	`88`	`+`
	`89`	`+ // First of all check version compatibility`
	`90`	`+ DBHelper.failOnVersionCompatibilityCheckFailed(conn);`
	`91`	`+`
`88`	`92`	`for (Reporter r : this.reporterList)`
`89`	`93`	`validateReporter(conn, r);`
`90`	`94`