Testcontainers

Testcontainers 库提供了一种管理在 Docker 容器内运行的服务的方法。 它与 JUnit 集成，允许你编写一个测试类，该类可以在任何测试运行之前启动容器。 Testcontainers 对于编写与真实后端服务（如 MySQL、MongoDB、Cassandra 等）通信的集成测试特别有用。spring-doc.cadn.net.cn

在接下来的章节中，我们将介绍一些可用于将 Testcontainers 与测试集成的方法。spring-doc.cadn.net.cn

使用 Spring Bean

Spring Boot 可以将 Testcontainers 提供的容器作为 Bean 进行管理。spring-doc.cadn.net.cn

要将容器声明为 bean，请在测试配置中添加一个 @Bean 方法：spring-doc.cadn.net.cn

import org.testcontainers.mongodb.MongoDBContainer;
import org.testcontainers.utility.DockerImageName;

import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.context.annotation.Bean;

@TestConfiguration(proxyBeanMethods = false)
class MyTestConfiguration {

	@Bean
	MongoDBContainer mongoDbContainer() {
		return new MongoDBContainer(DockerImageName.parse("mongo:5.0"));
	}

}
import org.springframework.boot.test.context.TestConfiguration
import org.springframework.context.annotation.Bean
import org.testcontainers.mongodb.MongoDBContainer
import org.testcontainers.utility.DockerImageName

@TestConfiguration(proxyBeanMethods = false)
class MyTestConfiguration {

	@Bean
	fun mongoDbContainer(): MongoDBContainer {
		return MongoDBContainer(DockerImageName.parse("mongo:5.0"))
	}

}

然后，您可以通过在测试类中导入配置类来注入并使用该容器：spring-doc.cadn.net.cn

import org.junit.jupiter.api.Test;
import org.testcontainers.mongodb.MongoDBContainer;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.annotation.Import;

@SpringBootTest
@Import(MyTestConfiguration.class)
class MyIntegrationTests {

	@Autowired
	private MongoDBContainer mongo;

	@Test
	void myTest() {
		...
	}

}
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.mongodb.MongoDBContainer

@SpringBootTest
@Import(MyTestConfiguration::class)
class MyIntegrationTests {

	@Autowired
	private val mongo: MongoDBContainer? = null

	@Test
	fun myTest() {
		...
	}

}
这种方法通常与 服务连接注解 一起使用。

使用 JUnit 扩展

Testcontainers 提供了一个 JUnit 扩展，可用于在测试中管理容器。 通过向测试类应用 Testcontainers 的 @Testcontainers 注解来激活该扩展。spring-doc.cadn.net.cn

然后，您可以在静态容器字段上使用 @Container 注解。spring-doc.cadn.net.cn

@Testcontainers 注解可用于原生 JUnit 测试，或与 @SpringBootTest 结合使用：spring-doc.cadn.net.cn

import org.junit.jupiter.api.Test;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;
import org.testcontainers.neo4j.Neo4jContainer;

import org.springframework.boot.test.context.SpringBootTest;

@Testcontainers
@SpringBootTest
class MyIntegrationTests {

	@Container
	static Neo4jContainer neo4j = new Neo4jContainer("neo4j:5");

	@Test
	void myTest() {
		...
	}

}
import org.junit.jupiter.api.Test;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;
import org.testcontainers.neo4j.Neo4jContainer;

import org.springframework.boot.test.context.SpringBootTest;

@Testcontainers
@SpringBootTest
class MyIntegrationTests {

	@Test
	fun myTest() {
		...
	}

	companion object {

		@Container
		@JvmStatic
		val neo4j = Neo4jContainer("neo4j:5");

	}
}

上面的示例将在运行任何测试之前启动一个Neo4j容器。 容器实例的生命周期由Testcontainers管理，如他们的官方文档所述。spring-doc.cadn.net.cn

在大多数情况下，您还需要配置应用程序以连接到容器中运行的服务。

导入容器配置接口

使用 Testcontainers 时，一种常见的模式是将容器实例声明为接口中的静态字段。spring-doc.cadn.net.cn

