TestContainer for Database

5 분 소요

Problem of using embedded database in @DataJpaTest

0. 들어가면서

데이터베이스가 연동된 결합 테스트(integration test)에서 활용할 수 있는 TestContainer에 대해 정리하였습니다.

1. Pain Point of Integration Test with Database

데이터베이스가 필요한 비즈니스 로직을 테스트하기 위해 주로 인-메모리(in-memory) 데이터베이스를 사용합니다. 인-메모리 데이터베이스는 다음과 같은 장점이 있습니다.

메모리 데이터베이스를 사용하기 때문에 실행 속도가 빠릅니다.
테스트마다 메모리에 데이터베이스를 구성하고, 테스트가 종료될 때 삭제하므로 멱등성(idempotent)이 보장됩니다.
- 멱등성이란 여러번 실행하더라도 결과가 바뀌지 않는 성질을 의미합니다.
개발자의 로컬 PC 환경에서 테스트를 실행할 때 별도의 데이터베이스 연결이 필요하지 않습니다.

아쉽게도 메모리 데이터베이스는 만능이 아닙니다. 장점도 많지만, 실제 사용하는 데이터베이스와 다르기 때문에 문제가 발생합니다.

데이터베이스 엔진이 다르게 동작하기 때문에 실제 운영 데이터베이스와 다른 결과를 반환할 수 있습니다.
데이터베이스마다 다른 문법을 사용하기 때문에 대체 가능한 SQL 문법을 찾아야합니다.
- ANSI SQL처럼 표준 문법만으로 비즈니스 기능을 모두 커버하기 어려울 수 있습니다.
- JPQL(Java Persistence Query Lanager)처럼 추상화 된 문법을 사용하더라도 해결하기 어려울 수 있습니다.
데이터베이스 전용 내장 함수를 사용한다면 대체 가능한 함수를 찾아야합니다.

빠른 개발을 위해 메모리 데이터베이스를 사용하고 있었다면, 운영에 진입하기 전엔 운영 환경과 동일한 테스트 환경을 구축해야 합니다. 개발/운영 데이터베이스를 사용한 테스트는 데이터를 오염시킬 위험이 있기 때문에 이를 제외하고 다음과 같은 옵션들이 있습니다.

개발자 로컬 데이터베이스
- 개발자 PC에 로컬 데이터베이스를 설치하고 이를 통해 테스트를 수행합니다.
- 테스트가 끝난 후에 데이터가 남게되면 다음 실행 시 동일한 결과가 얻지 못할 수 있으므로 멱등성 관리가 어렵습니다.
- 개발자마다 로컬 데이터베이스에 관련된 설정이 다를 수 있기 때문에 통일된 설정 파일을 통해 관리하기 어렵습니다.
- CI/CD 파이프라인에서 사용할 수 없습니다.
도커 컴포즈(docker compose)
- yml 파일에 필요한 이미지들을 명세하여 하나의 네트워크로 묶인 컨테이너(container) 그룹을 실행시킵니다.
- 실제 데이터베이스와 동일한 이미지를 기반으로 데이터베이스 컨테이너를 실행시킬 수 있습니다.
- 데이터베이스 컨테이너에 연결하여 테스트를 수행하고, 테스트가 종료되면 컨테이너를 정리합니다.
- 매 테스트마다 초기화 된 데이터베이스에서 테스트를 진행하므로 멱등성 관리가 쉽습니다.
- CI/CD 파이프라인에서 사용 가능합니다.

2. TestContainer

도커 컴포즈는 최적의 선택지처럼 보이지만, 더 간편하게 개선된 테스트 방법도 존재합니다. TestContainer는 도커 컴포즈처럼 테스트를 위해 컨테이너를 실행시킨는 원리는 동일하지만, 프로젝트 설정과 코드만으로 테스트를 위한 컨테이너를 실행시킬 수 있습니다.

Testcontainers for Java is a Java library that supports JUnit tests, providing lightweight, throwaway instances of common databases, Selenium web browsers, or anything else that can run in a Docker container.

TestContainer는 이번 포스트에서 다루는 것처럼 단순히 데이터베이스만 지원하지 않습니다. 쉬운 테스트를 위해 많은 기능들을 컨테이너화할 수 있습니다.

