[Android] 코루틴 테스트

💡우아한테크코스 활동 중에 경험한 코루틴 테스트에 대하여 기록하였습니다.

 

RunTest?

• runTest는 테스트 코드를 단일 스레드에서 실행할 수 있게 해주는 함수입니다.
• Kotlin Coroutines Test 라이브러리에서 제공하며, 비동기 테스트 환경에서 시간을 정확하게 제어하고 예외나 지연 작업을 효과적으로 처리할 수 있습니다.

runBlockingTest

• Coroutine 1.6 이전 버전에서 코루틴을 테스트하기 위해 사용되었지만, 1.6 이후 부터는 runBlockingTest가 Deprecated 되었기 때문에 runTest를 활용합니다.
• runTest를 활용할 경우 더 나은 시간 제어 및 안전성을 제공하며, 타임아웃과 시간 관련 작업의 동작을 제어할 수 있습니다.

특징

• runTest는 기본적으로 60초의 타임아웃을 적용하며, 테스트가 너무 오래 걸리거나 무한 대기에 빠질 경우 강제로 종료됩니다.
• delay, withTimeout 등의 코루틴에서 사용되는 시간 관련 함수들이 테스트 환경에서 더 빠르게 동작할 수 있도록 도와줍니다.
• 테스트 중 발생하는 예외를 잡아내고, 코루틴이 잘못된 상태로 끝나지 않도록 관리합니다.

Gradle

• runTest를 활용하기 위해서 의존성을 추가해야 합니다.

testImplementation "org.jetbrains.kotlinx:kotlinx-coroutines-test:1.6.0"

runTest 활용

• runTest 함수 안에서 코루틴을 동기적으로 실행할 수 있으며, 내부의 delay(1000)은 실제로 1초를 기다리지 않고 즉시 처리됩니다.
• delay(1000)을 통해 코루틴이 1초 동안 지연되지만, runTest의 테스트 시간 흐름 제어 기능으로 즉시 처리됩니다.
• 이를 활용하면 더 빠르게 테스트를 수행할 수 있습니다.

class CoroutineTest {

    @Test
    fun `test coroutine with runTest`() = runTest {
        val result = fetchData()
        assertEquals("Success", result)
    }

    // 예시 코루틴 함수 (네트워크 요청 등을 시뮬레이션)
    suspend fun fetchData(): String {
        delay(1000) // 1초 지연 (실제 작업을 시뮬레이션)
        return "Success"
    }
}

withTimeout

• runTest 환경 안에서 withTimeout을 적용할 경우, 시간을 초과하면 테스트에 실패하도록 설정할 수 있습니다.

@Test
fun `test coroutine with timeout`() = runTest {
    val result = withTimeout(500) { fetchData() }
    assertEquals("Success", result)
}

TestDispachers

• TestDispatchers는 테스트 목적으로 사용되는 CoroutineDispatcher 구현입니다.
• 새 코루틴의 실행을 예측할 수 있도록 테스트 중에 새 코루틴을 만드는 경우에 TestDispathcers를 사용해야 합니다.

https://developer.android.com/kotlin/coroutines/test?hl=ko#testdispatchers

Android에서 Kotlin 코루틴 테스트  |  Android Developers

테스트 코드에서 코루틴이 여러 스레드에서 실행된다면 예측 가능성이 떨어지게 됩니다. 코루틴의 실행 시간, 실행 순서 등을 보장받지 못합니다. TestDispachers를 사용하게 되면 하나의 스케쥴러를 공유하고 이 스케쥴러에 대해 모든 테스트 스레드가 공유되게 됩니다. 이를 통해 병목 현상을 막고, 실행 시간, 실행 순서에 대해 보장받을 수 있습니다.

StandardTestDispatcher

• StandardTestDispatcher에서 새 코루틴을 시작하면 코루틴이 기본 스케쥴러의 대기열에 추가되어 테스트 스레드를 사용할 수 있을 때마다 실행됩니다.
• runTest가 기본적으로 사용하는 TestDispatcher이며 실제 환경에서 코루틴 스케쥴링과 비슷하게 맞춰 테스트하고 싶을때 사용합니다.

class DataRepositoryTest {

    private lateinit var repository: DataRepository

    // 테스트 디스패처 선언
    private val testDispatcher = StandardTestDispatcher()

    @Before
    fun setup() {
        // 테스트 디스패처를 메인으로 설정
        Dispatchers.setMain(testDispatcher)
        repository = DataRepository()
    }

    @After
    fun tearDown() {
        // 메인 디스패처를 기본 디스패처로 복구
        Dispatchers.resetMain()
    }

    @Test
    fun `test fetchData returns Success`() = runTest {
        // fetchData가 "Success"를 반환하는지 테스트
        val result = repository.fetchData()
        assertEquals("Success", result)
    }
}