例如，以下接口声明了两个容器，一个名为 mongo，类型为 MongoDBContainer，另一个名为 neo4j，类型为 Neo4jContainer：spring-doc.cadn.net.cn

import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.mongodb.MongoDBContainer;
import org.testcontainers.neo4j.Neo4jContainer;

interface MyContainers {

	@Container
	MongoDBContainer mongoContainer = new MongoDBContainer("mongo:5.0");

	@Container
	Neo4jContainer neo4jContainer = new Neo4jContainer("neo4j:5");

}
import org.testcontainers.junit.jupiter.Container
import org.testcontainers.mongodb.MongoDBContainer
import org.testcontainers.neo4j.Neo4jContainer

interface MyContainers {

	companion object {

		@Container
		val mongoContainer: MongoDBContainer = MongoDBContainer("mongo:5.0")

		@Container
		val neo4jContainer: Neo4jContainer = Neo4jContainer("neo4j:5")

	}

}

当您以这种方式声明容器时，可以通过让测试类实现该接口，在多个测试中重用它们的配置。spring-doc.cadn.net.cn

也可以在 Spring Boot 测试中使用相同的接口配置。 为此，请将 @ImportTestcontainers 添加到您的测试配置类中：spring-doc.cadn.net.cn

import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.boot.testcontainers.context.ImportTestcontainers;

@TestConfiguration(proxyBeanMethods = false)
@ImportTestcontainers(MyContainers.class)
class MyTestConfiguration {

}
import org.springframework.boot.test.context.TestConfiguration
import org.springframework.boot.testcontainers.context.ImportTestcontainers

@TestConfiguration(proxyBeanMethods = false)
@ImportTestcontainers(MyContainers::class)
class MyTestConfiguration {

}

托管容器的生命周期

如果您使用了Testcontainers提供的注解和扩展，那么容器实例的生命周期将完全由Testcontainers管理。 有关信息，请参阅 Testcontainers官方文档。spring-doc.cadn.net.cn

当容器作为 Bean 由 Spring 管理时，它们的生命周期也由 Spring 管理：spring-doc.cadn.net.cn

这个过程确保了任何依赖容器提供的功能的 beans 都可以使用这些功能。 它还确保在容器仍然可用时它们被清理。spring-doc.cadn.net.cn

当您的应用程序 Bean 依赖于容器的功能时，建议将容器配置为 Spring Bean，以确保正确的生命周期行为。
由Testcontainers管理的容器而不是作为Spring bean，不能保证bean和容器的关闭顺序。 可能会出现依赖容器功能的bean在清理完成前容器就被关闭的情况。 这可能导致客户端bean抛出异常，例如由于连接丢失。

容器中的Bean由Spring的TestContext框架为每个应用程序上下文创建并启动一次。 有关TestContext框架如何管理底层应用程序上下文和其中的Bean的详细信息，请参阅 Spring框架文档。spring-doc.cadn.net.cn

容器 beans 作为 TestContext 框架的标准应用上下文关闭过程的一部分被停止。 当应用上下文关闭时，容器也会被关闭。 这通常发生在使用该特定缓存应用上下文的所有测试执行完毕之后。 也可能在更早的时候发生，具体取决于 TestContext 框架中配置的缓存行为。spring-doc.cadn.net.cn

单个测试容器实例可以（并且经常）在多个测试类的测试执行过程中被保留。

服务连接

服务连接是指与任何远程服务的连接。 Spring Boot 的自动配置可以读取服务连接的详细信息，并利用这些信息建立与远程服务的连接。 在此过程中，连接详细信息的优先级高于任何与连接相关的配置属性。spring-doc.cadn.net.cn

使用 Testcontainers 时，可以通过在测试类中的容器字段上添加注解，为容器中运行的服务自动创建连接详情。spring-doc.cadn.net.cn

import org.junit.jupiter.api.Test;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;
import org.testcontainers.neo4j.Neo4jContainer;

import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.testcontainers.service.connection.ServiceConnection;

@Testcontainers
@SpringBootTest
class MyIntegrationTests {

