From 46ec3e3a07ea6606b5e535342a3097f60b896b99 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Wed, 17 Jul 2024 11:08:52 +0100 Subject: [PATCH] Polish "Support service connections for redis-stack and redis-stack-server" See gh-41327 --- ...DockerComposeConnectionDetailsFactory.java | 4 +- .../pages/testing/testcontainers.adoc | 2 +- ...ontainerConnectionDetailsFactoryTests.java | 73 ------------------- ...ontainerConnectionDetailsFactoryTests.java | 4 +- ...ontainerConnectionDetailsFactoryTests.java | 4 +- .../container/RedisStackContainer.java | 35 +++++++++ .../container/RedisStackServerContainer.java | 35 +++++++++ .../boot/testsupport/container/TestImage.java | 12 ++- 8 files changed, 87 insertions(+), 82 deletions(-) delete mode 100644 spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/service/connection/redis/BitnamiRedisContainerConnectionDetailsFactoryTests.java create mode 100644 spring-boot-project/spring-boot-tools/spring-boot-test-support-docker/src/main/java/org/springframework/boot/testsupport/container/RedisStackContainer.java create mode 100644 spring-boot-project/spring-boot-tools/spring-boot-test-support-docker/src/main/java/org/springframework/boot/testsupport/container/RedisStackServerContainer.java diff --git a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/redis/RedisDockerComposeConnectionDetailsFactory.java b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/redis/RedisDockerComposeConnectionDetailsFactory.java index b44a2e97da..5a15429d2f 100644 --- a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/redis/RedisDockerComposeConnectionDetailsFactory.java +++ b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/redis/RedisDockerComposeConnectionDetailsFactory.java @@ -33,13 +33,13 @@ import org.springframework.boot.docker.compose.service.connection.DockerComposeC */ class RedisDockerComposeConnectionDetailsFactory extends DockerComposeConnectionDetailsFactory { - private static final String[] REDIS_IMAGE_NAMES = { "redis", "bitnami/redis", "redis/redis-stack", + private static final String[] REDIS_CONTAINER_NAMES = { "redis", "bitnami/redis", "redis/redis-stack", "redis/redis-stack-server" }; private static final int REDIS_PORT = 6379; RedisDockerComposeConnectionDetailsFactory() { - super(REDIS_IMAGE_NAMES); + super(REDIS_CONTAINER_NAMES); } @Override diff --git a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/testing/testcontainers.adoc b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/testing/testcontainers.adoc index 41010af6c1..0ee1dcab5a 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/testing/testcontainers.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/testing/testcontainers.adoc @@ -87,7 +87,7 @@ The following service connection factories are provided in the `spring-boot-test | Containers of type `RabbitMQContainer` | `RedisConnectionDetails` -| Containers named "redis", "bitnami/redis", "redis/redis-stack" or "redis/redis-stack-server" +| Containers named "redis", "redis/redis-stack" or "redis/redis-stack-server" | `ZipkinConnectionDetails` | Containers named "openzipkin/zipkin" diff --git a/spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/service/connection/redis/BitnamiRedisContainerConnectionDetailsFactoryTests.java b/spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/service/connection/redis/BitnamiRedisContainerConnectionDetailsFactoryTests.java deleted file mode 100644 index 212a2d1b8b..0000000000 --- a/spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/service/connection/redis/BitnamiRedisContainerConnectionDetailsFactoryTests.java +++ /dev/null @@ -1,73 +0,0 @@ -/* - * Copyright 2012-2024 the original author or authors. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.springframework.boot.testcontainers.service.connection.redis; - -import org.junit.jupiter.api.Test; -import org.testcontainers.containers.GenericContainer; -import org.testcontainers.junit.jupiter.Container; -import org.testcontainers.junit.jupiter.Testcontainers; - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.autoconfigure.ImportAutoConfiguration; -import org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration; -import org.springframework.boot.autoconfigure.data.redis.RedisConnectionDetails; -import org.springframework.boot.testcontainers.service.connection.ServiceConnection; -import org.springframework.boot.testsupport.container.TestImage; -import org.springframework.context.annotation.Configuration; -import org.springframework.data.redis.connection.RedisConnection; -import org.springframework.data.redis.connection.RedisConnectionFactory; -import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; - -import static org.assertj.core.api.Assertions.assertThat; - -/** - * Tests for {@link RedisContainerConnectionDetailsFactory}. - * - * @author Andy Wilkinson - * @author Eddú Meléndez - */ -@SpringJUnitConfig -@Testcontainers(disabledWithoutDocker = true) -class BitnamiRedisContainerConnectionDetailsFactoryTests { - - @Container - @ServiceConnection - static final GenericContainer redis = TestImage.BITNAMI_REDIS.genericContainer() - .withExposedPorts(6379) - .withEnv("ALLOW_EMPTY_PASSWORD", "yes"); - - @Autowired(required = false) - private RedisConnectionDetails connectionDetails; - - @Autowired - private RedisConnectionFactory connectionFactory; - - @Test - void connectionCanBeMadeToRedisContainer() { - assertThat(this.connectionDetails).isNotNull(); - try (RedisConnection connection = this.connectionFactory.getConnection()) { - assertThat(connection.commands().echo("Hello, World".getBytes())).isEqualTo("Hello, World".getBytes()); - } - } - - @Configuration(proxyBeanMethods = false) - @ImportAutoConfiguration(RedisAutoConfiguration.class) - static class TestConfiguration { - - } - -} diff --git a/spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/service/connection/redis/RedisStackContainerConnectionDetailsFactoryTests.java b/spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/service/connection/redis/RedisStackContainerConnectionDetailsFactoryTests.java index cc7f3395a0..03bcabb7e5 100644 --- a/spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/service/connection/redis/RedisStackContainerConnectionDetailsFactoryTests.java +++ b/spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/service/connection/redis/RedisStackContainerConnectionDetailsFactoryTests.java @@ -17,7 +17,6 @@ package org.springframework.boot.testcontainers.service.connection.redis; import org.junit.jupiter.api.Test; -import org.testcontainers.containers.GenericContainer; import org.testcontainers.junit.jupiter.Container; import org.testcontainers.junit.jupiter.Testcontainers; @@ -26,6 +25,7 @@ import org.springframework.boot.autoconfigure.ImportAutoConfiguration; import org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration; import org.springframework.boot.autoconfigure.data.redis.RedisConnectionDetails; import org.springframework.boot.testcontainers.service.connection.ServiceConnection; +import org.springframework.boot.testsupport.container.RedisStackContainer; import org.springframework.boot.testsupport.container.TestImage; import org.springframework.context.annotation.Configuration; import org.springframework.data.redis.connection.RedisConnection; @@ -46,7 +46,7 @@ class RedisStackContainerConnectionDetailsFactoryTests { @Container @ServiceConnection - static final GenericContainer redis = TestImage.REDIS_STACK.genericContainer().withExposedPorts(6379); + static final RedisStackContainer redis = TestImage.container(RedisStackContainer.class); @Autowired(required = false) private RedisConnectionDetails connectionDetails; diff --git a/spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/service/connection/redis/RedisStackServerContainerConnectionDetailsFactoryTests.java b/spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/service/connection/redis/RedisStackServerContainerConnectionDetailsFactoryTests.java index eba687c345..a3ebf8d7d8 100644 --- a/spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/service/connection/redis/RedisStackServerContainerConnectionDetailsFactoryTests.java +++ b/spring-boot-project/spring-boot-testcontainers/src/dockerTest/java/org/springframework/boot/testcontainers/service/connection/redis/RedisStackServerContainerConnectionDetailsFactoryTests.java @@ -17,7 +17,6 @@ package org.springframework.boot.testcontainers.service.connection.redis; import org.junit.jupiter.api.Test; -import org.testcontainers.containers.GenericContainer; import org.testcontainers.junit.jupiter.Container; import org.testcontainers.junit.jupiter.Testcontainers; @@ -26,6 +25,7 @@ import org.springframework.boot.autoconfigure.ImportAutoConfiguration; import org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration; import org.springframework.boot.autoconfigure.data.redis.RedisConnectionDetails; import org.springframework.boot.testcontainers.service.connection.ServiceConnection; +import org.springframework.boot.testsupport.container.RedisStackServerContainer; import org.springframework.boot.testsupport.container.TestImage; import org.springframework.context.annotation.Configuration; import org.springframework.data.redis.connection.RedisConnection; @@ -46,7 +46,7 @@ class RedisStackServerContainerConnectionDetailsFactoryTests { @Container @ServiceConnection - static final GenericContainer redis = TestImage.REDIS_STACK_SERVER.genericContainer().withExposedPorts(6379); + static final RedisStackServerContainer redis = TestImage.container(RedisStackServerContainer.class); @Autowired(required = false) private RedisConnectionDetails connectionDetails; diff --git a/spring-boot-project/spring-boot-tools/spring-boot-test-support-docker/src/main/java/org/springframework/boot/testsupport/container/RedisStackContainer.java b/spring-boot-project/spring-boot-tools/spring-boot-test-support-docker/src/main/java/org/springframework/boot/testsupport/container/RedisStackContainer.java new file mode 100644 index 0000000000..47ba11cd58 --- /dev/null +++ b/spring-boot-project/spring-boot-tools/spring-boot-test-support-docker/src/main/java/org/springframework/boot/testsupport/container/RedisStackContainer.java @@ -0,0 +1,35 @@ +/* + * Copyright 2012-2024 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.boot.testsupport.container; + +import org.testcontainers.containers.GenericContainer; +import org.testcontainers.utility.DockerImageName; + +/** + * A {@link GenericContainer} for Redis Stack. + * + * @author Andy Wilkinson + * @author Madhura Bhave + */ +public class RedisStackContainer extends GenericContainer { + + public RedisStackContainer(DockerImageName dockerImageName) { + super(dockerImageName); + addExposedPorts(6379); + } + +} diff --git a/spring-boot-project/spring-boot-tools/spring-boot-test-support-docker/src/main/java/org/springframework/boot/testsupport/container/RedisStackServerContainer.java b/spring-boot-project/spring-boot-tools/spring-boot-test-support-docker/src/main/java/org/springframework/boot/testsupport/container/RedisStackServerContainer.java new file mode 100644 index 0000000000..fc891b47da --- /dev/null +++ b/spring-boot-project/spring-boot-tools/spring-boot-test-support-docker/src/main/java/org/springframework/boot/testsupport/container/RedisStackServerContainer.java @@ -0,0 +1,35 @@ +/* + * Copyright 2012-2024 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.boot.testsupport.container; + +import org.testcontainers.containers.GenericContainer; +import org.testcontainers.utility.DockerImageName; + +/** + * A {@link GenericContainer} for Redis Stack Server. + * + * @author Andy Wilkinson + * @author Madhura Bhave + */ +public class RedisStackServerContainer extends GenericContainer { + + public RedisStackServerContainer(DockerImageName dockerImageName) { + super(dockerImageName); + addExposedPorts(6379); + } + +} diff --git a/spring-boot-project/spring-boot-tools/spring-boot-test-support-docker/src/main/java/org/springframework/boot/testsupport/container/TestImage.java b/spring-boot-project/spring-boot-tools/spring-boot-test-support-docker/src/main/java/org/springframework/boot/testsupport/container/TestImage.java index 1cbb70d33c..0c3c024a02 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-test-support-docker/src/main/java/org/springframework/boot/testsupport/container/TestImage.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-test-support-docker/src/main/java/org/springframework/boot/testsupport/container/TestImage.java @@ -186,12 +186,16 @@ public enum TestImage { /** * A container image suitable for testing Redis Stack. */ - REDIS_STACK("redis/redis-stack", "7.2.0-v11"), + REDIS_STACK("redis/redis-stack", "7.2.0-v11", () -> RedisStackContainer.class, + (container) -> ((RedisStackContainer) container).withStartupAttempts(5) + .withStartupTimeout(Duration.ofMinutes(10))), /** * A container image suitable for testing Redis Stack Server. */ - REDIS_STACK_SERVER("redis/redis-stack-server", "7.2.0-v11"), + REDIS_STACK_SERVER("redis/redis-stack-server", "7.2.0-v11", () -> RedisStackServerContainer.class, + (container) -> ((RedisStackServerContainer) container).withStartupAttempts(5) + .withStartupTimeout(Duration.ofMinutes(10))), /** * A container image suitable for testing Redpanda. @@ -281,6 +285,10 @@ public enum TestImage { this(name, tag, containerClass, null); } + TestImage(String name, String tag, Consumer containerSetup) { + this(name, tag, null, containerSetup); + } + TestImage(String name, String tag, Supplier> containerClass, Consumer containerSetup) { this.name = name; this.tag = tag;