Skip to content

Commit

Permalink
Add service connection from redis/redis-stack and redis/redis-stack-s…
Browse files Browse the repository at this point in the history
…erver

* Add new images to `RedisDockerComposeConnectionDetailsFactory`
* Support more than one connection name in `ContainerConnectionDetailsFactory`
* Add new images to `RedisContainerConnectionDetailsFactory`
  • Loading branch information
eddumelendez committed Jul 5, 2024
1 parent 2a20ceb commit 8acb5f9
Show file tree
Hide file tree
Showing 9 changed files with 187 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
* @author Andy Wilkinson
* @author Phillip Webb
* @author Scott Frederick
* @author Eddú Meléndez
*/
class RedisDockerComposeConnectionDetailsFactoryIntegrationTests {

Expand All @@ -43,6 +44,16 @@ void runWithBitnamiImageCreatesConnectionDetails(RedisConnectionDetails connecti
assertConnectionDetails(connectionDetails);
}

@DockerComposeTest(composeFile = "redis-compose.yaml", image = TestImage.REDIS_STACK)
void runWithRedisStackCreatesConnectionDetails(RedisConnectionDetails connectionDetails) {
assertConnectionDetails(connectionDetails);
}

@DockerComposeTest(composeFile = "redis-compose.yaml", image = TestImage.REDIS_STACK_SERVER)
void runWithRedisStackServerCreatesConnectionDetails(RedisConnectionDetails connectionDetails) {
assertConnectionDetails(connectionDetails);
}

private void assertConnectionDetails(RedisConnectionDetails connectionDetails) {
assertThat(connectionDetails.getUsername()).isNull();
assertThat(connectionDetails.getPassword()).isNull();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,17 @@
* @author Andy Wilkinson
* @author Phillip Webb
* @author Scott Frederick
* @author Eddú Meléndez
*/
class RedisDockerComposeConnectionDetailsFactory extends DockerComposeConnectionDetailsFactory<RedisConnectionDetails> {

private static final String[] REDIS_CONTAINER_NAMES = { "redis", "bitnami/redis" };
private static final String[] REDIS_IMAGE_NAMES = { "redis", "bitnami/redis", "redis/redis-stack",
"redis/redis-stack-server" };

private static final int REDIS_PORT = 6379;

RedisDockerComposeConnectionDetailsFactory() {
super(REDIS_CONTAINER_NAMES);
super(REDIS_IMAGE_NAMES);
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ The following service connections are currently supported:
| Containers named "rabbitmq" or "bitnami/rabbitmq"

| `RedisConnectionDetails`
| Containers named "redis" or "bitnami/redis"
| Containers named "redis", "bitnami/redis", "redis/redis-stack" or "redis/redis-stack-server"

| `ZipkinConnectionDetails`
| Containers named "openzipkin/zipkin".
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ The following service connection factories are provided in the `spring-boot-test
| Containers of type `RabbitMQContainer`

| `RedisConnectionDetails`
| Containers named "redis"
| Containers named "redis", "redis/redis-stack" or "redis/redis-stack-server"

| `ZipkinConnectionDetails`
| Containers named "openzipkin/zipkin"
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
/*
* 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 RedisStackContainerConnectionDetailsFactoryTests {

@Container
@ServiceConnection
static final GenericContainer<?> redis = TestImage.REDIS_STACK.genericContainer().withExposedPorts(6379);

@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 {

}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
/*
* 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 RedisStackServerContainerConnectionDetailsFactoryTests {

@Container
@ServiceConnection
static final GenericContainer<?> redis = TestImage.REDIS_STACK_SERVER.genericContainer().withExposedPorts(6379);

@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 {

}

}
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
* @author Moritz Halbritter
* @author Andy Wilkinson
* @author Phillip Webb
* @author Eddú Meléndez
* @since 3.1.0
*/
public abstract class ContainerConnectionDetailsFactory<C extends Container<?>, D extends ConnectionDetails>
Expand All @@ -61,7 +62,7 @@ public abstract class ContainerConnectionDetailsFactory<C extends Container<?>,
*/
protected static final String ANY_CONNECTION_NAME = null;

private final String connectionName;
private final String[] connectionNames;

private final String[] requiredClassNames;

Expand All @@ -80,7 +81,12 @@ protected ContainerConnectionDetailsFactory() {
* @param requiredClassNames the names of classes that must be present
*/
protected ContainerConnectionDetailsFactory(String connectionName, String... requiredClassNames) {
this.connectionName = connectionName;
this.connectionNames = new String[] { connectionName };
this.requiredClassNames = requiredClassNames;
}

protected ContainerConnectionDetailsFactory(String[] connectionNames, String... requiredClassNames) {
this.connectionNames = connectionNames;
this.requiredClassNames = requiredClassNames;
}

Expand All @@ -93,8 +99,10 @@ public final D getConnectionDetails(ContainerConnectionSource<C> source) {
Class<?>[] generics = resolveGenerics();
Class<?> containerType = generics[0];
Class<?> connectionDetailsType = generics[1];
if (source.accepts(this.connectionName, containerType, connectionDetailsType)) {
return getContainerConnectionDetails(source);
for (String connectionName : this.connectionNames) {
if (source.accepts(connectionName, containerType, connectionDetailsType)) {
return getContainerConnectionDetails(source);
}
}
}
catch (NoClassDefFoundError ex) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2023 the original author or authors.
* 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.
Expand Down Expand Up @@ -32,12 +32,16 @@
* @author Moritz Halbritter
* @author Andy Wilkinson
* @author Phillip Webb
* @author Eddú Meléndez
*/
class RedisContainerConnectionDetailsFactory
extends ContainerConnectionDetailsFactory<Container<?>, RedisConnectionDetails> {

private static final String[] REDIS_IMAGE_NAMES = { "redis", "bitnami/redis", "redis/redis-stack",
"redis/redis-stack-server" };

RedisContainerConnectionDetailsFactory() {
super("redis");
super(REDIS_IMAGE_NAMES);
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,16 @@ public enum TestImage {
(container) -> ((RedisContainer) container).withStartupAttempts(5)
.withStartupTimeout(Duration.ofMinutes(10))),

/**
* A container image suitable for testing Redis Stack.
*/
REDIS_STACK("redis/redis-stack", "7.2.0-v11"),

/**
* A container image suitable for testing Redis Stack Server.
*/
REDIS_STACK_SERVER("redis/redis-stack-server"),

/**
* A container image suitable for testing Redpanda.
*/
Expand Down

0 comments on commit 8acb5f9

Please sign in to comment.