Report code coverage to GitHub (#4574)

RussKie · web-flow · commit 1e2ad7cefe55 · 2023-10-31T13:46:23.000+11:00
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -56,27 +56,18 @@ variables:
 
   - name: runAsPublic
     value: ${{ eq(variables['System.TeamProject'], 'public') }}
+
   - name: _BuildConfig
     value: Release
   - name: isOfficialBuild
     value: ${{ and(ne(variables['runAsPublic'], 'true'), notin(variables['Build.Reason'], 'PullRequest')) }}
-  - name: IsDeltaBuild
-    value: ${{ eq(variables['Build.Reason'], 'PullRequest') }}
   - name: Build.Arcade.ArtifactsPath
     value: $(Build.SourcesDirectory)/artifacts/
   - name: Build.Arcade.LogsPath
     value: $(Build.Arcade.ArtifactsPath)log/$(_BuildConfig)/
   - name: Build.Arcade.TestResultsPath
     value: $(Build.Arcade.ArtifactsPath)TestResults/$(_BuildConfig)/
 
-  # For full build we can do a shallow build, for a delta build we need the full history.
-  - ${{ if eq(variables['IsDeltaBuild'], 'true') }}:
-    - name: _FetchDepth
-      value: 0
-  - ${{ else }}:
-    - name: _FetchDepth
-      value: 1
-
   - ${{ if or(startswith(variables['Build.SourceBranch'], 'refs/heads/release/'), startswith(variables['Build.SourceBranch'], 'refs/heads/internal/release/'), eq(variables['Build.Reason'], 'Manual')) }}:
     - name: PostBuildSign
       value: false
@@ -163,7 +154,7 @@ stages:
           - checkout: self
             clean: true
             persistCredentials: true
-            fetchDepth: $(_FetchDepth)
+            fetchDepth: 1
 
         steps:
           - template: /eng/pipelines/templates/BuildAndTest.yml
@@ -173,7 +164,6 @@ stages:
               repoLogPath: $(Build.Arcade.LogsPath)
               repoTestResultsPath: $(Build.Arcade.TestResultsPath)
               skipQualityGates: ${{ eq(variables['SkipQualityGates'], 'true') }}
-              isDeltaBuild: $(IsDeltaBuild)
               isWindows: true
               warnAsError: 0
 
@@ -200,7 +190,7 @@ stages:
           - checkout: self
             clean: true
             persistCredentials: true
-            fetchDepth: $(_FetchDepth)
+            fetchDepth: 1
 
         steps:
           - template: /eng/pipelines/templates/BuildAndTest.yml
@@ -210,7 +200,6 @@ stages:
               repoLogPath: $(Build.Arcade.LogsPath)
               repoTestResultsPath: $(Build.Arcade.TestResultsPath)
               skipQualityGates: ${{ eq(variables['SkipQualityGates'], 'true') }}
-              isDeltaBuild: $(IsDeltaBuild)
               isWindows: false
               warnAsError: 0
 
@@ -262,8 +251,6 @@ stages:
           displayName: Init toolset
 
         - template: /eng/pipelines/templates/VerifyCoverageReport.yml
-          parameters:
-            isDeltaBuild: $(IsDeltaBuild)
 
 
 # ----------------------------------------------------------------
@@ -304,7 +291,7 @@ stages:
           - checkout: self
             clean: true
             persistCredentials: true
-            fetchDepth: $(_FetchDepth)
+            fetchDepth: 1
 
         steps:
           - template: \eng\pipelines\templates\BuildAndTest.yml
@@ -315,7 +302,6 @@ stages:
               repoTestResultsPath: $(Build.Arcade.TestResultsPath)
               skipTests: true
               skipQualityGates: true
-              isDeltaBuild: $(IsDeltaBuild)
               isWindows: false
 
 
diff --git a/eng/pipelines/templates/BuildAndTest.yml b/eng/pipelines/templates/BuildAndTest.yml
@@ -7,8 +7,6 @@ parameters:
     type: string
   - name: repoTestResultsPath
     type: string
-  - name: isDeltaBuild
-    type: string
   - name: isWindows
     type: string
   - name: skipTests
@@ -22,24 +20,6 @@ parameters:
     default: 1
 
 steps:
-  # Debug
-  # - pwsh: |
-  #       Write-Host 'buildScript: ${{ parameters.buildScript }}'
-  #       Write-Host 'buildConfig: ${{ parameters.buildConfig }}'
-  #       Write-Host 'repoLogPath: ${{ parameters.repoLogPath }}'
-  #       Write-Host 'repoTestResultsPath: ${{ parameters.repoTestResultsPath }}'
-  #       Write-Host 'isDeltaBuild: ${{ parameters.isDeltaBuild }}'
-  #       Write-Host 'isWindows: ${{ parameters.isWindows }}'
-  #       Write-Host 'skipTests: ${{ parameters.skipTests }}'
-  #       Write-Host 'skipQualityGates: ${{ parameters.skipQualityGates }}'
-  #       Get-ChildItem env:* | Sort-Object Name
-  #   displayName: Debug
-
-  - pwsh: |
-        function Export { param($i); Write-Host "$i"; Write-Host "##$i" }
-        Export "vso[task.setvariable variable=IsDeltaBuild]${{ parameters.isDeltaBuild }}"
-    displayName: Set flags
-
   - script: ${{ parameters.buildScript }}
             -restore
             /bl:${{ parameters.repoLogPath }}/restore.binlog
diff --git a/eng/pipelines/templates/VerifyCoverageReport.yml b/eng/pipelines/templates/VerifyCoverageReport.yml
@@ -1,7 +1,3 @@
-parameters:
-  - name: isDeltaBuild
-    type: string
-
 steps:
   - task: DownloadBuildArtifacts@0
     displayName: Download code coverage reports
@@ -34,3 +30,12 @@ steps:
   - pwsh: |
         $(Build.SourcesDirectory)/eng/scripts/ValidateProjectCoverage.ps1 -CoberturaReportXml ./merged.cobertura.xml
     displayName: Check per-project coverage
+
+  - ${{ if and(eq(variables['System.TeamProject'], 'public'), eq(variables['Build.Reason'], 'PullRequest')) }}:
+    - task: GitHubComment@0
+      condition: always()
+      inputs:
+        gitHubConnection: dotnet-comment-bot-service-connection
+        repositoryName: '$(Build.Repository.Name)'
+        id: $(System.PullRequest.PullRequestNumber)
+      displayName: Report coverage to GitHub
diff --git a/eng/scripts/ValidateProjectCoverage.ps1 b/eng/scripts/ValidateProjectCoverage.ps1
@@ -1,5 +1,4 @@
 ﻿#!/usr/bin/env pwsh
-
 <#
 .SYNOPSIS
     Validates the code coverage policy for each project.
@@ -58,6 +57,8 @@ Get-ChildItem -Path src -Include '*.*sproj' -Recurse | ForEach-Object {
 $esc = [char]27
 $Errors = New-Object System.Collections.ArrayList
 $Kudos = New-Object System.Collections.ArrayList
+$ErrorsMarkdown = @();
+$KudosMarkdown = @();
 
 Write-Verbose "Collecting projects from code coverage report..."
 $CoberturaReport.coverage.packages.package | ForEach-Object {
@@ -80,10 +81,11 @@ $CoberturaReport.coverage.packages.package | ForEach-Object {
         # Detect the under-coverage
         if ($MinCodeCoverage -gt $LineCoverage) {
             $IsFailed = $true
+            $ErrorsMarkdown += "| $Name | Line | **$MinCodeCoverage** | $LineCoverage :small_red_triangle_down: |"
             [void]$Errors.Add(
                 (
                     New-Object PSObject -Property @{
-                        "Project" = $Name;
+                        "Project" = $Name.Replace('Microsoft.Extensions.', 'M.E.').Replace('Microsoft.AspNetCore.', 'M.AC.');
                         "Coverage Type" = "Line";
                         "Expected" = $MinCodeCoverage;
                         "Actual" = "$esc[1m$esc[0;31m$($LineCoverage)$esc[0m"
@@ -94,10 +96,11 @@ $CoberturaReport.coverage.packages.package | ForEach-Object {
 
         if ($MinCodeCoverage -gt $BranchCoverage) {
             $IsFailed = $true
+            $ErrorsMarkdown += "| $Name | Branch | **$MinCodeCoverage** | $BranchCoverage :small_red_triangle_down: |"
             [void]$Errors.Add(
                 (
                     New-Object PSObject -Property @{
-                        "Project" = $Name;
+                        "Project" = $Name.Replace('Microsoft.Extensions.', 'M.E.').Replace('Microsoft.AspNetCore.', 'M.AC.');
                         "Coverage Type" = "Branch";
                         "Expected" = $MinCodeCoverage;
                         "Actual" = "$esc[1m$esc[0;31m$($BranchCoverage)$esc[0m"
@@ -110,10 +113,11 @@ $CoberturaReport.coverage.packages.package | ForEach-Object {
         [int]$lowestReported = [math]::Min([math]::Truncate($LineCoverage), [math]::Truncate($BranchCoverage));
         Write-Debug "line: $LineCoverage, branch: $BranchCoverage, min: $lowestReported, threshold: $MinCodeCoverage"
         if ([int]$MinCodeCoverage -lt $lowestReported) {
+            $KudosMarkdown += "| $Name | $MinCodeCoverage | **$lowestReported** |"
             [void]$Kudos.Add(
                 (
                     New-Object PSObject -Property @{
-                        "Project" = $Name;
+                        "Project" = $Name.Replace('Microsoft.Extensions.', 'M.E.').Replace('Microsoft.AspNetCore.', 'M.AC.');
                         "Expected" = $MinCodeCoverage;
                         "Actual" = "$esc[1m$esc[0;32m$($lowestReported)$esc[0m";
                     }
@@ -129,8 +133,7 @@ $CoberturaReport.coverage.packages.package | ForEach-Object {
     }
 }
 
-if ($Kudos.Count -ne 0)
-{
+if ($Kudos.Count -ne 0) {
     Write-Header -message "`r`nGood job! The coverage increased" -isError $false
     $Kudos | `
         Sort-Object Project | `
@@ -139,6 +142,37 @@ if ($Kudos.Count -ne 0)
                     @{ Name="Actual"; Expression="Actual"; Width=10; Alignment = "Right" } `
                     -AutoSize -Wrap
     Write-Host "##vso[task.logissue type=warning;]Good job! The coverage increased, please update your projects"
+
+    $KudosMarkdown = @(':tada: **Good job! The coverage increased** :tada:', 'Update `MinCodeCoverage` in the project files.', "`r`n", '| Project | Expected | Actual |', '| --- | ---: | ---: |', $KudosMarkdown, "`r`n`r`n");
+}
+
+if ($Errors.Count -ne 0) {
+    Write-Header -message "`r`n[!!] Found $($Errors.Count) issues!" -isError ($Errors.Count -ne 0)
+    $Errors | `
+        Sort-Object Project, 'Coverage Type' | `
+        Format-Table "Project", `
+                    @{ Name="Expected"; Expression="Expected"; Width=10; Alignment = "Right" }, `
+                    @{ Name="Actual"; Expression="Actual"; Width=10; Alignment = "Right" }, `
+                    @{ Name="Coverage Type"; Expression="Coverage Type"; Width=10; Alignment = "Center" } `
+                    -AutoSize -Wrap
+
+    $ErrorsMarkdown = @(":bangbang: **Found issues** :bangbang: ", "`r`n", '| Project | Coverage Type |Expected | Actual | ', '| --- | :---: | ---: | ---: |', $ErrorsMarkdown, "`r`n`r`n");
+}
+
+# Write out markdown for publishing back to AzDO
+'' | Out-File coverage-report.md -Encoding ascii
+$ErrorsMarkdown | Out-File coverage-report.md -Encoding ascii -Append
+$KudosMarkdown | Out-File coverage-report.md -Encoding ascii -Append
+
+# Set the AzDO variable used by GitHubComment@0 task
+[string]$markdown = Get-Content coverage-report.md -Raw
+if (![string]::IsNullOrWhiteSpace($markdown)) {
+    # Add link back to the Code Coverage board
+    $link = "$($env:SYSTEM_COLLECTIONURI)$env:SYSTEM_TEAMPROJECT/_build/results?buildId=$env:BUILD_BUILDID&view=codecoverage-tab"
+    $markdown = "$markdown`n`nFull code coverage report: $link"
+
+    $gitHubCommentVar = '##vso[task.setvariable variable=GITHUB_COMMENT]' + $markdown.Replace("`r`n","`n").Replace("`n","%0D%0A")
+    Write-Host $gitHubCommentVar
 }
 
 if ($Errors.Count -eq 0)
@@ -147,13 +181,4 @@ if ($Errors.Count -eq 0)
     exit 0;
 }
 
-Write-Header -message "`r`n[!!] Found $($Errors.Count) issues!" -isError ($Errors.Count -ne 0)
-$Errors | `
-    Sort-Object Project, 'Coverage Type' | `
-    Format-Table "Project", `
-                @{ Name="Expected"; Expression="Expected"; Width=10; Alignment = "Right" }, `
-                @{ Name="Actual"; Expression="Actual"; Width=10; Alignment = "Right" }, `
-                @{ Name="Coverage Type"; Expression="Coverage Type"; Width=10; Alignment = "Center" } `
-                -AutoSize -Wrap
 exit -1;
-
