テストをXCTSkipする

大事なテストの結果を入手しましょう-そして大事でないものはSkipしましょう。XCTSkipを実行し、条件に合わせてテストがランタイム中に開始しないようにする方法をお伝えします。この新しいテスト結果をどう戻し、様々なテストの中で単にpassとfailだけではないドキュメントテストの実施方法を丁寧にご説明します。このセッションを最大限に活用するには、XCTestと、unit/UIテストについての知識があることが望ましいです。事前に"Testing in Xcode"をご覧ください。 XCTSkipを学んだら、テストに関する改善点も確認しましょう："Triage test failures with XCTIssue"、"Handle interruptions and alerts in UI tests"、"Eliminate animation hitches with XCTest"をご覧ください。テストスイートを改善するには、"Write tests to fail"をご覧ください。

リソース

- HDビデオ
- SDビデオ

関連ビデオ

WWDC22

Xcode Cloud用の高速で信頼性の高いテストを作成する

WWDC20

WWDC19

Xcodeでテストする

ダウンロード

こんにちは WWDCへようこそ “XCTSkip Your Tests” 私はウィル　Xcodeのテストおよび自動化を担当していますこのセッションでは XCTSkipについてお話しします実行時の条件に基づくテストの実行を管理する新しいAPIです一部のテスト特に統合テストでは模擬的に再現しにくい必要条件や依存関係があります例えばアプリケーションがiPad特有の機能を持っている場合 iPhoneではテストできません別のテストでは古いOSで動いているデバイスで利用できないAPIを用いるかもしれませんメンテナンスのために定期的にオフラインのサーバーでテストが必要なこともありますこれらすべては実行時にのみ決定できる条件の例ですテストの必要条件を満たさない環境で取り扱えるようにするには条件付きの実行の作成が必要ですそれ以外にテスト担当者には２つの選択肢しかありません早めに終わらせてテストを合格にするか不合格を報告するかです

どちらの場合にも問題があります実際には検証に合格していないプログラムが機能します他方でテスト不合格となると何が悪いのかわからず判断のため多くのリソースを消費したりするかもしれません幸い XCTSkipが使用できるようになりました条件付きの実行が必要なテストを行うことができますこのAPIはXcode 11.4で導入されたもので新しいテスト結果を出しますテストは合格か不合格ですが XCTSkipでは明示的に“スキップ”の結果が出せます

Xcodeはこのアイコンを使ってスキップされたテストを強調しテストスイートが実際に検証したことの明確な全体像を見ることができますこれが実際にどのように動作するか見てみましょう Play Gardenという名前の小さいプロジェクトがありますこれは私が３歳の娘と一緒に作ったものです Play Gardenは裏庭にあるすべての植物やおもちゃ家具などの追跡と管理を支援してくれます最近になってpointer interactionをサポートすることにしました人気の機能でアプリケーションをほぼiPadで使うためです

娘はまだ３歳ですがテスト重視の開発を完全に取り入れていますしたがってこの新しい機能に対していくつかの単体テストを加えることが課されます画面でこれらのテストの１つをご覧いただけるでしょうこのテストには２つの条件がありそれに従うと実行が意味をなさない可能性がありますまず pointer interactionは iOS 13.4で導入されたのでこのテストはそれ以前のOSで実行できませんそのため古いiOSバージョン用にXCTSkipを使った利用可能なガードを追加しました

次にアプリケーションはiPadでだけ pointer interactionを有効にしますしたがってもし他のデバイスで実行した場合このテストを実行する必要はありませんこの条件を扱うため “XCTSkipIf”を使います最初にこのテストを通常どおり実行できるような環境で行いましょう iOS 14が入ったiPadを使います

ご覧いただいたとおり期待通りに実行されて合格しましたそれではもっと古いデバイスで実行しましょう iOS 13.0が入ったiPhoneです

今回はテストを実行するのにキーボードショートカットを使用します “control option command G”ですこれは単純に直近のテストアクションを繰り返します

今度は緑の“合格”アイコンがグレーの“スキップ”アイコンに変わったのが見えますソースエディタの注記にテストがスキップされた場所と理由が示されます

他にXcodeでUIがスキップ結果を提供しているところがないか確認しましょう最初にTest Navigatorです

ここでスキップがテストの横に表示されているのがわかりますさらに表示されているリストを絞込みスキップされたテストだけを表示できますナビゲーター下のこのボタンを使います

それではテストの報告書を見てみましょう

ここにスキップされた実行があります

テストの詳細を開くとスキップが発生した場所のファイルと行が理由の説明とともにわかりますこうやって見ていくと行の最後の２つのボタンに気付いたかもしれません最初のボタンは“ジャンプ”ですスキップが発生した場所とソースに連れていってくれるものです２番目のボタンを確認するために戻ります

“アシスタント”ボタンはXcode 12の新機能で２番目のエディターを開いてスキップが参照したソースの場所を示しますこれによりテスト報告書とソースコードを並べて確認できます最後に連続した統合においてスキップがどう見えるか確認しましょう

CIシステムからの結果がここにありますテストを３つの異なるデバイスで実行したものですこのテストだけに焦点を当てるため “スキップ済”の絞り込みを使いますテスト結果の詳細でテストを実行した各デバイスの結果が見えます最初のiPadでは合格で他のデバイスではスキップですデバイスの結果の詳細を拡げるとスキップの場所と理由が表示されすべての情報を手に入れられますこれで終わりです簡単だったでしょう XCTSkipをテストで使うと様々な条件に対するテストについて Xcodeはスキップされたテストと通常に合格または不合格になったものの差をはっきりと表示することができますそれではAPIの詳細を見てみましょう

デモでご覧いただいたとおり XCTSkipの使用方法は何通りかあります XCTSkipを開始する関数は２つあります XCTSkipIfと XCTSkipUnlessですどちらの関数も同じパラメーターを取ります XCTSkipIfは条件式が真の場合にスキップします XCTSkipUnlessは条件式が偽の場合にスキップします

この例ではiPad以外のデバイスで実行された時にテストがスキップされる方法を示しています

テストはXCTSkip構造体を直接投げることもできますこれはガードと組み合わせると便利で先ほどiOS 13.4向けの利用可能なチェックとともに紹介しました

まとめると一部のテスト特に統合テストは特定の条件下では実行できない場合がありますそういった条件に対応するために XCTSkipが使えますテストの実行結果を最も正確にモデル化できる方法ですこれによって結果的に全体の結果が確実により明快になります連続統合システムの一連のテストを実行しているさいは特にそうですご視聴ありがとうございます

5:45 - Use XCTSkipUnless to bypass a test on devices other than iPad

func testExample() throws {

    /// Example usage: skip test if device is not an iPad
    try XCTSkipUnless(UIDevice.current.userInterfaceIdiom == .pad, 
              "Pointer interaction tests are for iPad only")

    // test...
}

5:58 - Use guard+XCTSkip to bypass a test on an older OS version

func testExample() throws {

    /// Example usage: skip test if OS version is older than iOS 13.4
    guard #available(iOS 13.4, *) else {
        throw XCTSkip("Pointer interaction tests can only run on iOS 13.4+")

    // test...
}

特定のトピックをお探しの場合は、上にトピックを入力すると、関連するトピックにすばやく移動できます。