[java] TestContainers로 단위 테스트 작성하는 방법

16 Nov 2023

java

TestContainers는 컨테이너 기반의 단위 테스트를 작성하는 데 도움이 되는 도구입니다. 이 도구를 사용하면 테스트 환경을 컨테이너로 쉽게 만들 수 있으며, 이를 통해 실제 환경과 유사한 조건에서 테스트를 수행할 수 있습니다. 이제 TestContainers를 사용하여 단위 테스트를 작성하는 방법에 대해 알아보도록 하겠습니다.

1. TestContainers 설치

TestContainers를 사용하기 위해 먼저 Maven 또는 Gradle을 통해 필요한 종속성을 설치해야 합니다. 다음은 Maven을 사용하는 경우의 예시입니다:

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

Gradle을 사용한다면 다음과 같이 종속성을 추가하세요:

testImplementation 'org.testcontainers:testcontainers:1.15.0'

2. 컨테이너 설정하기

TestContainers에서는 컨테이너를 사용하여 테스트 환경을 설정합니다. 예를 들어, MySQL 데이터베이스를 사용하는 테스트를 작성한다면 다음과 같이 설정해야 합니다:

import org.junit.jupiter.api.Test;
import org.testcontainers.containers.MySQLContainer;

public class DatabaseTest {

    @Test
    public void testDatabase() {
        try (MySQLContainer<?> container = new MySQLContainer<>("mysql:latest")) {
            container.start();

            // MySQL 컨테이너에 대한 테스트 코드 작성

            container.stop();
        }
    }
}

위의 예시에서는 MySQLContainer를 사용하여 MySQL 컨테이너를 생성하고 시작한 후, 컨테이너를 사용하는 테스트 코드를 작성합니다. 테스트가 완료되면 container.stop()을 호출하여 컨테이너를 종료합니다.

3. 컨테이너 환경 사용하기

TestContainers에서 제공하는 컨테이너는 실제 환경과 유사한 조건을 제공하기 때문에, 컨테이너를 사용하여 테스트 코드를 작성할 수 있습니다. 이를 통해 데이터베이스, 메시지 큐, 웹 서버 등의 인프라 서비스를 테스트할 수 있습니다. 예를 들어, MySQL 데이터베이스 컨테이너를 사용하는 테스트 코드를 다음과 같이 작성할 수 있습니다:

import org.junit.jupiter.api.Test;
import org.testcontainers.containers.MySQLContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;

@Testcontainers
public class DatabaseTest {

    @Container
    private static final MySQLContainer<?> container = new MySQLContainer<>("mysql:latest");

    @Test
    public void testDatabase() {
        container.start();

        // MySQL 컨테이너에 대한 테스트 코드 작성

        container.stop();
    }
}

위의 예시에서는 @Container 어노테이션을 사용하여 MySQL 컨테이너를 정적 필드로 생성합니다. 이렇게 하면 매번 테스트를 실행할 때마다 컨테이너가 생성되지 않고, 한 번 생성된 컨테이너가 재사용됩니다.

4. 추가 설정 및 활용

TestContainers를 통해 단위 테스트를 작성하는 방법에 대해 간단히 알아보았습니다. 이 외에도 TestContainers는 다양한 기능과 설정 옵션을 제공하므로, 자세한 내용은 공식 문서를 참조하는 것을 추천합니다.

위의 링크에서 자세한 정보를 얻을 수 있습니다. TestContainers를 활용하여 컨테이너 기반의 단위 테스트를 작성하면 테스트 환경을 쉽게 구성할 수 있고, 더 견고하고 신뢰할 수 있는 단위 테스트를 작성할 수 있습니다.