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

[アーティクル]
11/08/2024

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

構文

# 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 つのレポートにマージされます。この値には、ミニマッチパターンが含まれている場合があります。例: $(System.DefaultWorkingDirectory)/MyApp/**/site/cobertura/coverage.xml. minimatch パターンの詳細。

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

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

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

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

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

タスクコントロールのオプション

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

出力変数

何一つ。

備考

このタスクをビルドパイプラインで使用して、テストの実行時に生成されたコードカバレッジの結果を 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

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

パイプラインの .Net Core Sdk タスクを示すスクリーンショット。

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

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

によって生成された [コードカバレッジ] タブを示すスクリーンショット

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

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

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

港湾労働者

Docker を使用するアプリの場合、ビルドとテストはコンテナー内で実行され、コンテナー内でコードカバレッジの結果が生成される場合があります。結果をパイプラインに発行するには、結果の成果物を Publish Code Coverage Results タスクで使用できるようにする必要があります。参考までに、Dockerの Docker ファイルセクションで、ビルド、テスト、発行の結果を発行する場合の同様の例を確認できます。

結果を表示する

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

既知の問題

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

必要条件

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

次の方法で共有

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

構文