Testcontainer 的 Redis 容器连接到与测试中定义的容器不同的容器

Question

我正在我的 Spring Boot 应用程序中进行集成测试。该应用程序需要使用 Redis。

在开发阶段，我有一个应用程序连接到的本地 Redis 容器。

对于集成测试，我使用testcontainers，并且我还遵循了他们如何使用 Redis 容器的示例。

在某些时候，我了解到只有当开发容器启动并运行时测试才能正确运行。如果它宕机了，那么集成测试就会失败，因为它们无法到达 Redis。

所以集成测试类看起来像这样：

@RunWith(SpringRunner.class)
@SpringBootTest(classes = SharkApplication.class,
    webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@TestPropertySource(locations = "classpath:application-integrationtests.yml")
@AutoConfigureMockMvc
public class SharkIntegrationTest {
static GenericContainer redis = new GenericContainer("redis:3.0.6")
        .withExposedPorts(6379);

@BeforeClass
public static void before(){
    redis.start();
}

@AfterClass
public static void after(){
    redis.stop();
}
...

运行测试时，我可以在日志中看到以下内容：

14:36:24.372 [main] DEBUG  [redis:3.0.6] - Starting container: redis:3.0.6
14:36:24.372 [main] DEBUG  [redis:3.0.6] - Trying to start container: 
   redis:3.0.6
14:36:24.373 [main] DEBUG  [redis:3.0.6] - Trying to start container: 
    redis:3.0.6 (attempt 1/1)
14:36:24.373 [main] DEBUG  [redis:3.0.6] - Starting container: redis:3.0.6
14:36:24.373 [main] INFO  [redis:3.0.6] - Creating container for image: 
   redis:3.0.6
...
14:36:25.282 [main] INFO  [redis:3.0.6] - Container redis:3.0.6 started

但随后应用程序失败，因为它无法到达 Redis：

Caused by: redis.clients.jedis.exceptions.JedisConnectionException: java.net.ConnectException: Connection refused: connect

在某些时候，我尝试更改容器应启动的端口。从 6379 到 16379（在代码和 yml 文件中都更改了），但随后测试进入无限循环并打印到屏幕上：

14:41:57.258 [ducttape-0] DEBUG org.testcontainers.containers.ExecInContainerPattern - /amazing_beaver: Running "exec" command: /bin/bash -c </dev/tcp/localhost/16379 && echo

Answer 1

您缺少测试容器的一个非常重要的方面 - 随机端口。

从您提到的链接：

例如，对于上面的 Redis 示例，以下内容将允许您的测试访问 Redis 服务：
String redisUrl = redis.getContainerIpAddress() + ":" + redis.getMappedPort(6379);

测试容器使用随机端口启动一切以避免冲突。

您可以按照此研讨会来正确集成它。

Answer 2

当您以这种方式声明容器时：

static GenericContainer redis = new GenericContainer("redis:3.0.6")
    .withExposedPorts(6379);

您告诉 TestContainers 将随机主机端口映射到容器端口6379。如下图所示，例如，TestContainers从主机端口映射32881到容器端口6379：

测试中访问Redis容器需要使用随机主机端口，而不是redis端口6379。为此，您需要（在运行时）覆盖定义的配置值application.properties以使用随机主机端口。

您可以这样做：

package some.random.packagee;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.ApplicationContextInitializer;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.support.TestPropertySourceUtils;
import org.testcontainers.containers.GenericContainer;

@SpringBootTest
@ContextConfiguration(initializers = some.random.packagee.AbstractContainerBaseTest.Initializer.class)
public class AbstractContainerBaseTest {

    private static final int REDIS_PORT = 6379;

    // Optional
    @Autowired
    private RedisTemplate redisTemplate;

    // Optional 
    protected void cleanCache() {
        redisTemplate.getConnectionFactory().getConnection().flushAll();
    }

    public static class Initializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {

        static GenericContainer redis = new GenericContainer<>("redis:6-alpine")
            .withExposedPorts(REDIS_PORT)
            .withReuse(true);

        @Override
        public void initialize(ConfigurableApplicationContext context) {
            // Start container
            redis.start();

            // Override Redis configuration
            String redisContainerIP = "spring.redis.host=" + redis.getContainerIpAddress();
            String redisContainerPort = "spring.redis.port=" + redis.getMappedPort(REDIS_PORT); // <- This is how you get the random port.
            TestPropertySourceUtils.addInlinedPropertiesToEnvironment(context,  redisContainerIP, redisContainerPort); // <- This is how you override the configuration in runtime.
        }
    }
}

然后在需要使用Redis的类中扩展该类AbstractContainerBaseTest，例如：

package some.random.packagee;

import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;

class CacheTest extends AbstractContainerBaseTest {

    @Autowired
    private RedisTemplate<String, Object> redisTemplate;

    @AfterEach
    void tearDown() {
        cleanCache();
    }

    @Test
    public void testSomeMethodUsingRedis() {
        // Add your test here.
    }
}