WorkManager proporciona un artefacto work-testing que ayuda con la prueba de tus trabajadores.
Configuración
Para usar el artefacto work-testing, agrégalo como una dependencia androidTestImplementation en build.gradle.
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") }
Para obtener más información sobre cómo agregar dependencias, consulta la sección Cómo declarar dependencias en las notas de la versión de WorkManager.
Conceptos
work-testing proporciona una implementación especial de WorkManager para el modo de prueba, que se inicializa mediante WorkManagerTestInitHelper.
El artefacto work-testing también proporciona un SynchronousExecutor que facilita la escritura de pruebas de manera síncrona, sin tener que lidiar con varios subprocesos, bloqueos o trabas.
A continuación, puedes ver un ejemplo de cómo usar todas estas clases juntas.
@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) } }
Estructura pruebas
Ahora que WorkManager se inicializó en modo de prueba, está todo listo para probar tus trabajadores.
Supongamos que tienes un EchoWorker que espera algún inputData y simplemente copia (repite) la entrada en outputData.
class EchoWorker(context: Context, parameters: WorkerParameters) : Worker(context, parameters) { override fun doWork(): Result { return when (inputData.size()) { 0 -> Result.failure() else -> Result.success(inputData) } } }
Pruebas básicas
A continuación, se muestra una prueba de instrumentación de Android que evalúa EchoWorker. La conclusión principal aquí es que la evaluación de EchoWorker en el modo de prueba es muy similar al uso de EchoWorker en una aplicación real.
@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)) }
Escribamos otra prueba que asegure que cuando EchoWorker no obtenga datos de entrada, el Result esperado sea un 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)) }
Simula restricciones, retrasos y trabajos periódicos
WorkManagerTestInitHelper te proporciona una instancia de TestDriver que se puede usar para simular un retraso inicial, condiciones en las que se cumplan las restricciones para instancias de ListenableWorker e intervalos para instancias de PeriodicWorkRequest.
Prueba las demoras iniciales
Los trabajadores pueden tener retrasos iniciales. A fin de probar EchoWorker con un initialDelay, en lugar de tener que esperar el initialDelay en tu prueba, puedes usar el TestDriver para marcar el retraso inicial de la solicitud de trabajo según ocurra mediante 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)) }
Prueba restricciones
TestDriver también se puede usar para marcar restricciones a medida que se cumplen mediante setAllConstraintsMet. A continuación, se muestra un ejemplo de cómo puedes probar un Worker con restricciones.
@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)) }
Prueba el trabajo periódico
El TestDriver también expone un setPeriodDelayMet que se puede usar para indicar que se completó un intervalo. Este es un ejemplo de uso de 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)) }