[Kotlin] TestFixture

💡 TDD를 통해 로직을 구현하면서 TestFixture에 대한 개념을 알게 되었고, 이에 대하여 자세하게 학습하였습니다.

TestFixture

• 테스트를 위한 고정된 상태를 설정하는 것을 의미합니다.
• 테스트 실행 전에 공통으로 필요한 객체나 데이터를 준비하여, 중복 코드를 줄이고 가독성과 일관성을 향상시킬 수 있습니다.

테스트 대상 클래스 생성

class Calculator {
    fun add(a: Int, b: Int): Int {
        return a + b
    }

    fun subtract(a: Int, b: Int): Int {
        return a - b
    }
}

• 위와 같은 간단한 클래스가 있다고 가정하고, 테스트 코드를 작성해보겠습니다.

import org.junit.jupiter.api.BeforeEach
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.Assertions.assertEquals

class CalculatorTest {

    private lateinit var calculator: Calculator

    @BeforeEach
    fun setUp() {
        // TestFixture 설정
        calculator = Calculator()
    }

    @Test
    fun testAdd() {
        val result = calculator.add(2, 3)
        assertEquals(5, result)
    }

    @Test
    fun testSubtract() {
        val result = calculator.subtract(5, 3)
        assertEquals(2, result)
    }
}

• @BeforEach 어노테이션을 활용해서 각 테스트 메서드가 실행되기 전에 setUp() 메서드를 호출하여 calculator 객체를 초기화하였습니다.
• 이렇게 한다면 각 테스트가 독립적으로 수행될 수 있으며, 매번 calculator 객체를 생성할 필요가 없어져 중복 코드를 줄일 수 있었습니다.

확장함수 활용하기

• 테스트코드 만을 위한 확장함수를 선언하는 것도 TestFixture가 될 수 있습니다.

object TestFixture {
    fun CartItemDatabase.deleteAll() {
        this.openHelper.writableDatabase.execSQL("DELETE FROM ${CartItemDatabase.CART_ITEMS_DB_NAME}")
    }
}

• CartItemDatabase라는 로컬 데이터베이스를 초기화하는 코드를 확장함수로 선언하였습니다.
• 이는 중복 코드를 감소시키고, 일관성과 가독성을 높이는 데 도움을 주었으므로 일종의 TestFixture라고 할 수 있습니다.

Mock 데이터 생성

• 테스트 실행을 하기 전에 필요한 고정된 상태나 객체를 설정하는 것을 TestFixture라고 할 수 있습니다.
• 아래와 같은 테스트에 필요한 객체를 생성하는 함수를 제공함으로써 반복적으로 사용될 수 있는 객체 생성의 역할을 줄여줄 수 있습니다.

object TestFixture {
    fun makeCartItemEntity(): CartItemEntity {
        return CartItemEntity(
            product =
                Product(
                    imageUrl = "",
                    price = 10000,
                    name = "아메리카노",
                    id = 0L,
                    category = "",
                ),
        )
    }

    fun makeRecentlyProductEntity(): RecentlyProductEntity {
        return RecentlyProductEntity(
            id = 2L,
            productId = 9999999L,
            imageUrl = "",
            name = "",
            category = "fashion",
        )
    }
}

정리

• TestFixture는 테스트 코드에서 반복적으로 필요한 초기화 작업을 중앙 집중화할 수 있습니다.
• 일관성과 가독성을 높이는 데 도움이 되며, @BeforEach 혹은 @BeforAll 어노테이션을 사용하여 초기화 작업을 수행할 수 있습니다.

참고

https://oliveyoung.tech/blog/2024-04-01/testcode-use-fixture-monkey/

https://velog.io/@pood/Test-Fixture-에-대해서