Swift 5.5 在 init 中测试异步任务

Question

我想测试我的 init 函数是否按预期工作。Task {} 块内的 init 中有一个异步调用。如何让我的测试等待任务块的结果？

class ViewModel: ObservableObject {
    @Published private(set) var result: [Item]
        
    init(fetching: RemoteFetching) {
        self.result = []
        Task {
            do {
                let result = try await fetching.fetch()
                
                self.result = result // <- need to do something with @MainActor?
            } catch {
                print(error)   
            }
        }
    }  
}

测试：

func testFetching() async {
    let items = [Item(), Item()]
    let fakeFetching = FakeFetching(returnValue: items)

    let vm = ViewModel(fetching: FakeFetching())
        
    XCTAssertEqual(vm.result, [])
        
    // wait for fetching, but how?
        
    XCTAssertEqual(vm.result, items])
}

我尝试了这个，但是设置项目仅在 XCTWaiter 之后发生。编译器警告 XCTWaiter 不能用 wait 调用，因为它不是异步的。

    func testFetching() async {
        let items = [Item(), Item()]
        let fakeFetching = FakeFetching(returnValue: items)

        let expectation = XCTestExpectation()

        let vm = ViewModel(fetching: FakeFetching())
        
        XCTAssertEqual(vm.result, [])
        
        vm.$items
            .dropFirst()
            .sink { value in
                XCTAssertEqual(value, items)
                expectation.fulfill()
            }
            .store(in: &cancellables)
        
        let result = await XCTWaiter.wait(for: [expectation], timeout: 1)
        
        XCTAssertEqual(result, .completed)
    }

Answer 1

期待并等待是正确的。你只是用错了而已。

这件事你想太多了。您不需要async测试方法。你不需要给fulfill自己打电话。您不需要联合链。只需使用谓词期望来等待，直到vm.result设置。

基本上规则是这样的：测试一个async方法需要一个async测试方法。但是，测试碰巧进行异步调用的方法（如您的init方法）的异步“结果”，只需要良好的老式期望和等待测试。

我举个例子。这是代码的简化版本；该结构本质上与您正在做的相同：

protocol Fetching {
    func fetch() async -> String
}
class MyClass {
    var result = ""
    init(fetcher: Fetching) {
        Task {
            self.result = await fetcher.fetch()
        }
    }
}

好吧，下面是测试方法：

final class MockFetcher: Fetching {
    func fetch() async -> String { "howdy" }
}

final class MyLibraryTests: XCTestCase {
    let fetcher = MockFetcher()
    func testMyClassInit() {
        let subject = MyClass(fetcher: fetcher)
        let expectation = XCTNSPredicateExpectation(
            predicate: NSPredicate(block: { _, _ in
                subject.result == "howdy"
            }), object: nil
        )
        wait(for: [expectation], timeout: 2)
    }
}

专家额外提示： Bool 谓词期望是一种很常用的东西，因此手头有一个将期望、谓词和等待组合到单个包中的便捷方法会很有用：

extension XCTestCase {
    func wait(
        _ condition: @escaping @autoclosure () -> (Bool),
        timeout: TimeInterval = 10)
    {
        wait(for: [XCTNSPredicateExpectation(
            predicate: NSPredicate(block: { _, _ in condition() }), object: nil
        )], timeout: timeout)
    }
}

结果是，例如，上面的测试代码可以简化为：

    func testMyClassInit() {
        let subject = MyClass(fetcher: fetcher)
        wait(subject.result == "howdy")
    }

确实方便。在我自己的代码中，我经常添加显式断言，即使它完全多余，只是为了完全清楚我声称我的代码的作用：

    func testMyClassInit() {
        let subject = MyClass(fetcher: fetcher)
        wait(subject.result == "howdy")
        XCTAssertEqual(subject.result, "howdy") // redundant but nice
    }