infra: add Coverlet for code coverage in tests (#328)

Author: natemcmaster

.config/dotnet-tools.json

@@ -13,6 +13,12 @@
       "commands": [
         "NuGetKeyVaultSignTool"
       ]
+    },
+    "dotnet-reportgenerator-globaltool": {
+      "version": "4.4.0",
+      "commands": [
+        "reportgenerator"
+      ]
     }
   }
 }

azure-pipelines.yml

@@ -42,13 +42,18 @@ jobs:
     env:
       KEYVAULT_CLIENT_SECRET: $(kv-access-token)
   - task: PublishTestResults@2
-    displayName: Upload test results
+    displayName: Publish test results
     condition: always()
     continueOnError: true
     inputs:
       testRunTitle: $(vmImage)
       testRunner: vstest
       testResultsFiles: '**/*.trx'
+  - task: PublishCodeCoverageResults@1
+    displayName: Publish code coverage results
+    inputs:
+      codeCoverageTool: cobertura
+      summaryFileLocation: coverlet/reports/Cobertura.xml
   - publish: artifacts/
     artifact: Packages
     displayName: Publish artifacts

build.ps1

@@ -42,14 +42,14 @@ if (-not (Test-Path variable:\IsCoreCLR)) {
 $CodeSign = $sign -or ($ci -and -not $isPr -and $IsWindows)
 
 if ($CodeSign) {
-    exec dotnet tool restore
     $MSBuildArgs += '-p:CodeSign=true'
 }
 
 $artifacts = "$PSScriptRoot/artifacts/"
 
 Remove-Item -Recurse $artifacts -ErrorAction Ignore
 
+exec dotnet tool restore
 exec dotnet build --configuration $Configuration '-warnaserror:CS1591' @MSBuildArgs
 exec dotnet pack --no-restore --no-build --configuration $Configuration -o $artifacts @MSBuildArgs
 exec dotnet build --configuration $Configuration "$PSScriptRoot/docs/samples/samples.sln"
@@ -63,7 +63,15 @@ if ($env:TF_BUILD) {
 }
 
 exec dotnet test --no-restore --no-build --configuration $Configuration `
+    --collect:"XPlat Code Coverage" `
     @testArgs `
     @MSBuildArgs
 
+if ($ci) {
+    exec dotnet tool run reportgenerator `
+        "-reports:$PSScriptRoot/**/coverage.cobertura.xml" `
+        "-targetdir:$PSScriptRoot/coverlet/reports" `
+        "-reporttypes:Cobertura"
+}
+
 write-host -f magenta 'Done'

test/CommandLineUtils.Tests/McMaster.Extensions.CommandLineUtils.Tests.csproj

@@ -14,6 +14,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <PackageReference Include="coverlet.collector" Version="1.1.0" />
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="3.1.0" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.4.0" />
     <PackageReference Include="FluentAssertions" Version="5.9.0" />

test/Hosting.CommandLine.Tests/McMaster.Extensions.Hosting.CommandLine.Tests.csproj

@@ -14,6 +14,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <PackageReference Include="coverlet.collector" Version="1.1.0" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.4.0" />
     <PackageReference Include="Moq" Version="4.13.1" />
     <PackageReference Include="xunit" Version="2.4.1" />