	@Container
	@ServiceConnection
	static Neo4jContainer neo4j = new Neo4jContainer("neo4j:5");

	@Test
	void myTest() {
		...
	}

}
import org.junit.jupiter.api.Test;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;
import org.testcontainers.neo4j.Neo4jContainer;

import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.testcontainers.service.connection.ServiceConnection;

@Testcontainers
@SpringBootTest
class MyIntegrationTests {

	@Test
	fun myTest() {
		...
	}

	companion object {

		@Container
		@ServiceConnection
		@JvmStatic
		val neo4j = Neo4jContainer("neo4j:5");

	}

}

得益于 @ServiceConnection，上述配置允许应用程序中与 Neo4j 相关的 Bean 与运行在 Testcontainers 管理的 Docker 容器中的 Neo4j 进行通信。 这是通过自动定义一个 Neo4jConnectionDetails Bean 来实现的，该 Bean 随后会被 Neo4j 自动配置使用，从而覆盖任何与连接相关的配置属性。spring-doc.cadn.net.cn

您需要添加 spring-boot-testcontainers 模块作为测试依赖项，以便将服务连接与 Testcontainers 结合使用。

服务连接注解由注册了 spring.factories 的 ContainerConnectionDetailsFactory 类处理。 ContainerConnectionDetailsFactory 可以根据特定的 Container 子类或 Docker 镜像名称创建 ConnectionDetails bean。spring-doc.cadn.net.cn

spring-boot-testcontainers jar 中提供了以下服务连接工厂：spring-doc.cadn.net.cn

连接详情 匹配于

ActiveMQConnectionDetailsspring-doc.cadn.net.cn

名为 "symptoma/activemq" 或 ActiveMQContainer 的容器spring-doc.cadn.net.cn

ArtemisConnectionDetailsspring-doc.cadn.net.cn

类型为 ArtemisContainer 的容器spring-doc.cadn.net.cn

CassandraConnectionDetailsspring-doc.cadn.net.cn

类型为 CassandraContainer 的容器spring-doc.cadn.net.cn

CouchbaseConnectionDetailsspring-doc.cadn.net.cn

类型为 CouchbaseContainer 的容器spring-doc.cadn.net.cn

ElasticsearchConnectionDetailsspring-doc.cadn.net.cn

类型为 ElasticsearchContainer 的容器spring-doc.cadn.net.cn

FlywayConnectionDetailsspring-doc.cadn.net.cn

类型为 JdbcDatabaseContainer 的容器spring-doc.cadn.net.cn

JdbcConnectionDetailsspring-doc.cadn.net.cn

类型为 JdbcDatabaseContainer 的容器spring-doc.cadn.net.cn

KafkaConnectionDetailsspring-doc.cadn.net.cn

类型为 KafkaContainer、ConfluentKafkaContainer 或 RedpandaContainer 的容器spring-doc.cadn.net.cn

LdapConnectionDetailsspring-doc.cadn.net.cn

名为“osixia/openldap”或类型为 LLdapContainer 的容器spring-doc.cadn.net.cn

LiquibaseConnectionDetailsspring-doc.cadn.net.cn

类型为 JdbcDatabaseContainer 的容器spring-doc.cadn.net.cn

MongoConnectionDetailsspring-doc.cadn.net.cn

类型为 MongoDBContainer 或 MongoDBAtlasLocalContainer 的容器spring-doc.cadn.net.cn

Neo4jConnectionDetailsspring-doc.cadn.net.cn

类型为 Neo4jContainer 的容器spring-doc.cadn.net.cn

OtlpLoggingConnectionDetailsspring-doc.cadn.net.cn

名为 "otel/opentelemetry-collector-contrib" 或类型为 LgtmStackContainer 的容器spring-doc.cadn.net.cn

OtlpMetricsConnectionDetailsspring-doc.cadn.net.cn

名为 "otel/opentelemetry-collector-contrib" 或类型为 LgtmStackContainer 的容器spring-doc.cadn.net.cn

OtlpTracingConnectionDetailsspring-doc.cadn.net.cn

名为 "otel/opentelemetry-collector-contrib" 或类型为 LgtmStackContainer 的容器spring-doc.cadn.net.cn

