Merge pull request #214 from zonkyio/database-releasing-warnings

tomix26 · web-flow · commit b5a0bd6ab4a0 · 2022-11-12T19:17:47.000+01:00
#211 Fix false positive warnings related to releasing database resources
diff --git a/embedded-database-spring-test/src/main/java/io/zonky/test/db/provider/h2/H2DatabaseProvider.java b/embedded-database-spring-test/src/main/java/io/zonky/test/db/provider/h2/H2DatabaseProvider.java
@@ -20,10 +20,12 @@
 import io.zonky.test.db.provider.DatabaseProvider;
 import io.zonky.test.db.provider.EmbeddedDatabase;
 import io.zonky.test.db.provider.ProviderException;
+import io.zonky.test.db.util.ReflectionUtils;
 import org.h2.tools.Server;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.jdbc.datasource.SimpleDriverDataSource;
+import org.springframework.util.ClassUtils;
 
 import javax.sql.DataSource;
 import java.sql.Connection;
@@ -41,13 +43,23 @@ public class H2DatabaseProvider implements DatabaseProvider {
     private static Server startServer() {
         try {
             Server server = Server.createTcpServer("-tcp", "-tcpAllowOthers", "-tcpPort", "0").start();
-            Runtime.getRuntime().addShutdownHook(new Thread(server::shutdown));
+            registerShutdownHook(server);
             return server;
         } catch (SQLException e) {
             return null;
         }
     }
 
+    private static void registerShutdownHook(Server server) {
+        try {
+            Class<?> applicationType = ClassUtils.forName("org.springframework.boot.SpringApplication", null);
+            Object shutdownHandlers = ReflectionUtils.invokeStaticMethod(applicationType, "getShutdownHandlers");
+            ReflectionUtils.invokeMethod(shutdownHandlers, "add", (Runnable) server::shutdown);
+        } catch (Throwable ex) {
+            Runtime.getRuntime().addShutdownHook(new Thread(server::shutdown));
+        }
+    }
+
     @Override
     public EmbeddedDatabase createDatabase(DatabasePreparer preparer) throws ProviderException {
         SimpleDriverDataSource dataSource = new SimpleDriverDataSource();
@@ -86,12 +98,13 @@ private static void shutdownDatabase(DataSource dataSource, String dbName) {
         CompletableFuture.runAsync(() -> {
             try {
                 executeStatement(dataSource, "SHUTDOWN");
-            } catch (Exception e) {
-                if (logger.isTraceEnabled()) {
-                    logger.warn("Unable to release '{}' database", dbName, e);
-                } else {
-                    logger.warn("Unable to release '{}' database", 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);
+//                }
             }
         });
     }
diff --git a/embedded-database-spring-test/src/main/java/io/zonky/test/db/provider/mssql/DockerMSSQLDatabaseProvider.java b/embedded-database-spring-test/src/main/java/io/zonky/test/db/provider/mssql/DockerMSSQLDatabaseProvider.java
@@ -197,11 +197,13 @@ private void dropDatabase(ClientConfig config, String dbName) {
             CompletableFuture.runAsync(() -> {
                 try {
                     executeStatement(config, String.format("DROP DATABASE IF EXISTS %s", dbName));
-                } catch (Exception e) {
-                    if (logger.isTraceEnabled()) {
-                        logger.warn("Unable to release '{}' database", dbName, e);
-                    } else {
-                        logger.warn("Unable to release '{}' database", dbName);
+                } catch (SQLException e) {
+                    if (e.getErrorCode() == 3702) { // mssql server error code for database in use condition
+                        if (logger.isTraceEnabled()) {
+                            logger.warn("Unable to release '{}' database", dbName, e);
+                        } else {
+                            logger.warn("Unable to release '{}' database", dbName);
+                        }
                     }
                 }
             });
diff --git a/embedded-database-spring-test/src/main/java/io/zonky/test/db/provider/postgres/DockerPostgresDatabaseProvider.java b/embedded-database-spring-test/src/main/java/io/zonky/test/db/provider/postgres/DockerPostgresDatabaseProvider.java
@@ -224,11 +224,13 @@ private void dropDatabase(ClientConfig config, String dbName) {
             CompletableFuture.runAsync(() -> {
                 try {
                     executeStatement(config, String.format("DROP DATABASE IF EXISTS %s", dbName));
-                } catch (Exception e) {
-                    if (logger.isTraceEnabled()) {
-                        logger.warn("Unable to release '{}' database", dbName, e);
-                    } else {
-                        logger.warn("Unable to release '{}' database", dbName);
+                } catch (SQLException e) {
+                    if ("55006".equals(e.getSQLState())) { // postgres error code for object_in_use condition
+                        if (logger.isTraceEnabled()) {
+                            logger.warn("Unable to release '{}' database", dbName, e);
+                        } else {
+                            logger.warn("Unable to release '{}' database", dbName);
+                        }
                     }
                 }
             });
diff --git a/embedded-database-spring-test/src/main/java/io/zonky/test/db/provider/postgres/OpenTablePostgresDatabaseProvider.java b/embedded-database-spring-test/src/main/java/io/zonky/test/db/provider/postgres/OpenTablePostgresDatabaseProvider.java
@@ -25,13 +25,13 @@
 import com.google.common.util.concurrent.UncheckedExecutionException;
 import com.opentable.db.postgres.embedded.EmbeddedPostgres;
 import io.zonky.test.db.preparer.DatabasePreparer;
-import io.zonky.test.db.provider.support.BlockingDatabaseWrapper;
 import io.zonky.test.db.provider.DatabaseRequest;
 import io.zonky.test.db.provider.DatabaseTemplate;
 import io.zonky.test.db.provider.EmbeddedDatabase;
 import io.zonky.test.db.provider.ProviderException;
-import io.zonky.test.db.provider.support.SimpleDatabaseTemplate;
 import io.zonky.test.db.provider.TemplatableDatabaseProvider;
+import io.zonky.test.db.provider.support.BlockingDatabaseWrapper;
+import io.zonky.test.db.provider.support.SimpleDatabaseTemplate;
 import io.zonky.test.db.util.PropertyUtils;
 import io.zonky.test.db.util.RandomStringUtils;
 import org.postgresql.ds.PGSimpleDataSource;
@@ -169,11 +169,13 @@ private void dropDatabase(ClientConfig config, String dbName) {
             CompletableFuture.runAsync(() -> {
                 try {
                     executeStatement(config, String.format("DROP DATABASE IF EXISTS %s", dbName));
-                } catch (Exception e) {
-                    if (logger.isTraceEnabled()) {
-                        logger.warn("Unable to release '{}' database", dbName, e);
-                    } else {
-                        logger.warn("Unable to release '{}' database", dbName);
+                } catch (SQLException e) {
+                    if ("55006".equals(e.getSQLState())) { // postgres error code for object_in_use condition
+                        if (logger.isTraceEnabled()) {
+                            logger.warn("Unable to release '{}' database", dbName, e);
+                        } else {
+                            logger.warn("Unable to release '{}' database", dbName);
+                        }
                     }
                 }
             });
diff --git a/embedded-database-spring-test/src/main/java/io/zonky/test/db/provider/postgres/YandexPostgresDatabaseProvider.java b/embedded-database-spring-test/src/main/java/io/zonky/test/db/provider/postgres/YandexPostgresDatabaseProvider.java
@@ -25,13 +25,13 @@
 import de.flapdoodle.embed.process.distribution.GenericVersion;
 import de.flapdoodle.embed.process.distribution.IVersion;
 import io.zonky.test.db.preparer.DatabasePreparer;
-import io.zonky.test.db.provider.support.BlockingDatabaseWrapper;
 import io.zonky.test.db.provider.DatabaseRequest;
 import io.zonky.test.db.provider.DatabaseTemplate;
 import io.zonky.test.db.provider.EmbeddedDatabase;
 import io.zonky.test.db.provider.ProviderException;
-import io.zonky.test.db.provider.support.SimpleDatabaseTemplate;
 import io.zonky.test.db.provider.TemplatableDatabaseProvider;
+import io.zonky.test.db.provider.support.BlockingDatabaseWrapper;
+import io.zonky.test.db.provider.support.SimpleDatabaseTemplate;
 import io.zonky.test.db.util.PropertyUtils;
 import io.zonky.test.db.util.RandomStringUtils;
 import org.postgresql.ds.PGSimpleDataSource;
@@ -185,11 +185,13 @@ private void dropDatabase(ClientConfig config, String dbName) {
             CompletableFuture.runAsync(() -> {
                 try {
                     executeStatement(config, String.format("DROP DATABASE IF EXISTS %s", dbName));
-                } catch (Exception e) {
-                    if (logger.isTraceEnabled()) {
-                        logger.warn("Unable to release '{}' database", dbName, e);
-                    } else {
-                        logger.warn("Unable to release '{}' database", dbName);
+                } catch (SQLException e) {
+                    if ("55006".equals(e.getSQLState())) { // postgres error code for object_in_use condition
+                        if (logger.isTraceEnabled()) {
+                            logger.warn("Unable to release '{}' database", dbName, e);
+                        } else {
+                            logger.warn("Unable to release '{}' database", dbName);
+                        }
                     }
                 }
             });
diff --git a/embedded-database-spring-test/src/main/java/io/zonky/test/db/provider/postgres/ZonkyPostgresDatabaseProvider.java b/embedded-database-spring-test/src/main/java/io/zonky/test/db/provider/postgres/ZonkyPostgresDatabaseProvider.java
@@ -170,15 +170,17 @@ public EmbeddedDatabase createDatabase(ClientConfig config, DatabaseRequest requ
             }
         }
 
-        private void dropDatabase(ClientConfig config, String dbName)  {
+        private void dropDatabase(ClientConfig config, String dbName) {
             CompletableFuture.runAsync(() -> {
                 try {
                     executeStatement(config, String.format("DROP DATABASE IF EXISTS %s", dbName));
-                } catch (Exception e) {
-                    if (logger.isTraceEnabled()) {
-                        logger.warn("Unable to release '{}' database", dbName, e);
-                    } else {
-                        logger.warn("Unable to release '{}' database", dbName);
+                } catch (SQLException e) {
+                    if ("55006".equals(e.getSQLState())) { // postgres error code for object_in_use condition
+                        if (logger.isTraceEnabled()) {
+                            logger.warn("Unable to release '{}' database", dbName, e);
+                        } else {
+                            logger.warn("Unable to release '{}' database", dbName);
+                        }
                     }
                 }
             });

Original file line number	Diff line number	Diff line change
`@@ -170,15 +170,17 @@ public EmbeddedDatabase createDatabase(ClientConfig config, DatabaseRequest requ`
`170`	`170`	`}`
`171`	`171`	`}`
`172`	`172`
`173`		`- private void dropDatabase(ClientConfig config, String dbName) {`
	`173`	`+ private void dropDatabase(ClientConfig config, String dbName) {`
`174`	`174`	`CompletableFuture.runAsync(() -> {`
`175`	`175`	`try {`
`176`	`176`	`executeStatement(config, String.format("DROP DATABASE IF EXISTS %s", dbName));`
`177`		`- } catch (Exception e) {`
`178`		`- if (logger.isTraceEnabled()) {`
`179`		`- logger.warn("Unable to release '{}' database", dbName, e);`
`180`		`- } else {`
`181`		`- logger.warn("Unable to release '{}' database", dbName);`
	`177`	`+ } catch (SQLException e) {`
	`178`	`+ if ("55006".equals(e.getSQLState())) { // postgres error code for object_in_use condition`
	`179`	`+ if (logger.isTraceEnabled()) {`
	`180`	`+ logger.warn("Unable to release '{}' database", dbName, e);`
	`181`	`+ } else {`
	`182`	`+ logger.warn("Unable to release '{}' database", dbName);`
	`183`	`+ }`
`182`	`184`	`}`
`183`	`185`	`}`
`184`	`186`	`});`