Azure Pipelines にコードカバレッジを表示させてみた

はじめに

LIGTHzアドベントカレンダー 2022の21日目の記事です。

Microsoftの公式ドキュメントの記事をもとに実装してみました。

• PublishCodeCoverageResults@1 - コード カバレッジの結果 v1 タスクを発行する
• コード カバレッジの結果を確認する

コードカバレッジを確認できると何がいいのか

コード カバレッジは、単体テストなどのテストによって実際にテストされているプロジェクトのコードの割合を判断するのに役立ちます。 コードの変更に対する信頼度を高め、バグから効果的に保護するには、コードの大部分をテストで実行するか、カバーする必要があります。
コード カバレッジの結果を確認すると、テストでカバーされていないコード パスを特定するのに役立ちます。 この情報は、テスト負債を減らすことで、時間の経過と伴うテスト資料を改善するために重要です。

※公式ドキュメントより

Azure Pipelines に表示する方法

以下のコードを azure-pipeline.yml の steps の後に記述します。

azure-pipelines.yml

steps:
- task: PublishCodeCoverageResults@1
      inputs:
        # 使用するコードカバレッジツール
        # 使用できる値: Cobertura、JaCoCo 既定値: JaCoCo
        codeCoverageTool: 'JaCoCo' 

        # 行、メソッド、クラス カバレッジなどのコード カバレッジ統計を含むサマリー
        # ファイルのパスを指定する
        summaryFileLocation: '$(System.DefaultWorkingDirectory)/**/coverage.

結果の表示

コードカバレッジは、パイプライン実行の [Summary] タブの [Tests and coverage] で確認できます。

また、結果は [Summary] タブの横に [Code Coverage] タブが表示されるようになるので、 [Code Coverage]　タブから表示およびダウンロードできます。