implement database delegate abstraction for ScriptUtils

modules/database-commons/pom.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.testcontainers</groupId>
+        <artifactId>testcontainers-parent</artifactId>
+        <version>0-SNAPSHOT</version>
+        <relativePath>../../pom.xml</relativePath>
+    </parent>
+
+    <artifactId>database-commons</artifactId>
+    <name>TestContainers :: Database-Commons</name>
+
+    <dependencies>
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>testcontainers</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+    </dependencies>
+
+</project>

modules/database-commons/src/main/java/org/testcontainers/delegate/AbstractDatabaseDelegate.java

@@ -0,0 +1,61 @@
+package org.testcontainers.delegate;
+
+import java.util.Collection;
+
+/**
+ * @param <CONTAINER>  testcontainers container
+ * @param <CONNECTION> connection to the database
+ * @author Eugeny Karpov
+ */
+public abstract class AbstractDatabaseDelegate<CONTAINER, CONNECTION> implements DatabaseDelegate {
+
+    /**
+     * Testcontainers container
+     */
+    protected CONTAINER container;
+
+    /**
+     * Database connection
+     */
+    private CONNECTION connection;
+
+    public AbstractDatabaseDelegate(CONTAINER container) {
+        this.container = container;
+    }
+
+    /**
+     * Get or create new connection to the database
+     */
+    protected CONNECTION getConnection() {
+        if (connection == null) {
+            connection = createNewConnection();
+        }
+        return connection;
+    }
+
+    @Override
+    public void execute(Collection<String> statements, String scriptPath, boolean continueOnError, boolean ignoreFailedDrops) {
+        int lineNumber = 0;
+        for (String statement : statements) {
+            lineNumber++;
+            execute(statement, scriptPath, lineNumber, continueOnError, ignoreFailedDrops);
+        }
+    }
+
+    @Override
+    public void close() {
+        if (connection != null) {
+            closeConnectionQuietly(connection);
+        }
+    }
+
+    /**
+     * Quietly close the connection
+     */
+    protected abstract void closeConnectionQuietly(CONNECTION connection);
+
+    /**
+     * Template method for creating new connections to the database
+     */
+    protected abstract CONNECTION createNewConnection();
+}

modules/database-commons/src/main/java/org/testcontainers/delegate/DatabaseDelegate.java

@@ -0,0 +1,31 @@
+package org.testcontainers.delegate;
+
+import java.util.Collection;
+
+/**
+ * Database delegate
+ *
+ * Gives an abstraction from concrete database
+ *
+ * @author Eugeny Karpov
+ */
+public interface DatabaseDelegate extends AutoCloseable {
+
+    /**
+     * Execute statement by the implementation of the delegate
+     */
+    void execute(String statement, String scriptPath, int lineNumber, boolean continueOnError, boolean ignoreFailedDrops);
+
+    /**
+     * Execute collection of statements
+     */
+    void execute(Collection<String> statements, String scriptPath, boolean continueOnError, boolean ignoreFailedDrops);
+
+    /**
+     * Close connection to the database
+     *
+     * Overridden to suppress throwing Exception
+     */
+    @Override
+    void close();
+}

modules/database-commons/src/main/java/org/testcontainers/exception/ConnectionCreationException.java

@@ -0,0 +1,13 @@
+package org.testcontainers.exception;
+
+/**
+ * Inability to create connection to the database
+ *
+ * @author Eugeny Karpov
+ */
+public class ConnectionCreationException extends RuntimeException {
+
+    public ConnectionCreationException(String message, Throwable cause) {
+        super(message, cause);
+    }
+}

modules/jdbc/src/main/java/org/testcontainers/jdbc/ext/ScriptUtils.java → modules/database-commons/src/main/java/org/testcontainers/ext/ScriptUtils.java

@@ -14,16 +14,14 @@
  * limitations under the License.
  */
 
-package org.testcontainers.jdbc.ext;
+package org.testcontainers.ext;
 
 import org.apache.commons.lang.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.testcontainers.delegate.DatabaseDelegate;
 
 import javax.script.ScriptException;
-import java.sql.Connection;
-import java.sql.SQLException;
-import java.sql.Statement;
 import java.util.LinkedList;
 import java.util.List;
 
@@ -212,17 +210,16 @@ public static boolean containsSqlScriptDelimiters(String script, String delim) {
 		return false;
 	}
 
