Bazel には、bazel coverage でテストできるリポジトリのコード カバレッジ レポートを生成する coverage サブコマンドがあります。さまざまな言語エコシステムの特性により、特定のプロジェクトでこれを機能させることは必ずしも簡単ではありません。
このページでは、カバレッジ レポートの作成と表示に関する一般的なプロセスについて説明します。また、構成がよく知られている言語については、言語固有の注意事項も記載しています。まず一般的なセクションを読み、次に特定の言語の要件を読むことをおすすめします。リモート実行セクションもご覧ください。このセクションでは、追加の考慮事項について説明しています。
多くのカスタマイズが可能ですが、このドキュメントでは、現在最もサポートされている方法である lcov レポートの生成と使用に焦点を当てています。
カバレッジ レポートの作成
準備
カバレッジ レポートを作成する基本的なワークフローには、次のものが必要です。
- テスト ターゲットを含む基本的なリポジトリ
- 言語固有のコード カバレッジ ツールがインストールされたツールチェーン
- 正しい「計測」設定
前者の 2 つは言語固有で、ほとんどの場合簡単ですが、後者は複雑なプロジェクトでは難しくなることがあります。
ここでいう「計測」とは、特定のターゲットに使用されるカバレッジ ツールを指します。Bazel では、--instrumentation_filter フラグを使用して、特定のファイルのサブセットに対してこれを有効にできます。このフラグは、インストルメンテーションが有効になっている状態でテストされるターゲットのフィルタを指定します。テストのインストルメンテーションを有効にするには、--instrument_test_targets フラグが必要です。
デフォルトでは、bazel はターゲット パッケージとの照合を試み、関連するフィルタを INFO メッセージとして出力します。
カバレッジの実行
カバレッジ レポートを作成するには、bazel coverage
--combined_report=lcov
[target] を使用します。これにより、ターゲットのテストが実行され、各ファイルの lcov 形式のカバレッジ レポートが生成されます。
完了すると、bazel は生成されたすべてのカバレッジ ファイルを収集して 1 つにマージするアクションを実行し、最終的に $(bazel info
output_path)/_coverage/_coverage_report.dat に作成します。
テストが失敗した場合もカバレッジ レポートが生成されますが、失敗したテストはレポートされず、合格したテストのみがレポートされます。
記事の表示
カバレッジ レポートは、人が読めない lcov 形式でのみ出力されます。ここから、genhtml ユーティリティ（lcov プロジェクトの一部）を使用して、ウェブブラウザで表示できるレポートを生成できます。
genhtml --branch-coverage --output genhtml "$(bazel info output_path)/_coverage/_coverage_report.dat"
genhtml はソースコードも読み取り、これらのファイルで欠落しているカバレッジにアノテーションを付けます。この機能が動作するには、bazel プロジェクトのルートで genhtml が実行されることが想定されています。
結果を表示するには、genhtml ディレクトリに生成された index.html ファイルを任意のウェブブラウザで開きます。
genhtml ツールまたは lcov カバレッジ形式に関するヘルプと詳細については、lcov プロジェクトをご覧ください。
リモート実行
リモート テスト実行には、現在いくつかの注意点があります。
- レポートの組み合わせアクションは、まだリモートで実行できません。これは、Bazel がカバレッジ出力ファイルをグラフの一部と見なさないため（この問題を参照）、結合アクションの入力として正しく処理できないためです。この問題を回避するには、
--strategy=CoverageReport=localを使用します。- 注: Bazel が
local,remoteを試すように設定されている場合、Bazel が戦略を解決する方法により、代わりに--strategy=CoverageReport=local,remoteのようなものを指定する必要がある場合があります。
- 注: Bazel が
- また、
--remote_download_minimalなどのフラグも、前述の理由により使用できません。 - 現在、テストが以前にキャッシュに保存されている場合、Bazel はカバレッジ情報の作成に失敗します。この問題を回避するには、
--nocache_test_resultsをカバレッジ実行専用に設定できますが、テスト時間の面で大きなコストが発生します。 --experimental_split_coverage_postprocessing、--experimental_fetch_all_coverage_outputs- 通常、カバレッジはテスト アクションの一部として実行されるため、デフォルトでは、リモート実行の出力としてすべてのカバレッジが返されるわけではありません。これらのフラグはデフォルトをオーバーライドして、カバレッジ データを取得します。詳しくは、こちらの問題をご覧ください。
言語固有の構成
Java
Java は、デフォルトの構成でそのまま使用できます。bazel ツールチェーンには、JUnit を含むリモート実行に必要なものがすべて含まれています。
Python
Python でカバレッジのサポートを有効にするために必要な追加の手順については、rules_python カバレッジ ドキュメントをご覧ください。