Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish 'Document methods of starting Testcontainer containers'

Browse Source 
See gh-44187
This commit is contained in:
Phillip Webb
2025-05-05 22:03:01 -07:00
parent 4a98b1787f
commit 8814d8a7dc
18 changed files with 216 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties
View File

@@ -75,7 +75,7 @@ url-spring-data-rest-docs=https://docs.spring.io/spring-data/rest/reference/{ant
url-spring-data-rest-site=https://spring.io/projects/spring-data-rest
url-spring-data-rest-javadoc=https://docs.spring.io/spring-data/rest/docs/{dotxversion-spring-data-rest}/api
url-spring-data-site=https://spring.io/projects/spring-data
url-testcontainers-java-doc=https://java.testcontainers.org
url-testcontainers-docs=https://java.testcontainers.org
url-testcontainers-activemq-javadoc=https://javadoc.io/doc/org.testcontainers/activemq/{version-testcontainers-activemq}
url-testcontainers-cassandra-javadoc=https://javadoc.io/doc/org.testcontainers/cassandra/{version-testcontainers-cassandra}
url-testcontainers-couchbase-javadoc=https://javadoc.io/doc/org.testcontainers/couchbase/{version-testcontainers-couchbase}

115
spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/testing/testcontainers.adoc
View File

