コンテンツへスキップ

Xcodeのコードカバレッジ

早期アクセス

Xcodeプロジェクトのコードカバレッジは現在、早期アクセス段階です。お問い合わせいただければ、アカウントで有効化できます。それまでの間、Tuistは実行時にアップロードされたカバレッジデータを保存しません。

コードカバレッジは、テストが実行したコードの行を示します。Tuistは各テスト実行の行カバレッジをアップロードし、コミット内のすべての実行を集約して、プロジェクト全体、各ターゲット、および各ファイルごとに1つの数値としてまとめます。ダッシュボードのコードカバレッジページでは、コミットごとの値と各ブランチのトレンドを表示します。

Tip

Tuistでプロジェクトを生成している場合は、代わりに生成されたプロジェクトのガイドに従ってください。このガイドでは、バイナリキャッシュから提供されるコードを測定し、選択的テストでスキップされたテストターゲットのカバレッジを引き継ぐ方法について説明しています。

セットアップ#

カバレッジの収集#

Tuist.swiftでカバレッジのアップロードを有効にしてください。デフォルトでは無効になっています:

swift
import ProjectDescription
let tuist = Tuist(
fullHandle: "my-account/my-project",
testInsights: .testInsights(coverage: .coverage(upload: true)),
project: .xcode()
)

TUIST_COVERAGE_UPLOAD環境変数(1または0)はオプションよりも優先され、例えばフォークからのプルリクエストを実行するジョブでアップロードを無効にする場合に使用します。

次に、スキームのテストアクション(Edit Scheme › Test › Options)でコードカバレッジを有効にするか、実行時に-enableCodeCoverage YESを渡し、tuist xcodebuild testを通じてテストを実行します:

bash
tuist xcodebuild test \
-scheme MyScheme \
-enableCodeCoverage YES

Tuistは、テスト結果とともに実行中に収集されたカバレッジをアップロードします。

CIで各コミットを完了させる#

コミットのカバレッジは、複数のジョブ(スキームごと、シャードごと、またはプラットフォームごと)から得られることがよくあります。Tuistは最後に報告されたジョブを自動で検出できないため、明示的に通知する必要があります。コミットに関連するすべてのテストジョブが終了したら、それらすべてに依存するジョブで次のコマンドを実行します:

bash
tuist coverage complete

コミットが完了するまで、そのカバレッジは進行中として表示され、ブランチのトレンドには含まれません。各ステータスの詳細については、生成されたプロジェクトのガイドをご覧ください。

スキップされたテスト#

実行時に-skip-testingを使用してテストをスキップすると、コミットのテストがカバーする範囲よりも少ない測定となり、Tuistは以前の実行からそれらのテストを引き継ぐことができません。そのコミットで他の実行がそれらを実行していない限り、コミットのカバレッジは不完全となります。コミットを完全な状態に保つには、コミットごとに少なくとも1回の実行ですべてのテストを実行してください。

隔離によってスキップされたテストはカバレッジに含まれないため、コミットが不完全になることはありません。

パフォーマンスへの影響#

カバレッジの収集にはオーバーヘッドが生じ、主にテスト終了後にXcodeがカバレッジレポートを書き込み、Tuistがカバレッジをエクスポートする間に発生します。テストのビルドと実行にかかる時間は、カバレッジなしの場合とほぼ同じです。

カバレッジのクエリ#

tuist coverageコマンドは、ダッシュボードに表示されるデータを読み取ります。--commitを指定しない場合、--branchの最新の完了したコミット、またはデフォルトブランチの最新の完了したコミットを読み取ります:

bash
tuist coverage show # the project's coverage and its targets
tuist coverage files --commit <sha> # files, least covered first
tuist coverage file Sources/Cart.swift --lines # a file's functions, with per-line counts

いずれのコマンドも、スクリプト用途のために--jsonを受け付けます。