PublishCodeCoverageResults@2 - コード カバレッジの結果を発行する v2 タスク

このタスクを使用して、ビルドからコード カバレッジの結果を取得します。

構文

# Publish code coverage results v2
# Publish any of the code coverage results from a build.
- task: PublishCodeCoverageResults@2
  inputs:
    summaryFileLocation: # string. Required. Path to summary files. 
    #pathToSources: # string. Path to Source files. 
    #failIfCoverageEmpty: false # boolean. Fail if code coverage results are missing. Default: false.

入力

summaryFileLocation - サマリー ファイルへのパス
string. 必須です。

行、メソッド、クラス カバレッジなどのコード カバレッジ統計を含むサマリー ファイルのパスを指定します。 複数の概要ファイルが 1 つのレポートにマージされます。 値には minimatch パターンが含まれる場合があります。 (例: $(System.DefaultWorkingDirectory)/MyApp/**/site/cobertura/coverage.xml)。 ミニマッチ パターンの詳細。

pathToSources - ソース ファイルへのパス
string.

カバレッジ XML レポートにソース ファイルへの絶対パスが含まれていない場合は、ソース ファイルへのパスを指定する必要があります。 たとえば、JaCoCo レポートでは絶対パスが使用されないため、Java アプリの JaCoCo カバレッジを公開する場合、パターンは に $(System.DefaultWorkingDirectory)/MyApp/src/main/java/似ています。 この入力は、ホスト上のソース ファイルへの絶対パスを指す必要があります。 たとえば、「 $(System.DefaultWorkingDirectory)/MyApp/ 」のように入力します。

この入力は、テストが Docker コンテナーで実行される場合に使用できます。

failIfCoverageEmpty - コード カバレッジの結果が見つからない場合は失敗する
boolean. 既定値: false。

コード カバレッジで発行する結果が生成されなかった場合、タスクは失敗します。

タスク制御オプション

すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。

出力変数

[なし] :

解説

注意

コード カバレッジ結果の発行タスクの V2 の新機能と V1 から V2 への移行については、Azure DevOps ブログの「コード カバレッジ結果の発行タスクの新しいバージョン」を参照してください。

このタスクをビルド パイプラインで使用して、テストを実行するときに生成されたコード カバレッジの結果を Azure Pipelines または TFS に発行し、カバレッジ xml ファイルを生成した後、パイプラインでコード カバレッジ タブとカバレッジ レポートの詳細を取得します。 このタスクでは、コード カバレッジで生成された xml 形式がサポートされます。 このタスクは、コード カバレッジの詳細を含む cjson ファイルを生成します。 また、ビルド成果物の下にコード カバレッジ HTML レポートも生成されます。

このタスクはビルド パイプラインでのみサポートされ、リリース パイプラインではサポートされません。

Visual Studio Test、.NET Core、Ant、Maven、Gulp、Grunt などのタスクには、コード カバレッジ データをパイプラインに発行するオプションも用意されています。 これらのタスクを使用している場合は、パイプラインに個別のコード カバレッジ結果の発行タスクは必要ありません。

前提条件 - パイプラインでコード カバレッジ結果 v2 の発行タスクを使用するには、パイプラインの前提条件として dotnet 7.0.x タスクを使用してください。 コード カバレッジ v2 の発行タスクの前に dotnet core タスクを使用します。

前提条件

YAML パイプラインを使用して前提条件を構成するには、

# Dotnet core sdk task 7.0.x
- task: UseDotNet@2
  displayName: 'Use .NET Core sdk 7.0.x'
  inputs:
    version: 7.0.x

デザイナーを使用して前提条件を構成するには:

1. 次の設定を使用して、コード カバレッジ結果バージョン 2 の発行タスクを構成します。

   

2. ビルドが完了し、コード カバレッジ結果 v2 の発行タスクが成功したら、パイプライン実行の概要で [ コード カバレッジ ] タブを選択して、コード カバレッジの結果を表示します。

   

YAML を使用したイスタンブールでの JavaScript のコード カバレッジの結果

YAML を使用して、YAML を使用して JavaScript のコード カバレッジの結果を発行するには、これらのトピックの「Ecosystems」セクションの 「JavaScript のカスタマイズ 」を参照してください。これには、他の言語の例も含まれています。

Cobertura を使用してコード カバレッジを公開する例を参照してください。

Docker

Docker を使用するアプリの場合、ビルドとテストはコンテナー内で実行され、コンテナー内でコード カバレッジの結果が生成される場合があります。 結果をパイプラインに発行するには、結果の成果物を [コード カバレッジ結果の発行 ] タスクで使用できるようにする必要があります。 リファレンスについては、「Docker 用の Docker ファイルを使用して結果をビルド、テスト、発行する」セクションで、テスト結果を公開するための同様の例を確認できます。

結果の表示

パイプラインでコード カバレッジの結果を表示するには、「 コード カバレッジの結果を確認する」を参照してください。

既知の問題

コード カバレッジの結果 v2 の発行タスクは cjson ファイルを生成し、コード カバレッジ タブの下にコード カバレッジ レポートを発行します。また、メインindex.htmlファイルからリンクされた HTML ファイルのセットであるビルド成果物も生成されます。 コード カバレッジ タブにコード カバレッジ レポートが表示されない場合は、入力コード カバレッジ xml ファイルが正しい形式で、有効な詳細があるかどうかをチェックします。

要件

要件	説明
パイプラインの種類	YAML、クラシック ビルド
実行日	エージェント
確認要求	なし
Capabilities	このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限	Any
設定可能な変数	Any
エージェントのバージョン	2.144.0 以上
タスクのカテゴリ	テスト

こちらもご覧ください

• テスト結果を発行する