Android Kotlin下测试WorkManager enqueueUniqueWork与cancelUniqueWork的最优方法

前置依赖配置 #

你需要引入WorkManager官方测试组件，避免依赖真实系统调度逻辑，实现本地单元测试/ instrumentation测试：

• 测试依赖引入：androidx.work:work-testing:<最新版本号>
• 测试初始化阶段使用WorkManagerTestInitHelper初始化测试用的WorkManager实例，使用同步执行器避免异步等待问题

测试enqueueUniqueWork逻辑 #

核心验证点为不同ExistingWorkPolicy下的任务入队行为是否符合预期，通过getWorkInfosForUniqueWork()传入业务使用的唯一工作名，即可获取该名称关联的所有任务信息，无需持有任务ID：

@RunWith(JUnit4::class)
class UniqueWorkTest {
    private lateinit var workManager: WorkManager

    @Before
    fun setup() {
        val context = ApplicationProvider.getApplicationContext<Context>()
        val testConfig = Configuration.Builder()
            .setMinimumLoggingLevel(Log.DEBUG)
            .setExecutor(SynchronousExecutor())
            .build()
        WorkManagerTestInitHelper.initializeTestWorkManager(context, testConfig)
        workManager = WorkManager.getInstance(context)
    }

    @Test
    fun `enqueueUniqueWork with REPLACE policy 应覆盖已存在的同名称任务`() {
        val testUniqueName = "business_sync_unique_work"
        // 第一次入队任务
        val firstWork = OneTimeWorkRequestBuilder<BusinessSyncWorker>().build()
        workManager.enqueueUniqueWork(testUniqueName, ExistingWorkPolicy.REPLACE, firstWork)
        // 第二次入队同名称任务，策略为REPLACE
        val secondWork = OneTimeWorkRequestBuilder<BusinessSyncWorker>().build()
        workManager.enqueueUniqueWork(testUniqueName, ExistingWorkPolicy.REPLACE, secondWork)

        // 查询唯一名称关联的所有任务
        val workInfos = workManager.getWorkInfosForUniqueWork(testUniqueName).get()
        // 断言仅保留第二个任务，第一个被替换
        assertThat(workInfos.size).isEqualTo(1)
        assertThat(workInfos.first().id).isEqualTo(secondWork.id)
    }
}

如果需要验证KEEP/APPEND等其他策略，调整参数后校验返回的WorkInfo列表长度、状态即可。

测试cancelUniqueWork逻辑 #

先入队指定名称的任务，执行取消操作后查询任务状态验证结果：

@Test
fun `cancelUniqueWork 应取消指定名称下的所有关联任务`() {
    val testUniqueName = "business_upload_unique_work"
    val testWork = OneTimeWorkRequestBuilder<BusinessUploadWorker>()
        .setInitialDelay(5, TimeUnit.MINUTES) // 设置初始延迟避免任务提前执行
        .build()
    workManager.enqueueUniqueWork(testUniqueName, ExistingWorkPolicy.KEEP, testWork)

    // 执行业务侧的取消逻辑
    workManager.cancelUniqueWork(testUniqueName)

    // 校验任务状态为已取消
    val workInfos = workManager.getWorkInfosForUniqueWork(testUniqueName).get()
    assertThat(workInfos.first().state).isEqualTo(WorkInfo.State.CANCELLED)
}

额外测试技巧 #

• 针对周期性任务PeriodicWorkRequest，上述测试逻辑完全通用，getWorkInfosForUniqueWork()同样支持查询周期性唯一任务
• 可配合测试库提供的TestDriver模拟约束满足、延迟到期等场景，验证唯一任务的执行逻辑是否符合预期
• 所有测试用例不需要修改业务侧的唯一名称定义，完全对齐生产逻辑，测试结果可信度更高

内容的提问来源于stack exchange，提问作者user16976904