4-1 [통합TEST] testcontainers 사용하기 위한 설정 및 간단한 DB TEST

- 이번 4장에서는 테스트가 수행되는 동안 동적으로 컨테이너를 생성하고 종료하는 작업을 수행하도록 하겠습니다.

 

출처 :  인프런 강의 [쥬쥬와 함께 하루만에 끝내는 스프링 테스트]

1. 테스트 시작 : 테스트를 시작합니다.
2. 컨테이너 생성 : testcontainers가 Docker를 이용해 테스트 필요한 컨테이너들(MySQL, Redis 등..)을 생성합니다.
3. 동적 프로퍼티 주입 : 생성한 컨테이너의 정보를 기반으로 스프링 프로퍼티 동적으로 주입(overwrite)합니다.
4. 테스트 수행 : 생성한 컨테이너를 활용하여 테스트를 수행합니다.
5. 테스트 종료: 테스트 종료와 동시에 생성했던 컨테이너들을 정리합니다.

1.  testcontainers 사용하기 위해 설정 및 간단한 DB TEST

1) build.gradle

	...
	testImplementation "org.testcontainers:testcontainers:1.19.0"			// testcontainers
}

 

2) infra/test/docker-compose.yaml

# infra/test/docker-compose.yaml

version: "3.8"

services:
  local-db:
    image: mysql:8
    environment:
      MYSQL_DATABASE: score
      MYSQL_ROOT_PASSWORD: password
    ports:
      - 3306
  local-db-migrate:
    image: flyway/flyway:7
    restart: always
    environment:
      - FLYWAY_DB_URL=jdbc:mysql://local-db/score
      - FLYWAY_DB_USER=root
      - FLYWAY_DB_PASSWORD=password
    command: migrate
    volumes:
      - ../../db/flyway.conf:/flyway/conf/flyway.conf
      - ../../db/migration:/flyway/sql

3) IntegrationTest.class

- 위치 : com.pcy.dayonetest (test)

@Ignore
@Transactional
@SpringBootTest
@ContextConfiguration(initializers = IntegrationTest.IntegrationTestInitializer.class)
public class IntegrationTest {

    static DockerComposeContainer rdbms;

    static {
        rdbms = new DockerComposeContainer(new File("infra/test/docker-compose.yaml"))
                .withExposedService(
                        "local-db",
                        3306,
                        Wait.forLogMessage(".*ready for connections.*", 1)
                                .withStartupTimeout(Duration.ofSeconds(300))
                )
                .withExposedService(
                        "local-db-migrate",
                        0,
                        Wait.forLogMessage("(.*Successfully applied.*)|(.*Successfully validated.*)", 1)
                                .withStartupTimeout(Duration.ofSeconds(300))
                );

        rdbms.start();
    }

    static class IntegrationTestInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
        @Override
        public void initialize(ConfigurableApplicationContext applicationContext) {
            Map<String, String> properties = new HashMap<>();

            String rdbmsHost  = rdbms.getServiceHost("local-db", 3306);
            Integer rdbmsPort = rdbms.getServicePort("local-db", 3306);

            properties.put("spring.datasource.url", "jdbc:mysql://" + rdbmsHost + ":" + rdbmsPort + "/score");
            TestPropertyValues.of(properties).applyTo(applicationContext);
        }
    }
}

 

- Docker Compose를 사용하여 데이터베이스 환경을 설정하고, 테스트 중에 해당 환경을 사용할 수 있도록 구성합니다.

  아래에서 각 부분을 자세히 설명하겠습니다.

 

[1] 어노테이션

• @Ignore: 이 테스트 클래스를 무시하도록 지정합니다. 실제 테스트를 실행하지 않도록 할 때 사용됩니다.
• @Transactional: 테스트 메서드가 트랜잭션 내에서 실행되도록 하여, 테스트가 끝난 후 데이터베이스의 상태를 롤백합니다.
• @SpringBootTest: Spring Boot 애플리케이션 컨텍스트를 로드하여 통합 테스트를 수행합니다.
• @ContextConfiguration: initializers 속성을 사용하여 테스트 컨텍스트 초기화를 설정합니다. 여기서 IntegrationTestInitializer 클래스를 사용합니다.

 

[2] Docker Compose 설정

• DockerComposeContainer: Testcontainers 라이브러리를 사용하여 Docker Compose 환경을 설정합니다.

• new File("infra/test/docker-compose.yaml"): docker-compose.yaml 파일의 경로를 지정합니다.

