Kotest에서 가독성 있는 테스트 코드 작성하기

DaeHoon·2023년 10월 15일

회사에서 단위 테스트 작성 시, 가독성이 너무 떨어져 알아보기 힘들 경우가 종종 있었다. 어떻게 하면 조금 더 예쁘게 코드를 작성할 수 있을 지 간단하게 정리해보겠다.

BDD 작성 가이드

Given: 주어진 환경
When: 행위
Then: 기대 결과

BDD Example

Given
- 본인 인증된 사용자가 로그인된 상황에서
When
- 검수 정보를 입력하고 검수 등록 버튼을 누르면
- 검수 정보를 미입력하고 검수 등록 버튼을 누르면
Then
- 등록 결과가 포함된 검수 진행 목록 화면으로 이동한다.
- 검수 등록 실패 사유가 화면에 표시되어야 한다.
And
- 해당 분기의 컨텍스트 안에서 하위 분기를 생성함
- 중복된 서술을 재입력하지 않고, 상위에 서술된 동일한 내용을 테스트 케이스에 출력할 수 있고, 같은 코드 블록을 사용함으로써 변수를 공유할 수 있는 장점이 존재
주어지는 환경이 바뀌어야하면 새로운 Container (given, when, then이 묶여있는 scope)를 만든다.
- 예를 들어, 비회원 사용자를 테스트하는 경우에는 위의 새로운 컨테이너를 만들어 테스트 한다

mock, spy를 사용하여 Mock 객체 선언하기

class RegisterEmoticonFeature(
    _emoticonRepository: EmoticonRepository
) : BehaviorSpec() {
    private val emoticonRepository = spyk(_emoticonRepository)
    private val accountService = mockk<AccountService>()
    private val emoticonService = EmoticonService(repository = emoticonRepository)
    private val emoticonHandler = EmoticonHandler(
        accountService = accountService,
        emoticonService = emoticonService,
        emailService = mockk()
    )

    override fun isolationMode(): IsolationMode = InstancePerLeaf

    init {
	}
}

spyk: stub하지 않은 것들은 실제 구현한 코드와 동일하게 동작한다. (Spies allow you to mix mocks and real objects.)
mockk: 실제로 사용하는 메서드들을 stub 해줘야 한다.

각 테스트마다 반복적으로 실행되는 로직은 Test Fixture를 사용하기

작성 예정

비즈니스 관련 Mock 객체를 구현하여 Given 절 가독성 높이기

object Mock {
    fun account(identified: Boolean) = Account(
        id = Arb.long(min = 1).single(),
        name = Arb.string(5..20).single(),
        email = Arb.stringPattern("([a-zA-Z0-9]{5,20})\\@test\\.kakao\\.com").single(),
        identified = identified
    )


    fun emoticonEntity(createdDate: LocalDate, zone: ZoneId) = arb { rs ->
        val accountId = Arb.long(100_000L..200_000L)
        val title = Arb.string(10..100)
        val description = Arb.string(100..300)
        val choco = Arb.int(100..500)
        val images = Arb.stringPattern("([a-zA-Z0-9]{1,10})/([a-zA-Z0-9]{1,10})\\.jpg")
            .chunked(1..10)
        val created = Arb.instant(
            minValue = createdDate.atTime(LocalTime.MIN).atZone(zone).toInstant(),
            maxValue = createdDate.atTime(LocalTime.MAX).atZone(zone).toInstant()
        )

        generateSequence {
            created.next(rs).let { createdAt ->
                EmoticonEntity(
                    accountId = accountId.next(rs),
                    title = title.next(rs),
                    description = description.next(rs),
                    choco = choco.next(rs),
                    images = images.next(rs),
                    createdAt = createdAt,
                    updatedAt = createdAt
                )
            }
        }
    }
}

위의 Mock.kt 객체를 통해 아래처럼 Given 절에 정의할 수 있다.

init {
        Given("본인 인증된 사용자가 로그인된 상황에서") {
            val token = Arb.stringPattern("([a-zA-Z0-9]{20})").single()
            val account = Mock.account(identified = true) // 
            every { accountService.take(ofType(String::class)) } returns account
		'''
	}
}

완성된 코드

@ContextConfiguration(classes = [SpringDataConfig::class])
class RegisterEmoticonFeature(
    _emoticonRepository: EmoticonRepository
) : BehaviorSpec() {
    private val emoticonRepository = spyk(_emoticonRepository)
    private val accountService = mockk<AccountService>() // MSA
    private val emoticonService = EmoticonService(repository = emoticonRepository)
    private val emoticonHandler = EmoticonHandler(
        accountService = accountService,
        emoticonService = emoticonService,
        emailService = mockk()
    )

    override fun isolationMode(): IsolationMode = InstancePerLeaf

    init {
        Given("본인 인증된 사용자가 로그인된 상황에서") {
            val token = Arb.stringPattern("([a-zA-Z0-9]{20})").single()
            val account = Mock.account(identified = true)
            every { accountService.take(ofType(String::class)) } returns account

            When("검수 정보를 입력란에") {
                And("검수 정보를 입력하고 검수 등록 버튼을 누르면") {
                    val request = request()
                    val response = emoticonHandler.register(token, request)

                    Then("등록 결과가 포함된 검수 진행 목록 화면으로 이동한다") {
                        response.authorId shouldBe account.id
                        response.title shouldBe request.title
                        response.description shouldBe request.description
                        response.choco shouldBe request.choco
                        response.images shouldContainAll request.images

                        verify(exactly = 1) {
                            accountService.take(token = token)
                            emoticonRepository.save(match<EmoticonEntity> {
                                it.accountId == account.id
                            })
                        }
                    }
                }

                And("검수 정보를 입력하지 않고 검수 등록 버튼을 누르면") {
                    val ex = shouldThrowExactly<DeniedRegisterEmoticonException> {
                        emoticonHandler.register(token, null)
                    }

                    Then("검수 등록 실패 사유가 화면에 표시되어야 한다") {
                        ex.message.isNotBlank() shouldBe true

                        verify(exactly = 0) {
                            accountService.take(any())
                            emoticonRepository.save(ofType<EmoticonEntity>())
                        }
                    }
                }
            }
        }
    }

    private fun request() = RegisterEmoticon(
        title = Arb.string(10..100).single(),
        description = Arb.string(250..300).single(),
        choco = Arb.int(100..500).single(),
        images = Arb.stringPattern("([a-zA-Z0-9]{1,10})/([a-zA-Z0-9]{1,10})\\.jpg")
            .chunked(1..10)
            .single()
    )
}