Nimble アサーションでテストをより読みやすく:Quick プロジェクトにおける失敗メッセージ改善ガイド
Nimble アサーションでテストをより読みやすく:Quick プロジェクトにおける失敗メッセージ改善ガイド
テストが期待通りに動作しないとき、ユニットテストは 何が問題か を明確に示すべきです。本ガイドでは、Quick プロジェクト(Swift / Objective-C 向け BDD テストフレームワーク)の公式ドキュメント NimbleAssertions.md を軸に、XCTest 標準の XCTAssert と Nimble の expect(...).to(...) を比較しながら、失敗メッセージを読みやすくする具体的な手法を解説します。読み終えると、Nimble の基本構文と失敗メッセージ設計の考え方を身につけ、テストのデバッグ時間を大幅に短縮できるようになります。
まずは具体例:silliest 関数とそのテスト
次の関数は、サルの集団から「馬鹿なサル」だけを取得します。
public func silliest(monkeys: [Monkey]) -> [Monkey] {
return monkeys.filter { $0.silliness == .verySilly }
}
ここで、この関数に対するユニットテストを書いてみましょう。
func testSilliest_whenMonkeysContainSillyMonkeys_theyreIncludedInTheResult() {
let kiki = Monkey(name: "Kiki", silliness: .extremelySilly)
let carl = Monkey(name: "Carl", silliness: .notSilly)
let jane = Monkey(name: "Jane", silliness: .verySilly)
let sillyMonkeys = silliest([kiki, carl, jane])
XCTAssertTrue(contains(sillyMonkeys, kiki))
}
このテストは、次のメッセージとともに失敗します。
XCTAssertTrue failed
kiki の silliness は .extremelySilly(非常に馬鹿)ですが、silliest() は .verySilly のみをフィルタしているため、結果に kiki は含まれません。テスト自体は正しく問題を検出しています。
しかし失敗メッセージが XCTAssertTrue failed だけでは、「何か true のはずのものが false だった」ことしかわかりません。true / false だけでは何が問題なのか特定できず、テストコードを読み解いて原因を突き止めるまでに時間がかかってしまいます。失敗時には多くの情報を残すことが望ましいのです。
良い失敗メッセージを残す:Part 1 — XCTAssert に手動でメッセージを渡す
XCTAssert 系のアサーションは、失敗時のメッセージを自分で指定できます。
func testSilliest_whenMonkeysContainSillyMonkeys_theyreIncludedInTheResult() {
let kiki = Monkey(name: "Kiki", silliness: .extremelySilly)
let carl = Monkey(name: "Carl", silliness: .notSilly)
let jane = Monkey(name: "Jane", silliness: .verySilly)
let sillyMonkeys = silliest([kiki, carl, jane])
- XCTAssertTrue(contains(sillyMonkeys, kiki))
+ XCTAssertTrue(contains(sillyMonkeys, kiki), "Expected sillyMonkeys to contain 'Kiki'")
}
これで「期待していた内容」は伝わるようになります。ただし、メッセージを毎回自分で書かなければならないという問題が残ります。テストが増えるほどこの手間は積み重なり、書き忘れたアサーションはまた意味不明な失敗メッセージに逆戻りします。
良い失敗メッセージを残す:Part 2 — Nimble の失敗メッセージを使う
Nimble はアサーション自体と、その失敗メッセージを読みやすくしてくれます。同じテストを Nimble で書き換えると次のようになります。
func testSilliest_whenMonkeysContainSillyMonkeys_theyreIncludedInTheResult() {
let kiki = Monkey(name: "Kiki", silliness: .extremelySilly)
let carl = Monkey(name: "Carl", silliness: .notSilly)
let jane = Monkey(name: "Jane", silliness: .verySilly)
let sillyMonkeys = silliest([kiki, carl, jane])
- XCTAssertTrue(contains(sillyMonkeys, kiki), "Expected sillyMonkeys to contain 'Kiki'")
+ expect(sillyMonkeys).to(contain(kiki))
}
Nimble では自分でメッセージを書かなくても、Nimble が非常に読みやすい失敗メッセージを自動生成してくれます。
expected to contain <Monkey(name: Kiki, sillines: extremelySilly)>,
got <[Monkey(name: Jane, silliness: verySilly)]>
このメッセージから、問題が一瞬で明らかになります:kiki が silliest() の戻り値に含まれることを期待していたが、実際の結果には jane しか含まれていない、と。期待値(expected)と実測値(got)の両方が具体的な値として表示されるため、原因の特定と修正がすぐにできます。
メッセージの指し示すとおりに、関数側を修正します。
public func silliest(monkeys: [Monkey]) -> [Monkey] {
- return monkeys.filter { $0.silliness == .verySilly }
+ return monkeys.filter { $0.silliness == .verySilly || $0.silliness == .extremelySilly }
}
Nimble が失敗メッセージを自動生成する仕組み
Nimble のアサーションは expect(実際の値) と to / toNot / toEventually などのマッチャー(Matcher)の組み合わせで記述します。マッチャーは「期待値の表現」と「失敗時のメッセージ生成」を一体で担当するため、XCTAssert のように毎回自分でメッセージを指定する必要がありません。アサーションの種類ごとに「何を期待していたのか」「実際には何だったのか」を構造化された形で出力できるのが、Nimble 流の失敗メッセージ設計の要点です。
Quick プロジェクト内では、この考え方が実際のテストコードにも反映されています。たとえば Quick 自身のテストターゲット(Tests/QuickTests)や Lint 関連のテスト(Tests/QuickLintTests)では Nimble が利用されており、Package.swift の QuickTests と QuickLintTests の依存関係に "Nimble" が宣言されています。Quick と Nimble はもともと同一エコシステム(Quick プロジェクト)で開発されており、Quick を導入するときの標準的な組み合わせです。
Nimble アサーションの例
Nimble は多くの種類のアサーションを提供しており、それぞれに明確な失敗メッセージが付属します。公式ドキュメントからの抜粋をいくつか紹介します。
expect(1 + 1).to(equal(2))
expect(1.2).to(beCloseTo(1.1, within: 0.1))
expect(3) > 2
expect("seahorse").to(contain("sea"))
expect(["Atlantic", "Pacific"]).toNot(contain("Mississippi"))
expect(ocean.isClean).toEventually(beTruthy())
それぞれの意味は次の通りです。
| アサーション | 意味 | 補足 |
|---|---|---|
expect(1 + 1).to(equal(2)) |
値が等しいこと | 等値比較の基本形 |
expect(1.2).to(beCloseTo(1.1, within: 0.1)) |
値が許容誤差内であること | 浮動小数点の比較に有効 |
expect(3) > 2 |
値が大きいこと | 比較演算子による省略記法 |
expect("seahorse").to(contain("sea")) |
文字列・コレクションが要素を含むこと | contain は文字列にも配列にも使える |
expect(["Atlantic", "Pacific"]).toNot(contain("Mississippi")) |
要素を含まないこと | 否定形は toNot |
expect(ocean.isClean).toEventually(beTruthy()) |
いずれ真になること | 非同期処理のポーリングに利用 |
このうち expect(...).to(contain(...)) こそ、冒頭のサル集団の例で XCTAssertTrue(contains(...)) の代わりに使ったアサーションです。配列の部分一致を、期待値・実測値を明示した形で検証できます。
Quick プロジェクトでの導入方法
Nimble は Quick とセットで導入するのが一般的です。Quick のインストール方法の詳細は InstallingQuick.md にまとめられていますが、要点は次の通りです。
- Git Submodules 方式:
Vendor/QuickとVendor/Nimbleを submodule として追加し、両方の.xcodeprojを workspace に組み込み、Quick.frameworkとNimble.frameworkを "Link Binary with Libraries" に追加します。 - CocoaPods 方式:
Podfileにpod 'Quick'とpod 'Nimble'を宣言し、use_frameworks!を有効化したうえでpod installを実行します。
なお、このリポジトリでは Nimble が外部依存として宣言されており(Package.swift の from: "13.2.0")、Externals/Nimble ディレクトリがその受け入れ先として用意されています。Swift Package Manager で導入する場合は、Quick と Nimble の両方を dependencies に追加してください。導入後はテストターゲット内で import Nimble することで、expect(...).to(...) 構文が使えるようになります。
まとめ:失敗メッセージは「テストの可読性」の一部
XCTAssertは問題を検出できますが、失敗メッセージはXCTAssertTrue failedのように抽象的で、原因特定に時間がかかります。XCTAssertに手動でメッセージを渡す方法は改善になりますが、アサーションごとにメッセージを書き続ける必要があります。- Nimble の
expect(actual).to(matcher)は、期待値と実測値を構造化した形で自動的に失敗メッセージを生成し、原因を一瞬で特定できるようにします。 - Nimble は等値比較、近似比較、包含、比較演算子、非同期ポーリング(
toEventually)など、用途に応じた多くのマッチャーを備えています。
テストは「コードが正しいこと」を保証するだけでなく、「何が問題かを伝える」役割も担っています。Nimble を使うことで、その伝達力を大幅に高めることができるのです。Quick プロジェクトでのテスト記述の基本(Arrange / Act / Assert)については ArrangeActAssert.md もあわせて参照してください。