WorkManager 통합 테스트

WorkManager는 작업자 테스트에 도움이 되는 work-testing 아티팩트를 제공합니다.

설정

work-testing 아티팩트를 사용하려면 build.gradle에 androidTestImplementation 종속 항목으로 추가합니다.

Groovy

dependencies {
    def work_version = "2.5.0"

    ...

    // optional - Test helpers
    androidTestImplementation "androidx.work:work-testing:$work_version"
}

Kotlin

dependencies {
    val work_version = "2.4.0"

    ...

    // optional - Test helpers
    androidTestImplementation("androidx.work:work-testing:$work_version")
}

종속 항목 추가에 관한 자세한 내용은 WorkManager 출시 노트의 종속 항목 선언 섹션을 참고하세요.

개념

work-testing은 테스트 모드를 위해 특별한 WorkManager 구현을 제공하며 WorkManagerTestInitHelper를 사용하여 초기화됩니다.

또한 work-testing 아티팩트는 여러 스레드, 잠금 및 래치를 처리할 필요 없이 동기 방식으로 테스트를 더 쉽게 작성할 수 있게 해주는 SynchronousExecutor를 제공합니다.

다음은 이러한 모든 클래스를 함께 사용하는 방법을 예로 보여줍니다.

@RunWith(AndroidJUnit4::class)
class BasicInstrumentationTest {
    @Before
    fun setup() {
        val context = InstrumentationRegistry.getInstrumentation().targetContext
        val config = Configuration.Builder()
            .setMinimumLoggingLevel(Log.DEBUG)
            .setExecutor(SynchronousExecutor())
            .build()

        // Initialize WorkManager for instrumentation tests.
        WorkManagerTestInitHelper.initializeTestWorkManager(context, config)
    }
}

테스트 구조화하기

WorkManager를 테스트 모드로 초기화했으므로 이제 작업자를 테스트할 준비가 되었습니다.

inputData를 기다렸다가 단순히 입력을 outputData에 복사(에코)하는 EchoWorker를 가정해 보겠습니다.

class EchoWorker(context: Context, parameters: WorkerParameters) :
    Worker(context, parameters) {
    override fun doWork(): Result {
        return when (inputData.size()) {
            0 -> Result.failure()
            else -> Result.success(inputData)
        }
    }
}

기본 테스트

다음은 EchoWorker를 테스트하는 Android 계측 테스트입니다. 여기에서 핵심은 테스트 모드에서 EchoWorker를 테스트하는 것이 실제 애플리케이션에서 EchoWorker를 사용하는 방법과 매우 비슷하다는 것입니다.

@Test
@Throws(Exception::class)
fun testSimpleEchoWorker() {
    // Define input data.
    val input = workDataOf(KEY_1 to 1, KEY_2 to 2)

    // Create request.
    val request = OneTimeWorkRequestBuilder<EchoWorker>()
        .setInputData(input)
        .build()

    val workManager = WorkManager.getInstance(applicationContext)
    // Enqueue and wait for result. This also runs the Worker synchronously
    // because we are using a SynchronousExecutor.
    workManager.enqueue(request).result.get()
    // Get WorkInfo and outputData.
    val workInfo = checkNotNull(workManager.getWorkInfoById(request.id).get())
    val outputData = workInfo.outputData

    // Assert.
    assertThat(workInfo.state, `is`(WorkInfo.State.SUCCEEDED))
    assertThat(outputData, `is`(input))
}

EchoWorker가 입력 데이터를 받지 못했을 때 예상되는 Result가 Result.failure()인 것을 확인하는 다른 테스트를 작성해 보겠습니다.

@Test
@Throws(Exception::class)
fun testEchoWorkerNoInput() {
    // Create request.
    val request = OneTimeWorkRequestBuilder<EchoWorker>()
        .build()

    val workManager = WorkManager.getInstance(applicationContext)
    // Enqueue and wait for result. This also runs the Worker synchronously
    // because we are using a SynchronousExecutor.
    workManager.enqueue(request).result.get()
    // Get WorkInfo.
    val workInfo = checkNotNull(workManager.getWorkInfoById(request.id).get())

    // Assert.
    assertThat(workInfo.state, `is`(WorkInfo.State.FAILED))
}

