Testcontainers

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

Testcontainers 可以如下在 Spring Boot 测试中使用

  • Java

  • Kotlin

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 Boot 的自动配置可以读取服务连接的详细信息，并使用它们建立与远程服务的连接。在这样做时，连接详细信息优先于任何与连接相关的配置属性。

当使用 Testcontainers 时，可以通过在测试类中注释容器字段，自动为在容器中运行的服务创建连接详细信息。

  • Java

  • Kotlin

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 来实现的，该 Bean 随后被 Neo4j 自动配置使用，覆盖任何与连接相关的配置属性。

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

服务连接注解由 ContainerConnectionDetailsFactory 类处理，这些类已在 spring.factories 中注册。ContainerConnectionDetailsFactory 可以根据特定的 Container 子类或 Docker 镜像名称创建 ConnectionDetails Bean。

以下服务连接工厂在 spring-boot-testcontainers jar 中提供

连接详细信息 匹配对象

ActiveMQConnectionDetails

名为“symptoma/activemq”的容器或 ActiveMQContainer

ArtemisConnectionDetails

类型为 ArtemisContainer 的容器

CassandraConnectionDetails

类型为 CassandraContainer 的容器

CouchbaseConnectionDetails

类型为 CouchbaseContainer 的容器

ElasticsearchConnectionDetails

类型为 ElasticsearchContainer 的容器

FlywayConnectionDetails

类型为 JdbcDatabaseContainer 的容器

JdbcConnectionDetails

类型为 JdbcDatabaseContainer 的容器

KafkaConnectionDetails

类型为 org.testcontainers.containers.KafkaContainer 或 RedpandaContainer 的容器

LiquibaseConnectionDetails

类型为 JdbcDatabaseContainer 的容器

MongoConnectionDetails

类型为 MongoDBContainer 的容器

Neo4jConnectionDetails

类型为 Neo4jContainer 的容器

OtlpMetricsConnectionDetails

名为“otel/opentelemetry-collector-contrib”的容器

OtlpTracingConnectionDetails

名为“otel/opentelemetry-collector-contrib”的容器

PulsarConnectionDetails

类型为 PulsarContainer 的容器

R2dbcConnectionDetails

类型为 MariaDBContainer、MSSQLServerContainer、MySQLContainer、OracleContainer 或 PostgreSQLContainer 的容器

RabbitConnectionDetails

类型为 RabbitMQContainer 的容器

RedisConnectionDetails

名为“redis”的容器

ZipkinConnectionDetails

名为“openzipkin/zipkin”的容器

默认情况下，对于给定的 Container，将创建所有适用的连接详细信息 Bean。例如，PostgreSQLContainer 将同时创建 JdbcConnectionDetails 和 R2dbcConnectionDetails。

如果只想创建适用类型的一个子集，可以使用 @ServiceConnection 的 type 属性。

默认情况下，Container.getDockerImageName().getRepository() 用于获取用于查找连接详细信息的名称。Docker 镜像名称的存储库部分忽略任何注册表和版本。只要 Spring Boot 能够获取 Container 的实例，这就可以正常工作，在使用如上例所示的 static 字段时就是这样。

如果您使用的是 @Bean 方法，Spring Boot 不会调用 Bean 方法来获取 Docker 镜像名称，因为这会导致急切初始化问题。相反，Bean 方法的返回类型用于找出应使用哪个连接详细信息。只要您使用的是类型化容器（例如 Neo4jContainer 或 RabbitMQContainer），这就可以正常工作。如果您使用的是 GenericContainer（例如，使用 Redis，如下例所示），则此方法将停止工作。

  • Java

  • Kotlin

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 属性来提供该提示。

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

动态属性

与服务连接相比，@DynamicPropertySource 是一种稍微冗长但更灵活的替代方案。静态 @DynamicPropertySource 方法允许向 Spring 环境添加动态属性值。

  • Java

  • Kotlin

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 通信。