Swift Snapshot Testing 中支持重复运行测试的技术实现

在 Swift Testing 测试框架中实现可靠的重复测试运行支持是一个具有挑战性的技术问题。本文将深入分析问题本质、解决方案的技术实现，以及背后的设计考量。

问题背景

在 Swift Testing 测试框架中，当尝试重复运行包含快照测试的用例时，会遇到一个核心问题：快照命名的计数器（如 xxx.1.yyy 中的数字部分）不会在每次测试迭代时重置。这导致重复运行测试时生成的快照文件名会持续递增，而不是从1重新开始计数。

技术挑战分析

1. 测试生命周期管理：Swift Testing 没有提供类似 XCTest 中 XCTestObserver 的机制来感知测试开始/结束事件
2. 并行测试执行：Swift Testing 支持并行测试执行，使得全局状态管理更加复杂
3. 参数化测试支持：需要区分参数化测试的不同用例和真正的测试重复运行

解决方案演进

初步探索

开发者尝试了多种方法来解决这个问题：

• 检查 Test.current 对象的变化
• 使用指针地址比较
• 分析 #line 指令的变化
• 检查测试用例的 debugDescription

但这些方法都存在各种局限性，无法在所有场景下可靠工作。

最终解决方案

基于 Swift 6.1 引入的 TestScoping 特性，实现了以下核心机制：

1. 任务本地存储(TaskLocal)：使用 @TaskLocal 属性包装器创建线程安全的计数器存储
2. 自定义测试特性：引入 .snapshots 测试特性来显式启用快照计数支持
3. 计数器隔离：每个测试运行在独立的上下文中，拥有自己的计数器实例

实现细节

计数器管理

private class SnapshotCount {
    var previousAssertLine: UInt = 0
    var encounteredCaseIds = [String]()
    var count = 0
}

private class SnapshotCounts {
    private var snapshotCounts = [SourceLocation: SnapshotCount]()
    // 获取或创建计数器实例
}

任务本地上下文

private enum TestContext {
    @TaskLocal
    static var snapshotCounts = SnapshotCounts()
}

测试特性集成

通过自定义测试特性，在测试开始时初始化计数器：

extension TestTrait where Self == SnapshotsTrait {
    public static func snapshots() -> Self {
        SnapshotsTrait()
    }
}

使用方式

开发者需要在测试套件或测试用例上添加 .snapshots() 特性：

@Suite(.snapshots())
struct MySnapshotTests {
    @Test func myTest() {
        assertSnapshot(...)
    }
}

设计考量

1. 显式优于隐式：要求开发者显式启用快照计数支持，避免意外行为
2. 线程安全：使用 DispatchQueue 和 TaskLocal 确保线程安全
3. 向前兼容：为未来 Swift Testing 可能提供的原生支持留出扩展空间

最佳实践建议

1. 对于参数化测试，建议使用 named: 参数为不同参数值指定明确的快照名称
2. 在测试类级别而非方法级别应用 .snapshots() 特性，确保一致性
3. 考虑将快照测试组织到独立的测试套件中，便于管理

总结

通过结合 Swift Testing 的新特性和精心设计的计数器管理机制，Swift Snapshot Testing 现在能够可靠地支持测试的重复运行。这一解决方案不仅解决了当前问题，还为未来的扩展奠定了良好基础。开发者现在可以更自信地使用快照测试来验证UI和行为，特别是在调试间歇性测试失败时。