如何测试并验证Timber日志调用已执行？

要验证Timber日志是否执行，核心思路是利用Timber支持自定义Tree的特性，通过自定义测试用Tree捕获日志输出，再进行断言验证。具体步骤如下：

1. 编写测试专用的Timber Tree #

创建一个Timber.Tree子类，用来存储所有日志的tag、内容（如果需要，还可以记录日志级别）：

class TestTree : Timber.Tree() {
    // 用Pair存储tag和对应的日志内容
    val capturedLogs = mutableListOf<Pair<String, String>>()

    override fun log(priority: Int, tag: String?, message: String, t: Throwable?) {
        tag?.run {
            capturedLogs.add(this to message)
        }
    }
}

2. 在测试生命周期中配置Timber #

在测试开始前将自定义Tree植入Timber，测试结束后移除，避免影响其他测试用例：

class TargetFunctionTest {
    private val testTree = TestTree()

    @Before
    fun setupTimber() {
        Timber.plant(testTree)
    }

    @After
    fun cleanupTimber() {
        Timber.uproot(testTree)
    }
}

3. 执行测试并验证日志 #

调用目标函数后，直接检查自定义Tree中捕获的日志是否符合预期：

@Test
fun `verify expected log is emitted`() {
    val testParam = "demo"
    // 调用包含Timber日志的目标函数
    yourFunctionUnderTest(testParam)

    // 断言日志存在：tag为"MyGag"，内容匹配"My message demo"
    val expectedLog = "MyGag" to "My message $testParam"
    assert(expectedLog in testTree.capturedLogs)
}

扩展优化 #

• 如果需要验证日志级别（比如这里的DEBUG级），可以在TestTree中额外存储priority，断言时检查priority == Log.DEBUG。
• 若使用JUnit 5，替换@Before为@BeforeEach、@After为@AfterEach即可。
• 测试时建议确保Timber只加载测试用Tree，避免正式环境的Tree（比如CrashlyticsTree）干扰测试结果。

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