#12 add logging of jdbc url for connecting to embedded database

Author: tomix26

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

@@ -121,7 +121,7 @@ public void releaseTarget(Object target) throws Exception {
     }
 
     @Override
-    public synchronized ListenableFuture<Void> reload(Flyway flyway) {
+    public synchronized ListenableFuture<DataSource> reload(Flyway flyway) {
         Executor executor = bootstrapExecutor != null ? bootstrapExecutor : Runnable::run;
 
         List<Consumer<Builder>> customizers = ImmutableList.<Consumer<Builder>>builder()
@@ -151,7 +151,7 @@ public synchronized ListenableFuture<Void> reload(Flyway flyway) {
         // main data source future must never fail, otherwise all following tests will fail
         dataSourceFuture = reloadFuture.exceptionally(throwable -> null);
 
-        return new CompletableToListenableFutureAdapter<>(reloadFuture.thenApply(dataSource -> null));
+        return new CompletableToListenableFutureAdapter<>(reloadFuture);
     }
 
     /**

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

@@ -20,12 +20,14 @@
 import org.springframework.aop.TargetSource;
 import org.springframework.util.concurrent.ListenableFuture;
 
+import javax.sql.DataSource;
+
 /**
  * Interface extending {@link TargetSource} that is used by {@link io.zonky.test.db.postgres.FlywayEmbeddedPostgresDataSourceFactoryBean}
  * for deferred initialization of the embedded database until the application context is fully loaded and the flyway bean is available.
  */
 public interface FlywayDataSourceContext extends TargetSource {
 
-    ListenableFuture<Void> reload(Flyway flyway);
+    ListenableFuture<DataSource> reload(Flyway flyway);
 
 }

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

@@ -18,6 +18,7 @@
 
 import com.google.common.collect.Iterables;
 import com.google.common.collect.ObjectArrays;
+import io.zonky.test.db.logging.EmbeddedDatabaseReporter;
 import org.apache.commons.lang3.ArrayUtils;
 import org.flywaydb.core.Flyway;
 import org.flywaydb.core.api.FlywayException;
@@ -37,6 +38,7 @@
 import org.springframework.util.ClassUtils;
 import org.springframework.util.CollectionUtils;
 
+import javax.sql.DataSource;
 import java.lang.annotation.Annotation;
 import java.lang.reflect.AnnotatedElement;
 import java.lang.reflect.InvocationTargetException;
@@ -93,7 +95,7 @@ public void beforeTestClass(TestContext testContext) throws Exception {
             logger.warn("Optimized database loading is not supported when using multiple flyway test annotations");
         }
         for (FlywayTest annotation : annotations) {
-            optimizedDbReset(testContext, annotation);
+            optimizedDbReset(testContext, testClass, annotation);
         }
     }
 
@@ -106,7 +108,7 @@ public void beforeTestMethod(TestContext testContext) throws Exception {
             logger.warn("Optimized database loading is not supported when using multiple flyway test annotations");
         }
         for (FlywayTest annotation : annotations) {
-            optimizedDbReset(testContext, annotation);
+            optimizedDbReset(testContext, testMethod, annotation);
         }
     }
 
@@ -126,7 +128,7 @@ protected FlywayTest[] findFlywayTestAnnotations(AnnotatedElement element) {
         return new FlywayTest[0];
     }
 
