理解 RXSwift：單元測試（四）

理解 RxSwift：爲何要使用 RxSwift（一）

理解 RxSwift：實現原理（二）

理解 RxSwift：單元測試（四）

這篇文章是閱讀 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。

1. 建立一個異步事件指望。
2. 建立 expectedColor 表示預期的測試結果。
3. 定義實際結果變量。

// 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)
}
複製代碼

1. 建立一個訂閱，追蹤 viewModel 的color 變化。這略過了第一個元素，由於第一個元素一般是初始化值。
2. 分配.next事件，把結果賦值給result，並在expect上調用fulfill()，表示此異步事件已完成。
3. 給viewModel的hexString賦一個新值
4. 超時1秒來等待expectation的完成，並提供error處理
5. 斷言指望的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)
  }
}
複製代碼

1. 建立colorObservable來訂閱併發scheduler上的observable結果。
2. 在viewModel的hexString上賦一個新值。
3. 調用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)
}
複製代碼

1. 建立rgbObservable來訂閱viewModel的rgb值。
2. 在viewModel的hexString上賦一個新值。
3. 檢索在rgbObservable上調用toBlocking的第一個結果，而後斷言每一個值與指望的相等。

func testColorNameIsRayWenderlichGreenWhenHexStringIs006636() {
  // 1
  let colorNameObservable =
    viewModel.colorName.asObservable().subscribeOn(scheduler)
  // 2
  viewModel.hexString.value = "#006636"
  // 3
  XCTAssertEqual("rayWenderlichGreen", try!
    colorNameObservable.toBlocking().first()!)
}
複製代碼

1. 建立observable
2. 在viewModel的hexString上賦一個新值。
3. 斷言實際的結果來匹配指望的結果。