如何在Android DataStore中结合TestCoroutineScope进行测试？

I've run into this exact issue before—Android DataStore's internal ActorCoroutine tends to stay active after tests finish when using runBlockingTest, triggering that annoying UncompletedCoroutinesError. While your in-memory mock via constructor injection works, here are a few ways to test your Feature class without modifying its constructor:

1. Force Coroutine Completion and Cleanup #

The error occurs because DataStore's background actor doesn't finish before the test scope closes. You can explicitly drive all pending coroutines to completion and clean up the test scope before running your assertions:

runBlockingTest {
    val feature = Feature(this)
    feature.foo()
    
    // Wait for all suspended tasks (including DataStore's internal work) to finish
    advanceUntilIdle()
    // Explicitly clean up the test scope to terminate any remaining active coroutines
    cleanupTestCoroutines()
    
    // Now run your verification logic
    verifyStuff...
}

This works by pushing the test scope to process all pending jobs, then wiping out any leftover coroutine state that DataStore might leave behind.

2. Swap DataStore Implementation for Tests #

Instead of modifying your Feature class's constructor, you can override how createDataStore behaves in test environments. Create a test-specific extension function that returns your in-memory mock instead of the real DataStore:

Step 1: Create a Test DataStore Extension #

// In your test source set
fun Context.createTestDataStore(
    fileName: String,
    serializer: Serializer<MetaDataStore>,
    scope: CoroutineScope
): DataStore<MetaDataStore> {
    return DatastoreInmemoryImpl(serializer.defaultValue)
}

Step 2: Replace the Real Creation Logic in Tests #

If your Feature class uses a Context extension to create DataStore, you can shadow the real createDataStore function in your test code (ensure the package matches) or use a dependency replacement tool (like Dagger Hilt's test bindings) to inject the test version automatically. This way, your Feature class stays unchanged, but tests use the in-memory implementation with no background actors.

3. Use DataStore's Official Test Utilities (If Available) #

Check if you're using the latest version of DataStore—Google has added better test support in newer releases. Some versions provide a TestDataStore designed to work with test coroutine scopes without leaving active jobs. If this is available for your version, it's the cleanest solution.

Why Your Original Mock Works (And When to Stick With It) #

Your DatastoreInmemoryImpl is a solid solution because it eliminates the real DataStore's background coroutine entirely. If constructor injection is an option long-term, it's still one of the most reliable ways to isolate your tests from Android framework dependencies.

内容的提问来源于stack exchange，提问作者David Michael Gang