WorkManager предоставляет артефакт work-testing, который помогает тестировать воркеры.
Настроить
Чтобы использовать артефакт work-testing, добавьте его в качестве зависимости androidTestImplementation в build.gradle.
Яркий
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 инициализирован в тестовом режиме, вы готовы протестировать своих работников.
Допустим, у вас есть EchoWorker, который ожидает некоторые inputData и просто копирует (повторяет) свои входные данные в 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) } } }
Базовые тесты
Ниже приведен инструментальный тест Android, который тестирует EchoWorker. Главное, что нужно запомнить: тестирование 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 предоставляет экземпляр TestDriver, который можно использовать для симуляции начальной задержки, условий, при которых выполняются ограничения для экземпляров ListenableWorker, и интервалов для экземпляров PeriodicWorkRequest.
Проверить начальные задержки
В начале работы могут возникать задержки. Чтобы протестировать EchoWorker с initialDelay, не дожидаясь 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)) }