Merge pull request #62 from zonkyio/docker-provider-customizers

#61 Add customizer to configure postgres container

Author: tomix26

README.md

@@ -228,7 +228,7 @@ or through `zonky.test.database.provider` property globally.
 ### Common Configuration
 
 The `@AutoConfigureEmbeddedDatabase` annotation can be used for some basic configuration, advanced configuration requires properties or yaml files.
-The following configuration keys are used by all providers:
+The following configuration keys are honored by all providers:
 
 ```properties
 zonky.test.database.provider=zonky # Provider used to create the underlying embedded database, see the documentation for the comparision matrix.
@@ -339,7 +339,7 @@ Note that not all architectures are supported by all platforms, look here for an
 
 Since `PostgreSQL 10.0`, there are additional artifacts with `alpine-lite` suffix. These artifacts contain postgres binaries for Alpine Linux with disabled [ICU support](https://blog.2ndquadrant.com/icu-support-postgresql-10/) for further size reduction.
 
-#### Zonky-specific provider configuration [![zonky-provider only](https://img.shields.io/badge/-zonky--provider%20only-3399ff.svg)](#database-providers)
+#### Zonky-provider specific configuration [![zonky-provider only](https://img.shields.io/badge/-zonky--provider%20only-3399ff.svg)](#database-providers)
 
 The provider configuration can be customized with bean implementing `Consumer<EmbeddedPostgres.Builder>` interface.
 The obtained builder provides methods to change the configuration before the database is started.
@@ -392,7 +392,7 @@ public class DockerProviderIntegrationTest {
 }
 ```
 
-#### Docker-specific provider configuration
+#### Docker-provider specific configuration
 
 The provider configuration can be controlled by properties in the `zonky.test.database.postgres.docker` group.
 
@@ -402,6 +402,30 @@ zonky.test.database.postgres.docker.tmpfs.enabled=false # Whether to mount postg
 zonky.test.database.postgres.docker.tmpfs.options=rw,noexec,nosuid # Mount options used to configure the tmpfs filesystem.
 ``` 
 
+Or, the provider configuration can be also customized with bean implementing `PostgreSQLContainerCustomizer` interface.
+
+```java
+import io.zonky.test.db.config.PostgreSQLContainerCustomizer;
+
+@Configuration
+public class EmbeddedPostgresConfiguration {
+    
+    @Bean
+    public PostgreSQLContainerCustomizer postgresContainerCustomizer() {
+        return container -> container.withStartupTimeout(Duration.ofSeconds(60L));
+    }
+}
+```
+
+```java
+@RunWith(SpringRunner.class)
+@AutoConfigureEmbeddedDatabase(provider = DOCKER)
+@ContextConfiguration(classes = EmbeddedPostgresConfiguration.class)
+public class EmbeddedPostgresIntegrationTest {
+    // class body...
+}
+```
+
 ### Using OpenTable Provider
 
 Before you use OpenTable provider, you must add the following Maven dependency:
@@ -425,7 +449,7 @@ public class OpenTableProviderIntegrationTest {
 }
 ```
 
-#### OpenTable-specific provider configuration
+#### OpenTable-provider specific configuration
 
 The provider configuration can be customized with bean implementing `Consumer<EmbeddedPostgres.Builder>` interface.
 The obtained builder provides methods to change the configuration before the database is started.
