Added junit5 Extension (replaces Rule)

Author: airwallex-dan-bell

pom.xml

@@ -149,6 +149,13 @@
             <scope>provided</scope>
             <optional>true</optional>
         </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+            <version>5.3.2</version>
+            <scope>provided</scope>
+            <optional>true</optional>
+        </dependency>
 
         <dependency>
             <groupId>org.slf4j</groupId>

src/main/java/io/zonky/test/db/postgres/junit5/EmbeddedPostgresExtension.java

@@ -0,0 +1,39 @@
+/*
+ * 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.postgres.junit5;
+
+import io.zonky.test.db.postgres.embedded.DatabasePreparer;
+import org.junit.rules.TestRule;
+
+public final class EmbeddedPostgresExtension {
+
+    private EmbeddedPostgresExtension() {}
+
+    /**
+     * Create a vanilla Postgres cluster -- just initialized, no customizations applied.
+     */
+    public static SingleInstancePostgresExtension singleInstance() {
+        return new SingleInstancePostgresExtension();
+    }
+
+    /**
+     * Returns a {@link TestRule} to create a Postgres cluster, shared amongst all test cases in this JVM.
+     * The rule contributes Config switches to configure each test case to get its own database.
+     */
+    public static PreparedDbExtension preparedDatabase(DatabasePreparer preparer)
+    {
+        return new PreparedDbExtension(preparer);
+    }
+
+}

src/main/java/io/zonky/test/db/postgres/junit5/PreparedDbExtension.java

@@ -0,0 +1,88 @@
+/*
+ * 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.postgres.junit5;
+
+import io.zonky.test.db.postgres.embedded.ConnectionInfo;
+import io.zonky.test.db.postgres.embedded.DatabasePreparer;
+import io.zonky.test.db.postgres.embedded.EmbeddedPostgres;
+import io.zonky.test.db.postgres.embedded.PreparedDbProvider;
+import org.junit.jupiter.api.extension.AfterAllCallback;
+import org.junit.jupiter.api.extension.BeforeAllCallback;
+import org.junit.jupiter.api.extension.ExtensionContext;
+
+import javax.sql.DataSource;
+import java.util.List;
+import java.util.concurrent.CopyOnWriteArrayList;
+import java.util.function.Consumer;
+
+public class PreparedDbExtension implements BeforeAllCallback, AfterAllCallback {
+
+    private final DatabasePreparer preparer;
+    private volatile DataSource dataSource;
+    private volatile PreparedDbProvider provider;
+    private volatile ConnectionInfo connectionInfo;
+
+    private final List<Consumer<EmbeddedPostgres.Builder>> builderCustomizers = new CopyOnWriteArrayList<>();
+
+    PreparedDbExtension(DatabasePreparer preparer) {
+        if (preparer == null) {
+            throw new IllegalStateException("null preparer");
+        }
+        this.preparer = preparer;
+    }
+
+    public PreparedDbExtension customize(Consumer<EmbeddedPostgres.Builder> customizer) {
+        if (dataSource != null) {
+            throw new AssertionError("already started");
+        }
+        builderCustomizers.add(customizer);
+        return this;
+    }
+
+    @Override
+    public void beforeAll(ExtensionContext extensionContext) throws Exception {
+        provider = PreparedDbProvider.forPreparer(preparer, builderCustomizers);
+        connectionInfo = provider.createNewDatabase();
+        dataSource = provider.createDataSourceFromConnectionInfo(connectionInfo);
+    }
+
+    @Override
+    public void afterAll(ExtensionContext extensionContext) {
+        dataSource = null;
+        connectionInfo = null;
+        provider = null;
+    }
+
+    public DataSource getTestDatabase() {
+        if (dataSource == null) {
+            throw new AssertionError("not initialized");
+        }
+        return dataSource;
+    }
+
+    public ConnectionInfo getConnectionInfo() {
+        if (connectionInfo == null) {
+            throw new AssertionError("not initialized");
+        }
+        return connectionInfo;
+    }
+
+    public PreparedDbProvider getDbProvider() {
+        if (provider == null) {
+            throw new AssertionError("not initialized");
+        }
+        return provider;
+    }
+
+}

src/main/java/io/zonky/test/db/postgres/junit5/SingleInstancePostgresExtension.java

@@ -0,0 +1,78 @@
+/*
+ * 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.postgres.junit5;
+
+import io.zonky.test.db.postgres.embedded.EmbeddedPostgres;
+import org.junit.jupiter.api.extension.AfterTestExecutionCallback;
+import org.junit.jupiter.api.extension.BeforeTestExecutionCallback;
+import org.junit.jupiter.api.extension.ExtensionContext;
+
+import java.io.IOException;
+import java.sql.Connection;
+import java.sql.SQLException;
+import java.util.List;
+import java.util.concurrent.CopyOnWriteArrayList;
+import java.util.function.Consumer;
+
+public class SingleInstancePostgresExtension implements AfterTestExecutionCallback, BeforeTestExecutionCallback {
+
+    private volatile EmbeddedPostgres epg;
+    private volatile Connection postgresConnection;
+    private final List<Consumer<EmbeddedPostgres.Builder>> builderCustomizers = new CopyOnWriteArrayList<>();
+
+    SingleInstancePostgresExtension() { }
+
+    @Override
+    public void beforeTestExecution(ExtensionContext extensionContext) throws Exception {
+        epg = pg();
+        postgresConnection = epg.getPostgresDatabase().getConnection();
+    }
+
+    private EmbeddedPostgres pg() throws IOException {
+        final EmbeddedPostgres.Builder builder = EmbeddedPostgres.builder();
+        builderCustomizers.forEach(c -> c.accept(builder));
+        return builder.start();
+    }
+
+    public SingleInstancePostgresExtension customize(Consumer<EmbeddedPostgres.Builder> customizer) {
+        if (epg != null) {
+            throw new AssertionError("already started");
+        }
+        builderCustomizers.add(customizer);
+        return this;
+    }
+
+    public EmbeddedPostgres getEmbeddedPostgres()
+    {
+        EmbeddedPostgres epg = this.epg;
+        if (epg == null) {
+            throw new AssertionError("JUnit test not started yet!");
+        }
+        return epg;
+    }
+
+    @Override
+    public void afterTestExecution(ExtensionContext extensionContext) {
+        try {
+            postgresConnection.close();
+        } catch (SQLException e) {
+            throw new AssertionError(e);
+        }
+        try {
+            epg.close();
+        } catch (IOException e) {
+            throw new AssertionError(e);
+        }
+    }
+}