[우사기] Github Actions PR 테스트용 workflow 및 테스트 코드 작성 , 테스트 환경 구성

 

 

테스트  workflow 작성 (feature → dev PR 시 실행)

기존 workflow는 dev 브랜치에 push 할 때마다 테스트와 배포가 함께 동작을 하고 있었는데,

테스트가 포함되다 보니 Github Actions 실행 시간이 오래 걸리고,

BE는 혼자 개발하다 보니  PR 과정을 생략했었는데 이러면서 검증되지 않은 코드들이 dev에 merge될 가능성이 있었다.

이러한 문제점들을 해결하기 위해서 workflow를 테스트용/배포용 두 가지로 분리하는 작업을 진행해보았다. 🔥

 

name: Test on Pull Request

on:
  pull_request:
    branches:
      - dev
    types: [opened, synchronize, reopened]

 

feature 브랜치에서 개발 후 dev 브랜치에 Pull Reqeuset를 올리면 workflow가 실행된다.

type을 지정할 수 있는데 opened은 PR 최초 생성, synchronize는 PR에 새 커밋이 추가될 때, reopened는 닫힌 PR을 다시 열었을 때 workfolw가 실행되게 설정했다.

 

 

Testcontainers  라이브러리를 이용한 테스트 환경 구성

DB연결이 필요한 테스트 코드들은 H2 database를 이용했었는데 redis는 따로 테스트 구성이 되어있지 않아서 Testcontainers 라이브러리를 이용해 테스트 환경을 구성하는 방식으로 변경했다.

Docker를 통해 격리된 Redis와 PostgreSQL 컨테이너를 일회용으로 띄우고, 테스트가 끝나면 자동으로 삭제되도록 했다.

 

 

build.gradle 의존성 추가

    testImplementation("org.springframework.boot:spring-boot-testcontainers:4.0.1")

    testImplementation("com.redis.testcontainers:testcontainers-redis:1.6.4")
    testImplementation("org.testcontainers:junit-jupiter:1.21.3")
    testImplementation("org.testcontainers:postgresql:1.21.3")

 

 

application-test.yml 수정

spring:
    datasource:
    jpa:
        hibernate:
            ddl-auto: create-drop
        show-sql: true
    data:
        redis:

 

이 부분을 놓쳐서 계속 table 생성이 안 돼서 고생했는데 ..

Testcontainers 라이브러리를 이용하면 알아서 컨테이너 주소를 주입해주기 때문에, 꼭! 값을 비워줘야 한다.

 

 

 

테스트 환경 추상화

@ServiceConnection 어노테이션을 이용해서 Redis와 PostgreSQL 컨테이너를 설정하는 추상 클래스를 만들고, 해당 클래스를 상속 받아 테스트 코드를 작성했다. 기존 테스트 코드들이 DescribeSpec을 상속 받고 있었기 때문에 생성자에서 body를 받아 DescribeSpec에게 넘겨주는 로직도 추가했다.

@SpringBootTest
abstract class IntegrationTestSupport(body: DescribeSpec.() -> Unit = {}) : DescribeSpec(body) {

    // Kotest에서 Spring을 쓰려면 이 확장이 필수
    override fun extensions() = listOf(SpringExtension)

    companion object {
        // Redis
        @Container
        @ServiceConnection
        val redisContainer = GenericContainer(DockerImageName.parse("redis:alpine"))
            .withExposedPorts(6379)

        // PostgreSQL
        @Container
        @ServiceConnection
        val postgresContainer = PostgreSQLContainer<Nothing>(DockerImageName.parse("postgres:15-alpine")).apply {
            withDatabaseName("testdb")
            withUsername("test")
            withPassword("test")
        }
    }
}

 

하지만 계속 되는 redis 연결 실패 문제 ... 🤯 

계속되는 삽질과 구글링, 온갖 AI와 씨름을 하면서 컨테이너 연결 성공시킨 테스트 추상 클래스는 아래와 같다.

 

 

@SpringBootTest
abstract class IntegrationTestSupport(
    body: DescribeSpec.() -> Unit = {},
) : DescribeSpec(body) {
    override fun extensions(): List<Extension> = listOf(SpringExtension)

    companion object {
        val redisContainer =
            GenericContainer(DockerImageName.parse("redis:alpine"))
                .withExposedPorts(6379)
                .apply { start() }

        @ServiceConnection
        val postgresContainer =
            PostgreSQLContainer<Nothing>(DockerImageName.parse("postgres:15-alpine"))
                .apply {
                    withDatabaseName("testdb")
                    withUsername("test")
                    withPassword("test")
                }.apply { start() }

        @JvmStatic
        @DynamicPropertySource
        fun overrideProps(registry: DynamicPropertyRegistry) {
            registry.add("spring.data.redis.host") { redisContainer.host }
            registry.add("spring.data.redis.port") { redisContainer.getMappedPort(6379).toString() }
        }
    }
}

 

Redis 컨테이너 설정도 Redis 전용 라이브러리가 있어서 적용을 해봤는데, redis config에서 계속 host, port를 찾지 못 하는 에러가 있어서 일단 GenericContainer로 구현했다.

@ServiceConnection은 타입이 명확할 때만 사용할 수 있기 때문에 redis 컨테이너 설정에서는 사용하지 않았다.

 

 

 

특정 테스트 코드 제외시키기

이미지 업로드 테스트나 Google 토큰 검증 테스트는 로컬 환경에서만 동작하게 하고 싶어서 @Tag("local-only") 어노테이션 달린 테스트 코드는 동작하지 않게 설정을 해줬다. 하지만 해당 workflow 로그를 확인해보니 제외시키고 싶은 코드들이 계속 테스트가 되고 있었다. 🤯

 

      - name: Run tests with Testcontainers
        run: ./gradlew test -PexcludeTags="local-only" --no-daemon
        env:
          SPRING_PROFILES_ACTIVE: test

 

 

workflow 자체에는 문제 없었고 또 다시 시작된 삽질... 

결국 GPT가 해답을 내줬는데 내가 사용하고 있던 @Tag 어노테이션은 JUnit 테스트에만 적용되고,

현재 내 테스트 코드들은 Kotest 엔진으로 실행되기 때문에 @Tags 어노테이션을 사용해야 한다고 한다.

 

 

tasks.withType<Test> {
    useJUnitPlatform()

    systemProperty(
        "kotest.tags.exclude",
        project.findProperty("excludeTags") ?: "",
    )
}

 

build.gradle도 위처럼 kotest 전용 필터링 설정을 해줬더니 의도한대로 지정해준 테스트 코드들이 제외됐다.

테스트 엔진, 테스트 코드 작성, mock 객체 다루는 방법 열심히 공부해야겠다는 생각이 들었다 ..😇🔫

 

 

 

온갖 삽질 끝에 드디어 테스트 통과시켰다.

다음은 dev 배포하는 workflow 작성할 예정입니다.