-    protected synchronized void optimizedDbReset(TestContext testContext, FlywayTest annotation) throws Exception {
+    protected synchronized void optimizedDbReset(TestContext testContext, AnnotatedElement element, FlywayTest annotation) throws Exception {
         String dbResetMethodName = repeatableAnnotationPresent ? "dbResetWithAnnotation" : "dbResetWithAnotation";
 
         if (annotation != null && annotation.invokeCleanDB() && annotation.invokeMigrateDB()
@@ -141,7 +143,8 @@ protected synchronized void optimizedDbReset(TestContext testContext, FlywayTest
                 if (dataSourceContext != null) {
 
                     dataSourceContext.getTarget(); // wait for completion of running flyway migration
-                    prepareDataSourceContext(dataSourceContext, flywayBean, annotation);
+                    DataSource dataSource = reloadDataSource(dataSourceContext, flywayBean, annotation);
+                    EmbeddedDatabaseReporter.reportDataSource(dataSource, element);
 
                     FlywayTest adjustedAnnotation = copyAnnotation(annotation, false, false, true);
                     invokeMethod(this, dbResetMethodName, testContext, adjustedAnnotation);
@@ -164,9 +167,9 @@ protected synchronized void optimizedDbReset(TestContext testContext, FlywayTest
         }
     }
 
-    protected static void prepareDataSourceContext(FlywayDataSourceContext dataSourceContext, Flyway flywayBean, FlywayTest annotation) throws Exception {
+    protected static DataSource reloadDataSource(FlywayDataSourceContext dataSourceContext, Flyway flywayBean, FlywayTest annotation) throws Exception {
         if (isAppendable(flywayBean, annotation)) {
-            dataSourceContext.reload(flywayBean).get();
+            return dataSourceContext.reload(flywayBean).get();
         } else {
             String[] oldLocations = getFlywayLocations(flywayBean);
             try {
@@ -175,7 +178,7 @@ protected static void prepareDataSourceContext(FlywayDataSourceContext dataSourc
                 } else {
                     flywayBean.setLocations(ObjectArrays.concat(oldLocations, annotation.locationsForMigrate(), String.class));
                 }
-                dataSourceContext.reload(flywayBean).get();
+                return dataSourceContext.reload(flywayBean).get();
             } finally {
                 flywayBean.setLocations(oldLocations);
             }

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

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2016 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.logging;
+
+import org.postgresql.ds.common.BaseDataSource;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.sql.DataSource;
+import java.lang.reflect.AnnotatedElement;
+import java.lang.reflect.Method;
+
+public class EmbeddedDatabaseReporter {
+
+    private static final String JDBC_FORMAT = "jdbc:postgresql://localhost:%s/%s?user=%s";
+
+    private static final Logger logger = LoggerFactory.getLogger(EmbeddedDatabaseReporter.class);
+
+    public static void reportDataSource(DataSource dataSource) {
+        logger.info("JDBC URL to connect to the embedded database: {}", getJdbcUrl(dataSource));
+    }
+
+    public static void reportDataSource(DataSource dataSource, AnnotatedElement element) {
+        logger.info("JDBC URL to connect to the embedded database: {}, scope: {}", getJdbcUrl(dataSource), getElementName(element));
+    }
+
+    private static String getJdbcUrl(DataSource dataSource) {
+        try {
+            BaseDataSource ds = dataSource.unwrap(BaseDataSource.class);
+            return String.format(JDBC_FORMAT, ds.getPortNumber(), ds.getDatabaseName(), ds.getUser());
+        } catch (Exception e) {
+            logger.warn("Unexpected error occurred while resolving url to the embedded database", e);
+            return "unknown";
+        }
+    }
+
+    private static String getElementName(AnnotatedElement element) {
+        if (element instanceof Class) {
+            return ((Class) element).getSimpleName();
+        } else if (element instanceof Method) {
+            Method method = (Method) element;
+            return getElementName(method.getDeclaringClass()) + "#" + method.getName();
+        } else {
+            return element.toString();
+        }
+    }
+}

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

@@ -25,6 +25,7 @@
 import com.opentable.db.postgres.embedded.PreparedDbProvider;
 import io.zonky.test.db.flyway.BlockingDataSourceWrapper;
 import io.zonky.test.db.postgres.embedded.DefaultPostgresBinaryResolver;
+import io.zonky.test.db.logging.EmbeddedDatabaseReporter;
 import org.postgresql.ds.PGSimpleDataSource;
 import org.springframework.beans.factory.FactoryBean;
 import org.springframework.beans.factory.InitializingBean;
@@ -91,6 +92,7 @@ public void afterPropertiesSet() throws Exception {
 
         PreparedDbProvider provider = PreparedDbProvider.forPreparer(EmptyDatabasePreparer.INSTANCE, customizers);
         PGSimpleDataSource dataSource = provider.createDataSource().unwrap(PGSimpleDataSource.class);
+        EmbeddedDatabaseReporter.reportDataSource(dataSource);
         Semaphore semaphore = CONNECTION_SEMAPHORES.get(dataSource.getPortNumber());
         this.dataSource = new BlockingDataSourceWrapper(dataSource, semaphore);
     }

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

@@ -17,6 +17,7 @@
 package io.zonky.test.db.postgres;
 
 import io.zonky.test.db.flyway.FlywayDataSourceContext;
+import io.zonky.test.db.logging.EmbeddedDatabaseReporter;
 import org.apache.commons.lang3.StringUtils;
 import org.flywaydb.core.Flyway;
 import org.slf4j.Logger;
@@ -78,8 +79,10 @@ public void afterPropertiesSet() throws Exception {
     @Override
     public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
         if (bean instanceof Flyway && StringUtils.equals(beanName, flywayName)) {
-            ListenableFuture<Void> reloadFuture = dataSourceContext.reload((Flyway) bean);
-            reloadFuture.addCallback(r -> {}, e -> logger.error("Unexpected error during the initialization of embedded database", e));
+            ListenableFuture<DataSource> reloadFuture = dataSourceContext.reload((Flyway) bean);
+            reloadFuture.addCallback(
+                    result -> EmbeddedDatabaseReporter.reportDataSource(result),
+                    error -> logger.error("Unexpected error during the initialization of embedded database", error));
         }
         return bean;
     }

embedded-database-spring-test/src/test/resources/logback-test.xml

@@ -11,7 +11,7 @@
 
     <logger name="org.flywaydb" level="INFO"/>
 
-    <root level="WARN">
+    <root level="INFO">
         <appender-ref ref="STDOUT" />
     </root>