Spring Boot集成测试随机自由端口

Question

我能够让Spring Boot集成自动生成一个随机的空闲端口来启动自身。但是我也需要为Redis获得一个空闲端口。

@ContextConfiguration(classes = {MyApplication.class}, loader = SpringApplicationContextLoader.class)
@WebIntegrationTest(randomPort = true, value = "server.port:0")
@ActiveProfiles(profiles = {"local"})
public class SegmentSteps {

    private static final String HOST_TEMPLATE = "http://localhost:%s";

    // Needs to be a random open port
    private static final int REDIS_PORT = 6380;

    private String host;
    @Value("${local.server.port}")
    private int serverPort;

    private RedisServer redisServer;

    @Before
    public void beforeScenario() throws Exception {
        host = String.format(HOST_TEMPLATE, serverPort);
        redisServer = RedisServer.builder()
                .redisExecProvider(RedisExecProvider.defaultProvider())
                .port(REDIS_PORT)
                .setting("bind 127.0.0.1")
                .build();
        redisServer.start();
    }

    ...
}

如何实现这一目标呢？

- ptimson

Answer 1

你可以使用 Spring Framework 的 SocketUtils 来获取一个可用的端口：

int redisPort = SocketUtils.findAvailableTcpPort();

- Andy Wilkinson

---

在这个情境中能够获得相同的数字吗？ - ptimson

还是我只需使用一个 int bean？带有限定符吗？ - ptimson

@ptimson，我不明白你的问题。能否详细说明一下？ - mre

SocketUtils 已经被弃用，自 Spring Framework 5.3.16 开始，将在 6.0 版本中移除。 - Andrei Damian-Fekete

Redis不支持使用“port: 0”配置来选择随机端口启动。请参见https://github.com/redis/redis/issues/7652#issuecomment-672941031。 - Andrei Damian-Fekete

现在是 org.springframework.test.util.TestSocketUtils.findAvailableTcpPort()。 - Udo Klimaschewski

Answer 2

我认为，这是2021年最好的方式。这需要spring-boot >= 2.3 / spring framework 5.2.5，并且使用 @DynamicPropertySource 注释。

帮助类：

@TestConfiguration
public class TestRedisConfiguration
{
    private RedisServer redisServer;

    public TestRedisConfiguration(
            @Value("${spring.redis.port}")
                    int redisPort
    )
    {
        this.redisServer = new RedisServer(redisPort);
    }

    @PostConstruct
    public void postConstruct()
    {
        redisServer.start();
    }

    @PreDestroy
    public void preDestroy()
    {
        redisServer.stop();
    }

    static public void configurePort(DynamicPropertyRegistry r)
    {
        int port = SocketUtils.findAvailableTcpPort();
        r.add("spring.redis.host", () -> "localhost");
        r.add("spring.redis.port", () -> port);
    }
}

在你的测试类（或基类）中：

@SpringBootTest
@Import({TestRedisConfiguration.class})
public abstract class BaseTestFullContext
{
...
   @DynamicPropertySource
    static public void properties(DynamicPropertyRegistry r)
    {
        TestRedisConfiguration.configurePort(r);
    }
...

- Casey

---

SocketUtils在5.3.16中已经被弃用，并计划在6.0中删除：“这些工具不能保证给定端口的后续可用性，因此不可靠。建议不要使用SocketUtils查找服务器的可用本地端口，而是依赖服务器能够启动其自行选择或由操作系统分配的随机端口。” - M. Justin

TestSocketUtils是在较新的Spring版本中SocketUtils的“继任者”。 如果你只需要TestRedisConfiguration在一个地方（测试或基类），我更喜欢将其作为静态嵌套类；这样你就可以省略@Import，一切都在一个地方。 - undefined

抱歉，你仍然需要使用@Import，我的错误。 - undefined

Answer 3

您也可以通过使用自己选择的Java客户端或利用Overcast将Redis在Docker中运行。 如果使用Overcast，通过激活exposeAllPorts选项，您的Redis将绑定到主机上的随机端口。

至于如何在上下文中启用该属性-需要一些工作，但您可以实现一个侦听器，启动Docker容器并将端口作为环境中的属性放置：

public class IntegrationTestBootstrapApplicationListener implements
    ApplicationListener<ApplicationEnvironmentPreparedEvent>, Ordered {

    public static final int DEFAULT_ORDER = Ordered.HIGHEST_PRECEDENCE + 4;
    public static final int PROPERTY_SOURCE_NAME = "integrationTestProps";

    private int order = DEFAULT_ORDER;

    public void setOrder(int order) {
        this.order = order;
    }

    @Override
    public int getOrder() {
        return this.order;
    }

    @Override
    public void onApplicationEvent(ApplicationEnvironmentPreparedEvent event) {
        ConfigurableEnvironment environment = event.getEnvironment();

        if (!environment.getPropertySources().contains(PROPERTY_SOURCE_NAME)) {
            CloudHost itestHost = CloudHostFactory.getCloudHost("redis");
            itestHost.setup();

            String host = itestHost.getHostName();
            // fetch the dynamic port from Docker
            int port = itestHost.getPort(6379); 

            // alternatively, skip the whole CloudHost setup above and just use:
            // int port = SocketUtils.findAvailableTcpPort();

            environment.getPropertySources().addLast(
              new MapPropertySource(
                PROPERTY_SOURCE_NAME, Collections.<String, Object> singletonMap(
                  "redis.port", port));
            );
        }
    }

}

- Miloš Milivojević

---

很好，会去尝试一下 - 对于这个项目可能有点过头了。 - ptimson

是的，我明白了，但如果您需要配置多个外部资源（例如Redis、RabbitMQ、PostgreSQL和FTP服务器），这是一个很好的选择。 - Miloš Milivojević