Xcode 16 中 Swift Testing 的参数化（Parameterized）机制趣谈

概述

我们之前曾在《用接地气的例子趣谈 WWDC 24 全新的 Swift Testing 入门》系列博文以及《WWDC24（Xcode 16）中全新的 Swift Testing 使用进阶》博文中较为系统地介绍了今年 WWDC 24 中全新的 Swift Testing 测试系统。

不过 Swift Testing 的本领远不止于此！这里我们将会用它"最重量级"的特性之一 参数化（Parameterized） 让多输入样本测试易如反掌、收放自如。

在本篇博文中，您将学到如下内容：

传统多输入样本测试的弊端
Swift Testing 中全新的 Parameterized 机制
对于可能抛出错误的测试也是不在话下！
细粒度管控 Parameterized 中每个参数的测试

利用 Swift Testing 中强大的 Parameterized 机制可以让秃头码农们的测试如虎添翼，那还等什么呢？

让我们马上开始测试吧！Let's Testing！！！;)

1. 传统多输入样本测试的弊端

在以往的 XCTest 测试系统中，要想检测多个输入值的执行结果我们往往需要编写多个测试方法来一一验证。

swift 复制代码

enum ValidationError: Error {
    case valueTooSmall
    case valueTooBig
    case unknown
}

struct Validator {
    static func validate(input: Int) throws(ValidationError) -> Bool {
        if input < 0 {
            throw .valueTooSmall
        } else if input > 100 {
            throw .valueTooBig
        } else {
            true
        }
    }
}

比如，上面我们实现了一个 Validator 验证器，并用它的 validate() 静态方法来验证输入值必须在 0 - 100 之间。注意，为了演示之目的我们在输入值超大或超小时抛出了错误。

在下面的代码中，我们期望输入值 5 是有效的：

swift 复制代码

@Test("验证 5 是否为有效输入")
func testCorrectValue() throws {
  #expect(try Validator.validate(input: 5), "期待 5 为有效输入")
}

照例，我们还要验证一下无效值是否能够顺利的抛出错误：

swift 复制代码

@Test("验证 -10 是非法输入")
func testTooSmall() throws {
  #expect(throws: ValidationError.valueTooSmall) {
    try Validator.validate(input: -10)
  }
}

如此这般，我们需要继续验证其它输入值的检测结果：比如 -10, 0, 15, 90, 100, 和 200 等等。照以往来说，此时我们要为每一个输入值写一个测试方法，或是将若干个测试放在一个测试方法中。这样做有一些讨厌的"坏味道"：

违反 KISS 和 DRY原则；
不适合测试的细粒度管控；

所以，我们该如何是好呢？

2. Swift Testing 中全新的 Parameterized 机制

所幸的是，在 Xcode 16 崭新的 Swift Testing 中我们有了一种更现代化的方法来解决它，这就是 Parameterized（参数化）机制：

从上面文档中可以看到，Swift Testing 的参数化机制其实就是 Test 宏构造器的一种重载形式。我们还可以看到，使用 Parameterized 机制的必备条件为：Swift 6+ 和 Xcode 16+。

回到 Validator 验证器的测试中，我们这回使用 Parameterized 机制来降服一下之前多个输入值的"桀骜不驯"：

swift 复制代码

@Test(
  "验证一些有效的输入值",
  arguments: [0, 11, 20, 55, 90, 99, 100]
)
func testRejectsOutOfBoundsValues(input: Int) throws {
    #expect(try Validator.validate(input: input), "期待 \(input) 要有效哦 ;)")
}

现在，我们可以用同一个方法测试任意数量的输入值了。而且可以看到，其实参数化机制就是将多个输入值以参数数组的形式传入到测试方法里进行集中测试。

3. 对于可能抛出错误的测试也是不在话下！

在上面的代码中，我们仅仅测试了有效的输入值，那么对于无效的输入值我们还需要另外写一个参数化测试方法来"一蹴而就"吗？

答案是：没问题，但不需要！

我们完全可以将有效和无效的测试输入样本统统放到一起考量，即使它们可能抛出错误也"毫无压力"：

swift 复制代码

@Test(
  "验证有效和无效的输入值",
  arguments: [
    (input: -10, expectedError: ValidationError.valueTooSmall),
    (input: 0, expectedError: nil),
    (input: 15, expectedError: nil),
    (input: 55, expectedError: nil),
    (input: 95, expectedError: nil),
    (input: 100, expectedError: nil),
    (input: 200, expectedError: ValidationError.valueTooBig),
    (input: 29352354, expectedError: ValidationError.valueTooBig),
  ]
)
func testRejectsOutOfBoundsValues(input: Int, error: ValidationError?) throws {
    if let error {
        #expect(throws: error) {
            try Validator.validate(input: input)
        }
    } else {
        #expect(try Validator.validate(input: input), "期待 \(input) 要有效哦 ;)")
    }
}

从上面代码可以看到：我们将无效值和其对应期望抛出的错误打包到元组（Tuple）中，这样在测试方法中我们即可通过附加的实参取得该错误值并决定如何完成该输入值的测试。

当然，如果小伙伴们愿意的话我们仍然可以保持 testRejectsOutOfBoundsValues 测试方法只含有一个实参：

swift 复制代码

@Test(
  "验证有效和无效的输入值",
  arguments: [
    (input: -10, expectedError: ValidationError.valueTooSmall),
    (input: 0, expectedError: nil),
    (input: 15, expectedError: nil),
    (input: 55, expectedError: nil),
    (input: 95, expectedError: nil),
    (input: 100, expectedError: nil),
    (input: 200, expectedError: ValidationError.valueTooBig),
    (input: 29352354, expectedError: ValidationError.valueTooBig),
  ]
)
func testRejectsOutOfBoundsValues(condition: (value: Int, error: ValidationError?)) throws {
    if let error = condition.error{
        #expect(throws: error) {
            try Validator.validate(input: condition.value)
        }
    } else {
        #expect(try Validator.validate(input: condition.value), "期待 \(condition.value) 要有效哦 ;)")
    }
}

4. 细粒度管控 Parameterized 中每个参数的测试

使用 Parameterized 机制来规划 Swift Testing 不但能让海量样本的测试逻辑芟繁就简，而且更为"炸裂"的是我们现在可以：

一目了然的观察是哪几个输入值导致测试失败了；
继续单独测试任意输入值；

在下面的演示中，我们可以"鸟瞰"参数化方法中所有输入值测试的成功与否；我们可以一次性测试全部输入值，也可以单独测试某几个输入值。我们甚至可以重复测试某一参数值并设定测试结束条件：

看到这里，小伙伴们对 Swift Testing 是否更加"刮目相看"了呢？别再犹豫，马上在自己的项目中放手簪星曳月的使用它们吧！棒棒哒！💯

总结

在本篇博文中，我们继续介绍了 Xcode 16 全新 Swift Testing 中的参数化（Parameterized）测试机制。有此神兵利器，相信小伙伴们在今后的单元测试中必将出奇制胜、手到擒来！

感谢观赏，再会吧！8-)