[Android] LiveData 테스트

💡우아한테크코스 과정에시 진행한 LiveData를 포함한 테스트에 대하여 기록하였습니다.

 

LiveData Testing

• 안드로이드의 LiveData는 Android에서 UI와 데이터 상태를 관찰할 수 있도록 설계된 구조입니다.
• LiveData는 Lifecycle에 의존하기 때문에 직접 테스트하기에는 복잡할 수 있으며, 이를 해결하기 위해서 라이프사이클을 수동으로 조작하거나 JUnit과 함께 테스트 도구를 활용해야 합니다.

 

JUnit4 +InstantTaskExecutorRule

• LiveData는 기본적으로 백그라운드 스레드에서 동작합니다.
• InstantTaskExecutorRule를 활용하면 이를 테스트 환경에서 제어 가능하게 하며, 스레드 문제를 회피할 수 있습니다.
• InstantTaskExecutorRule은 JVM 테스트 환경에서 Android Main Thread를 사용할 수 있도록 설정해줍니다.

Gradle

testImplementation("androidx.arch.core:core-testing:2.2.0")

JUnit4 - Rule

class MainViewModelTest {
    @get:Rule
    val instantExecutorRule = InstantTaskExecutorRule()
    
    @Test
    fun testLiveData() {
        // Given
        // LiveData 생성
        val liveData = MutableLiveData<String>()
        val observer = Observer<String> {}
        
        // When
        liveData.observeForever(observer)
        liveData.value = "Hello, World!"

        // Then
        assertEquals("Hello, World!", liveData.value)

        liveData.removeObserver(observer)
    }
}

 

Junit5 + InstantTaskExecutorExtension

• JUnit5에서는 JUnit 4의 Rule 을 사용할 수 없으므로, 직접 제작해야 합니다.

InstantTaskExecutorExtension

• Callback을 상속받아 구현하며, 메인 스레드에서 동작하도록 구현합니다.

class InstantTaskExecutorExtension : BeforeEachCallback, AfterEachCallback {
    override fun beforeEach(context: ExtensionContext?) {
        ArchTaskExecutor.getInstance().setDelegate(object : TaskExecutor() {
            override fun executeOnDiskIO(runnable: Runnable) {
                runnable.run()
            }

            override fun postToMainThread(runnable: Runnable) {
                runnable.run()
            }

            override fun isMainThread(): Boolean {
                return true
            }
        })
    }

    override fun afterEach(context: ExtensionContext?) {
        ArchTaskExecutor.getInstance().setDelegate(null)
    }
}

in Test

• ExtendWith을 활용하여 테스트 환경을 구축할 수 있습니다.

@ExtendWith(InstantTaskExecutorExtension::class)
class MainViewModelTest

 

getOrAwaitValue

• LiveData의 데이터를 얻어오기 위해 해당 객체를 구독하여 변경사항을 체크할 수 있습니다.
• getOrAwaitValue는 LiveData 값을 비동기적으로 기다렸다가 테스트할 때 사용됩니다.
• getOrAwaitValue 확장 함수를 통해 LiveData 값을 관찰하고, 그 값이 설정될 때까지 기다릴 수 있습니다.

import androidx.lifecycle.LiveData
import androidx.lifecycle.Observer
import java.util.concurrent.CountDownLatch
import java.util.concurrent.TimeUnit

fun <T> LiveData<T>.getOrAwaitValue(
    time: Long = 2,
    timeUnit: TimeUnit = TimeUnit.SECONDS
): T {
    var data: T? = null
    val latch = CountDownLatch(1)
    val observer = object : Observer<T> {
        override fun onChanged(t: T?) {
            data = t
            latch.countDown()
            this@getOrAwaitValue.removeObserver(this)
        }
    }

    this.observeForever(observer)

    if (!latch.await(time, timeUnit)) {
        throw TimeoutException("LiveData value was never set.")
    }

    @Suppress("UNCHECKED_CAST")
    return data as T
}

in Test

• 비동기적으로 값을 기다렸다가 테스트할 수 있습니다.

import androidx.arch.core.executor.testing.InstantTaskExecutorRule
import androidx.lifecycle.MutableLiveData
import org.junit.Assert.*
import org.junit.Rule
import org.junit.Test

class LiveDataTest {

    @get:Rule
    val instantTaskExecutorRule = InstantTaskExecutorRule()

    @Test
    fun testLiveData_withGetOrAwaitValue() {
        val liveData = MutableLiveData<String>()

        liveData.value = "Hello, World!"
        val value = liveData.getOrAwaitValue()

        assertEquals("Hello, World!", value)
    }
}

 

Robolectric

• Robolectric는 JVM 내에서 시뮬레이션 된 안드로이드 환경을 제공합니다.
  • 안드로이드 의존 테스트도 JVM 환경에서 실행할 수 있습니다.
• Robolectric를 활용하면 LiveData의 생명주기를 쉽게 시뮬레이션할 수 있습니다.
• 실제 LiveData가 생명주기에 따라 어떻게 동작하는지 확인이 가능하다는 장점이 있습니다.

in Test

import androidx.lifecycle.MutableLiveData
import androidx.lifecycle.Observer
import androidx.lifecycle.LifecycleOwner
import androidx.lifecycle.Lifecycle
import androidx.lifecycle.LifecycleRegistry
import org.junit.Test
import org.junit.Assert.*
import org.junit.Before
import org.robolectric.RobolectricTestRunner
import org.robolectric.annotation.Config
import org.junit.runner.RunWith

@RunWith(RobolectricTestRunner::class)
@Config(manifest = Config.NONE)
class LiveDataRobolectricTest {

    private lateinit var lifecycleOwner: LifecycleOwner
    private lateinit var lifecycle: LifecycleRegistry

    @Before
    fun setup() {
        lifecycleOwner = LifecycleOwner { lifecycle }
        lifecycle = LifecycleRegistry(lifecycleOwner)
        lifecycle.handleLifecycleEvent(Lifecycle.Event.ON_CREATE)
    }

    @Test
    fun testLiveData_withRobolectric() {
        val liveData = MutableLiveData<String>()
        val observer = Observer<String> {}

        liveData.observe(lifecycleOwner, observer)

        lifecycle.handleLifecycleEvent(Lifecycle.Event.ON_START)
        
        liveData.value = "Hello, Robolectric!"

        assertEquals("Hello, Robolectric!", liveData.value)

        lifecycle.handleLifecycleEvent(Lifecycle.Event.ON_STOP)
    }
}