Support for HSQLDB and Apache Derby

Author: ammachado

README.md

@@ -10,7 +10,7 @@ The primary goal of this project is to make it easier to write Spring-powered in
   * Spring `4.3.8` - `6.0.x`
   * Spring Boot `1.4.6` - `3.0.x`
 * Supports multiple different databases
-  * [PostgreSQL](#postgresql), [MSSQL](#microsoft-sql-server), [MySQL](#mysql), [MariaDB](#mariadb), [H2](#h2)
+  * [PostgreSQL](#postgresql), [MSSQL](#microsoft-sql-server), [MySQL](#mysql), [MariaDB](#mariadb), [H2](#h2), [HSQLDB](#hsqldb) and [Derby](#derby)
 * Supports multiple database providers
   * [Docker / Testcontainers](#using-docker-provider-default), [Zonky](#using-zonky-provider-previous-default), [OpenTable](#using-opentable-provider), [Yandex](#using-yandex-provider)
 * Supports various database migration tools
@@ -66,7 +66,7 @@ Add the following Maven dependency:
 <dependency>
     <groupId>io.zonky.test</groupId>
     <artifactId>embedded-database-spring-test</artifactId>
-    <version>2.2.0</version>
+    <version>2.3.0</version>
     <scope>test</scope>
 </dependency>
 ```
@@ -348,6 +348,46 @@ Before you use H2 database, you have to add the following Maven dependency:
 **Note that the associated database provider supports database prefetching, but not template databases.
 So you may notice some performance degradation compared to other database providers in some cases.**
 
+### HSQLDB
+
+This provider may be convenient if you have an application that supports multiple databases
+and you want to reuse the tests using the `@AutoConfigureEmbeddedDatabase` annotation for all these databases, including the HSQLDB database.
+In this case, you can override the `zonky.test.database.provider` property externally and change the used database provider for each run without changing the code.
+You can find more information about externalized configuration here: https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.external-config
+
+Before you use HSQLDB database, you have to add the following Maven dependency:
+
+```xml
+<dependency>
+    <groupId>org.hsqldb</groupId>
+    <artifactId>hsqldb</artifactId>
+    <version>2.7.1</version>
+</dependency>
+```
+
+**Note that the associated database provider supports database prefetching, but not template databases.
+So you may notice some performance degradation compared to other database providers in some cases.**
+
+### Derby
+
+This provider may be convenient if you have an application that supports multiple databases
+and you want to reuse the tests using the `@AutoConfigureEmbeddedDatabase` annotation for all these databases, including the Apache Derby database.
+In this case, you can override the `zonky.test.database.provider` property externally and change the used database provider for each run without changing the code.
+You can find more information about externalized configuration here: https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.external-config
+
+Before you use Apache Derby database, you have to add the following Maven dependency:
+
+```xml
+<dependency>
+    <groupId>org.apache.derby</groupId>
+    <artifactId>derby</artifactId>
+    <version>10.16.1.1</version>
+</dependency>
+```
+
+**Note that the associated database provider supports database prefetching, but not template databases.
+So you may notice some performance degradation compared to other database providers in some cases.**
+
 ## Supported Migration Tools
 
 Note that although any migration tool is supported,

build.gradle

@@ -77,6 +77,20 @@ ext {
                     [name: '1.4.200',  'h2': '1.4.200'],
                     [name: '2.0.206',  'h2': '2.0.206'],
                     [name: '2.1.214',  'h2': '2.1.214']
+            ]],
+            [name: 'hsqldb', versions: [
+                    [name: '2.3.6',  'hsqldb': '2.3.6'],
+                    [name: '2.4.1',  'hsqldb': '2.4.1'],
+                    [name: '2.5.1',  'hsqldb': '2.5.1'],
+                    [name: '2.5.2',  'hsqldb': '2.5.2'],
+                    [name: '2.7.1',  'hsqldb': '2.7.1'],
+            ]],
+            [name: 'derby', versions: [
+                    [name: '10.13.1.1',  'derby': '10.13.1.1'],
+                    [name: '10.14.2.0',  'derby': '10.14.2.0'],
+                    [name: '10.15.1.3',  'derby': '10.15.1.3'],
+                    [name: '10.15.2.0',  'derby': '10.15.2.0'],
+                    [name: '10.16.1.1',  'derby': '10.16.1.1']
             ]]
     ]
 }
@@ -107,12 +121,12 @@ subprojects {
     }
 
     task sourcesJar(type: Jar) {
-        classifier = 'sources'
+        archiveClassifier = 'sources'
         from sourceSets.main.allSource
     }
 
     task javadocJar(type: Jar) {
-        classifier = 'javadoc'
+        archiveClassifier = 'javadoc'
         from javadoc
     }
 
@@ -213,6 +227,8 @@ project(':embedded-database-spring-test') {
         compile 'mysql:mysql-connector-java:8.0.30', optional
         compile 'org.mariadb.jdbc:mariadb-java-client:3.1.0', optional
         compile 'com.h2database:h2:2.1.214', optional
+        compile 'org.hsqldb:hsqldb:2.5.2', optional
+        compile 'org.apache.derby:derbynet:10.14.2.0', optional
 
         compile 'org.flywaydb:flyway-core:9.8.2', optional
         compile 'org.flywaydb.flyway-test-extensions:flyway-spring-test:7.0.0', optional
@@ -370,6 +386,26 @@ project(':embedded-database-spring-test') {
                                 }
                             }
                         }
+
+                        if (version.hsqldb == null) { // optional dependencies are implicitly excluded
+                            exclude group: 'org.hsqldb', module: 'hsqldb'
+                        } else if (version.hsqldb != 'default') {
+                            eachDependency { details ->
+                                if (details.requested.group == 'org.hsqldb' && details.requested.name == 'hsqldb') {
+                                    details.useVersion "${version.hsqldb}"
+                                }
+                            }
+                        }
+
+                        if (version.derby == null) { // optional dependencies are implicitly excluded
+                            exclude group: 'org.apache.derby', module: 'derby'
+                        } else if (version.derby != 'default') {
+                            eachDependency { details ->
+                                if (details.requested.group == 'org.apache.derby') {
+                                    details.useVersion "${version.derby}"
+                                }
+                            }
+                        }
                     }
                 }
             }
@@ -414,6 +450,8 @@ project(':embedded-database-spring-test') {
             excludeCategories 'io.zonky.test.category.MySQLTestSuite'
             excludeCategories 'io.zonky.test.category.MariaDBTestSuite'
             excludeCategories 'io.zonky.test.category.H2TestSuite'
+            excludeCategories 'io.zonky.test.category.HSQLDBTestSuite'
+            excludeCategories 'io.zonky.test.category.DerbyTestSuite'
         }
     }
 
@@ -456,6 +494,10 @@ project(':embedded-database-spring-test') {
                         includeCategories 'io.zonky.test.category.MariaDBTestSuite'
                     } else if (suite.name == 'h2') {
                         includeCategories 'io.zonky.test.category.H2TestSuite'
+                    } else if (suite.name == 'hsqldb') {
+                        includeCategories 'io.zonky.test.category.HSQLDBTestSuite'
+                    } else if (suite.name == 'derby') {
+                        includeCategories 'io.zonky.test.category.DerbyTestSuite'
                     }
                 }
             }

embedded-database-spring-test/src/main/java/io/zonky/test/db/AutoConfigureEmbeddedDatabase.java

@@ -64,7 +64,7 @@
 
     /**
      * The type of embedded database to be created when {@link #replace() replacing} the data source.
-     * By default will attempt to detect the database type based on the classpath.
+     * By default, will attempt to detect the database type based on the classpath.
      *
      * <p>The database type may also be configured via the {@code zonky.test.database.type} configuration property.
      *
@@ -155,8 +155,23 @@ enum DatabaseType {
         /**
          * H2 Database
          */
-        H2
+        H2,
 
+        /**
+         * HSQL Database
+         */
+        HSQL,
+
+        /**
+         * Apache Derby
+         */
+        DERBY;
+
+        public static boolean canBeEmbedded(String databaseType) {
+            return DatabaseType.H2.name().equalsIgnoreCase(databaseType) ||
+                    DatabaseType.HSQL.name().equalsIgnoreCase(databaseType) ||
+                    DatabaseType.DERBY.name().equalsIgnoreCase(databaseType);
+        }
     }
 
     /**
@@ -206,7 +221,7 @@ enum DatabaseProvider {
     enum Replace {
 
         /**
-         * Replace any DataSource bean (auto-configured or manually defined).
+         * Replace any DataSource bean (autoconfigured or manually defined).
          */
         ANY,
 

embedded-database-spring-test/src/main/java/io/zonky/test/db/event/EventPublishingTestExecutionListener.java

@@ -13,7 +13,7 @@ public class EventPublishingTestExecutionListener extends AbstractTestExecutionL
     private static final Logger logger = LoggerFactory.getLogger(EventPublishingTestExecutionListener.class);
 
     private static final boolean TEST_EXECUTION_METHODS_SUPPORTED = ClassUtils.getMethodIfAvailable(
-            TestExecutionListener.class, "beforeTestExecution", null) != null;
+            TestExecutionListener.class, "beforeTestExecution") != null;
 
     @Override
     public void beforeTestMethod(TestContext testContext) {

embedded-database-spring-test/src/main/java/io/zonky/test/db/provider/derby/DerbyDatabaseProvider.java

@@ -0,0 +1,85 @@
+/*
+ * Copyright 2021 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.zonky.test.db.provider.derby;
+
+import io.zonky.test.db.preparer.DatabasePreparer;
+import io.zonky.test.db.provider.DatabaseProvider;
+import io.zonky.test.db.provider.EmbeddedDatabase;
+import io.zonky.test.db.provider.ProviderException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.jdbc.datasource.SimpleDriverDataSource;
+
+import java.sql.DriverManager;
+import java.sql.SQLException;
+import java.util.Objects;
+import java.util.UUID;
+import java.util.concurrent.CompletableFuture;
+
+public class DerbyDatabaseProvider implements DatabaseProvider {
+
+    private static final Logger logger = LoggerFactory.getLogger(DerbyDatabaseProvider.class);
+    private static final String URL_TEMPLATE = "jdbc:derby:memory:%s";
+
+    @Override
+    public EmbeddedDatabase createDatabase(DatabasePreparer preparer) throws ProviderException {
+        SimpleDriverDataSource dataSource = new SimpleDriverDataSource();
+        String databaseName = UUID.randomUUID().toString();
+
+        dataSource.setDriverClass(org.h2.Driver.class);
+        dataSource.setUrl(String.format(URL_TEMPLATE + ";drop=true", databaseName));
+        dataSource.setUsername("sa");
+        dataSource.setPassword("");
+
+        DerbyEmbeddedDatabase database = new DerbyEmbeddedDatabase(dataSource, databaseName,
+                () -> shutdownDatabase(databaseName));
+        try {
+            if (preparer != null) {
+                preparer.prepare(database);
+            }
+        } catch (SQLException e) {
+            throw new ProviderException("Unexpected error when creating a database", e);
+        }
+        return database;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        return o != null && getClass() == o.getClass();
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(DerbyDatabaseProvider.class);
+    }
+
+    private static void shutdownDatabase(String dbName) {
+        CompletableFuture.runAsync(() -> {
+            try {
+                DriverManager.getConnection(String.format(URL_TEMPLATE + ";shutdown=true", dbName));
+            } catch (SQLException e) {
+                // it seems that there is no error for database in use condition
+                if (logger.isTraceEnabled()) {
+                    logger.warn("Unable to release '{}' database", dbName, e);
+                } else {
+                    logger.warn("Unable to release '{}' database", dbName);
+                }
+            }
+        });
+    }
+}

embedded-database-spring-test/src/main/java/io/zonky/test/db/provider/derby/DerbyEmbeddedDatabase.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2021 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.zonky.test.db.provider.derby;
+
+import io.zonky.test.db.provider.support.AbstractEmbeddedDatabase;
+import org.apache.derby.drda.NetworkServerControl;
+
+import javax.sql.DataSource;
+
+public class DerbyEmbeddedDatabase extends AbstractEmbeddedDatabase {
+
+    private final DataSource dataSource;
+    private final String dbName;
+
+    public DerbyEmbeddedDatabase(DataSource dataSource, String dbName, Runnable closeCallback) {
+        super(closeCallback);
+        this.dataSource = dataSource;
+        this.dbName = dbName;
+    }
+
+    @Override
+    protected DataSource getDataSource() {
+        return dataSource;
+    }
+
+    @Override
+    public String getJdbcUrl() {
+        return String.format("jdbc:derby:mem:%s;USER=sa", dbName);
+    }
+
+    public String getDatabaseName() {
+        return dbName;
+    }
+}