メインコンテンツまでスキップ

iOSアプリのユニットテストとUIテストの実行

Bitriseでは、専用のStepを使って、iOSアプリのユニットテストとUIテストの両方を実行できます。Stepは、Xcodeプロジェクト内で定義したテストターゲットを実行し、結果を詳細に確認できるようにエクスポートします。

BitriseでXcodeテストを実行するには、Xcodeテストを実行して結果を確認するために2つのStepsが必要です:

Xcode Test for iOS。

デプロイ先Bitrise.io。

Code signingファイル

Xcodeテストの実行と、その結果をBitriseへデプロイする作業では、code signingファイルは一切不要です。今は気にしなくても問題ありません!

Xcode Test for iOS Stepは、テストを実行し、テスト結果、.xcresultファイル、すべてのテスト添付ファイル、xcodebuild testコマンドのログをエクスポートします。

XcodeのHTML形式のテスト結果

Generate Xcode test report html Stepを使うと、Xcodeのテスト結果をリッチなHTML形式で確認することもできます。Xcodeのテスト結果をリッチなHTML形式で表示する。

Stepを使ってテストを実行するには:

  1. you install all of the app's dependenciesがWorkflowに含まれていることを確認してください。

  2. Xcode Test for iOS StepをWorkflowに追加します。

  3. Project path入力が正しい場所を指していることを確認してください。

    この入力には、.xcodeproj,``.xcworkspace、またはPackage.swiftファイルへのパスを指定します。ほとんどの場合、この入力を変更する必要はありません。新しいアプリを追加すると、プロジェクトスキャナーが該当するファイルを自動的に検出し、その場所を入力のdefault valueである環境変数に保存します。

    xcode-test-for-ios.png

  4. Scheme入力が、アプリのビルドに使用するスキームを指していることを確認してください。

    default valueは、アプリの初期設定時に指定したスキームを保存する環境変数です。別のスキームを使用する場合は、その名前を入力フィールドに入力してください。

    共有スキームのみ

    スキームは共有されたXcodeスキームである必要があります!

  5. Device destination specifier入力でデバイスの宛先を設定します。この入力にはカンマ区切りのキーと値のペアを指定します。たとえば、最新の利用可能なOSを搭載したiPhone 14でテストするアプリをビルドする場合は、次のようにします:

    platform=iOS,name=iPhone 14 Plus,OS=latest

    この入力は、xcodebuildの-destinationオプションを設定します。指定可能なオプションの詳細については、コマンドラインからユニットテストを実行するには?を参照してください。

  6. 必要に応じて、Test plan入力で特定のテストプランを設定します。

    この入力は、xcodebuildのtestアクションの-testPlanオプションを設定します。空のままにした場合は、Xcodeスキームで指定されたテストプランが使用されます。

  7. テスト結果やその他の出力にアクセスできるようにするため、Deploy to Bitrise.io - Build Artifacts, Test Reports, and Pipeline intermediate files StepをWorkflowの最後に追加します: テスト結果のデプロイ。

ヘッドレスモード

Xcode 9以降では、デフォルトでテストがヘッドレスモードで実行されます。つまり、シミュレーターはバックグラウンドでのみ動作します。これを変更するには、StepのDebug入力グループに移動し、Run the simulator in headless mode入力の値をnoに設定します。ただし、このオプションを使用すると、テストにより時間がかかります。

- xcode-test:
inputs:
- headless_mode: 'no'
xcprettyの使用

xcpretty出力ツールは並列テストに対応していません。プロジェクトで並列テストが有効になっている場合は、Stepのxcodebuild log formatting入力グループに移動し、Log formatter入力の値をxcodebuildまたはxcbeautifyに設定してください。

- xcode-test:
inputs:
- log_formatter: xcbeautify

失敗したテストの再実行Click to copy link​

バージョン6.0.0より前のXcode Test for iOSでは、Test repetitionセクションのShould retry test on failure?入力により、テストが失敗した場合にxcodebuildがもう一度実行され、失敗したテストだけでなく、すべてのテストが再実行されていました。この入力はバージョン6.0.0以降には存在しません。

失敗したテストのみを再実行するには、Test Repetition Mode入力でretry_on_failureオプションを選択します:テストの繰り返し実行。このテスト繰り返し実行機能は、バージョン3.0.0以降のXcode Test for iOS Stepで利用できます。

テストの繰り返し実行Click to copy link​

Xcodeのテスト再実行モードは、Bitrise上でXcode 13以降を実行しているスタックのXcode Test for iOS Stepで利用できます。テストの繰り返し実行を使うと、失敗時に再試行する、失敗するまで実行する、最大繰り返し回数まで実行するなど、さまざまな方法でテストを複数回実行できます。

Xcode Test for iOS StepのTest Repetitions Mode (Available in Xcode 13+)入力には、次のオプションがあります:

  • none: テストは繰り返されません。
  • until_failure: テストが失敗するか、最大繰り返し回数に達するまでテストを繰り返します。デフォルトのテスト実行回数は3回です。
  • retry_on_failure: 失敗したテストは、成功するか、指定した繰り返し回数に達するまで実行されます。デフォルトのテスト繰り返し回数は3回です。
  • up_until_maximum_repetitions: テスト結果にかかわらず、最大テスト繰り返し回数に達するまですべてのテストを再実行します。

デフォルトのオプションは、バージョン6.0.0以降ではretry_on_failureです。それ以前のバージョンでは、デフォルトはnoneです。

これらのオプションは、Xcode Test for iOSバージョン3.0.0以降でのみ利用できる点にご注意ください。

Maximum Test Repetitions (Available in Xcode 13+)入力を使用すると、テストの最大繰り返し回数を指定できます。Test Repetition Mode (Available in Xcode 13+)入力がnone以外に設定されている場合は、1より大きい数値を指定する必要がある点にご注意ください。

Relaunch Tests for Each Repetition (Available in Xcode 13+)入力を有効にすると、繰り返しごとに完全に新しいプロセスでテストを起動します。デフォルトはnoです。