Kotlin Firebase单元测试Mock await()函数无返回问题排查

云原生阿岚

2026-7-9

Firebase Firestore单元测试Mock await()卡住的问题解决

问题分析

你的Mock代码忽略了Firebase Task 的核心状态逻辑：await() 挂起函数会等待任务进入完成状态（isSuccessful 或 isComplete 为true）。如果只mock了await()的返回值但未设置Task的完成状态，协程会一直阻塞等待任务完成，导致调用无法返回。

修正后的Mock代码

// 先mock所需的DocumentSnapshot实例
val deliveryDocument = mockk<DocumentSnapshot>()

val db = mockk<FirebaseFirestore>()

val querySnapshot = mockk<QuerySnapshot> {
    every { documents } returns mutableListOf(deliveryDocument)
}

val querySnapshotTask: Task<QuerySnapshot> = mockk {
    // 标记任务成功完成，让await()可以正常返回
    every { isSuccessful } returns true
    // 正确mock挂起函数await()的返回值
    coEvery { await() } returns querySnapshot
    // 可选：如果业务代码用到了任务监听，补充mock监听回调
    every { addOnSuccessListener(any<OnSuccessListener<QuerySnapshot>>()) } answers {
        firstArg<OnSuccessListener<QuerySnapshot>>().onSuccess(querySnapshot)
        this@mockk
    }
}

// 关联Firestore调用链
every { db.collection("some_path_to_documents").get() } returns querySnapshotTask

测试协程注意事项

由于await()是挂起函数，测试代码必须使用kotlinx-coroutines-test库提供的协程测试工具，确保挂起函数能在测试环境中正确执行：

import kotlinx.coroutines.test.runTest
import org.junit.Test

@Test
fun testFetchDocuments() = runTest {
    // 初始化上述mock实例
    // 调用待测试的业务方法
    val yourService = YourFirebaseService(db)
    yourService.fetchDocuments()
    
    // 执行断言逻辑，比如验证documents是否被正确遍历
    verify { querySnapshot.documents.forEach(any()) }
}