RxTest跟RxBlocking是基於RxSwift上,測試Rx-based的library。個人覺得,RxBlocking的概念比較單純,就從RxBlocking先講起。
RxBlocking
RxBlocking概念是Observable stream轉換成BlockingObservable,是一種特殊的Observable,blocking就是阻斷的意思,他會阻斷當前的thread,就好像現在我們排隊要進餐廳,會有人把你擋下來幫你量體溫一樣,配合一些RxBlocking的operator,當符合條件時,就會返回結果,下面讓我們看個範例
範例
在有限的序列當中,過濾出小於3的數字
let observable = Observable.of(1, 2, 3, 2, 5).filter { $0 < 3 }// 1let result = observable.toBlocking()// 2XCTAssertEqual(try result.first(), 1)// 3XCTAssertEqual(try result.last(), 2)// 4XCTAssertEqual(try result.toArray(), [1, 2, 2])- 把Observable轉換成BlockingObservable
first()是BlockingObservable的operator,可以攔截第一個元素,以範例來說就是數字1last()是BlockingObservable的operator,可以攔截最後一個元素,所以必須要等到Observable結束才會觸發,以範例來說就是數字2toArray()是BlockingObservable的operator,當Observable結束後,可以發送過的元素以陣列返回結果,以範例來說就是[1, 2, 2]
優劣
- 好處就是簡單好懂
- 可用於測試第一個元素或是有限的序列
- 使用的情境受侷限,RxBlocking是透過阻斷當前thread方式來獲取元素,當在長時間運行的Observable、異步的或是延遲觸發的情境,對RxBlocking都是同步的,這時就不適合使用RxBlocking
- 對RxBlocking沒有時間的概念,他在意的是元素,而不是時間
RxTest
RxBlocking雖然好用,但仍然不夠靈活,於是一些情境下需要RxTest解決問題,RxTest提供TestScheduler,是一種特殊的Scheduler,它只能用於測試,並提供虛擬的時間、模擬的Observer跟模擬的Observable,下面讓我們看一個範例。
首先是測試的宣告、setUp()和tearDown()部分
// 1var scheduler: TestScheduler!
override func setUp() { super.setUp() // 2 scheduler = TestScheduler(initialClock: 0)}
override func tearDown() { super.tearDown()}- 宣告一個TestScheduler
- 初始化TestScheduler,並在虛擬時間(virtual time)為0的時候,建立這個Scheduler,這裡說的虛擬時間是TestScheduler所提供的一種時間,並非現實時間中的1秒或1毫秒,我們可以利用這虛擬時間來達到時間線性的模擬
主要測試的程式
func testRxTestExample() { let disposeBag = DisposeBag() // 1 let observer = scheduler.createObserver(Int.self) // 2, 3 let observable = scheduler.createColdObservable([ Recorded.next(100, 1), Recorded.next(200, 2), Recorded.next(300, 3), Recorded.next(400, 2), Recorded.next(500, 1) ])
let filterObservable = observable.filter { $0 < 3 }
filterObservable.subscribe(observer).disposed(by: disposeBag) // 4 scheduler.start() // 5 let results = observer.events.compactMap { $0.value.element }
XCTAssertEqual(results, [1, 2, 2, 1])}- 建立Observer,並表明要接收Int元素,也就是
TestableObserver<Int> - 建立Observable,並分別在虛擬時間100, 200, 300, 400, 500分別發送5個數字元素
- Recorded是RxTest中定義的struct,它包含一個time(虛擬時間)跟value(實際Element值)變數,在Recorded+Event.swift中對其擴展了
.next方法,會把Element轉成Event,這也是createColdObservable或createHotObservable所需要的input - Scheduler啟動,以上所設定跟TestScheduler有關的才會開始運行
- TestableObserver包含一個變數
events,它是[Recorded<Event<Element>>]型態,也就是所有Observable所.next發送的元素都存在這變數當中,再使用compactMap把陣列降。
ColdObservable & HotObservable
Cold/Hot Observable可以視為Observable的一種屬性差異 Hot Observable表示不管有無訂閱,都會發送元素,也代表一建立後,就會佔用資源,任何訂閱者從中訂閱後,可接收所發出的元素,像是Button或是Subject。 Cold Observable僅在訂閱後,才會開始發送元素,也代表有人訂閱時才會佔用資源,訂閱者在訂閱時可以從第一個元素開始接收,就像是data stream或是跟server請求資料 根據RxSwift: Reactive Programming with Swift所提到,在Rx世界中,通常是在測試時,需要較大的控制權,才會需要去探討到Cold/Hot Observable,不然平常只要使用Rx所提供的Observable即可。
為列表 ViewModel 加上測試
接著為前面UITableView範例的ViewModel加上測試。
宣告
var viewModel: ProductListViewModel!viewModel就是待會要測試的對象
測試程式的setUp()和tearDown()
override func setUp() { super.setUp()
let apiService = TestAPI() viewModel = ProductListViewModel(apiService: apiService)}
override func tearDown() { super.tearDown()}- 在
setUp()時,建立測試的API,並且注入到ViewModel當中
測試ViewModel初始化
原始版本
func test_init_load_data() { let disposeBag = DisposeBag() // 1 let expect = expectation(description: #function)
var result: [Product]!
viewModel.data.asObservable() .skip(1) // 2 .subscribe(onNext: { // 3 result = $0 expect.fulfill() }) .disposed(by: disposeBag) // 4 waitForExpectations(timeout: 5.0) { error in guard error == nil else { XCTFail(error!.localizedDescription) return } // 5 XCTAssertEqual(20, result.count) }}expectation會建立一個XCTestExpectation,可用來測試非同步狀況,因為非同步並非由我們指定的步驟進行,所以,我們在預期的會經過的地方,放expect.fulfill(),執行到這行的話,就代表達到我們預期。- 因為data為
BehaviorRelay,在訂閱後會拿到最一開始會得的[],所以我們skip(1) - 把結果儲存,並且執行
expect.fulfill(),表示符合我們預期 - 因為call API需要時間,這邊我們撰寫
waitForExpectations(timeout: 5.0)來表示等待5秒,若在5秒內都沒有執行到expect.fulfill(),那測試就會失敗 - 這邊我預期會得到20筆資料,這是定義在
TestAPI()中的假資料
RxBlocking版本 嘗試以RxBlocking測試ViewModel初始化
func test_init_load_data_ver_blocking() throws { let disposeBag = DisposeBag() // 1 let observable = viewModel.data.skip(1).map { $0.count } // 2 viewModel.data.subscribe().disposed(by: disposeBag) // 3 XCTAssertEqual(try observable.toBlocking().first(), 20)}- 這邊寫法就簡單多,不用透過
XCTestExpectation - 這邊其實可寫可不寫,因為data是
BehaviorRelay,所以,就算不訂閱也能發送元素,反之,若是需要訂閱才能發送的Observable,就必須寫這段 - 使用
first()來獲取第一個元素,預期會得到20筆
測試Pull to Refresh
func test_pull_to_refresh() throws { let disposeBag = DisposeBag() // 1 viewModel.data.skip(1).take(1) .subscribe(onNext: { _ in self.viewModel.triggerAPI.onNext(()) // 2 }) .disposed(by: disposeBag) // 3 let observable = viewModel.data.skip(2).map { $0.count } // 4 XCTAssertEqual(try observable.toBlocking().first(), 20)}- 使用
skip(1)略過BehaviorRelay的初始值,使用take(1)來抓取第二個元素,也就是初始化後會call API,這時data會收到第二個元素 - 這時我們向
viewModel.triggerAPI發送元素,也就會執行reload - 我們要取得data的第三個元素,也就是第2步驟所reload後,得到的值
- 轉換成BlockingObservable,預期得到20筆
測試Next Page
func test_betch_reload() throws { let disposeBag = DisposeBag()
viewModel.data.skip(1).take(1) .subscribe(onNext: { _ in self.viewModel.triggerNextPage.onNext(()) // 1 }) .disposed(by: disposeBag)
let observable = viewModel.data.skip(2).map { $0.count } // 2 XCTAssertEqual(try observable.toBlocking().first(), 21)}- 同樣的,只是改成向
viewModel.triggerNextPage發送元素 - 這時我們預期得到21筆
編按(2026):原本也想用 RxTest 的
TestScheduler為同一個 ViewModel 寫測試,但寫作當時沒有成功跑起來,所以這裡只保留XCTestExpectation與 RxBlocking 的版本;RxTest 的觀念請參考前面的 RxTest 段落。