웹 브라우저
- 셀레니움
웹 서버나 프록시
- nginx, 아파치
NoSQL 데이터베이스
- 레디스, 엘라스틱서치, 몽고
로그 서비스
- 카프카, 키바나

3. Practice

간단한 실습을 통해 사용 방법을 알아보겠습니다. 패키지 구조는 다음과 같습니다.

./
├── HELP.md
├── build.gradle
├── gradle
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── settings.gradle
└── src
    ├── main
    │   ├── java
    │   │   └── action
    │   │       └── in
    │   │           └── blog
    │   │               ├── ActionInBlogApplication.java
    │   │               └── post
    │   │                   ├── Post.java
    │   │                   └── PostRepository.java
    │   └── resources
    │       ├── application.properties
    │       ├── static
    │       └── templates
    └── test
        ├── java
        │   └── action
        │       └── in
        │           └── blog
        │               └── ApplicationIT.java
        └── resources
            ├── application-test.yml
            └── logback-test.xml

3.1. build.gradle

TestContainer 관련된 의존성을 추가합니다.
- org.testcontainers:mysql:1.18.0
- org.testcontainers:junit-jupiter:1.18.0
테스트에 사용할 데이터베이스는 MySQL이므로 관련된 의존성을 추가합니다.
- mysql:mysql-connector-java:8.0.32

plugins {
    id 'java'
    id 'org.springframework.boot' version '3.0.5'
    id 'io.spring.dependency-management' version '1.1.0'
}

group = 'action.in.blog'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '17'

configurations {
    compileOnly {
        extendsFrom annotationProcessor
    }
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation group: 'mysql', name: 'mysql-connector-java', version: '8.0.32'
    compileOnly 'org.projectlombok:lombok'
    annotationProcessor 'org.projectlombok:lombok'

    testCompileOnly 'org.projectlombok:lombok'
    testAnnotationProcessor 'org.projectlombok:lombok'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
    testImplementation 'org.testcontainers:mysql:1.18.0'
    testImplementation group: 'org.testcontainers', name: 'junit-jupiter', version: '1.18.0'
}

tasks.named('test') {
    useJUnitPlatform()
}

3.2. application-test.yml

프로파일(profile)이 test로 설정된 경우 사용하는 설정 파일입니다.
컨테이너 URL정보를 입력합니다.
- jdbc:tc:mysql:8.0.32:///{database_name}
테스트 컨테이너에 접근할 때 사용하는 드라이버를 지정합니다.
- ContainerDatabaseDriver를 사용하지만, 내부에서 MySQL 드라이버를 사용하기 때문에 커넥터 의존성이 필요합니다.
간편한 테스트를 위해 스키마를 자동으로 생성하도록 설정합니다.
- spring.jpa.hibernate.ddl-auto: create-drop
- 운영 환경과 동일한 초기화 스크립트(script)를 사용하는 것도 좋은 방법입니다.
기타 다른 데이터베이스 연결 정보는 아래 링크에서 확인할 수 있습니다.
- https://www.testcontainers.org/modules/databases/jdbc/

spring:
  datasource:
    url: jdbc:tc:mysql:8.0.32:///test
    driver-class-name: org.testcontainers.jdbc.ContainerDatabaseDriver
  jpa:
    hibernate:
      ddl-auto: create-drop

3.3. PostRepository Interface

네이티브(native) 쿼리를 실행하는 메소드를 선언합니다.

package action.in.blog.post;

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.query.Param;

import java.util.List;

public interface PostRepository extends JpaRepository<Post, Long> {

    @Query(value = "select * from post p where p.title like trim(:title)", nativeQuery = true)
    List<Post> findByTitleContainsWithTrim(@Param("title") String title);
}

3.4. ApplicationIT Class