PulsarConnectionDetailsspring-doc.cadn.net.cn

类型为 PulsarContainer 的容器spring-doc.cadn.net.cn

R2dbcConnectionDetailsspring-doc.cadn.net.cn

类型为 ClickHouseContainer, MariaDBContainer, MSSQLServerContainer, MySQLContainer, OracleContainer（免费版）, OracleContainer（XE版） 或 PostgreSQLContainer 的容器spring-doc.cadn.net.cn

RabbitConnectionDetailsspring-doc.cadn.net.cn

类型为 RabbitMQContainer 的容器spring-doc.cadn.net.cn

DataRedisConnectionDetailsspring-doc.cadn.net.cn

类型为 RedisContainer 或 RedisStackContainer 的容器，或名为 "redis"、"redis/redis-stack" 或 "redis/redis-stack-server" 的容器spring-doc.cadn.net.cn

ZipkinConnectionDetailsspring-doc.cadn.net.cn

名为“openzipkin/zipkin”的容器spring-doc.cadn.net.cn

默认情况下，将为给定的 Container 创建所有适用的连接详情 Bean。 例如，PostgreSQLContainer 将同时创建 JdbcConnectionDetails 和 R2dbcConnectionDetails。spring-doc.cadn.net.cn

如果您只想创建适用类型的一个子集，可以使用 type 属性的 @ServiceConnection。spring-doc.cadn.net.cn

默认情况下，使用 Container.getDockerImageName().getRepository() 来获取用于查找连接详情的名称。 Docker 镜像名称的仓库部分会忽略任何注册表和版本信息。 只要 Spring Boot 能够获取 Container 的实例，此方法就有效，例如在上述示例中使用 static 字段时就是这种情况。spring-doc.cadn.net.cn

如果您使用的是 @Bean 方法，Spring Boot 将不会调用该 Bean 方法来获取 Docker 镜像名称，因为这会导致提前初始化问题。 相反，系统会使用 Bean 方法的返回类型来确定应使用哪种连接详情。 只要您使用的是类型化容器（例如 Neo4jContainer 或 RabbitMQContainer），此方法就有效。 如果您使用的是 GenericContainer，则此方法将失效，例如下面展示的 Redis 示例：spring-doc.cadn.net.cn

import org.testcontainers.containers.GenericContainer;

import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
import org.springframework.context.annotation.Bean;

@TestConfiguration(proxyBeanMethods = false)
public class MyRedisConfiguration {

	@Bean
	@ServiceConnection(name = "redis")
	public GenericContainer<?> redisContainer() {
		return new GenericContainer<>("redis:7");
	}

}
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.GenericContainer

@TestConfiguration(proxyBeanMethods = false)
class MyRedisConfiguration {

	@Bean
	@ServiceConnection(name = "redis")
	fun redisContainer(): GenericContainer<*> {
		return GenericContainer("redis:7")
	}

}

Spring Boot 无法从 GenericContainer 知道使用了哪个容器镜像，因此必须使用 @ServiceConnection 中的 name 属性来提供该提示。spring-doc.cadn.net.cn

您还可以使用 name 属性的 @ServiceConnection 来覆盖将使用的连接详细信息，例如在使用自定义镜像时。 如果您使用的是 Docker 镜像 registry.mycompany.com/mirror/myredis，则会使用 @ServiceConnection(name="redis") 来确保 DataRedisConnectionDetails 被创建。spring-doc.cadn.net.cn

服务连接与 SSL

您可以在支持的容器上使用 @Ssl、@JksKeyStore、@JksTrustStore、@PemKeyStore 和 @PemTrustStore 注解，以启用该服务连接的 SSL 支持。 请注意，您仍然需要自行启用运行在 Testcontainer 内部的服务的 SSL，这些注解仅在您的应用程序中配置客户端侧的 SSL。spring-doc.cadn.net.cn

import com.redis.testcontainers.RedisContainer;
import org.junit.jupiter.api.Test;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.testcontainers.service.connection.PemKeyStore;
import org.springframework.boot.testcontainers.service.connection.PemTrustStore;
import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
import org.springframework.data.redis.core.RedisOperations;

