コンテンツへスキップ

Xcode テストのインサイト

Tuist Test Insights は、遅いテストを特定したり CI 実行の失敗をすばやく把握することで、テストスイートの健全性を監視するための Xcode テスト分析を提供します。テストスイートが大きくなるにつれて、徐々に遅くなるテストや断続的な失敗といった傾向を見極めることが難しくなります。Tuist Test Insights は、高速で信頼性の高いテストスイートを維持するために必要な可視性をもたらします。

Test Insights を使うと、次のような質問に答えられます:

  • テストが遅くなっていませんか?どのテストですか?
  • 不安定な(flaky)テストはどれで、注意が必要ですか?
  • CI 実行が失敗したのはなぜですか?

セットアップ#

テストの追跡を開始するには、tuist inspect test コマンドをスキームのテスト後処理アクションに追加してください:

テストを検査するための後処理アクション

Mise を使用している場合、スクリプトで後処理アクション環境内で tuist を有効にする必要があります:

bash
# -C ensures that Mise loads the configuration from the Mise configuration
# file in the project's root directory.
$HOME/.local/bin/mise x -C $SRCROOT -- tuist inspect test
Mise とプロジェクトパス

環境変数 PATH はスキームの後処理アクションには継承されないため、Mise の絶対パスを使用する必要があります。このパスは Mise のインストール方法によって異なります。また、$SRCROOT が指すディレクトリから Mise を実行できるよう、プロジェクト内のターゲットからビルド設定を継承することを忘れないでください。

Tuist アカウントにログインしていれば、テスト実行が追跡されます。Tuist ダッシュボードでテストインサイトにアクセスし、時間経過とともにどのように変化するかを確認できます:

テストインサイトを表示するダッシュボード

全体の傾向だけでなく、CI での失敗や遅いテストのデバッグ時など、個々のテストを詳しく調べることもできます:

テストの詳細

生成されたプロジェクト#

Note

自動生成されたスキームには、tuist inspect test 後処理アクションが自動的に含まれます。

自動生成されたスキームでテストインサイトの追跡が必要ない場合は、testInsightsDisabled 生成オプションを使用して無効にしてください。

カスタムスキームを使用した生成済みプロジェクトを利用している場合、テストインサイト用の後処理アクションを設定できます:

swift
let project = Project(
name: "MyProject",
targets: [
// Your targets
],
schemes: [
.scheme(
name: "MyApp",
shared: true,
buildAction: .buildAction(targets: ["MyApp"]),
testAction: .testAction(
targets: ["MyAppTests"],
postActions: [
// Test insights: Track test duration and flakiness
.executionAction(
title: "Inspect Test",
scriptText: """
$HOME/.local/bin/mise x -C $SRCROOT -- tuist inspect test
""",
target: "MyAppTests"
)
]
),
runAction: .runAction(configuration: "Debug")
)
]
)

Mise を使用していない場合、スクリプトは次のように簡略化できます:

swift
testAction: .testAction(
targets: ["MyAppTests"],
postActions: [
.executionAction(
title: "Inspect Test",
scriptText: "tuist inspect test"
)
]
)

継続的インテグレーション#

CI でテストインサイトを追跡するには、CI が 認証済み であることを確認する必要があります。

さらに、次のいずれかが必要です:

  • xcodebuild アクションを呼び出す際に、tuist xcodebuild コマンドを使用する。
  • xcodebuild の呼び出しに -resultBundlePath を追加する。

xcodebuild が -resultBundlePath なしでプロジェクトをテストする場合、必要な結果バンドルファイルが生成されません。tuist inspect test 後処理アクションは、テストを分析するためにこれらのファイルを必要とします。

Git の履歴#

CI では、Tuist はチェックアウトのコミット履歴(コミット SHA、その親コミット、コミット日時、および実行とそのプルリクエストのベースブランチが属していたブランチ)もアップロードします。ファイルの内容、コミットメッセージ、著者はアップロードされません。これは、マージキューがテストしたコミットなど、どのコミットがデフォルトブランチに取り込まれたかを Tuist に伝えます。Tuist はチェックアウトがすでに持っている履歴を読み取り、チェックアウトにベースブランチがない場合は、リモートに対して最新のコミットを問い合わせます(git ls-remote)。コードカバレッジ以外では履歴を取得しません。コードカバレッジがある場合、ファイルの内容なしで浅いチェックアウトを深化させ、プルリクエストが分岐した場所を特定し、Tuist がすでに持っているコミットに到達できるようにします。これにより、親コミットのないコミットがアップロードされることはありません。

変数 効果
TUIST_GIT_UPLOAD_ENABLED=false Git の履歴を読み取ったりアップロードしたりしません。
TUIST_GIT_UNSHALLOW_ENABLED=false リモートに接続せず、チェックアウトのみを読み取ります。