测试容器

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

Testcontainers 可以在 Spring Boot 测试中使用，如下所示：spring-doc.cn

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

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.containers.Neo4jContainer;
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
class MyIntegrationTests {

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

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

这将在运行任何测试之前启动运行 Neo4j（如果 Docker 在本地运行）的 docker 容器。 在大多数情况下，您需要配置应用程序以连接到容器中运行的服务。spring-doc.cn

服务连接

服务连接是与任何远程服务的连接。 Spring Boot 的自动配置可以使用服务连接的详细信息，并使用它们来建立与远程服务的连接。 执行此操作时，连接详细信息优先于任何与连接相关的配置属性。spring-doc.cn

使用 Testcontainers 时，可以通过在 test 类中注释 container 字段，为容器中运行的服务自动创建连接详细信息。spring-doc.cn

import org.junit.jupiter.api.Test;
import org.testcontainers.containers.Neo4jContainer;
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
class MyIntegrationTests {

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

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

}
import org.junit.jupiter.api.Test;
import org.testcontainers.containers.Neo4jContainer;
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
class MyIntegrationTests {

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

	companion object {

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

	}

}

多亏了 @ServiceConnection，上述配置允许应用程序中与 Neo4j 相关的 bean 与在 Testcontainers 管理的 Docker 容器内运行的 Neo4j 进行通信。 这是通过自动定义一个 Neo4jConnectionDetails bean 来完成的，然后由 Neo4j 自动配置使用，覆盖任何与连接相关的配置属性。spring-doc.cn

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

服务连接注释由注册的 ContainerConnectionDetailsFactory 类处理。 ContainerConnectionDetailsFactory可以基于特定的Container子类或 Docker 镜像名称创建ConnectionDetails Bean。spring.factoriesspring-doc.cn

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

连接详细信息 匹配时间

ActiveMQConnectionDetailsspring-doc.cn

名为 “symptoma/activemq” 或 ActiveMQContainer 的容器spring-doc.cn

ArtemisConnectionDetailsspring-doc.cn

ArtemisContainer 类型的容器spring-doc.cn

CassandraConnectionDetailsspring-doc.cn

CassandraContainer 类型的容器spring-doc.cn

CouchbaseConnectionDetailsspring-doc.cn

CouchbaseContainer 类型的容器spring-doc.cn

ElasticsearchConnectionDetailsspring-doc.cn

ElasticsearchContainer 类型的容器spring-doc.cn

FlywayConnectionDetailsspring-doc.cn

JdbcDatabaseContainer 类型的容器spring-doc.cn

JdbcConnectionDetailsspring-doc.cn

JdbcDatabaseContainer 类型的容器spring-doc.cn

KafkaConnectionDetailsspring-doc.cn

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

LiquibaseConnectionDetailsspring-doc.cn

JdbcDatabaseContainer 类型的容器spring-doc.cn

MongoConnectionDetailsspring-doc.cn

MongoDBContainer 类型的容器spring-doc.cn

Neo4jConnectionDetailsspring-doc.cn

Neo4jContainer 类型的容器spring-doc.cn

OtlpLoggingConnectionDetailsspring-doc.cn

名为 “otel/opentelemetry-collector-contrib” 或LgtmStackContainerspring-doc.cn

OtlpMetricsConnectionDetailsspring-doc.cn

名为 “otel/opentelemetry-collector-contrib” 或LgtmStackContainerspring-doc.cn

OtlpTracingConnectionDetailsspring-doc.cn

名为 “otel/opentelemetry-collector-contrib” 或LgtmStackContainerspring-doc.cn

PulsarConnectionDetailsspring-doc.cn

PulsarContainer 类型的容器spring-doc.cn

R2dbcConnectionDetailsspring-doc.cn

MariaDBContainer、MSSQLServerContainer、MySQLContainer、OracleContainer（免费）、OracleContainer （XE） 或 PostgreSQLContainer 类型的容器ClickHouseContainerspring-doc.cn

RabbitConnectionDetailsspring-doc.cn

RabbitMQContainer 类型的容器spring-doc.cn

RedisConnectionDetailsspring-doc.cn

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

ZipkinConnectionDetailsspring-doc.cn

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

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

如果只想创建适用类型的子集，则可以使用 @ServiceConnection 的属性。typespring-doc.cn

默认情况下，用于获取用于查找连接详细信息的名称。 Docker 镜像名称的存储库部分会忽略任何注册表和版本。 只要 Spring Boot 能够获取 Container 的实例，这就有效，当使用如上例所示的字段时就是这种情况。Container.getDockerImageName().getRepository()staticspring-doc.cn

如果您使用的是 @Bean 方法，则 Spring Boot 不会调用 bean 方法来获取 Docker 镜像名称，因为这会导致预先初始化问题。 相反，使用 bean 方法的返回类型来找出应该使用哪个连接详细信息。 只要您使用的是类型化容器（如 Neo4jContainer 或 RabbitMQContainer），就可以正常工作。 如果您使用的是 GenericContainer，例如使用 Redis，这将停止工作，如以下示例所示：spring-doc.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 中的属性来提供该提示。namespring-doc.cn

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

动态属性

与服务连接相比，@DynamicPropertySource 是一种稍微详细但更灵活的替代方案。 static @DynamicPropertySource 方法允许向 Spring Environment 添加动态属性值。spring-doc.cn

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

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.containers.Neo4jContainer
import org.testcontainers.junit.jupiter.Container
import org.testcontainers.junit.jupiter.Testcontainers

@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.cn