[java] TestContainers를 사용하여 분산 시스템 테스트하기

16 Nov 2023

java

소개

TestContainers는 개발자들이 로컬 환경에서 실제 분산 시스템과 통합 테스트를 수행할 수 있도록 도와주는 도구입니다. 이 라이브러리를 사용하면 테스트 실행 중에 실제 컨테이너를 시작하고 종료할 수 있습니다. 따라서 실제 환경에서 시스템이 어떻게 작동하는지를 더욱 신뢰할 수 있게 확인할 수 있습니다.

설치

Maven 또는 Gradle을 사용하는 경우, pom.xml 또는 build.gradle 파일에 TestContainers를 추가합니다.

Maven:

<dependency>
    <groupId>org.testcontainers</groupId>
    <artifactId>testcontainers</artifactId>
    <version>1.15.3</version>
    <scope>test</scope>
</dependency>

Gradle:

testImplementation 'org.testcontainers:testcontainers:1.15.3'

사용법

TestContainers를 사용하려면 초기화 코드와 테스트 코드가 필요합니다. 먼저 테스트 클래스의 @BeforeAll 메서드에서 초기화 코드를 작성합니다. 이 코드는 테스트 스위트가 시작되기 전에 실행됩니다.

@BeforeAll
static void init() {
    // Docker Compose 파일을 사용하여 컨테이너 시작
    DockerComposeContainer<?> environment = new DockerComposeContainer<>(new File("docker-compose.yml"))
            .withPull(false)
            .withLogConsumer(new Slf4jLogConsumer(LoggerFactory.getLogger("testcontainers")));

    environment.start();
}

이제 테스트 클래스에서 분산 시스템과 통합 테스트 코드를 작성할 수 있습니다. TestContainers는 테스트를 위해 컨테이너를 시작하고 종료하는 데 도움이 됩니다.

@Test
void testDistributedSystem() {
    // 분산 시스템과 상호작용하는 코드 작성
}

예제

다음은 TestContainers를 사용하여 분산 시스템을 테스트하는 예제입니다.

public class DistributedSystemIntegrationTest {

    @BeforeAll
    static void init() {
        DockerComposeContainer<?> environment = new DockerComposeContainer<>(new File("docker-compose.yml"))
                .withPull(false)
                .withLogConsumer(new Slf4jLogConsumer(LoggerFactory.getLogger("testcontainers")));

        environment.start();
    }

    @Test
    void testDistributedSystem() {
        // 분산 시스템과 상호작용하는 코드 작성
    }
}

이 예제에서는 docker-compose.yml 파일을 사용하여 컨테이너를 정의하고 테스트 스위트가 시작되기 전에 이 파일을 통해 컨테이너를 시작합니다. 그런 다음 testDistributedSystem() 메서드에서 분산 시스템과 상호작용하는 테스트 코드를 작성할 수 있습니다.

결론

TestContainers는 개발자들이 로컬 환경에서 분산 시스템과의 통합 테스트를 수행할 수 있도록 도와줍니다. 이 라이브러리를 사용하면 테스트 중에 실제 환경을 구축하고 테스트를 실행할 수 있습니다. 이를 통해 시스템이 예상대로 작동하는지 확신할 수 있습니다.