스케줄러 작업 실행

• StandardTestDispatcher를 활용한 아래 테스트의 경우 테스트에 실패하게 됩니다.
• 테스트 스레드를 바로 실행할 수 없게 되면, 대기열에 있는 상태가 되고 assertEquals가 바로 호출되면서 실패합니다.

@Test
fun standardTest() = runTest {
    val userRepo = UserRepository()

    launch { userRepo.register("Alice") }
    launch { userRepo.register("Bob") }

    assertEquals(listOf("Alice", "Bob"), userRepo.getAllUsers()) // ❌ Fails
}

• 스케줄러에 있는 작업들을 실행하기 위해 아래 api를 제공해야 합니다.
• [advanceUntilIdle] : 대기열에 아무것도 남아있지 않을 때까지 스케줄러에서 다른 모든 코루틴을 실행합니다.
• [advanceTimeBy] : 주어진 양만큼 가상 시간을 진행하고, 가상 시간의 해당 지점 전에 실행되도록 예약된 코루틴을 실행합니다.
• [runCurrent] : 현재 가상 시간에 예약된 코루틴을 실행합니다.

이전 테스트를 수정하려면 어셜선으로 검사하기 직전에 advanceUntilIdle를 활용해 대기 중인 코루틴 두 개가 작업을 실행하게 할 수 있습니다. 다른 방법으로는 launch 호출에서 반환된 Job 인스턴스를 join하여 어설션을 실행하기 전에 새 코루틴을 완료하도록 할 수 있습니다. 가장 중요한 점은 StandardTestDispatcher는 복잡한 테스트 시나리오에서 유용한 코루틴 실행을 정밀하게 제어할 수 있다는 것입니다.

@Test
fun standardTest() = runTest {
    val userRepo = UserRepository()

    launch { userRepo.register("Alice") }
    launch { userRepo.register("Bob") }
    advanceUntilIdle() // Yields to perform the registrations

    assertEquals(listOf("Alice", "Bob"), userRepo.getAllUsers()) // ✅ Passes
}

UnconfinedTestDispatcher

• UnconfinedTestDispatcher는 Kotlin Coroutine Test 라이브러리에서 제공하는 테스트 디스패처로, 지연 없이 즉시 실행되는 테스트 환경을 만들기 위해 사용합니다.
• 일반적인 디스패처와 다르게 동작하며, 단위 테스트에 적합합니다.
• 어떤 특정 스레드에 바인딩되지 않고, 바로 실행하며 코루틴의 동작을 확인하거나 동기적으로 즉시 실행되는 테스트에서 유용합니다.

class UnconfinedDispatcherTest {

    // UnconfinedTestDispatcher 선언
    private val testDispatcher = UnconfinedTestDispatcher()

    private lateinit var repository: DataRepository

    @Before
    fun setup() {
        // 테스트 환경에서 Dispatchers.Main을 UnconfinedTestDispatcher로 설정
        Dispatchers.setMain(testDispatcher)
        repository = DataRepository()
    }

    @After
    fun tearDown() {
        // 테스트가 끝나면 메인 디스패처를 기본값으로 복구
        Dispatchers.resetMain()
    }

    @Test
    fun `test fetchData with UnconfinedTestDispatcher`() = runTest {
        // fetchData를 테스트하는 코루틴 함수
        val result = repository.fetchData()
        assertEquals("Success", result)
    }
}

CoroutinesTestExtension

• 테스트 환경에서 UnconfinedTestDispatcher를 사용하도록 설정하기 위해서 별도의 익스텐션을 설정할 수 있습니다.

@ExperimentalCoroutinesApi
class CoroutinesTestExtension(
    private val dispatcher: TestDispatcher = UnconfinedTestDispatcher()
) : BeforeEachCallback, AfterEachCallback {

    override fun beforeEach(context: ExtensionContext?) {
        Dispatchers.setMain(dispatcher)
    }

    override fun afterEach(context: ExtensionContext?) {
        Dispatchers.resetMain()
    }
}

UnconfinedTestDispatcher vs StandardTestDispatcher

특징UnconfinedTestDispatcherStandardTestDispatcher

실행 방식	즉시 실행 (지연 없음)	예약된 작업을 큐에 쌓아 동기적으로 처리
스레드 바인딩	특정 스레드에 바인딩되지 않음	테스트 스레드에서 동기적으로 실행
사용 시기	코루틴을 즉시 실행해야 할 때	코루틴이 실행될 시점을 제어해야 할 때
비동기 작업	기본적으로 비동기 작업 없음	비동기 작업을 테스트할 때 사용

참고

https://velog.io/@picbel/Kotlin-Coroutine-테스트-코드-작성-예제

https://munseong.dev/kotlin/runtest/