Skip to content

Commit 35a3f4a

Browse files
committed
Reinstate the use of shutdown hooks in the tests
Commit adf2c44 was an attempt to prevent HSQLDB from throwing an exception when the JVM exits. This was achieved by disabling the application context’s shutdown hook in the tests. This had the unwanted side effect of causing tests’ application contexts not to be closed. The reported symptom was that @destroy methods were no longer being invoked. We need a different solution to the problem. The exception was: Caused by: org.hsqldb.HsqlException: Database lock acquisition failure: attempt to connect while db opening /closing at org.hsqldb.error.Error.error(Unknown Source) at org.hsqldb.error.Error.error(Unknown Source) at org.hsqldb.error.Error.error(Unknown Source) at org.hsqldb.DatabaseManager.getDatabase(Unknown Source) at org.hsqldb.DatabaseManager.newSession(Unknown Source) ... 23 common frames omitted I originally thought this was due to a race between the application context’s shutdown hook and HSQLDB’s shutdown hook, however HSQLDB doesn’t use a shutdown hook. I believe that the problem is due to an HSQLDB database being created with shutdown=true in its URL, similar to the problem described here [1]. This will shut down the database when the last connection to it is closed, however the shutdown will happen asynchronously. If the JVM then runs the application context’s shutdown hook, EmbeddedDatabaseFactory will attempt to connect to the database to execute the SHUTDOWN command. This executes synchronously but will race with the asynchronous shutdown that’s executing as a result of shutdown=true in the JDBC url and the last connection to the database being closed. This commit reinstates the use of application context shutdown hooks in the tests, and updates the documentation to recommend that, if a user manually configures the URL for their embedded database, they do so in such a way that the database doesn’t shutdown automatically, thereby allowing the shutdown to be driven by application context close. Closes gh-4208 [1] http://sourceforge.net/p/hsqldb/bugs/1400/
1 parent 1c46fd2 commit 35a3f4a

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1526,6 +1526,13 @@ For example, typical POM dependencies would be:
15261526
</dependency>
15271527
----
15281528

1529+
TIP: If, for whatever reason, you do configure the connection URL for an embedded
1530+
database, care should be taken to ensure that the database’s automatic shutdown is
1531+
disabled. If you're using H2 you should use `DB_CLOSE_ON_EXIT=FALSE` to do so. If you're
1532+
using HSQLDB, you should ensure that `shutdown=true` is not used. Disabling the database's
1533+
automatic shutdown allows Spring Boot to control when the database is closed, thereby
1534+
ensuring that it happens once access to the database is no longer needed.
1535+
15291536
NOTE: You need a dependency on `spring-jdbc` for an embedded database to be
15301537
auto-configured. In this example it's pulled in transitively via
15311538
`spring-boot-starter-data-jpa`.

spring-boot/src/main/java/org/springframework/boot/test/SpringApplicationContextLoader.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,6 @@ public ApplicationContext loadContext(final MergedContextConfiguration config)
8282
throws Exception {
8383
assertValidAnnotations(config.getTestClass());
8484
SpringApplication application = getSpringApplication();
85-
application.setRegisterShutdownHook(false);
8685
application.setMainApplicationClass(config.getTestClass());
8786
application.setSources(getSources(config));
8887
ConfigurableEnvironment environment = new StandardEnvironment();

0 commit comments

Comments
 (0)