@ActiveProfiles 애너테이션
- 실행 시 프로파일을 test로 지정합니다.
@AutoConfigureTestDatabase 애너테이션
- @DataJpaTest 애너테이션을 사용한 테스트 시 데이터베이스가 바뀌지 않는 현상이 있습니다.
- 설정한 데이터베이스를 사용할 수 있도록 설정합니다.
- Problem of using embedded database in @DataJpaTest 포스트를 참고 바랍니다.
@DataJpaTest 애너테이션
- JPA 테스트를 위한 최소한의 컨텍스트를 준비합니다.
@Testcontainers 애너테이션
- @Container 애너테이션이 붙은 인스턴스들과 연결된 컨테이너들의 라이프사이클을 관리합니다.
@Container 애너테이션
- 테스트 컨테이너를 생성하기 위해 사용합니다.
- 해당 애너테이션이 붙은 필드가 있는 경우 생성될 인스턴스를 통해 컨테이너 생성에 필요한 정보를 파악합니다.
- @TestContainers 애너테이션에 의해 생성, 소멸 라이프사이클이 관리됩니다.
@Container 애너테이션이 붙은 필드에 따라 라이프사이클이 다르게 관리됩니다.
- static 필드는 테스트들 사이에서 공유할 수 있는 컨테이너가 생성되며 한 번만 컨테이너를 실행하고, 마지막 테스트가 종료되면 컨테이너를 소멸시킵니다.
- static 키워드가 붙지 않은 instance 필드는 모든 테스트마다 컨테이너를 실행하고 소멸시킵니다.

package action.in.blog;

import action.in.blog.post.Post;
import action.in.blog.post.PostRepository;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase;
import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
import org.springframework.test.context.ActiveProfiles;
import org.testcontainers.containers.MySQLContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;

import java.util.List;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.core.IsEqual.equalTo;

@ActiveProfiles("test")
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
@DataJpaTest
@Testcontainers
class ApplicationIT {

    @Container
    static MySQLContainer<?> mysqlContainer = new MySQLContainer<>("mysql:8.0.32").withDatabaseName("test");

    @Autowired
    PostRepository sut;

    @Test
    void find_posts_by_title_containing_with_trim() {
        sut.save(
                Post.builder()
                        .title("Hello World")
                        .content("This is sample content")
                        .build()
        );


        List<Post> result = sut.findByTitleContainsWithTrim("       Hello World       ");


        Post firstPost = result.get(0);
        assertThat(result.size(), equalTo(1));
        assertThat(firstPost.getTitle(), equalTo("Hello World"));
        assertThat(firstPost.getContent(), equalTo("This is sample content"));
    }
}

Reulst of Test

Hibernate: select next_val as id_val from post_seq for update
Hibernate: update post_seq set next_val= ? where next_val=?
Hibernate: insert into post (content, title, id) values (?, ?, ?)
Hibernate: select * from post p where p.title like trim(?)

3.5. logback-test.xml

TestContainer를 사용하면 로그가 과도하게 출력됩니다. 이를 방지하기 위해 다음과 같은 로그 설정을 추가합니다.

로그백(logback) 설정을 통해 로그를 제한합니다.

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="STDOUT"/>
    </root>

    <logger name="org.testcontainers" level="INFO"/>
    <!-- The following logger can be used for containers logs since 1.18.0 -->
    <logger name="tc" level="INFO"/>
    <logger name="com.github.dockerjava" level="WARN"/>
    <logger name="com.github.dockerjava.zerodep.shaded.org.apache.hc.client5.http.wire" level="OFF"/>
</configuration>

TEST CODE REPOSITORY

https://github.com/Junhyunny/blog-in-action/tree/master/2023-04-12-test-container-for-database

REFERENCE

Twitter Facebook LinkedIn

강준현

TestContainer for Database

0. 들어가면서

1. Pain Point of Integration Test with Database

2. TestContainer

3. Practice

3.1. build.gradle

3.2. application-test.yml

3.3. PostRepository Interface

3.4. ApplicationIT Class

Reulst of Test

3.5. logback-test.xml

TEST CODE REPOSITORY

REFERENCE

공유하기

댓글남기기

참고

Styling for range type input HTML Element

Register client in Keycloak for OAuth2

Setup Keycloak

TestContainer for DynamoDB test

강준현

RECOMMEND POSTS BEFORE THIS

0. 들어가면서

1. Pain Point of Integration Test with Database

2. TestContainer

3. Practice

3.1. build.gradle

3.2. application-test.yml

3.3. PostRepository Interface

3.4. ApplicationIT Class

Reulst of Test

3.5. logback-test.xml

TEST CODE REPOSITORY

REFERENCE

공유하기

댓글남기기

참고

Styling for range type input HTML Element

Register client in Keycloak for OAuth2

Setup Keycloak

TestContainer for DynamoDB test