@@ -8,85 +8,90 @@ Testcontainers is especially useful for writing integration tests that talk to a
In following sections we will describe some of the methods you can use to integrate Testcontainers with your tests.
[[testing.testcontainers.via-junit-extension]]
== Using via @Testcontainers JUnit5 extension
The Testcontainers provides JUnit5 extensions, which can be used to manage containers in your tests.
The extension is activated by applying the `@Testcontainers` annotation from Testcontainers to your test class.
Testcontainers can be used in a Spring Boot test as follows:
include-code::vanilla/MyIntegrationTests[]
This will start up a Docker container running Neo4j (if Docker is running locally) before any of the tests are run.
In most cases, you will need to configure the application to connect to the service running in the container.
In this case the lifecycle of the container instance is managed by Testcontainers, as described in official documentation.
[[testing.testcontainers.via-spring-beans]]
== Using via Spring managed beans
[[testing.testcontainers.spring-beans]]
== Using Spring Beans
The containers provided by Testcontainers can be managed by Spring Boot as beans.
This method of managing contains can be used in combination with javadoc:org.springframework.boot.testcontainers.service.connection.ServiceConnection[format=annotation].
To use Testcontainer contains as Spring beans we need to create a configuration class declaring the container as bean:
To declare a container as a bean, add a javadoc:org.springframework.context.annotation.Bean[format=annotation] method to your test configuration:
include-code::beandeclaration/BeanDeclarationConfig[]
include-code::MyTestConfiguration[]
then we can start the container by importing the configuration class in the test class:
You can then inject and use the container by importing the configuration class in the test class:
include-code::beandeclaration/SpringTest[]
include-code::MyIntegrationTests[]
TIP: This method of managing containers is often used in combination with xref:#testing.testcontainers.service-connections[service connection annotations].
[[testing.testcontainers.via-declaration-classes]]
== Using via importing container declaration classes
A common pattern with Testcontainers is to declare the Container instances as static fields in an interface.
For example the following interface `MyInterface` declares two containers, one named `mongo` of type MongoDB and another named `neo` of type Neo4j:
[[testing.testcontainers.junit-extension]]
== Using the JUnit Extension
include-code::importcontainers/MyInterface[]
Testcontainers provides a JUnit extension which can be used to manage containers in your tests.
The extension is activated by applying the javadoc:org.testcontainers.junit.jupiter.Testcontainers[format=annotation] annotation from Testcontainers to your test class.
When you have containers declared in this way, then you can have these containers managed by Spring Boot as beans.
All that is needed to do that is adding javadoc:org.springframework.boot.testcontainers.context.ImportTestcontainers[format=annotation] to your configuration class as in:
You can then use the javadoc:org.testcontainers.junit.jupiter.Container[format=annotation] annotation on static container fields.
include-code::importcontainers/MyConfiguration[]
The javadoc:org.testcontainers.junit.jupiter.Testcontainers[format=annotation] annotation can be used on vanilla JUnit tests, or in combination with javadoc:org.springframework.boot.test.context.SpringBootTest[format=annotation]:
TIP: Using interfaces for declaring contains helps with reuse.
When containers are declared in an interface, this can be reused in your javadoc:org.springframework.context.annotation.Configuration[format=annotation] classes and in test classes.
include-code::MyIntegrationTests[]
The example above will start up a Neo4j container before any of the tests are run.
The lifecycle of the container instance is managed by Testcontainers, as described in {url-testcontainers-docs}/test_framework_integration/junit_5/#extension[their official documentation].
NOTE: In most cases, you will additionally need to configure the application to connect to the service running in the container.
[[test.testcontainers.container-lifecycle]]
== Lifecycle of managed containers
If you have used the annotations and extensions provided by Testcontainers, then the lifecycle of container instances is managed by the Testcontainers.
Please refer to the {url-testcontainres-java-doc}[Testcontainers official documentation] for the information about lifecycle of the containers, when managed by the Testcontainers.
[[testing.testcontainers.importing-configuration-interfaces]]
== Importing Container Configuration Interfaces
A common pattern with Testcontainers is to declare the container instances as static fields in an interface.
For example, the following interface declares two containers, one named `mongo` of type javadoc:org.testcontainers.containers.MongoDBContainer[] and another named `neo4j` of type javadoc:org.testcontainers.containers.Neo4jContainer.Neo4jContainer[]:
include-code::MyContainers[]
When you have containers declared in this way, you can reuse their configuration in multiple tests by having the test classes implement the interface.
It's also possible to use the same interface configuration in your Spring Boot tests.
To do so, add javadoc:org.springframework.boot.testcontainers.context.ImportTestcontainers[format=annotation] to your test configuration class:
include-code::MyTestConfiguration[]
[[testing.testcontainers.lifecycle]]
== Lifecycle of Managed Containers
If you have used the annotations and extensions provided by Testcontainers, then the lifecycle of container instances is managed entirely by Testcontainers.
Please refer to the {url-testcontainers-docs}[offical Testcontainers documentation] for the information.
When the containers are managed by Spring as beans, then their lifecycle is managed by Spring:
* Container beans are created and started before all other beans.
* Container beans are stopped after the destruction of all other beans.
When the containers are managed by Spring as beans, then the lifecycle is clearly defined by Spring.
The container beans are created and started before the beans of other types are created.
This process ensures that any beans, which rely on functionality provided by the containers, can use those functionalities.
It also ensures that they are cleaned up whilst the container is still available.
The test containers can be started multiple times.
Like any other beans the test containers are created and started once per application context managed by the TestContext Framework.
For details about how TestContext framework manages the underlying application contexts and beans therein, please refer to the {url-spring-framework-docs}[official Spring documentation].
TIP: When your application beans rely on functionality of containers, prefer configuring the containers as Spring beans to ensure the correct lifecycle behavior.
The container beans are stopped after the destruction of beans of other types.
This ensures that any beans depending on the functionalities provided by the containers are cleaned up first.
TIP: When your application beans rely on functionality of containers, prefer configuring the containers as Spring beans.
When containers are managed as Spring beans, then Spring framework ensures that upon start the container beans are started before any beans relying on them.
On shutdown the application beans depending on container functionalities are cleaned up first, and only then are the containers shut down.
NOTE: Having containers managed by Testcontainers instead of as Spring beans provides no guarantee of order in which beans and containers will shutdown.
NOTE: Having containers managed by Testcontainers instead of as Spring beans provides no guarantee of the order in which beans and containers will shutdown.
It can happen that containers are shutdown before the beans relying on container functionality are cleaned up.
This can lead to exceptions being thrown by client beans due to loss of connection for example.
This can lead to exceptions being thrown by client beans, for example, due to loss of connection.
The containers are stopped as part of the application shutdown process, managed by the TestContext framework.
Container beans are created and started once per application context managed by Spring's TestContext Framework.
For details about how TestContext Framework manages the underlying application contexts and beans therein, please refer to the {url-spring-framework-docs}[Spring Framework documentation].
Container beans are stopped as part of the TestContext Framework's standard application context shutdown process.
When the application context gets shutdown, the containers are shutdown as well.
This usually happens after all tests using that specific cached application context have finished executing, but may happen earlier depending on the caching behavior configured in TestContext Framework.
This usually happens after all tests using that specific cached application context have finished executing.
It may also happen earlier, depending on the caching behavior configured in TestContext Framework.
It is important to note that a single test container instance can be, and often is, retained across execution of tests from multiple test classes.
NOTE: A single test container instance can, and often is, retained across execution of tests from multiple test classes.

8
spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/testing/testcontainers/importcontainers/MyInterface.java → spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/testing/testcontainers/importingconfigurationinterfaces/MyContainers.java
View File