• withExposedService: Docker Compose에서 노출할 서비스를 설정합니다.

  - local-db: 데이터베이스 서비스.

  - 3306: 데이터베이스 포트.

  - Wait.forLogMessage: 로그 메시지를 기다려서 서비스가 준비되었는지 확인합니다.

  - withStartupTimeout: 서비스가 준비될 때까지의 타임아웃을 설정합니다.

  - local-db-migrate: 데이터베이스 마이그레이션 서비스.

  - 0: 임의의 포트 사용.

• rdbms.start(): Docker Compose 컨테이너를 시작합니다.

 

[3] 컨텍스트 초기화

• IntegrationTestInitializer: 애플리케이션 컨텍스트를 초기화하는 클래스입니다.

• initialize: 컨텍스트 초기화 메서드입니다.

• rdbmsHost: Docker Compose에서 설정한 데이터베이스의 호스트 주소를 가져옵니다.

• rdbmsPort: Docker Compose에서 설정한 데이터베이스의 포트를 가져옵니다.

• properties.put: 데이터베이스 연결 URL을 설정합니다.

• TestPropertyValues.of(properties).applyTo(applicationContext): 설정한 프로퍼티 값을 애플리케이션 컨텍스트에 적용합니다.

 

** 

이 코드는 Docker Compose를 사용하여 통합 테스트를 위한 데이터베이스 환경을 설정하고, Spring Boot 애플리케이션 컨텍스트 초기화 시 해당 데이터베이스 환경을 사용할 수 있도록 구성합니다. 이를 통해 실제 데이터베이스와 유사한 환경에서 통합 테스트를 수행할 수 있습니다.

**

4) DayonetestApplicationTests.class

- 위치 : com.pcy.dayonetest (test)

 

[1] 상속처리

@SpringBootTest
class DayonetestApplicationTests extends IntegrationTest {

	@Test
	void contextLoads() {
	}

}

- IntegrationTest 상속받아서 실행을 하면 아래와 같이 TEST 컨테이너가 수행되는 것을 확인 할 수 있습니다(테스트 수행중에만)

 

테스트 수행 중

테스트 종료 후

[2] 실제로 MySQL에 입력 및 입력 데이터 확인

@SpringBootTest
class DayonetestApplicationTests extends IntegrationTest {

	@Autowired
	private StudentScoreRepository studentScoreRepository;

	@Autowired
	private EntityManager entityManager;

	@Test
	void contextLoads() {
		StudentScore studentScore = StudentScoreTestDataBuilder.passed()
				.studentName("pcy")     // 오버라이딩 사용 가능
				.build();
		StudentScore savedStudentScore = studentScoreRepository.save(studentScore);

		entityManager.flush();
		entityManager.clear();

		StudentScore queryStudentScore = studentScoreRepository.findById(savedStudentScore.getId()).orElseThrow();
		Assertions.assertEquals(savedStudentScore, savedStudentScore);
	}

}

• @Autowired: Spring의 의존성 주입을 사용하여 StudentScoreRepository와 EntityManager 인스턴스를 주입합니다.

• studentScoreRepository: StudentScore 엔티티에 대한 데이터베이스 작업을 수행하는 리포지토리입니다.

• entityManager: JPA의 엔티티 매니저로, 데이터베이스 연산을 직접 수행할 수 있습니다.

 

메서드 내부 설명

1. 테스트 데이터 생성

• StudentScoreTestDataBuilder.passed(): StudentScore 객체를 생성하기 위한 빌더 패턴을 사용합니다. 초기 상태로 passed() 메서드를 호출하여 기본 설정을 적용합니다.

• studentName("pcy"): 학생 이름을 “pcy”로 새롭게 설정합니다.

• build(): 설정된 값을 기반으로 StudentScore 객체를 생성합니다.

 

2. 데이터 저장

 

3. 데이터베이스 반영 

• entityManager.flush(): 현재 영속성 컨텍스트에 있는 변경 사항을 데이터베이스에 반영합니다.

• entityManager.clear(): 영속성 컨텍스트를 초기화하여 캐시를 비웁니다. 

 

4. 데이터 조회 및 검증

• studentScoreRepository.findById(savedStudentScore.getId()): 저장된 StudentScore 엔티티를 ID를 기준으로 조회합니다.

• orElseThrow(): 해당 ID로 엔티티를 찾지 못하면 예외를 발생시킵니다.

• Assertions.assertEquals(savedStudentScore, savedStudentScore): 저장된 엔티티와 조회된 엔티티가 동일한지 검증합니다. 

 

 

2. Github으로 확인

전체 파일 확인(현재 변경내역) 
[Github]

[통합TEST] MySQL(RDMS) TEST · pcy4196/dayonetest@aa2924c

참조 : 인프런 강의 [쥬쥬와 함께 하루만에 끝내는 스프링 테스트]