-    public static void executeSqlScript(Connection connection, String scriptPath, String script) throws ScriptException {
-        executeSqlScript(connection, scriptPath, script, false, false, DEFAULT_COMMENT_PREFIX, DEFAULT_STATEMENT_SEPARATOR, DEFAULT_BLOCK_COMMENT_START_DELIMITER, DEFAULT_BLOCK_COMMENT_END_DELIMITER);
+    public static void executeDatabaseScript(DatabaseDelegate databaseDelegate, String scriptPath, String script) throws ScriptException {
+        executeDatabaseScript(databaseDelegate, scriptPath, script, false, false, DEFAULT_COMMENT_PREFIX, DEFAULT_STATEMENT_SEPARATOR, DEFAULT_BLOCK_COMMENT_START_DELIMITER, DEFAULT_BLOCK_COMMENT_END_DELIMITER);
     }
 
     /**
-	 * Execute the given SQL script.
+	 * Execute the given database script.
 	 * <p>Statement separators and comments will be removed before executing
 	 * individual statements within the supplied script.
      * <p><b>Do not use this method to execute DDL if you expect rollback.</b>
-     * @param connection the JDBC connection to use to execute the script; already
-     * configured and ready to use
+     * @param databaseDelegate database delegate for script execution
      * @param scriptPath the resource (potentially associated with a specific encoding)
      * to load the SQL script from
      * @param script the raw script content
@@ -240,13 +237,13 @@ public static void executeSqlScript(Connection connection, String scriptPath, St
      * @param blockCommentEndDelimiter the <em>end</em> block comment delimiter; never
 * {@code null} or empty       @throws ScriptException if an error occurred while executing the SQL script
 	 */
-	public static void executeSqlScript(Connection connection, String scriptPath, String script, boolean continueOnError,
+	public static void executeDatabaseScript(DatabaseDelegate databaseDelegate, String scriptPath, String script, boolean continueOnError,
 			boolean ignoreFailedDrops, String commentPrefix, String separator, String blockCommentStartDelimiter,
 			String blockCommentEndDelimiter) throws ScriptException {
 
 		try {
 			if (LOGGER.isInfoEnabled()) {
-				LOGGER.info("Executing SQL script from " + scriptPath);
+				LOGGER.info("Executing database script from " + scriptPath);
 			}
 
 			long startTime = System.currentTimeMillis();
@@ -261,44 +258,14 @@ public static void executeSqlScript(Connection connection, String scriptPath, St
 
 			splitSqlScript(scriptPath, script, separator, commentPrefix, blockCommentStartDelimiter,
 				blockCommentEndDelimiter, statements);
-			int lineNumber = 0;
-			Statement stmt = connection.createStatement();
-			try {
-				for (String statement : statements) {
-					lineNumber++;
-					try {
-						stmt.execute(statement);
-						int rowsAffected = stmt.getUpdateCount();
-						if (LOGGER.isDebugEnabled()) {
-							LOGGER.debug(rowsAffected + " returned as updateCount for SQL: " + statement);
-						}
-					}
-					catch (SQLException ex) {
-						boolean dropStatement = statement.trim().toLowerCase().startsWith("drop");
-						if (continueOnError || (dropStatement && ignoreFailedDrops)) {
-							if (LOGGER.isDebugEnabled()) {
-								LOGGER.debug("Failed to execute SQL script statement at line " + lineNumber
-										+ " of resource " + scriptPath + ": " + statement, ex);
-							}
-						}
-						else {
-							throw new ScriptStatementFailedException(statement, lineNumber, scriptPath, ex);
-						}
-					}
-				}
-			}
-			finally {
-				try {
-					stmt.close();
-				}
-				catch (Throwable ex) {
-					LOGGER.debug("Could not close JDBC Statement", ex);
-				}
+
+			try (DatabaseDelegate closeableDelegate = databaseDelegate) {
+				closeableDelegate.execute(statements, scriptPath, continueOnError, ignoreFailedDrops);
 			}
 
 			long elapsedTime = System.currentTimeMillis() - startTime;
 			if (LOGGER.isInfoEnabled()) {
-				LOGGER.info("Executed SQL script from " + scriptPath + " in " + elapsedTime + " ms.");
+				LOGGER.info("Executed database script from " + scriptPath + " in " + elapsedTime + " ms.");
 			}
 		}
 		catch (Exception ex) {
@@ -317,8 +284,8 @@ public ScriptParseException(String format, String scriptPath) {
         }
     }
 
-    private static class ScriptStatementFailedException extends RuntimeException {
-        public ScriptStatementFailedException(String statement, int lineNumber, String scriptPath, SQLException ex) {
+    public static class ScriptStatementFailedException extends RuntimeException {
+        public ScriptStatementFailedException(String statement, int lineNumber, String scriptPath, Exception ex) {
             super(String.format("Script execution failed (%s:%d): %s", scriptPath, lineNumber, statement), ex);
         }
     }

modules/jdbc/pom.xml

@@ -18,6 +18,12 @@
             <artifactId>testcontainers</artifactId>
             <version>${project.version}</version>
         </dependency>
+
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>database-commons</artifactId>
+            <version>${project.version}</version>
+        </dependency>
     </dependencies>
 
 </project>

modules/jdbc/src/main/java/org/testcontainers/jdbc/ContainerDatabaseDriver.java

@@ -4,7 +4,8 @@
 import org.slf4j.LoggerFactory;
 import org.testcontainers.containers.JdbcDatabaseContainer;
 import org.testcontainers.containers.JdbcDatabaseContainerProvider;
-import org.testcontainers.jdbc.ext.ScriptUtils;
+import org.testcontainers.delegate.DatabaseDelegate;
+import org.testcontainers.ext.ScriptUtils;
 
 import javax.script.ScriptException;
 import java.io.IOException;
@@ -153,7 +154,8 @@ public synchronized Connection connect(String url, final Properties info) throws
               an init script or function has been specified, use it
              */
             if (!initializedContainers.contains(container.getContainerId())) {
-                runInitScriptIfRequired(url, connection);
+                DatabaseDelegate databaseDelegate = new JdbcDatabaseDelegate(container);
+                runInitScriptIfRequired(url, databaseDelegate);
                 runInitFunctionIfRequired(url, connection);
                 initializedContainers.add(container.getContainerId());
             }
@@ -214,10 +216,10 @@ private Connection wrapConnection(final Connection connection, final JdbcDatabas
      * Run an init script from the classpath.
      *
      * @param url        the JDBC URL to check for init script declarations.
-     * @param connection JDBC connection to apply init scripts to.
+     * @param databaseDelegate database delegate to apply init scripts to the database
      * @throws SQLException on script or DB error
      */
-    private void runInitScriptIfRequired(String url, Connection connection) throws SQLException {
+    private void runInitScriptIfRequired(String url, DatabaseDelegate databaseDelegate) throws SQLException {
         Matcher matcher = INITSCRIPT_MATCHING_PATTERN.matcher(url);
         if (matcher.matches()) {
             String initScriptPath = matcher.group(2);
@@ -230,7 +232,7 @@ private void runInitScriptIfRequired(String url, Connection connection) throws S
                 }
 
                 String sql = IOUtils.toString(resource, StandardCharsets.UTF_8);
-                ScriptUtils.executeSqlScript(connection, initScriptPath, sql);
+                ScriptUtils.executeDatabaseScript(databaseDelegate, initScriptPath, sql);
             } catch (IOException e) {
                 LOGGER.warn("Could not load classpath init script: {}", initScriptPath);
                 throw new SQLException("Could not load classpath init script: " + initScriptPath, e);

modules/jdbc/src/main/java/org/testcontainers/jdbc/JdbcDatabaseDelegate.java

@@ -0,0 +1,58 @@
+package org.testcontainers.jdbc;
+
+import lombok.extern.slf4j.Slf4j;
+import org.testcontainers.containers.JdbcDatabaseContainer;
+import org.testcontainers.delegate.AbstractDatabaseDelegate;
+import org.testcontainers.exception.ConnectionCreationException;
+import org.testcontainers.ext.ScriptUtils;
+
+import java.sql.SQLException;
+import java.sql.Statement;
+
+/**
+ * JDBC database delegate
+ *
+ * @author Eugeny Karpov
+ */
+@Slf4j
+public class JdbcDatabaseDelegate extends AbstractDatabaseDelegate<JdbcDatabaseContainer, Statement> {
+
+    public JdbcDatabaseDelegate(JdbcDatabaseContainer jdbcDatabaseContainer) {
+        super(jdbcDatabaseContainer);
+    }
+
+    @Override
+    protected Statement createNewConnection() {
+        try {
+            return container.createConnection("").createStatement();
+        } catch (SQLException e) {
+            log.error("Could not obtain JDBC connection");
+            throw new ConnectionCreationException("Could not obtain JDBC connection", e);
+        }
+    }
+
+
+    @Override
+    public void execute(String statement, String scriptPath, int lineNumber, boolean continueOnError, boolean ignoreFailedDrops) {
+        try {
+            boolean rowsAffected = getConnection().execute(statement);
+            log.debug("{} returned as updateCount for SQL: {}", rowsAffected, statement);
+        } catch (SQLException ex) {
+            boolean dropStatement = statement.trim().toLowerCase().startsWith("drop");
+            if (continueOnError || (dropStatement && ignoreFailedDrops)) {
+                log.debug("Failed to execute SQL script statement at line {} of resource {}: {}", lineNumber, scriptPath, statement, ex);
+            } else {
+                throw new ScriptUtils.ScriptStatementFailedException(statement, lineNumber, scriptPath, ex);
+            }
+        }
+    }
+
+    @Override
+    protected void closeConnectionQuietly(Statement statement) {
+        try {
+            statement.close();
+        } catch (Exception e) {
+            log.error("Could not close JDBC connection", e);
+        }
+    }
+}

pom.xml

@@ -166,6 +166,7 @@
         <module>modules/selenium</module>
         <module>modules/nginx</module>
         <module>modules/jdbc-test</module>
+        <module>modules/database-commons</module>
     </modules>
 
     <profiles>