Fix code coverage collection with VSTest

Author: Tsingis

.github/workflows/test.yml

@@ -35,14 +35,14 @@ jobs:
         run: dotnet build -c Release --no-restore
       - name: Test & collect coverage
         run: |
-          dotnet test -c Release --no-restore --no-build -- \
-          --coverage --coverage-output-format xml --coverage-output ${{ github.workspace }}/coverage.xml
+          dotnet test -c Release --no-restore --no-build \
+          --settings tests/coverage.runsettings --results-directory ${{ github.workspace }}/test-results
         env:
           USE_MOCKING: ${{ vars.USE_MOCKING }}
           SHOW_MOCKING_LOGS: ${{ vars.SHOW_MOCKING_LOGS }}
       - name: Find coverage files and generate report
         run: |
-          dotnet tool run reportgenerator -reports:"${{ github.workspace }}/**/coverage.xml" \
+          dotnet tool run reportgenerator -reports:"${{ github.workspace }}/test-results/**/*cobertura.xml" \
           -targetdir:"coverage-report" \
           -reporttypes:MarkdownSummaryGithub
       - name: Upload coverage report

.gitignore

@@ -26,8 +26,9 @@ bld/
 [Ll]ogs/
 
 # Coverage
-[Cc]overagereport
-coverage.*.xml
+[Cc]overage-report
+*coverage.*.xml
+*cobertura.xml
 
 # PDFs
 *.pdf

Directory.Build.props

@@ -32,6 +32,10 @@
     </PackageReference>
   </ItemGroup>
   <ItemGroup Condition="$(MSBuildProjectName.EndsWith('Tests'))">
+    <PackageReference Include="coverlet.collector">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+    </PackageReference>
     <PackageReference Include="Microsoft.NET.Test.Sdk" />
     <PackageReference Include="Microsoft.Testing.Extensions.CodeCoverage" />
     <PackageReference Include="xunit.v3" />

coverage.ps1

@@ -1,14 +1,15 @@
-dotnet test -c Debug --no-restore --no-build -- --coverage --coverage-output-format xml --coverage-output coverage.xml
+dotnet build -c Release
+dotnet test -c Release --no-build --settings tests/coverage.runsettings --results-directory test-results
 
-$coverageFiles = Get-ChildItem -Path "tests" -Recurse -Filter "coverage.xml"
+$coverageFiles = Get-ChildItem -Path "test-results" -Recurse -Filter "*cobertura.xml"
 
 if ($coverageFiles) {
     $reportFiles = ($coverageFiles | ForEach-Object { $_.FullName }) -join ";"
-    dotnet tool run reportgenerator -reports:$reportFiles -targetdir:coveragereport
+    dotnet tool run reportgenerator -reports:$reportFiles -targetdir:coverage-report
 
-    Start-Process "coveragereport/index.html"
+    Start-Process "coverage-report/index.html"
 } else {
     Write-Host "Coverage reports not found."
 }
 
-Get-ChildItem -Path "tests" -Recurse -Filter "TestResults" | ForEach-Object { Remove-Item -Recurse -Force -Path $_.FullName }
+Get-ChildItem -Path "test-results" -Recurse | ForEach-Object { Remove-Item -Recurse -Force -Path $_.FullName }

tests/ArchitectureTests/packages.lock.json

@@ -2,6 +2,12 @@
   "version": 2,
   "dependencies": {
     "net9.0": {
+      "coverlet.collector": {
+        "type": "Direct",
+        "requested": "[6.0.4, )",
+        "resolved": "6.0.4",
+        "contentHash": "lkhqpF8Pu2Y7IiN7OntbsTtdbpR1syMsm2F3IgX6ootA4ffRqWL5jF7XipHuZQTdVuWG/gVAAcf8mjk8Tz0xPg=="
+      },
       "Microsoft.NET.Test.Sdk": {
         "type": "Direct",
         "requested": "[18.0.0, )",

tests/Directory.Packages.props

@@ -4,6 +4,7 @@
     <CentralPackageTransitivePinningEnabled>true</CentralPackageTransitivePinningEnabled>
   </PropertyGroup>
   <ItemGroup>
+    <PackageVersion Include="coverlet.collector" Version="6.0.4" />
     <PackageVersion Include="Microsoft.AspNetCore.Mvc.Testing" Version="9.0.9" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.0.0" />
     <PackageVersion Include="Microsoft.Testing.Extensions.CodeCoverage" Version="18.0.4" />
@@ -15,4 +16,4 @@
     <PackageVersion Include="xunit.v3" Version="3.1.0" />
     <PackageVersion Include="xunit.runner.visualstudio" Version="3.1.5" />
   </ItemGroup>
-</Project>
+</Project>

tests/IntegrationTests/packages.lock.json

@@ -2,6 +2,12 @@
   "version": 2,
   "dependencies": {
     "net9.0": {
+      "coverlet.collector": {
+        "type": "Direct",
+        "requested": "[6.0.4, )",
+        "resolved": "6.0.4",
+        "contentHash": "lkhqpF8Pu2Y7IiN7OntbsTtdbpR1syMsm2F3IgX6ootA4ffRqWL5jF7XipHuZQTdVuWG/gVAAcf8mjk8Tz0xPg=="
+      },
       "Microsoft.AspNetCore.Mvc.Testing": {
         "type": "Direct",
         "requested": "[9.0.9, )",

tests/UnitTests/packages.lock.json

@@ -2,6 +2,12 @@
   "version": 2,
   "dependencies": {
     "net9.0": {
+      "coverlet.collector": {
+        "type": "Direct",
+        "requested": "[6.0.4, )",
+        "resolved": "6.0.4",
+        "contentHash": "lkhqpF8Pu2Y7IiN7OntbsTtdbpR1syMsm2F3IgX6ootA4ffRqWL5jF7XipHuZQTdVuWG/gVAAcf8mjk8Tz0xPg=="
+      },
       "Microsoft.NET.Test.Sdk": {
         "type": "Direct",
         "requested": "[18.0.0, )",

tests/coverage.runsettings

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<RunSettings>
+  <DataCollectionRunSettings>
+    <DataCollectors>
+      <DataCollector friendlyName="XPlat Code Coverage">
+        <Configuration>
+          <Format>cobertura</Format>
+          <Include>
+            <ModulePath>.*[\\/]src[\\/].*\.dll$</ModulePath>
+          </Include>
+        </Configuration>
+      </DataCollector>
+    </DataCollectors>
+  </DataCollectionRunSettings>
+</RunSettings>