[spring test] TestContainer 로 Redis 의존성 해결하기

TestContainer

TestContainer 초기 설정 및 기능 설명

TestContainer 기능

자바 코드로 docker image를 띄우는 Junit 의 기능이라 생각하면 된다.

즉, 자바 코드로 구현하는 docker compose라 생각하면 된다.

TestContainer 사용 이유

redis를 단위 테스트를 하기 위해서 여러가지 방안을 찾아봤다. 일단 지금 현재 프로젝트가 H2로 embeded test로 진행됐으니 embended redis가 있는지 찾아봤다.

 

https://github.com/ozimov/embedded-redis

GitHub - ozimov/embedded-redis: Redis embedded server

 

 

embeded redis 를 지원하는 오픈소스가 존재했고 실제로 이렇게 적용한 사례들도 몇몇 있었지만 블로그나 다른 의견에서 오류 점이 많이 있다하는 말도 있었고 무엇보다 마지막 commit이 4년전이라 내키지 않게 됐다.

embeded redis를 사용하는거에 대한 부정적인 블로그 참고자료

스프링 Redis 테스트 환경 구축하기 (Embedded Redis, TestContainer) — devoong2 (tistory.com)

Spring에서 Redis Test 하기 — 기러기는 기록기록 (tistory.com)

TestContainer 초기 설정

    // test-containers
    testImplementation "org.testcontainers:testcontainers:1.19.0"
    testImplementation "org.testcontainers:junit-jupiter:1.19.0"

 

@Configuration
public class RedisConfig {

	private static final String REDIS_IMAGE = "redis:7.0.8-alpine";
	private static final int REDIS_PORT = 6379;  // 기본 포트로 변경
	private static final GenericContainer<?> REDIS_CONTAINER = new GenericContainer<>(REDIS_IMAGE)
		.withExposedPorts(REDIS_PORT)
		.withReuse(true);

	static {
		REDIS_CONTAINER.start();
	}

	@Bean
	public LettuceConnectionFactory redisConnectionFactory() {
		RedisStandaloneConfiguration configuration = new RedisStandaloneConfiguration(
			REDIS_CONTAINER.getHost(), REDIS_CONTAINER.getMappedPort(REDIS_PORT)
		);
		return new LettuceConnectionFactory(configuration);
	}
}

 

	private static final String REDIS_IMAGE = "redis:7.0.8-alpine";
	private static final int REDIS_PORT = 6379;  // 기본 포트로 변경
	private static final GenericContainer<?> REDIS_CONTAINER = new GenericContainer<>(REDIS_IMAGE)
		.withExposedPorts(REDIS_PORT)
		.withReuse(true);

	static {
		REDIS_CONTAINER.start();
	}

위 설정대로면 docker container가 test 실행시 2개가 띄워진다.(docker demon 이 실행중이어야 한다)

위처럼 docker 가 띄워지고 redis container 와 ryuk container 2개가 띄워진다.

ryuk container는 일종의 회수하는 container라고 생각하면 된다( 이부분은 깊게 공부 못함)

그리고 redis를 띄우기만 하지말고 redis conection 을 맺어야 한다.

헤맨 경험

처음에는 SpringBootTest 를 실행하면 Spring이 부팅되니까 Spring Data Redis에서 프로퍼티로 redis 커넥션 맺어주는 거처럼 해주는 줄 알고 다음과 같이 구성했었다.

public class RedisConfig {

	private static final String REDIS_IMAGE = "redis:7.0.8-alpine";
	private static final int REDIS_PORT = 6379;  // 기본 포트로 변경
	private static final GenericContainer<?> REDIS_CONTAINER = new GenericContainer<>(REDIS_IMAGE)
		.withExposedPorts(REDIS_PORT)
		.withReuse(true);

	static {
		REDIS_CONTAINER.start();
    System.setProperty("spring.data.redis.host", REDIS_CONTAINER.getHost());
    System.setProperty("spring.data.redis.port", REDIS_CONTAINER.getMappedPort(REDIS_PORT).toString());
	}
}

하지만 Spring Data Redis가 connection을 안맺어주는건지 test 환경에서는 안맺어주는건지 아니면 내가 잘못 설정한건지 test 실패를 하였고 경고 문자에서는 connection 실패가 계속 되었다.

따라서 다른 블로그를 훑어보니까 Test 환경에서 Redis Config 를 따로 설정해주었길래 아직 프로젝트에서 Redis Template을 안쓰기에 RedisConfig 에 다음과 같이 connection을 구성해주었다.

	@Bean
	public LettuceConnectionFactory redisConnectionFactory() {
		RedisStandaloneConfiguration configuration = new RedisStandaloneConfiguration(
			REDIS_CONTAINER.getHost(), REDIS_CONTAINER.getMappedPort(REDIS_PORT)
		);
		return new LettuceConnectionFactory(configuration);
	}

추가 정보

SpringBoot가 지원하는 TestContainer 기능

Improved Testcontainers Support in Spring Boot 3.1

Spring Boot에서 3.1 부터 TestContainer 의 인스턴스와 연결을 더욱 쉽게 어노테이션으로 지원해주는 기능이 있다는 글을 봐서 추후에 코드를 개선할 예정이다.

DockerCompose로 Container 구성하기

testContainer도 Docker를 사용하기 때문에 DockerCompose에 명세되어 있는대로 Container 환경을 구성하는 기능을 지원하는 것 같다.

활용사례

https://sg-choi.tistory.com/543

[Spring] Testcontainers

 

    @Override
    public void initialize(ConfigurableApplicationContext context) {
        DockerComposeContainer<?> container = new DockerComposeContainer(new File("src/test/resources/docker-compose.yml"))
            .withExposedService(REDIS_NAME, REDIS_PORT)
            .withExposedService(MYSQL_NAME, MYSQL_PORT);

        container.start();

공식문서에서 제공한 TestContainer 예제와 동적 프로퍼티 설정

Context Configuration with Dynamic Property Sources :: Spring Framework

@SpringJUnitConfig
@Testcontainers
class ExampleIntegrationTests {

    @Container
    static GenericContainer redis = 
        new GenericContainer("redis:5.0.3-alpine").withExposedPorts(6379);

    @DynamicPropertySource
    static void redisProperties(DynamicPropertyRegistry registry) {
        registry.add("redis.host", redis::getHost);
        registry.add("redis.port", redis::getFirstMappedPort);
    }

    // tests ...
}