@Testcontainers
@SpringBootTest
class MyRedisWithSslIntegrationTests {

	@Container
	@ServiceConnection
	@PemKeyStore(certificate = "classpath:client.crt", privateKey = "classpath:client.key")
	@PemTrustStore("classpath:ca.crt")
	static RedisContainer redis = new SecureRedisContainer("redis:latest");

	@Autowired
	private RedisOperations<Object, Object> operations;

	@Test
	void testRedis() {
		// ...
	}

}

上述代码使用 @PemKeyStore 注解将客户端证书和密钥加载到密钥库中，并使用 @PemTrustStore 注解将 CA 证书加载到信任库中。 这将针对服务器对客户端进行身份验证，而信任库中的 CA 证书可确保服务器证书有效且受信任。spring-doc.cadn.net.cn

此示例中的 SecureRedisContainer 是 RedisContainer 的自定义子类，它将证书复制到正确的位置，并使用启用 SSL 的命令行参数调用 redis-server。spring-doc.cadn.net.cn

以下服务连接支持 SSL 注解：spring-doc.cadn.net.cn

ElasticsearchContainer 还支持自动检测服务器端 SSL。 要使用此功能，请使用 @Ssl 对容器进行注解，如下例所示，Spring Boot 将为您处理客户端 SSL 配置：spring-doc.cadn.net.cn

import org.junit.jupiter.api.Test;
import org.testcontainers.elasticsearch.ElasticsearchContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.data.elasticsearch.test.autoconfigure.DataElasticsearchTest;
import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
import org.springframework.boot.testcontainers.service.connection.Ssl;
import org.springframework.data.elasticsearch.client.elc.ElasticsearchTemplate;

@Testcontainers
@DataElasticsearchTest
class MyElasticsearchWithSslIntegrationTests {

	@Ssl
	@Container
	@ServiceConnection
	static ElasticsearchContainer elasticsearch = new ElasticsearchContainer(
			"docker.elastic.co/elasticsearch/elasticsearch:8.17.2");

	@Autowired
	private ElasticsearchTemplate elasticsearchTemplate;

	@Test
	void testElasticsearch() {
		// ...
	}

}

动态属性

与服务连接相比，@DynamicPropertySource 是一种稍微冗长但更灵活的替代方案。 静态 @DynamicPropertySource 方法允许将动态属性值添加到 Spring 环境中。spring-doc.cadn.net.cn

import org.junit.jupiter.api.Test;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;
import org.testcontainers.neo4j.Neo4jContainer;

import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.DynamicPropertyRegistry;
import org.springframework.test.context.DynamicPropertySource;

@Testcontainers
@SpringBootTest
class MyIntegrationTests {

	@Container
	static Neo4jContainer neo4j = new Neo4jContainer("neo4j:5");

	@Test
	void myTest() {
		// ...
	}

	@DynamicPropertySource
	static void neo4jProperties(DynamicPropertyRegistry registry) {
		registry.add("spring.neo4j.uri", neo4j::getBoltUrl);
	}

}
import org.junit.jupiter.api.Test
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.test.context.DynamicPropertyRegistry
import org.springframework.test.context.DynamicPropertySource
import org.testcontainers.junit.jupiter.Container
import org.testcontainers.junit.jupiter.Testcontainers
import org.testcontainers.neo4j.Neo4jContainer

@Testcontainers
@SpringBootTest
class MyIntegrationTests {

	@Test
	fun myTest() {
		...
	}

	companion object {
		@Container
		@JvmStatic
		val neo4j = Neo4jContainer("neo4j:5");

		@DynamicPropertySource
		@JvmStatic
		fun neo4jProperties(registry: DynamicPropertyRegistry) {
			registry.add("spring.neo4j.uri") { neo4j.boltUrl }
		}
	}
}

上述配置允许应用程序中与 Neo4j 相关的 Bean 与运行在由 Testcontainers 管理的 Docker 容器中的 Neo4j 进行通信。spring-doc.cadn.net.cn