제약 조건, 지연, 주기적 작업 시뮬레이션

WorkManagerTestInitHelper는 초기 지연, ListenableWorker 인스턴스의 제약 조건이 충족되는 조건, PeriodicWorkRequest 인스턴스의 주기를 시뮬레이션하는 데 사용할 수 있는 TestDriver 인스턴스를 제공합니다.

초기 지연 테스트

작업자에 초기 지연이 있을 수 있습니다. initialDelay로 EchoWorker를 테스트하려면 테스트에서 initialDelay를 기다리지 않고 TestDriver에서 setInitialDelayMet을 사용하여 작업 요청의 초기 지연을 충족됨으로 표시하면 됩니다.

@Test
@Throws(Exception::class)
fun testWithInitialDelay() {
    // Define input data.
    val input = workDataOf(KEY_1 to 1, KEY_2 to 2)

    // Create request.
    val request = OneTimeWorkRequestBuilder<EchoWorker>()
        .setInputData(input)
        .setInitialDelay(10, TimeUnit.SECONDS)
        .build()

    val workManager = WorkManager.getInstance(getApplicationContext())
    // Get the TestDriver.
    val testDriver = checkNotNull(WorkManagerTestInitHelper.getTestDriver(getApplicationContext()))
    // Enqueue.
    workManager.enqueue(request).result.get()
    // Tells the WorkManager test framework that initial delays are now met.
    testDriver.setInitialDelayMet(request.id)
    // Get WorkInfo and outputData.
    val workInfo = checkNotNull(workManager.getWorkInfoById(request.id).get())
    val outputData = workInfo.outputData

    // Assert.
    assertThat(workInfo.state, `is`(WorkInfo.State.SUCCEEDED))
    assertThat(outputData, `is`(input))
}

제약 조건 테스트하기

TestDriver에서 setAllConstraintsMet을 사용하여 제약 조건을 충족됨으로 표시할 수도 있습니다. 다음은 제약 조건으로 Worker를 테스트할 수 있는 방법의 예입니다.

@Test
@Throws(Exception::class)
fun testWithConstraints() {
    // Define input data.
    val input = workDataOf(KEY_1 to 1, KEY_2 to 2)

    val constraints = Constraints.Builder()
        .setRequiredNetworkType(NetworkType.CONNECTED)
        .build()

    // Create request.
    val request = OneTimeWorkRequestBuilder<EchoWorker>()
        .setInputData(input)
        .setConstraints(constraints)
        .build()

    val workManager = WorkManager.getInstance(myContext)
    val testDriver = checkNotNull(WorkManagerTestInitHelper.getTestDriver(myContext))
    // Enqueue.
    workManager.enqueue(request).result.get()
    // Tells the testing framework that all constraints are met.
    testDriver.setAllConstraintsMet(request.id)
    // Get WorkInfo and outputData.
    val workInfo = checkNotNull(workManager.getWorkInfoById(request.id).get())
    val outputData = workInfo.outputData

    // Assert.
    assertThat(workInfo.state, `is`(WorkInfo.State.SUCCEEDED))
    assertThat(outputData, `is`(input))
}

주기적인 작업 테스트하기

TestDriver은 하나의 주기가 완료되었음을 나타내는 데 사용할 수 있는 setPeriodDelayMet도 노출합니다. 다음은 setPeriodDelayMet을 사용하는 예입니다.

@Test
@Throws(Exception::class)
fun testPeriodicWork() {
    // Define input data.
    val input = workDataOf(KEY_1 to 1, KEY_2 to 2)

    // Create request.
    val request = PeriodicWorkRequestBuilder<EchoWorker>(15, MINUTES)
        .setInputData(input)
        .build()

    val workManager = WorkManager.getInstance(myContext)
    val testDriver = checkNotNull(WorkManagerTestInitHelper.getTestDriver(myContext))
    // Enqueue and wait for result.
    workManager.enqueue(request).result.get()
    // Tells the testing framework the period delay is met.
    testDriver.setPeriodDelayMet(request.id)
    // Get WorkInfo and outputData.
    val workInfo = checkNotNull(workManager.getWorkInfoById(request.id).get())

    // Assert.
    assertThat(workInfo.state, `is`(WorkInfo.State.ENQUEUED))
}