WorkManager ile entegrasyon testleri

WorkManager, çalışanlarınızın test edilmesine yardımcı olan bir work-testing yapısı sağlar.

Kurulum

work-testing yapısını kullanmak için build.gradle dosyasına androidTestImplementation bağımlılığı olarak ekleyin.

Modern

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")
}

Bağımlılık ekleme hakkında daha fazla bilgi için WorkManager sürüm notlarındaki Bağımlılıkları bildirme bölümüne bakın.

Kavramlar

work-testing, test modu için WorkManager'ın özel bir uygulamasını sağlar. Bu uygulama, WorkManagerTestInitHelper kullanılarak başlatılır.

work-testing yapısı, birden fazla iş parçacığı, kilit veya mandalla uğraşmak zorunda kalmadan testleri eşzamanlı olarak yazmayı kolaylaştıran bir SynchronousExecutor da sağlar.

Aşağıda, tüm bu sınıfların birlikte nasıl kullanılacağına dair bir örnek verilmiştir.

@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)
    }
}

Testleri Yapılandırma

WorkManager test modunda başlatıldığına göre çalışanlarınızı test etmeye hazırsınız.

inputData bekleyen ve girişini outputData'ye kopyalayan (yankılayan) bir EchoWorker olduğunu varsayalım.

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

Temel Testler

Aşağıda, EchoWorker testini gerçekleştiren bir Android enstrümantasyon testi verilmiştir. Burada asıl vurgulamak istediğimiz nokta, EchoWorker'i test modunda test etmenin, gerçek bir uygulamada EchoWorker kullanmaya çok benzediğidir.

@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 işlevine giriş verisi sağlanmadığında beklenen Result değerinin Result.failure() olduğunu doğrulayan başka bir test yazalım.

@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))
}

Kısıtlamaları, gecikmeleri ve periyodik çalışmaları simüle etme

WorkManagerTestInitHelper, ilk gecikmeyi, ListenableWorker örnekleri için kısıtlamaların karşılandığı koşulları ve PeriodicWorkRequest örnekleri için aralıkları simüle etmek amacıyla kullanılabilecek bir TestDriver örneği sağlar.

İlk Gecikmeleri Test Etme

Çalışanlar başlangıçta gecikmeler yaşayabilir. EchoWorker öğesini bir initialDelay ile test etmek için testinizde initialDelay öğesini beklemek yerine TestDriver kullanarak iş isteğinin ilk gecikmesini setInitialDelayMet ile karşılandı olarak işaretleyebilirsiniz.

@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))
}

Test Kısıtlamaları

TestDriver, setAllConstraintsMet kullanarak kısıtlamaları karşılandı olarak işaretlemek için de kullanılabilir. Kısıtlamalarla Worker test etme örneğini aşağıda bulabilirsiniz.

@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))
}

Periyodik Çalışmayı Test Etme

TestDriver, bir aralığın tamamlandığını belirtmek için kullanılabilecek bir setPeriodDelayMet de sunar. setPeriodDelayMet kullanımına dair bir örnek:

@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))
}