WorkManager menyediakan API untuk pengujian Worker, ListenableWorker,
dan varian ListenableWorker (CoroutineWorker dan
RxWorker).
Menguji Pekerja
Misalkan Anda memiliki Worker yang terlihat seperti ini:
class SleepWorker(context: Context, parameters: WorkerParameters) : Worker(context, parameters) { override fun doWork(): Result { // Sleep on a background thread. Thread.sleep(1000) return Result.success() } }
Untuk menguji Worker ini, Anda dapat menggunakan TestWorkerBuilder. Builder ini membantu
membangun instance Worker yang dapat digunakan untuk tujuan pengujian logika
bisnis.
// Kotlin code uses the TestWorkerBuilder extension to build // the Worker @RunWith(AndroidJUnit4::class) class SleepWorkerTest { private lateinit var context: Context private lateinit var executor: Executor @Before fun setUp() { context = ApplicationProvider.getApplicationContext() executor = Executors.newSingleThreadExecutor() } @Test fun testSleepWorker() { val worker = TestWorkerBuilder<SleepWorker>( context = context, executor = executor ).build() val result = worker.doWork() assertThat(result, `is`(Result.success())) } }
TestWorkerBuilder juga dapat digunakan untuk menetapkan tag, seperti inputData atau
runAttemptCount, sehingga Anda dapat memverifikasi status pekerja secara terpisah. Perhatikan
contoh berikut, saat SleepWorker menggunakan durasi tidur sebagai data input
dan bukan konstanta yang ditetapkan di pekerja:
class SleepWorker(context: Context, parameters: WorkerParameters) : Worker(context, parameters) { override fun doWork(): Result { // Sleep on a background thread. val sleepDuration = inputData.getLong(SLEEP_DURATION, 1000) Thread.sleep(sleepDuration) return Result.success() } companion object { const val SLEEP_DURATION = "SLEEP_DURATION" } }
Di SleepWorkerTest, Anda dapat memberikan data input tersebut ke
TestWorkerBuilder untuk memenuhi kebutuhan SleepWorker.
// Kotlin code uses the TestWorkerBuilder extension to build // the Worker @RunWith(AndroidJUnit4::class) class SleepWorkerTest { private lateinit var context: Context private lateinit var executor: Executor @Before fun setUp() { context = ApplicationProvider.getApplicationContext() executor = Executors.newSingleThreadExecutor() } @Test fun testSleepWorker() { val worker = TestWorkerBuilder<SleepWorker>( context = context, executor = executor, inputData = workDataOf("SLEEP_DURATION" to 1000L) ).build() val result = worker.doWork() assertThat(result, `is`(Result.success())) } }
Untuk mengetahui detail selengkapnya tentang TestWorkerBuilder API, lihat halaman referensi untuk
TestListenableWorkerBuilder, superclass TestWorkerBuilder.
Menguji ListenableWorker dan variannya
Untuk menguji ListenableWorker atau variannya (CoroutineWorker dan
RxWorker), gunakan TestListenableWorkerBuilder. Perbedaan utama
antara TestWorkerBuilder dan TestListenableWorkerBuilder adalah
TestWorkerBuilder memungkinkan Anda menentukan Executor latar belakang yang digunakan untuk menjalankan
Worker, sedangkan TestListenableWorkerBuilder mengandalkan logika threading
implementasi ListenableWorker.
Misalnya, anggaplah kita perlu menguji CoroutineWorker yang terlihat seperti ini:
class SleepWorker(context: Context, parameters: WorkerParameters) : CoroutineWorker(context, parameters) { override suspend fun doWork(): Result { delay(1000L) // milliseconds return Result.success() } }
Untuk menguji SleepWorker, pertama-tama buat instance Pekerja menggunakan
TestListenableWorkerBuilder, lalu panggil fungsi doWork dalam
coroutine.
@RunWith(AndroidJUnit4::class) class SleepWorkerTest { private lateinit var context: Context @Before fun setUp() { context = ApplicationProvider.getApplicationContext() } @Test fun testSleepWorker() { val worker = TestListenableWorkerBuilder<SleepWorker>(context).build() runBlocking { val result = worker.doWork() assertThat(result, `is`(Result.success())) } } }
runBlocking logis sebagai builder coroutine untuk pengujian Anda agar setiap kode
yang dijalankan secara asinkron akan berjalan secara paralel.
Menguji implementasi RxWorker mirip dengan menguji CoroutineWorker, karena
TestListenableWorkerBuilder dapat menangani setiap subclass ListenableWorker.
Pertimbangkan versi SleepWorker yang menggunakan RxJava dan bukan coroutine.
class SleepWorker( context: Context, parameters: WorkerParameters ) : RxWorker(context, parameters) { override fun createWork(): Single<Result> { return Single.just(Result.success()) .delay(1000L, TimeUnit.MILLISECONDS) } }
Versi SleepWorkerTest yang menguji RxWorker mungkin terlihat mirip dengan
versi yang menguji CoroutineWorker. Anda menggunakan TestListenableWorkerBuilder yang sama, tetapi sekarang memanggil fungsi createWork RxWorker. createWork menampilkan Single yang dapat digunakan untuk memverifikasi
perilaku pekerja. TestListenableWorkerBuilder menangani setiap kerumitan
threading dan menjalankan kode pekerja Anda secara paralel.
@RunWith(AndroidJUnit4::class) class SleepWorkerTest { private lateinit var context: Context @Before fun setUp() { context = ApplicationProvider.getApplicationContext() } @Test fun testSleepWorker() { val worker = TestListenableWorkerBuilder<SleepWorker>(context).build() worker.createWork().subscribe { result -> assertThat(result, `is`(Result.success())) } } }