Move Redis testcontainers support into spring-boot-data-redis

spring-boot-project/spring-boot-data-redis/src/dockerTest/java/org/springframework/boot/data/redis/testcontainers/CustomRedisContainerConnectionDetailsFactoryTests.java

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2012-2025 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.data.redis.testcontainers;
+
+import java.util.Map;
+
+import com.redis.testcontainers.RedisContainer;
+import com.redis.testcontainers.RedisStackContainer;
+import org.junit.jupiter.api.Test;
+
+import org.springframework.boot.autoconfigure.service.connection.ConnectionDetails;
+import org.springframework.boot.autoconfigure.service.connection.ConnectionDetailsFactories;
+import org.springframework.boot.data.redis.autoconfigure.RedisConnectionDetails;
+import org.springframework.boot.testcontainers.service.connection.ContainerConnectionSource;
+import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
+import org.springframework.boot.testcontainers.service.connection.TestContainerConnectionSource;
+import org.springframework.core.annotation.MergedAnnotation;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Test for {@link RedisContainerConnectionDetailsFactory} when using a custom container
+ * without "redis" as the name.
+ *
+ * @author Phillip Webb
+ */
+class CustomRedisContainerConnectionDetailsFactoryTests {
+
+	@Test
+	void getConnectionDetailsWhenRedisContainerWithCustomName() {
+		ConnectionDetailsFactories factories = new ConnectionDetailsFactories(null);
+		MergedAnnotation<ServiceConnection> annotation = MergedAnnotation.of(ServiceConnection.class,
+				Map.of("value", ""));
+		ContainerConnectionSource<RedisContainer> source = TestContainerConnectionSource.create("test", null,
+				RedisContainer.class, "mycustomimage", annotation, null);
+		Map<Class<?>, ConnectionDetails> connectionDetails = factories.getConnectionDetails(source, true);
+		assertThat(connectionDetails.get(RedisConnectionDetails.class)).isNotNull();
+	}
+
+	@Test
+	void getConnectionDetailsWhenRedisStackContainerWithCustomName() {
+		ConnectionDetailsFactories factories = new ConnectionDetailsFactories(null);
+		MergedAnnotation<ServiceConnection> annotation = MergedAnnotation.of(ServiceConnection.class,
+				Map.of("value", ""));
+		ContainerConnectionSource<RedisStackContainer> source = TestContainerConnectionSource.create("test", null,
+				RedisStackContainer.class, "mycustomimage", annotation, null);
+		Map<Class<?>, ConnectionDetails> connectionDetails = factories.getConnectionDetails(source, true);
+		assertThat(connectionDetails.get(RedisConnectionDetails.class)).isNotNull();
+	}
+
+}

spring-boot-project/spring-boot-data-redis/src/dockerTest/java/org/springframework/boot/data/redis/testcontainers/RedisContainerConnectionDetailsFactoryTests.java

@@ -0,0 +1,70 @@
+/*
+ * Copyright 2012-2025 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.data.redis.testcontainers;
+
+import com.redis.testcontainers.RedisContainer;
+import org.junit.jupiter.api.Test;
+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.data.redis.autoconfigure.RedisAutoConfiguration;
+import org.springframework.boot.data.redis.autoconfigure.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
+ */
+@SpringJUnitConfig
+@Testcontainers(disabledWithoutDocker = true)
+class RedisContainerConnectionDetailsFactoryTests {
+
+	@Container
+	@ServiceConnection
+	static final RedisContainer redis = TestImage.container(RedisContainer.class);
+
+	@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 {
+
+	}
+
+}

spring-boot-project/spring-boot-data-redis/src/dockerTest/java/org/springframework/boot/data/redis/testcontainers/RedisStackContainerConnectionDetailsFactoryTests.java

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2012-2025 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.data.redis.testcontainers;
+
+import com.redis.testcontainers.RedisStackContainer;
+import org.junit.jupiter.api.Test;
+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.data.redis.autoconfigure.RedisAutoConfiguration;
+import org.springframework.boot.data.redis.autoconfigure.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 RedisStackContainerConnectionDetailsFactoryTests {
+
+	@Container
+	@ServiceConnection
+	static final RedisStackContainer redis = TestImage.container(RedisStackContainer.class);
+
+	@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 {
+
+	}
+
+}

spring-boot-project/spring-boot-data-redis/src/dockerTest/java/org/springframework/boot/data/redis/testcontainers/RedisStackServerContainerConnectionDetailsFactoryTests.java

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2012-2025 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.data.redis.testcontainers;
+
+import org.junit.jupiter.api.Test;
+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.data.redis.autoconfigure.RedisAutoConfiguration;
+import org.springframework.boot.data.redis.autoconfigure.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;
+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 RedisStackServerContainerConnectionDetailsFactoryTests {
+
+	@Container
+	@ServiceConnection
+	static final RedisStackServerContainer redis = TestImage.container(RedisStackServerContainer.class);
+
+	@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 {
+
+	}
+
+}

