MockK을 활용한 Presenter 테스트

💡 우아한테크코스 과정에서 진행한 mocking을 활용한 Presenter 테스트를 기록하였습니다.

 

개요

• MVC to MVP 과정을 통해서 MVP 패턴을 구현하였습니다.
• 구현 후 테스트 코드를 리팩터링 하는 과정에서 Presenter 테스트에 대하여 학습하였고, 그 과정을 기록하였습니다 !
• 이전 기수의 수달님의 영상을 많이 참고하였습니다.

[10분 테코톡] 수달의 mock을 사용해 android presenter test하기

 

Mock

• Mock은 Test Double의 종류 중 하나로 호출에 대한 기대를 명세하고 내용에 따라 동작하도록 프로그래밍 된 객체입니다.
• 안드로이드에서는 Mockito 프레임워크를 사용해 Mock 객체를 사용할 수 있으며, 이를 통해 테스트 상에서 어떤 결과를 반환할지 결정이 가능해집니다.

Test Double

• 테스트 더블이란 테스트를 진행하기 어려운 경우 이를 대신해 테스트를 진행할 객체를 뜻합니다.

• 특정 상태에 따라 다른 결과를 받는 이유로 테스트가 어려운 경우, 테스트하려는 객체와 연관된 객체를 사용하기 어려운 경우 이를 대신할 수 있는 객체를 뜻합니다.

Kotlin 라이브러리

• 테스트 코드 작성 시 mock 처리를 위해 Java에서는 Mockito를 많이 사용합니다.
• Kotlin에서는 Mockito와 유사한 MockK 라이브러리가 존재하며, Java의 Mockito 사용법과 유사합니다.

의존성 추가

• MockK를 사용하기 위해선 dependency 추가가 필요합니다.

testImplementation "io.mockk:mockk:$mockk_version"
androidTestImplementation "io.mockk:mockk-android:$mockk_version"

MockK 메서드

every()

• every() 함수는 mock 객체가 어떻게 동작할지 정의하는 함수입니다.
• returns 함수로 특정 객체를 반환시켜줄 수 있고, throws로 에러를 발생시킬 수 있습니다.

// mockObject.someMethod()가 호출 시 "Mocked Value"를 반환하도록 설정
every { mockObject.someMethod() } returns "Mocked Value"

verify()

• mock 객체의 특정 메서드가 지정된 횟수만큼 호출되었는지 검증합니다.

// mockObject.someMethod()가 호출되었는지 확인
verify { mockObject.someMethod() }

relaxed()

• relaxed = true로 설정하면 정의되지 않은 모든 메서드 호출에 대한 기본 값을 반환합니다.
• 이를 활용하면 모든 메서드를 명시적으로 정의하지 않아도 됩니다.

// mockObject의 모든 메서드는 호출이 자동으로 기본 값을 반환
val mockObject = mockk<MyClass>(relaxed = true)

slot()

• 메서드 호출 중 인자를 캡처할 수 있는 객체를 생성합니다.

val slot = slot<String>()
every { mockObject.someMethod(capture(slot)) } returns

• someMethod에 전달 된 인자가 slot에 저장됩니다.

coEvery(), coVerify()

• 코투린에서 사용되는 메서드나 함수의 동작을 설정하거나 검증할 때 사용합니다.

// suspendMethod에 대해 mock 동작을 설정하거나 검증한다.
coEvery { mockObject.suspendMethod() } returns "Mocked Value"
coVerify { mockObject.suspendMethod() }

clearMocks()

• 호출 기록이나 설정된 기록을 포함한 mock 객체의 상태를 초기화합니다.

clearMocks(mockObject)

spyk()

• 실제 객체를 spy 객체로 생성합니다.
• spy 객체는 실제 객체의 메서드를 호출하면서도, 특정 메서드는 mock 동작을 설정할 수 있습니다.

// someMethod 호출 대신 Mocked value 반환
val spiedObject = spyk<MyClass>()
every { spiedObject.someMethod() } returns "Mocked Value"

justRun()

• 특정 메서드가 호출될 때 아무 동작도 하지 않도록 설정합니다.