@@ -14,22 +14,18 @@
* limitations under the License.
*/
package org.springframework.boot.docs.testing.testcontainers.importcontainers;
package org.springframework.boot.docs.testing.testcontainers.importingconfigurationinterfaces;
import org.testcontainers.containers.MongoDBContainer;
import org.testcontainers.containers.Neo4jContainer;
import org.testcontainers.junit.jupiter.Container;
import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
interface MyInterface {
interface MyContainers {
@Container
@ServiceConnection
MongoDBContainer mongoContainer = new MongoDBContainer("mongo:5.0");
@Container
@ServiceConnection
Neo4jContainer<?> neo4jContainer = new Neo4jContainer<>("neo4j:5");
}

6
spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/testing/testcontainers/importcontainers/MyConfiguration.java → spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/testing/testcontainers/importingconfigurationinterfaces/MyTestConfiguration.java
View File

@@ -14,13 +14,13 @@
* limitations under the License.
*/
package org.springframework.boot.docs.testing.testcontainers.importcontainers;
package org.springframework.boot.docs.testing.testcontainers.importingconfigurationinterfaces;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.boot.testcontainers.context.ImportTestcontainers;
@TestConfiguration(proxyBeanMethods = false)
@ImportTestcontainers(MyInterface.class)
class MyConfiguration {
@ImportTestcontainers(MyContainers.class)
class MyTestConfiguration {
}

6
spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/testing/testcontainers/vanilla/MyIntegrationTests.java → spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/testing/testcontainers/junitextension/MyIntegrationTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2024 the original author or authors.
* Copyright 2012-2025 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.
@@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.boot.docs.testing.testcontainers.vanilla;
package org.springframework.boot.docs.testing.testcontainers.junitextension;
import org.junit.jupiter.api.Test;
import org.testcontainers.containers.Neo4jContainer;
@@ -32,7 +32,7 @@ class MyIntegrationTests {
@Test
void myTest() {
// ...
/**/ System.out.println(neo4j);
}
}

4
spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/testing/testcontainers/serviceconnections/MyIntegrationTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2024 the original author or authors.
* Copyright 2012-2025 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.
@@ -34,7 +34,7 @@ class MyIntegrationTests {
@Test
void myTest() {
// ...
/**/ System.out.println(neo4j);
}
}

10
spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/testing/testcontainers/beandeclaration/SpringTest.java → spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/testing/testcontainers/springbeans/MyIntegrationTests.java
View File

@@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.boot.docs.testing.testcontainers.beandeclaration;
package org.springframework.boot.docs.testing.testcontainers.springbeans;
import org.junit.jupiter.api.Test;
import org.testcontainers.containers.MongoDBContainer;
@@ -24,15 +24,15 @@ import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.annotation.Import;
@SpringBootTest
@Import(BeanDeclarationConfig.class)
class SpringTest {
@Import(MyTestConfiguration.class)
class MyIntegrationTests {
@Autowired
private MongoDBContainer mongo;
@Test
void doTest() {
System.out.println("Mongo db is running: " + this.mongo.isRunning());
void myTest() {
/**/ System.out.println(this.mongo);
}
}

10
spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/testing/testcontainers/beandeclaration/BeanDeclarationConfig.java → spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/testing/testcontainers/springbeans/MyTestConfiguration.java
View File

@@ -14,22 +14,20 @@
* limitations under the License.
*/
package org.springframework.boot.docs.testing.testcontainers.beandeclaration;
package org.springframework.boot.docs.testing.testcontainers.springbeans;
import org.testcontainers.containers.MongoDBContainer;
import org.testcontainers.utility.DockerImageName;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
import org.springframework.context.annotation.Bean;
@TestConfiguration(proxyBeanMethods = false)
class BeanDeclarationConfig {
class MyTestConfiguration {
@ServiceConnection
@Bean
MongoDBContainer container() {
return new MongoDBContainer(DockerImageName.parse("mongo:latest"));
MongoDBContainer mongoDbContainer() {
return new MongoDBContainer(DockerImageName.parse("mongo:5.0"));
}
}

17
spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/testing/testcontainers/beandeclaration/BeanDeclarationConfig.kt
View File

@@ -1,17 +0,0 @@
package org.springframework.boot.docs.testing.testcontainers.beandeclaration
import org.springframework.boot.test.context.TestConfiguration
import org.springframework.boot.testcontainers.service.connection.ServiceConnection
import org.springframework.context.annotation.Bean
import org.testcontainers.containers.MongoDBContainer
import org.testcontainers.utility.DockerImageName
@TestConfiguration(proxyBeanMethods = false)
internal class BeanDeclarationConfig {
@ServiceConnection
@Bean
fun container(): MongoDBContainer {
return MongoDBContainer(DockerImageName.parse("mongo:latest"))
}
}

19
spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/testing/testcontainers/beandeclaration/SpringTest.kt
View File

@@ -1,19 +0,0 @@
package org.springframework.boot.docs.testing.testcontainers.beandeclaration
import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.context.annotation.Import
import org.testcontainers.containers.MongoDBContainer
@SpringBootTest
@Import(BeanDeclarationConfig::class)
class SpringTest {
@Autowired
private val mongo: MongoDBContainer? = null
@Test
fun doTest() {
println("Mongo db is running: " + mongo!!.isRunning)
}
}

2
spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/testing/testcontainers/dynamicproperties/MyIntegrationTests.kt
View File

@@ -29,7 +29,7 @@ class MyIntegrationTests {
@Test
fun myTest() {
// ...
/**/ println()
}
companion object {

35
spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/testing/testcontainers/importingconfigurationinterfaces/MyContainers.kt Normal file
View File

@@ -0,0 +1,35 @@
/*
* Copyright 2012-2025 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
*
* https://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 org.springframework.boot.docs.testing.testcontainers.importingconfigurationinterfaces
import org.testcontainers.containers.MongoDBContainer
import org.testcontainers.containers.Neo4jContainer
import org.testcontainers.junit.jupiter.Container
interface MyContainers {
companion object {
@Container
val mongoContainer: MongoDBContainer = MongoDBContainer("mongo:5.0")
@Container
val neo4jContainer: Neo4jContainer<*> = Neo4jContainer("neo4j:5")
}
}

26
spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/testing/testcontainers/importingconfigurationinterfaces/MyTestConfiguration.kt Normal file
View File

@@ -0,0 +1,26 @@
/*
* Copyright 2012-2025 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
*
* https://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 org.springframework.boot.docs.testing.testcontainers.importingconfigurationinterfaces
import org.springframework.boot.test.context.TestConfiguration
import org.springframework.boot.testcontainers.context.ImportTestcontainers
@TestConfiguration(proxyBeanMethods = false)
@ImportTestcontainers(MyContainers::class)
class MyTestConfiguration {
}

7
spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/testing/testcontainers/vanilla/MyIntegrationTests.kt → spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/testing/testcontainers/junitextension/MyIntegrationTests.kt
View File

@@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.boot.docs.testing.testcontainers.vanilla
package org.springframework.boot.docs.testing.testcontainers.junitextension
import org.junit.jupiter.api.Test;
import org.testcontainers.containers.Neo4jContainer;
@@ -22,7 +22,6 @@ import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.testcontainers.service.connection.ServiceConnection
@Testcontainers
@SpringBootTest
@@ -30,13 +29,15 @@ class MyIntegrationTests {
@Test
fun myTest() {
// ...
/**/ println()
}
companion object {
@Container
@JvmStatic
val neo4j = Neo4jContainer("neo4j:5");
}
}

2
spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/testing/testcontainers/serviceconnections/MyIntegrationTests.kt
View File

@@ -30,7 +30,7 @@ class MyIntegrationTests {
@Test
fun myTest() {
// ...
/**/ println()
}
companion object {

2
spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/testing/testcontainers/serviceconnections/MyRedisConfiguration.kt
View File

@@ -23,9 +23,11 @@ import org.testcontainers.containers.GenericContainer
@TestConfiguration(proxyBeanMethods = false)
class MyRedisConfiguration {
@Bean
@ServiceConnection(name = "redis")
fun redisContainer(): GenericContainer<*> {
return GenericContainer("redis:7")
}
}

36
spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/testing/testcontainers/springbeans/MyIntegrationTests.kt Normal file
View File

@@ -0,0 +1,36 @@
/*
* Copyright 2012-2025 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
*
* https://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 org.springframework.boot.docs.testing.testcontainers.springbeans
import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.context.annotation.Import
import org.testcontainers.containers.MongoDBContainer
@SpringBootTest
@Import(MyTestConfiguration::class)
class MyIntegrationTests {
@Autowired
private val mongo: MongoDBContainer? = null
@Test
fun myTest() {
/**/ println()
}
}

31
spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/testing/testcontainers/springbeans/MyTestConfiguration.kt Normal file
View File

@@ -0,0 +1,31 @@
/*
* Copyright 2012-2025 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
*
* https://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 org.springframework.boot.docs.testing.testcontainers.springbeans
import org.springframework.boot.test.context.TestConfiguration
import org.springframework.context.annotation.Bean
import org.testcontainers.containers.MongoDBContainer
import org.testcontainers.utility.DockerImageName
@TestConfiguration(proxyBeanMethods = false)
class MyTestConfiguration {
@Bean
fun mongoDbContainer(): MongoDBContainer {
return MongoDBContainer(DockerImageName.parse("mongo:5.0"))
}
}