PublisherExpectations

简化 Combine Publisher 测试并帮助提高单元测试可读性的 XCTestExpectation 子类。

动机

使用 XCTestExpectation 为 Combine Publisher (或 @Published 属性) 编写测试通常涉及一些样板代码，例如

let expectation = XCTestExpectation(description: "Wait for the publisher to emit the expected value")
viewModel.$output.sink { _ in
} receiveValue: { value in
    if value == expectedValue {
        expectation.fulfill()
    }
}
.store(in: &cancellables)

wait(for: [expectation], timeout: 1)

我们可以尝试使用 XCTKeyPathExpectation，但这要求被观察的对象继承自 NSObject，并且还需要使用 @objc 属性和 dynamic 修饰符标记我们要观察的属性，以使其符合 KVO 规范

class ViewModel: NSObject {
    @objc dynamic var isLoading = false
}

let expectation = XCTKeyPathExpectation(keyPath: \ViewModel.isLoading, observedObject: viewModel, expectedValue: true)

另一种诱人的方法是使用 XCTNSPredicateExpectation，例如

let expectation = XCTNSPredicateExpectation(predicate: NSPredicate { _,_ in
    viewModel.output == expectedValue
}, object: viewModel)

虽然这看起来不错且简洁，但 XCTNSPredicateExpectation 的问题在于它非常慢，最适合用于 UI 测试。这是因为它使用某种轮询机制，该机制会在期望被满足之前至少增加 1 秒的显著延迟。因此，最好不要在单元测试中采用这种方法。

描述

PublisherExpectations 是一组 3 个 XCTestExpectation，允许以清晰简洁的方式声明 publisher 事件的期望。它们继承自 XCTestExpectation，因此可以像任何其他 expectation 一样在 wait(for: [expectations]) 调用中使用。

PublisherValueExpectation：当 publisher 发出一个符合特定条件的值时，该 expectation 会被满足。
PublisherFinishedExpectation：当 publisher 成功完成时，该 expectation 会被满足。
PublisherFailureExpectation：当 publisher 以失败完成时，该 expectation 会被满足。

用法

PublisherValueExpectation

等待预期值

let publisherExpectation = PublisherValueExpectation(stringPublisher, expectedValue: "Got it")

等待符合条件的值

let publisherExpectation = PublisherValueExpectation(arrayPublisher) { $0.contains(value) }

也适用于 @Published 属性包装器

let publisherExpectation = PublisherValueExpectation(viewModel.$isLoaded, expectedValue: true)

let publisherExpectation = PublisherValueExpectation(viewModel.$keywords) { $0.contains("Cool") }

PublisherFinishedExpectation

等待 publisher 完成

let publisherExpectation = PublisherFinishedExpectation(publisher)

等待 publisher 在发出预期值后完成

let publisherExpectation = PublisherFinishedExpectation(publisher, expectedValue: 2)

等待在发出符合特定条件的值后完成

let publisherExpectation = PublisherFinishedExpectation(arrayPublisher) { array in
    array.allSatisfy { $0 > 5 }
}

PublisherFailureExpectation

期望失败

let publisherExpectation = PublisherFailureExpectation(publisher)

期望发生符合条件的错误导致的失败

let publisherExpectation = PublisherFailureExpectation(publisher) { error in
    guard case .apiError(let code) = error, code = 500 else { return false }
    return true
}

如果预期的错误符合 Equatable 协议

let publisherExpectation = PublisherFailureExpectation(publisher, expectedError: ApiError(code: 100))

安装

从“File”菜单中，选择“Add Packages...”
输入包仓库 URL： https://github.com/yannxou/PublisherExpectations
确认版本并让 Xcode 解析包

提示

感谢 Combine，我们可以调整 publisher 以检查许多事情，同时保持测试的可读性

期望发出多个值

let publisherExpectation = PublisherValueExpectation(publisher.collect(3), expectedValue: [1,2,3])

期望第一个/最后一个发出的值

let publisherExpectation = PublisherValueExpectation(publisher.first(), expectedValue: 1)
let publisherExpectation = PublisherValueExpectation(publisher.last(), expectedValue: 5)

期望第二个发出的值

let publisherExpectation = PublisherValueExpectation(publisher.dropFirst().first(), expectedValue: 2)