用接地气的例子趣谈 WWDC 24 全新的 Swift Testing 入门（三）

news2024/11/26 11:26:44

在这里插入图片描述

概述

从 WWDC 24 开始，苹果推出了全新的测试机制：Swift Testing。利用它我们可以大幅度简化之前“老态龙钟”的 XCTest 编码范式，并且使得单元测试更加灵动自由，更符合 Swift 语言的优雅品味。

在这里插入图片描述

在这里我们会和大家一起初涉并领略 Swift Testing 的测试之美。

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

概述
4. #expect 宏
5. #require 宏
6. Swift Testing 目前的不足
总结

测试为先，质量为王！无测试，不软件！

那还等什么呢？Let’s testing！！！😉

4. #expect 宏

如果说前面介绍的 @Test 宏为测试奠定了基调，那么 #expect 宏则无疑是当之无愧的测试核心所在。

在这里插入图片描述

在以往“陈言老套”的 XCTest 体系中，我们往往需要用超多 XCTAssertXXX 之类的方法来验证测试通过与否：

在这里插入图片描述

记住这些“聚蚊成雷”般的方法可不是件容易的活。不过这一切在 Swift Testing 都不是事儿了，因为不管现实如何千变万化我们都只需一个 #expect 宏即可统统搞定！

import Testing

func add(_ a: Int, _ b: Int) -> Int {
    a + b
}

@Test func verifyAdd() {
    let result = add(1, 2)
    #expect(result == 3)
}

上面是 #expect 宏最简单的形式，即验证结果是否为真。如此这般，多个 #expect 连续助攻自然也是不在话下：

@Test func verifyMagicNumber() {
    let number = magicNumber()
    
    #expect(number != 0)
    #expect(number > 10)
    #expect(number <= 100)
}

我们还可以利用 #expect 来验证被测试方法是否抛出错误、以及是否抛出指定错误：

enum MyError: Error {
    case invalidInput
}

func throwingFunction() throws {
    throw MyError.invalidInput
}

@Test func verifyThrowingFunction() {
    #expect(throws: MyError.self) {
        try throwingFunction()
    }
}

在上面的代码中，如果 throwingFunction 抛出 MyError 错误则表示测试通过！

我们还可以更进一步，细粒度控制方法抛出错误时的测试行为，比如仅当抛出指定 MyError.invalidInput 错误时才能使测试 Pass：

@Test func verifyThrowingFunction() {
    #expect {
        try throwingFunction()
    } throws: { error in
        guard let myError = error as? MyError else {
            return false
        }
        return myError == .invalidInput
    }
}

Swift Testing 中 #expect 的能耐远不止于此，更多它的使用介绍请小伙伴们参考苹果官方开发文档。

5. #require 宏

除了 #expect 之外，在 Swift Testing 中还有另一个不可或缺的“超级助手”，那就是 #require 宏：

在这里插入图片描述

简单来说，#require 宏的精妙之处在于它可以让我们立即判断条件是否满足，并提早结束测试。具体来说，它会在测试可选值（Optional Value）为 nil （或者其它条件不满足）时让测试失败并抛出错误。

@Test func verifyOptionalFunc() throws {
    let result = optionalFunc()
    try #require(result != nil)
    
    #expect(result! > 0)
}

还拿之前博文中 Item 的“栗子”来说，我们可以写一个验证 Model 中第一个 Item 名称的方法，不过由于我们忘记了创建 Model 中的 items，所以下面的测试会在 #require 那行抛出错误，因为此时 items 数组为空：

@Test
func firstItemCheck() throws {
    let model = Model.shared
    let firstItem = try #require(model.items.first)
    #expect(firstItem.name == "大熊猫侯佩")
}

失败的测试结果如下图所示：
在这里插入图片描述

更进一步，我们还可以利用 Issue 对象来记录测试遇到的任何问题，它们都会在测试日志中分毫不差的反映出来：

@Test
func firstItemCheck() {
    let model = Model.shared
    
    do {
        let firstItem = try #require(model.items.first)
        #expect(firstItem.name == "大熊猫侯佩")
    } catch {
        Issue.record("Model 中没有任何数据，忘记创建了？？？")
    }
}