Swift-Testing 中 expect 宏对 try 表达式的输出显示问题分析

问题背景

在 Swift-Testing 测试框架中，开发者使用 #expect 宏进行断言时，发现当表达式包含 try 关键字时，测试失败时的输出信息不完整。具体表现为：对于包含 try 的表达式，测试失败时不会显示实际计算得到的值，而不含 try 的表达式则会正常显示实际值。

问题现象

考虑以下测试代码示例：

enum MultiError: Error {
    case invalidInput
}

func multi(_ a: Int, _ b: Int) throws -> Int {
    guard a > 0, b > 0 else {
        throw MultiError.invalidInput
    }
    return a * b
}

func multiWithoutThrow(_ a: Int, _ b: Int) -> Int {
    return a * b
}

@Test func example() async throws {
    #expect(try multi(1, 2) == 3)  // 不显示实际值
    #expect(multiWithoutThrow(1, 2) == 3)  // 显示实际值
}

期望的输出应该是：

Expectation failed: (try multi(1, 2) → 2) == 3
Expectation failed: (multiWithoutThrow(1, 2) → 2) == 3

但实际输出是：

Expectation failed: try multi(1, 2) == 3
Expectation failed: (multiWithoutThrow(1, 2) → 2) == 3

技术分析

通过调试 Swift-Testing 源码发现，问题出在表达式解析阶段。框架内部会将 #expect 宏的参数转换为 __Expression.Kind 枚举：

1. 对于 try multi(1, 2) == 3，它被解析为一个通用的字符串表达式 generic("try multi(1, 2) == 3")，没有提取出子表达式和实际值。

2. 对于 multiWithoutThrow(1, 2) == 3，它被正确解析为二元操作 binaryOperation，其中包含左操作数、操作符和右操作数，并且左操作数的实际值被正确捕获。

临时解决方案

目前发现一个简单的解决方案是给 try 表达式加上括号：

#expect((try multi(1, 2)) == 3)

这样修改后，测试失败时会显示期望的输出：

Expectation failed: ((try multi(1, 2)) → 2) == 3

深入理解

这个问题本质上是因为 Swift 语法解析的优先级问题。不加括号时，try 关键字会与整个比较表达式绑定在一起，导致测试框架无法正确分解表达式结构。加上括号后，try 只作用于括号内的表达式，使得框架能够正确识别比较操作的各个部分。

最佳实践建议

1. 在使用 try 表达式进行断言时，始终将其用括号括起来，以确保表达式结构清晰。

2. 对于复杂的测试断言，考虑将可能抛出错误的操作提取到单独的变量中，提高测试代码的可读性：

let result = try multi(1, 2)
#expect(result == 3)

3. 关注 Swift-Testing 框架的更新，这个问题已被标记为重复问题，可能会在后续版本中得到修复。

总结

Swift-Testing 框架中 #expect 宏对 try 表达式的处理存在显示不完整的问题，这主要是由于表达式解析时的语法优先级导致的。通过给 try 表达式添加括号可以暂时解决这个问题。理解这一现象有助于开发者编写更健壮的测试代码，并在测试失败时获得更有价值的诊断信息。