[Kotlin] Private Funtion 테스트

 💡 테스트 환경에서 private 메소드를 검증해야 하는 경우가 발생하였고, 이를 해결하기 위한 방법을 학습하였습니다.

 

private 함수 테스트 문제점

• MonthPicker 클래스는 유효한 달을 검사하고, 모든 달의 일을 30일로 가정하여 합을 구하는 클래스입니다.
• makeDays를 통해서 내부의 가변인자로 들어온 값이 모두 정확한 달인지 isValid를 통해 검사하고 있습니다.

class MonthPicker() {
    fun makeDays(vararg months: Int): Int {
        if (isValid(*months)) throw IllegalArgumentException(ERROR_MONTH)
        return months.reduce { acc, month ->
            acc + month * DAY_OF_MONTH
        }
    }

    private fun isValid(vararg months: Int): Boolean {
        return months.all { it in START_MONTH .. END_MONTH }
    }

    companion object {
        private const val START_MONTH = 1
        private const val END_MONTH = 12
        private const val DAY_OF_MONTH = 30
        private const val ERROR_MONTH = "올바른 달이 아닙니다."
    }
}

• makeDays에 대한 테스트는 문제가 없지만, isValid 함수는 private로 선언되어 테스트가 어렵습니다.

책임 분리

• 객체 내부에 private로 선언된 함수가 있다는 것은, 객체가 자신의 책임이 아닌 역할까지 하고 있다는 것을 뜻할 수도 있습니다.
• 새로운 객체를 생성하여 책임을 가져가도록 분리하여 문제를 해결하고자 하였습니다.

class MonthPicker(
    private val monthValidator: MonthValidator
) {
    fun makeDays(vararg months: Int): Int {
        if (monthValidator.isValid(*months)) throw IllegalArgumentException(ERROR_MONTH)
        return months.reduce { acc, month ->
            acc + month * DAY_OF_MONTH
        }
    }

    companion object {
        private const val DAY_OF_MONTH = 30
        private const val ERROR_MONTH = "올바른 달이 아닙니다."
    }
}

class MonthValidator(){
    fun isValid(vararg months: Int): Boolean {
        return months.all { it in START_MONTH .. END_MONTH }
    }
    companion object {
        private const val START_MONTH = 1
        private const val END_MONTH = 12
    }
}

• MonthValidator() 클래스가 해당 책임을 가져가도록 수정하였습니다.
• 이로 인해서 각 클래스를 따로 테스트를 작성하여 문제를 해결할 수 있었습니다.
• 하지만 많은 의존성이 생겨서 책임을 분리할 수 없는 상황이 있고, 책임을 지나치게 분리하면 디미터의 법칙을 위반하는 경우가 발생할 수도 있습니다.

호출하는 함수를 테스트

• private 함수를 테스트하기 위해서 private 함수를 호출하는 public 함수를 테스트할 수 있습니다.

class MonthPikerTest {
    private lateinit var monthPicker: MonthPicker
    
    @BeforEach
    fun setUp() {
        monthPicker = MonthPicker()
    }
    
    @Test
    fun `test isValid`() {
        // then
        asserThrows(java.lang.IllegalArgumentException::class.java){
            monthPicker.makeDays(0)
        }
    }
}

• 위와 같이 private를 호출하는 함수를 테스트하여 정상적인 테스트를 진행할 수 있습니다.
• 하지만 이는 아래와 같은 문제가 발생합니다.
  • 세부 동작을 직접 테스트하지 못한다
  • 구체적인 원인 분석이 어렵다
  • 테스트 코드의 의미와 범위가 불확실하다
  • 리팩토링에 취약하며 테스트의 의미를 생각했을 때 잘못될 수 있다

mockk 활용

• Mockk는 코틀린을 위한 Mock 프레임워크입니다.
• Repository, Api 호출 메소드와 같이 외부 의존성을 가지는 객체를 mocking하여 결합도를 낮출 수 있고, private 함수를 테스트할 수 있습니다.

class MonthPickerTest {

    @Test
    fun `test makeDays with valid months`() {
        // MonthValidator를 모킹
        val monthValidator = mockk<MonthValidator>()

        // 모킹된 MonthValidator가 항상 true를 반환하도록 설정
        every { monthValidator.isValid(anyVararg()) } returns true

        // MonthPicker에 모킹된 MonthValidator를 주입
        val monthPicker = MonthPicker(monthValidator)

        // 유효한 월일 경우 정상적으로 계산
        val result = monthPicker.makeDays(1, 2, 3)

        // 1, 2, 3개월의 합계 * 30일 = 180일
        assertEquals(180, result)
    }

    @Test
    fun `test makeDays with invalid months`() {
        // MonthValidator를 모킹
        val monthValidator = mockk<MonthValidator>()

        // 모킹된 MonthValidator가 항상 false를 반환하도록 설정
        every { monthValidator.isValid(anyVararg()) } returns false

        // MonthPicker에 모킹된 MonthValidator를 주입
        val monthPicker = MonthPicker(monthValidator)

        // 유효하지 않은 월일 경우 예외 발생
        val exception = assertThrows<IllegalArgumentException> {
            monthPicker.makeDays(13, 14)
        }

        // 예외 메시지 확인
        assertEquals("올바른 달이 아닙니다.", exception.message)
    }

• spyk로 실제 객체를 생성하고, 그 객체의 메서드를 모킹하였습니다.
• every로 private 메서드 모킹
  • every { monthPicker"메서드명” } returns false or true
  • 위와 같은 형식으로 항상 false나 true를 반환하도록 합니다.
  • 이를 통해 월이 유효하지 않다고 판단하도록 설정하여 에러를 발생시킵니다.
• verify로 호출 검증
  • isValid 메서드가 특정 인자와 함께 호출되었는지를 검증합니다.

결과

• 위 방식을 사용하여 private 메서드를 모킹하고, 이를 통해 간접적으로 public 메서드를 테스트할 수 있습니다.