Kotest项目中assertSoftly断言丢失堆栈跟踪的问题分析

问题背景

在Kotest测试框架中，assertSoftly是一个非常有用的功能，它允许在单个测试块中执行多个断言，即使其中一个断言失败，也会继续执行其他断言，最后将所有失败结果汇总报告。然而，在5.9.1版本中存在一个关于堆栈跟踪显示不准确的问题。

问题现象

当使用assertSoftly块时，如果满足以下两个条件：

1. 块中只收集到一个断言错误
2. 该断言错误的类型不是标准的AssertionFailedError(例如是普通的AssertionError)

那么错误报告中显示的堆栈跟踪会指向assertSoftly块的开始位置，而不是实际断言失败的位置。这使得开发者难以快速定位到真正出错的代码行。

问题复现

通过一个简单的测试类可以清晰地复现这个问题：

import io.kotest.assertions.assertSoftly
import io.kotest.core.spec.style.StringSpec
import io.kotest.matchers.should
import io.kotest.matchers.shouldBe
import io.kotest.matchers.string.beEmpty

class Test : StringSpec ({
    "多个断言错误" {
        assertSoftly {
            1 shouldBe 2                  // 错误1
            null should beEmpty()         // 错误2
        }
    }
    "单个断言错误" {
        assertSoftly {                    // 堆栈跟踪指向这里
            null should beEmpty()         // 实际错误位置
        }
    }
})

在第一个测试用例中，由于有两个断言错误，堆栈跟踪会正确地指向两个错误位置。但在第二个测试用例中，由于只有一个断言错误，堆栈跟踪会错误地指向assertSoftly块的开始位置。

问题影响

虽然这个问题看起来不大，因为堆栈跟踪至少指向了包含错误的代码块，但当启用全局软断言设置(kotest.framework.assertion.globalassertsoftly = true)时，问题会变得更加严重，因为所有的断言都会自动包裹在软断言中，导致调试变得更加困难。

技术分析

这个问题的根本原因在于assertSoftly实现中对错误处理的逻辑。当只有一个错误且类型不是AssertionFailedError时，框架没有正确地保留原始错误的堆栈跟踪信息。正确的实现应该始终保留原始断言失败的堆栈信息，无论错误类型如何。

解决方案

该问题已在后续版本中得到修复。修复的核心思路是确保无论错误类型和数量如何，都正确保留原始错误的堆栈跟踪信息。开发者可以通过升级到最新版Kotest来解决这个问题。

最佳实践

1. 及时更新Kotest版本以获取最新的错误修复
2. 在调试软断言问题时，可以临时关闭全局软断言设置
3. 对于关键断言，考虑使用硬断言(shouldBe)而非软断言，以获得更准确的错误位置
4. 编写测试时，尽量保持断言块的简洁，便于定位问题

通过理解这个问题及其解决方案，开发者可以更有效地使用Kotest的软断言功能，提高测试代码的可维护性和调试效率。