Xcode テストのインサイト

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

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

テストが遅くなっていないか？どのテストか？
不安定なテストはどれで、対応が必要か？
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 のインストール方法に応じた絶対パスを使用する必要があります。さらに、$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_GIT_UPLOAD_ENABLED=false`	Git ヒストリーを読み取ったりアップロードしたりしません。
`TUIST_GIT_UNSHALLOW_ENABLED=false`	リモートに接続せず、チェックアウトのみを読み取ります。