spring-boot-project/spring-boot-data-redis/src/dockerTest/resources/logback-test.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+	<include resource="org/springframework/boot/logging/logback/base.xml"/>
+</configuration>

spring-boot-project/spring-boot-data-redis/src/dockerTest/resources/spring.properties

@@ -0,0 +1 @@
+spring.test.context.cache.maxSize=1

spring-boot-project/spring-boot-data-redis/src/main/java/org/springframework/boot/data/redis/testcontainers/RedisContainerConnectionDetailsFactory.java

@@ -0,0 +1,86 @@
+/*
+ * Copyright 2012-2025 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.data.redis.testcontainers;
+
+import java.util.List;
+
+import com.redis.testcontainers.RedisContainer;
+import com.redis.testcontainers.RedisStackContainer;
+import org.testcontainers.containers.Container;
+import org.testcontainers.containers.GenericContainer;
+
+import org.springframework.boot.data.redis.autoconfigure.RedisConnectionDetails;
+import org.springframework.boot.testcontainers.service.connection.ContainerConnectionDetailsFactory;
+import org.springframework.boot.testcontainers.service.connection.ContainerConnectionSource;
+import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
+
+/**
+ * {@link ContainerConnectionDetailsFactory} to create {@link RedisConnectionDetails} from
+ * a {@link ServiceConnection @ServiceConnection}-annotated {@link GenericContainer} using
+ * the {@code "redis"} image.
+ *
+ * @author Moritz Halbritter
+ * @author Andy Wilkinson
+ * @author Phillip Webb
+ * @author Eddú Meléndez
+ */
+class RedisContainerConnectionDetailsFactory
+		extends ContainerConnectionDetailsFactory<Container<?>, RedisConnectionDetails> {
+
+	private static final List<String> REDIS_IMAGE_NAMES = List.of("redis", "bitnami/redis", "redis/redis-stack",
+			"redis/redis-stack-server");
+
+	private static final int REDIS_PORT = 6379;
+
+	RedisContainerConnectionDetailsFactory() {
+		super(REDIS_IMAGE_NAMES);
+	}
+
+	@Override
+	protected boolean sourceAccepts(ContainerConnectionSource<Container<?>> source, Class<?> requiredContainerType,
+			Class<?> requiredConnectionDetailsType) {
+		return super.sourceAccepts(source, requiredContainerType, requiredConnectionDetailsType)
+				|| source.accepts(ContainerConnectionDetailsFactory.ANY_CONNECTION_NAME, RedisContainer.class,
+						requiredConnectionDetailsType)
+				|| source.accepts(ContainerConnectionDetailsFactory.ANY_CONNECTION_NAME, RedisStackContainer.class,
+						requiredConnectionDetailsType);
+	}
+
+	@Override
+	protected RedisConnectionDetails getContainerConnectionDetails(ContainerConnectionSource<Container<?>> source) {
+		return new RedisContainerConnectionDetails(source);
+	}
+
+	/**
+	 * {@link RedisConnectionDetails} backed by a {@link ContainerConnectionSource}.
+	 */
+	private static final class RedisContainerConnectionDetails extends ContainerConnectionDetails<Container<?>>
+			implements RedisConnectionDetails {
+
+		private RedisContainerConnectionDetails(ContainerConnectionSource<Container<?>> source) {
+			super(source);
+		}
+
+		@Override
+		public Standalone getStandalone() {
+			return Standalone.of(getContainer().getHost(), getContainer().getMappedPort(REDIS_PORT),
+					super.getSslBundle());
+		}
+
+	}
+
+}

spring-boot-project/spring-boot-data-redis/src/main/java/org/springframework/boot/data/redis/testcontainers/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2012-2025 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.
+ */
+
+/**
+ * Support for testcontainers Redis service connections.
+ */
+package org.springframework.boot.data.redis.testcontainers;

spring-boot-project/spring-boot-data-redis/src/main/resources/META-INF/spring.factories

@@ -1,3 +1,7 @@
+# Connection Details Factories
+org.springframework.boot.autoconfigure.service.connection.ConnectionDetailsFactory=\
+org.springframework.boot.data.redis.testcontainers.RedisContainerConnectionDetailsFactory
+
 # Failure Analyzers
 org.springframework.boot.diagnostics.FailureAnalyzer=\
 org.springframework.boot.data.redis.autoconfigure.RedisUrlSyntaxFailureAnalyzer