// 일반적으로 Unit을 반환하는 메서드에 사용됩니다.
justRun { mockObject.someMethod() }

mockkStatic(), mockkObject()

• 정적 메서드나 싱글톤 객체를 mock으로 만들 때 사용합니다.

mockkStatic("com.example.MyClassKt")
every { someStaticFunction() } returns "Mocked Value"

Test 범위 지정

• 사용자의 입력에 따라 원하는 행동을 하고 뷰가 노출되는지를 확인하는 것에 대한 테스트 코드를 작성할 수 있습니다.
• HTTP API 통신 응답 값과 성공 및 실패 여부에 따라 값을 잘 처리하는지 확인할 수 있습니다.
• 이번 주제에서는 View나 통신에 대한 테스트 코드 작성이 아닌 Presenter에 대한 테스트를 진행하였습니다.

Presenter 테스트

• 가장 간단한 MVP 구조를 통해 테스트를 진행하였습니다.
• 우선 아래와 같은 MVP 패턴 구조를 구현합니다.
• Presenter의 중요 로직인 loadData()를 주로 테스트하려 합니다.

interface MainView { // 뷰 인터페이스
    fun showData(data: String)
    fun showError(message: String)
}

 class GetMainUseCase { // 유즈케이스
    fun load() : String = "Sample Data"
}

class MainPresenter( // Presenter
    private val view: MainView,
    private val getMainUseCase: GetMainUseCase,
) {
    fun loadData() {
        val data = getMainUseCase.load()
        if (data.isNotEmpty()) {
            view.showData(data)
        } else {
            view.showError("No data available")
        }
    }
}

초기화 작업

• View 인터페이스와 useCase를 @Mock으로 mocking을 진행하였습니다.
• 이를 통해서 Mock 객체로 생성하며, 두 객체는 실제 인스턴스가 아닌 Mockito가 생성한 가짜 객체입니다.

import org.junit.Before
import org.junit.Test
import org.mockito.Mock

class MainPresenterTest {
    @Mock
    private lateinit var getMainUseCase: GetMainUseCase
    @Mock
    private val mainView: MainView

    private lateinit var presenter: MainPresenter

    @Before
    fun setup() {
        // MockitoAnnotations.openMocks(this)
        mainView = mockk()
        getMainUseCase = mockk()
        presenter = MainPresenter(mockView,getMainUseCase)
    }
}

• @Before 메서드에서 Mockito를 초기하여 모든 객체들을 초기화하였습니다.
• Presenter에 초기화된 Mock 객체들을 주입하여 MainPresenter를 생성하였습니다.

테스트 시나리오 작성

• “should show data when data is available”
  • GetMainUseCase가 데이터를 반환하는 경우 MainView의 showData()를 호출하고, showError()를 호출하지 않는지 확인합니다.
• “should show error when data is not available”
  • GetMainUserCase가 빈 문자열을 반환하는 경우 showError()가 호출되고, showData()를 호출하지 않는지 확인합니다.

테스트 작성

import org.junit.Before
import org.junit.Test
import org.mockito.Mock
import org.mockito.Mockito.*
import org.mockito.MockitoAnnotations

class MainPresenterTest {

    @Test
    fun `should show data when data is available`() {
        // Given
        val sampleData = "Sample Data"
        `when`(getMainUseCase.load()).thenReturn(sampleData)

        // When
        presenter.loadData()

        // Then
        verify(mainView).showData(sampleData)
        verify(mainView, never()).showError(anyString())
    }

    @Test
    fun `should show error when data is not available`() {
        // Given
        `when`(getMainUseCase.load()).thenReturn("")

        // When
        presenter.loadData()

        // Then
        verify(mainView).showError("No data available")
        verify(mainView, never()).showData(anyString())
    }
}

 

참고

Test Double을 알아보자

https://medium.com/@igorwojda/kotlin-introduction-to-testing-android-presenters-e038f1064e04

https://blog.banksalad.com/tech/test-in-banksalad-android/

https://site.mockito.org/

https://leveloper.tistory.com/199