@@ -475,7 +499,7 @@ public class YandexProviderIntegrationTest {
 }
 ```
 
-#### Yandex-specific provider configuration
+#### Yandex-provider specific configuration
 
 The provider configuration can be controlled by properties in the `zonky.test.database.postgres.yandex-provider` group.
 

build.gradle

@@ -162,6 +162,10 @@ project(':embedded-database-spring-test') {
         compile "org.flywaydb.flyway-test-extensions:flyway-spring-test:$flywayTestVersion"
         compile 'com.google.guava:guava:23.0'
         compile 'org.tukaani:xz:1.8'
+
+        compile('com.cedarsoftware:java-util:1.34.0') {
+            exclude group: 'org.apache.logging.log4j'
+        }
 
         testCompile 'org.springframework.boot:spring-boot-starter-test:1.5.19.RELEASE'
         testCompile 'ch.qos.logback:logback-classic:1.2.3'

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

@@ -0,0 +1,18 @@
+package io.zonky.test.db.config;
+
+import org.testcontainers.containers.PostgreSQLContainer;
+
+/**
+ * Callback interface that can be implemented by beans wishing to customize
+ * the postgres container before it is used by a {@code DockerPostgresDatabaseProvider}.
+ */
+@FunctionalInterface
+public interface PostgreSQLContainerCustomizer {
+
+    /**
+     * Customize the given {@link PostgreSQLContainer}.
+     * @param container the container to customize
+     */
+    void customize(PostgreSQLContainer container);
+
+}

embedded-database-spring-test/src/main/java/io/zonky/test/db/provider/impl/DockerPostgresDatabaseProvider.java

@@ -16,11 +16,13 @@
 
 package io.zonky.test.db.provider.impl;
 
+import com.cedarsoftware.util.DeepEquals;
 import com.github.dockerjava.api.command.CreateContainerCmd;
 import com.google.common.cache.CacheBuilder;
 import com.google.common.cache.CacheLoader;
 import com.google.common.cache.LoadingCache;
 import com.google.common.collect.ImmutableMap;
+import io.zonky.test.db.config.PostgreSQLContainerCustomizer;
 import io.zonky.test.db.flyway.BlockingDataSourceWrapper;
 import io.zonky.test.db.provider.DatabasePreparer;
 import io.zonky.test.db.provider.DatabaseProvider;
@@ -31,6 +33,7 @@
 import org.apache.commons.lang3.RandomStringUtils;
 import org.postgresql.ds.PGSimpleDataSource;
 import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.core.env.Environment;
 import org.testcontainers.containers.PostgreSQLContainer;
 import org.testcontainers.containers.output.Slf4jLogConsumer;
@@ -40,19 +43,22 @@
 import java.sql.PreparedStatement;
 import java.sql.SQLException;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Locale;
 import java.util.Map;
 import java.util.Objects;
+import java.util.Optional;
 import java.util.concurrent.Semaphore;
 import java.util.function.Consumer;
 import java.util.stream.Collectors;
 
+import static java.util.Collections.emptyList;
 import static org.testcontainers.containers.PostgreSQLContainer.POSTGRESQL_PORT;
 
 public class DockerPostgresDatabaseProvider implements DatabaseProvider {
 
-    private static final String POSTGRES_USERNAME = "postgres";
-    private static final String POSTGRES_PASSWORD = "docker";
+    private static final String DEFAULT_POSTGRES_USERNAME = "postgres";
+    private static final String DEFAULT_POSTGRES_PASSWORD = "docker";
 
     private static final LoadingCache<DatabaseConfig, DatabaseInstance> databases = CacheBuilder.newBuilder()
             .build(new CacheLoader<DatabaseConfig, DatabaseInstance>() {
@@ -64,7 +70,7 @@ public DatabaseInstance load(DatabaseConfig config) {
     private final DatabaseConfig databaseConfig;
     private final ClientConfig clientConfig;
 
-    public DockerPostgresDatabaseProvider(Environment environment) {
+    public DockerPostgresDatabaseProvider(Environment environment, ObjectProvider<List<PostgreSQLContainerCustomizer>> containerCustomizers) {
         String dockerImage = environment.getProperty("zonky.test.database.postgres.docker.image", "postgres:10.9-alpine");
         String tmpfsOptions = environment.getProperty("zonky.test.database.postgres.docker.tmpfs.options", "rw,noexec,nosuid");
         boolean tmpfsEnabled = environment.getProperty("zonky.test.database.postgres.docker.tmpfs.enabled", boolean.class, false);
@@ -73,7 +79,9 @@ public DockerPostgresDatabaseProvider(Environment environment) {
         Map<String, String> configProperties = PropertyUtils.extractAll(environment, "zonky.test.database.postgres.server.properties");
         Map<String, String> connectProperties = PropertyUtils.extractAll(environment, "zonky.test.database.postgres.client.properties");
 
-        this.databaseConfig = new DatabaseConfig(dockerImage, tmpfsOptions, tmpfsEnabled, initdbProperties, configProperties);
+        List<PostgreSQLContainerCustomizer> customizers = Optional.ofNullable(containerCustomizers.getIfAvailable()).orElse(emptyList());
+
+        this.databaseConfig = new DatabaseConfig(dockerImage, tmpfsOptions, tmpfsEnabled, initdbProperties, configProperties, customizers);
         this.clientConfig = new ClientConfig(connectProperties);
     }
 
@@ -150,13 +158,15 @@ protected void configure() {
                 container.withCreateContainerCmdModifier(consumer);
             }
 
-            container.withUsername(POSTGRES_USERNAME);
-            container.withPassword(POSTGRES_PASSWORD);
+            container.withUsername(DEFAULT_POSTGRES_USERNAME);
+            container.withPassword(DEFAULT_POSTGRES_PASSWORD);
+
+            config.customizers.forEach(c -> c.customize(container));
+
             container.start();
             container.followOutput(new Slf4jLogConsumer(LoggerFactory.getLogger(DockerPostgresDatabaseProvider.class)));
 
             semaphore = new Semaphore(Integer.parseInt(serverProperties.get("max_connections")));
-
         }
 
         public DatabaseTemplate getTemplate(ClientConfig config, DatabasePreparer preparer) {
@@ -197,8 +207,8 @@ private DataSource getDatabase(String dbName) throws SQLException {
                 dataSource.setPortNumber(container.getMappedPort(POSTGRESQL_PORT));
                 dataSource.setDatabaseName(dbName);
 
-                dataSource.setUser(POSTGRES_USERNAME);
-                dataSource.setPassword(POSTGRES_PASSWORD);
+                dataSource.setUser(container.getUsername());
+                dataSource.setPassword(container.getPassword());
 
                 for (Map.Entry<String, String> entry : config.connectProperties.entrySet()) {
                     dataSource.setProperty(entry.getKey(), entry.getValue());
@@ -241,13 +251,15 @@ private static class DatabaseConfig {
         private final boolean tmpfsEnabled;
         private final Map<String, String> initdbProperties;
         private final Map<String, String> configProperties;
+        private final List<PostgreSQLContainerCustomizer> customizers;
 
-        private DatabaseConfig(String dockerImage, String tmpfsOptions, boolean tmpfsEnabled, Map<String, String> initdbProperties, Map<String, String> configProperties) {
+        private DatabaseConfig(String dockerImage, String tmpfsOptions, boolean tmpfsEnabled, Map<String, String> initdbProperties, Map<String, String> configProperties, List<PostgreSQLContainerCustomizer> customizers) {
             this.dockerImage = dockerImage;
             this.tmpfsOptions = tmpfsOptions;
             this.tmpfsEnabled = tmpfsEnabled;
             this.initdbProperties = ImmutableMap.copyOf(initdbProperties);
             this.configProperties = ImmutableMap.copyOf(configProperties);
+            this.customizers = customizers;
         }
 
         @Override
@@ -259,12 +271,15 @@ public boolean equals(Object o) {
                     Objects.equals(dockerImage, that.dockerImage) &&
                     Objects.equals(tmpfsOptions, that.tmpfsOptions) &&
                     Objects.equals(initdbProperties, that.initdbProperties) &&
-                    Objects.equals(configProperties, that.configProperties);
+                    Objects.equals(configProperties, that.configProperties) &&
+                    DeepEquals.deepEquals(customizers, that.customizers);
         }
 
         @Override
         public int hashCode() {
-            return Objects.hash(dockerImage, tmpfsOptions, tmpfsEnabled, initdbProperties, configProperties);
+            int result = Objects.hash(dockerImage, tmpfsOptions, tmpfsEnabled, initdbProperties, configProperties);
+            result = 31 * result + DeepEquals.deepHashCode(customizers);
+            return result;
         }
     }
 

embedded-database-spring-test/src/main/java/io/zonky/test/db/provider/impl/OpenTablePostgresDatabaseProvider.java

@@ -67,6 +67,7 @@ public OpenTablePostgresDatabaseProvider(Environment environment, ObjectProvider
         Map<String, String> initdbProperties = PropertyUtils.extractAll(environment, "zonky.test.database.postgres.initdb.properties");
         Map<String, String> configProperties = PropertyUtils.extractAll(environment, "zonky.test.database.postgres.server.properties");
         Map<String, String> connectProperties = PropertyUtils.extractAll(environment, "zonky.test.database.postgres.client.properties");
+
         List<Consumer<EmbeddedPostgres.Builder>> customizers = Optional.ofNullable(databaseCustomizers.getIfAvailable()).orElse(emptyList());
 
         this.databaseConfig = new DatabaseConfig(initdbProperties, configProperties, customizers);
@@ -122,7 +123,6 @@ private DatabaseInstance(DatabaseConfig config) throws IOException {
 
             postgres = builder.start();
             semaphore = new Semaphore(MAX_DATABASE_CONNECTIONS);
-
         }
 
         public DatabaseTemplate getTemplate(ClientConfig config, DatabasePreparer preparer) {

embedded-database-spring-test/src/main/java/io/zonky/test/db/provider/impl/ZonkyPostgresDatabaseProvider.java

@@ -70,6 +70,7 @@ public ZonkyPostgresDatabaseProvider(Environment environment, ObjectProvider<Lis
         Map<String, String> initdbProperties = PropertyUtils.extractAll(environment, "zonky.test.database.postgres.initdb.properties");
         Map<String, String> configProperties = PropertyUtils.extractAll(environment, "zonky.test.database.postgres.server.properties");
         Map<String, String> connectProperties = PropertyUtils.extractAll(environment, "zonky.test.database.postgres.client.properties");
+
         List<Consumer<EmbeddedPostgres.Builder>> customizers = Optional.ofNullable(databaseCustomizers.getIfAvailable()).orElse(emptyList());
 
         this.databaseConfig = new DatabaseConfig(initdbProperties, configProperties, customizers, isolation);
@@ -126,7 +127,6 @@ private DatabaseInstance(DatabaseConfig config) throws IOException {
 
             postgres = builder.start();
             semaphore = new Semaphore(MAX_DATABASE_CONNECTIONS);
-
         }
 
         public DatabaseTemplate getTemplate(ClientConfig config, DatabasePreparer preparer) {

embedded-database-spring-test/src/test/java/io/zonky/test/db/provider/DockerProviderWithConfigurationIntegrationTest.java

@@ -17,10 +17,13 @@
 package io.zonky.test.db.provider;
 
 import io.zonky.test.db.AutoConfigureEmbeddedDatabase;
+import io.zonky.test.db.config.PostgreSQLContainerCustomizer;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.postgresql.ds.PGSimpleDataSource;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
 import org.springframework.jdbc.core.JdbcTemplate;
 import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.context.TestPropertySource;
@@ -41,12 +44,21 @@
 @ContextConfiguration
 public class DockerProviderWithConfigurationIntegrationTest {
 
+    @Configuration
+    static class Config {
+
+        @Bean
+        public PostgreSQLContainerCustomizer postgresContainerCustomizer() {
+            return container -> container.withPassword("docker-postgres");
+        }
+    }
+
     @Autowired
     private DataSource dataSource;
 
     @Test
     public void testDataSource() throws SQLException {
-        assertThat(dataSource.unwrap(PGSimpleDataSource.class).getPassword()).isEqualTo("docker");
+        assertThat(dataSource.unwrap(PGSimpleDataSource.class).getPassword()).isEqualTo("docker-postgres");
 
         JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
         String version = jdbcTemplate.queryForObject("show server_version", String.class);

embedded-database-spring-test/src/test/java/io/zonky/test/db/provider/DockerProviderWithPostgisImageIntegrationTest.java

@@ -17,10 +17,13 @@
 package io.zonky.test.db.provider;
 
 import io.zonky.test.db.AutoConfigureEmbeddedDatabase;
+import io.zonky.test.db.config.PostgreSQLContainerCustomizer;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.postgresql.ds.PGSimpleDataSource;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
 import org.springframework.jdbc.core.JdbcTemplate;
 import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.context.TestPropertySource;
@@ -40,12 +43,21 @@
 @ContextConfiguration
 public class DockerProviderWithPostgisImageIntegrationTest {
 
+    @Configuration
+    static class Config {
+
+        @Bean
+        public PostgreSQLContainerCustomizer postgresContainerCustomizer() {
+            return container -> container.withPassword("docker-postgis");
+        }
+    }
+
     @Autowired
     private DataSource dataSource;
 
     @Test
     public void testDataSource() throws SQLException {
-        assertThat(dataSource.unwrap(PGSimpleDataSource.class).getPassword()).isEqualTo("docker");
+        assertThat(dataSource.unwrap(PGSimpleDataSource.class).getPassword()).isEqualTo("docker-postgis");
 
         JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);