Bazel によるコードカバレッジ

<ph type="x-smartling-placeholder"></ph> 問題を報告するソースを表示夜間 · 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bazel には、コードカバレッジを生成する coverage サブコマンドがあります bazel coverage でテストできるリポジトリに関するレポート。期限さまざまな言語エコシステムの特異性にかかわるものですが、特定のプロジェクトでこれを行うのは簡単です。

このページでは、Google Cloud Storage バケットをレポートについても、言語ごとの説明よく知られた言語の人だけが使用できます。最初に読むことをおすすめします全般的なセクションを読んでから特定の言語の要件を確認してくださいまた、リモート実行セクション。いくつかの考慮事項を確認します

さまざまなカスタマイズが可能ですが、このドキュメントでは、 lcov レポートの作成と使用が可能です。ルートの 1 つです

カバレッジレポートを作成する

準備

カバレッジレポートを作成する基本的なワークフローでは、次のとおりです。

テストターゲットを含む基本的なリポジトリ
言語固有のコードカバレッジツールがインストールされたツールチェーン
正しい「計測」構成

前者の 2 つは言語固有でほとんどがわかりやすいものです複雑なプロジェクトでは後者の方が難しい場合があります

"インストルメンテーション"カバレッジツールは使用されます。Bazel を使用すると、サブセットを 1 つに --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 の一部）をプロジェクト）を使用して、ウェブで表示できるレポートを作成します。 browser:

genhtml --output genhtml "$(bazel info output_path)/_coverage/_coverage_report.dat"

genhtml はソースコードも読み取って、欠損値にアノテーションを付けます。です。これが機能するには、次のことが期待されます。 genhtml は bazel プロジェクトのルートで実行されます。

結果を表示するには、Terraform で生成された index.html ファイルを開くだけです。任意のウェブブラウザの genhtml ディレクトリ。

genhtml ツールに関するその他のヘルプと情報については、 lcov カバレッジ形式については、lcov プロジェクトをご覧ください。

リモート実行

現在、リモートテスト実行で実行する場合、いくつかの注意点があります。

レポートの組み合わせの操作はまだリモートで実行できません。これは、 Bazel では、カバレッジ出力ファイルが（この問題を参照）、組み合わせアクションへの入力として正しく扱いません。宛先 --strategy=CoverageReport=local を使用してください。
- 注: 次のように指定する必要がある場合があります。 Bazel が設定されている場合、代わりに --strategy=CoverageReport=local,remote Bazel によるストラテジーの解決により、local,remote が試行されます。
--remote_download_minimal などのフラグは使用できません。影響しています
テストを行うと、Bazel は現在、カバレッジ情報の作成に失敗します。キャッシュに保存されています。この問題を回避するには --nocache_test_results は、カバレッジ実行専用に設定できます。ただしテスト時間の面で大きなコストがかかります
--experimental_split_coverage_postprocessing、 --experimental_fetch_all_coverage_outputs <ph type="x-smartling-placeholder">
- 通常、カバレッジはテストアクションの一環として実行されるため、デフォルトでは、すべてのカバレッジがリモートリソースの出力として返されるわけではありません。実行されています。これらのフラグはデフォルトをオーバーライドし、適用範囲データを抽出できます。詳しくは、この問題をご覧ください。表示されます。

言語固有の構成

Java

Java は、デフォルトの構成ですぐに使用できます。「 bazel ツールチェーンには、移行に必要なすべてのものがリモート実行にも対応しています

Python

rules_python カバレッジのドキュメントをご覧ください。をご覧ください。

Bazel によるコード カバレッジ

カバレッジ レポートを作成する

準備