这篇文章是阅读 RxSwift: Reactive Programming with Swift 时记的笔记,介绍如何使用RxTest和RxBlocking对RxSwift编写单元测试。
书上使用RxTest和RxBlocking对一个 demo 进行了完整的单元测试和讲解,在这个过程中,我们可以熟悉一下RxSwift 单元测试的使用方法,了解单元测试的一般使用技巧和注意事项。
Demo 介绍
Demo 是一个转换颜色的小应用,根据用户输入的16进制颜色代码自动转换为红、绿、蓝色值和颜色名字(若有)。
Demo 是使用MVVM模式实现的,逻辑代码放在了ViewModel中,ViewController管理和控制View。ViewModel的主要代码如下:
// Convert hex text to color
color = hexString.asObservable()
.map { hex in
guard hex.characters.count == 7 else { return .clear }
let color = UIColor(hex: hex)
return color
}
.asDriver(onErrorJustReturn: .clear)
// Convert the color to an rgb tuple
rgb = color.asObservable()
.map { color in
var red: CGFloat = 0.0
var green: CGFloat = 0.0
var blue: CGFloat = 0.0
color.getRed(&red, green: &green, blue: &blue, alpha: nil)
let rgb = (Int(red * 255.0), Int(green * 255.0), Int(blue * 255.0))
return rgb
}
.asDriver(onErrorJustReturn: (0, 0, 0))
// Convert the hex text to a matching name
colorName = hexString.asObservable()
.map { hexString in
let hex = String(hexString.characters.dropFirst())
if let color = ColorName(rawValue: hex) {
return "\(color)"
} else {
return "--"
}
}
.asDriver(onErrorJustReturn: "")
接下来,主要针对ViewModel编写单元测试。
编写单元测试
首先介绍两个RxSwift单元测试的库,RxTest 和 RxBlocking,它们让编写测试用例更简单。
RxTest 是一个独立的库,需要通过pod单独安装。RxTest提供了很多有用的功能,例如TestScheduler,它是一个虚拟时间scheduler,可以在指定时间发出事件,包括next、completed和error。
RxBlocking 也是独立的库,也需要通过pod安装。它的作用是通过它的toBlocking(timeout:)方法将observable 转换成 BlockingObservable。阻塞当前线程,从而将异步操作转换为同步操作,使测试变得容易。
打开TestingTests组中的TestingViewModel.swift,在类的顶部定义两个属性:
var scheduler: ConcurrentDispatchQueueScheduler!
var disposeBag: Disposable!
ConcurrentDispatchQueueScheduler 是并行队列调度器,封装了GCD的并行队列。
setUp()方法,每个测试用例在开始前都会调用它。这里初始化一个新的 scheduler 和 viewModel。tearDown(),在每个测试完成时调用,一般执行一些销毁操作。
func testColorIsRedWhenHexStringIsFF0000_async() {
let disposeBag = DisposeBag()
// 1
let expect = expectation(description: #function)
// 2
let expectedColor = UIColor(red: 1.0, green: 0.0, blue: 0.0, alpha:
1.0)
// 3
var result: UIColor!
}
验证异步操作是否按预期运行,我们在测试中创建期望 expectation,然后在异步操作成功后调用fulfill()方法,表示满足期望 expectation。
- 创建一个异步事件期望。
- 创建 expectedColor 表示预期的测试结果。
- 定义实际结果变量。
// 1
viewModel.color.asObservable()
.skip(1)
.subscribe(onNext: {
// 2
result = $0
expect.fulfill()
})
.disposed(by: disposeBag)
// 3
viewModel.hexString.value = "#ff0000"
// 4
waitForExpectations(timeout: 1.0) { error in
guard error == nil else {
XCTFail(error!.localizedDescription)
return
}
// 5
XCTAssertEqual(expectedColor, result)
}
- 创建一个订阅,追踪 viewModel 的color 变化。这略过了第一个元素,因为第一个元素通常是初始化值。
- 分配.next事件,把结果赋值给result,并在expect上调用fulfill(),表示此异步事件已完成。
- 给viewModel的hexString赋一个新值
- 超时1秒来等待expectation的完成,并提供error处理
- 断言期望的color等于实际的result。
现在使用RxBlocking来实现同样的事情:
func testColorIsRedWhenHexStringIsFF0000() {
// 1
let colorObservable =
viewModel.color.asObservable().subscribeOn(scheduler)
// 2
viewModel.hexString.value = "#ff0000"
// 3
do {
guard let result = try colorObservable.toBlocking(timeout:
1.0).first() else { return }
XCTAssertEqual(result, .red)
} catch {
print(error)
}
}
- 创建colorObservable来订阅并发scheduler上的observable结果。
- 在viewModel的hexString上赋一个新值。
- 调用toBlocking(),并设置1秒的超时时间,如果抛出,捕获并打印错误,然后断言实际的结果与预期的匹配。
func testRgbIs010WhenHexStringIs00FF00() {
// 1
let rgbObservable =
viewModel.rgb.asObservable().subscribeOn(scheduler)
// 2
viewModel.hexString.value = "#00ff00"
// 3
let result = try! rgbObservable.toBlocking().first()!
XCTAssertEqual(0 * 255, result.0)
XCTAssertEqual(1 * 255, result.1)
XCTAssertEqual(0 * 255, result.2)
}
- 创建rgbObservable来订阅viewModel的rgb值。
- 在viewModel的hexString上赋一个新值。
- 检索在rgbObservable上调用toBlocking的第一个结果,然后断言每个值与期望的相等。
func testColorNameIsRayWenderlichGreenWhenHexStringIs006636() {
// 1
let colorNameObservable =
viewModel.colorName.asObservable().subscribeOn(scheduler)
// 2
viewModel.hexString.value = "#006636"
// 3
XCTAssertEqual("rayWenderlichGreen", try!
colorNameObservable.toBlocking().first()!)
}
- 创建observable
- 在viewModel的hexString上赋一个新值。
- 断言实际的结果来匹配期望的结果。