통합 테스트 환경 구축

[junha-ahn]

Description

testcontainers를 이용한 통합 테스트를 위한 환경 구축

• Docker Compose 구성
• testcontainer에 docker-compose 환경 공유 고려

To do

• testcontainers
  • local:
    • only unit test for git commit hook
    • integration test for git push hook
    • 통합테스트 환경 분리 설정 - Gradle Kotlin DSL
  • git actions:
    • unit + integration test
• Docker Image #43
  • gradlew build inside image
  • multi-stage build
  • layered jar
• Docker-compose
  • mysql image
  • init scrypt
• docker-compose + Testcontainer + git actions
  • init 속도 문제로 잠정 중단
  • 향후 testcontainer에 각각의 container 구성 복잡성이 증가한다면, docker-compose를 testcontainer에서 사용

ect. testcontainer setup study

• 1. spring boot initializr add testcontainer
• 2. print mysql version
• 3. test simple api
• 4. use singleton pattern container
• 5. use Docker-compose

Test Checklist

• spring boot test

[junha-ahn]

Testcontainer for gradle

reference

• https://java.testcontainers.org/
• https://testcontainers.com/guides/getting-started-with-testcontainers-for-java/
• https://testcontainers.com/guides/testing-spring-boot-rest-api-using-testcontainers/
• testcontainers-java-spring-boot-quickstart

example

• testcontainers-spring-boot-kotlin-redis
• wonwoo/testcontainers-test-java-kotlin-both

PR

• you should install docker
• print testcontainer mysql version

// build.gradle.kts

dependencies {
        ...
	runtimeOnly("com.mysql:mysql-connector-j")
	testImplementation("org.springframework.boot:spring-boot-testcontainers")
	testImplementation("org.testcontainers:junit-jupiter")
	testImplementation("org.testcontainers:mysql")
}

package com.group4.ticketingservice

import org.junit.jupiter.api.Test
import org.springframework.boot.test.context.TestConfiguration
import org.springframework.boot.testcontainers.service.connection.ServiceConnection
import org.springframework.context.annotation.Bean
import org.testcontainers.containers.MySQLContainer

// @SpringBootTest()
@TestConfiguration(proxyBeanMethods = false)
class MySQLContainerTest {

    @Bean
    @ServiceConnection
    fun mysqlContainer(): MySQLContainer<*> {
        return MySQLContainer("mysql:latest")
    }

    @Test
    fun printMysqlVersion() {
        val mysqlContainer = mysqlContainer()
        mysqlContainer.start()
        val mysqlVersion = mysqlContainer.execInContainer("mysql", "--version")
        println("MySQL version: $mysqlVersion")
    }
}

COMMIT

$ ./gradlew test
$ docker ps 
CONTAINER ID   IMAGE                       COMMAND                  CREATED          STATUS          PORTS                                                    NAMES
32d2b99ba756   mysql:latest                "docker-entrypoint.s…"   34 seconds ago   Up 33 seconds   33060/tcp, 0.0.0.0:32771->3306/tcp, :::32771->3306/tcp   objective_gates
a6ed58c36aa8   testcontainers/ryuk:0.4.0   "/bin/ryuk"              34 seconds ago   Up 33 seconds   0.0.0.0:32770->8080/tcp, :::32770->8080/tcp              testcontainers-ryuk-6ce2605b-946a-476a-8bdc-901c7294246a

# After test

$ docker ps 
CONTAINER ID   IMAGE     COMMAND   CREATED   STATUS    PORTS     NAMES

• actions test 성공
• DinD or DoD로 잘 돌아간건가?...

Testcontainer for docker-compose

reference

• https://java.testcontainers.org/modules/docker_compose/
• Using DockerComposeContainer in kotlin? testcontainers/testcontainers-java#1010

에러 해결

• Problem setting environment variables through docker-compose docker-library/postgres#203 (comment)

코드 예시

• https://github.com/rogervinas/top-5-server-side-kotlin-frameworks-2022/blob/9996c6446f5394e821b8da62be9920c1e5e776db/http4k-app/README.md?plain=1#L233
• https://github.com/AdevintaSpain/ms-test--hello-twitch/blob/7bd45f419a6bffbda2ed61945096720101750348/src/integrationTest/java/com/adevinta/mstesthellotwitch1/infrastructure/helper/DockerComposeHelper.kt#L19
• https://github.com/FacuRamallo/user-crud_Jwt-auth_springboot_kotlin/blob/55c73ed1d3f9caf860cae14e70a5e9c6b7ac2661/src/integrationTests/kotlin/com/facundo/friends/ApplicationIntegrationTest.kt#L20
• https://github.com/jesperancinha/buy-odd-yucca-concert/blob/0dd3c0e9f9b971c50caae505f316dd8a94c29554/buy-oyc-commons/src/it/kotlin/org/jesperaninha/concert/buy/oyc/containers/AbstractContainersTest.kt#L13

Testcontainer for git actions

Reference

• E2E Testing in CI Environment with Spring Boot and Testcontainers usage
• ci-examples.yml

접기/펼치기

Tech Stack

• Java 17
• JUnit 5 + Spring Boot Test
• Testcontainers

Potential Problem

• Long execution time
  • How to make containers start quicker
    • started in parallel
    • Be aware of pull policy
    • ...

[junha-ahn]

경험 공유

상황

• Kotlin + Spring Boot에 대한 이해 부족 (메인스택은 Nodejs이고, 현재 인프라팀으로써, 인프라 공부만 하고 있음)
• 하지만 해당 이슈는 Kotlin + Spring Boot 및 junit(및 기타 라이브러리) 에 대한 "최신" 지식을 요구함

해당 이슈를 해결 하는 과정에서 여러 글과 공식 문서를 읽었지만 "Kotlin"으로 설명해놓은 최신 (또는 다양한) 예시는 없었다.

따라서 계속적인 검색, GPT 등 여러 방법을 썼으나

• 공식 문서 포함 대부분 글은 Java로 작성되어 있다. (=> kotlin covert 불가능, 인텔리제이또한 사용하지 않고, vscode codespace 사용 - 싸지방)
• 어떤 글은 Kotlin + Spring Boot 이나 Junit4를 사용
• 어떤 글은 Kotlin + Spring Boot + Junit5이나, 내가 원하는 예제 (Singleton 패턴)이 아님

위와 같은 문제점에 마주치고, 2일간 (하루에 4시간씩) 체계적 문제 해결에 실패. (계속 뭔지도 모르고 복붙만 진행)

해결방법

git repo에 내가 원하는 기술을 검색하고 최신순 정렬을해서, "가장 생생한 예시"를 확인하고 문제 해결

• kotlin spring boot testcontainer

• https://github.com/roar-skinderviken/postgres-testcontainer-demo/blob/main/src/test/kotlin/no/javatec/demo/TestDbContainer.kt

• Thank you so much open this repo roar-skinderviken/postgres-testcontainer-demo#16