chore: add codecoverage settings

Author: filzrev

.github/workflows/ci.yml

@@ -48,26 +48,36 @@ jobs:
         $env:PLAYWRIGHT_NODEJS_PATH = (Get-Command node).Path
         ./playwright.ps1 install chromium --only-shell
 
-    - run: dotnet test -c Release -f net8.0 --no-build --collect:"XPlat Code Coverage" --consoleLoggerParameters:"Summary;Verbosity=Minimal" -- --seed ${{ env.seed }}
+    - name: Install `dotnet-coverage` as .NET Global Tool
+      run: dotnet tool install -g dotnet-coverage
+
+    - name: Start dotnet-coverage with background server mode
+      run: dotnet coverage collect --session-id docfx_coverage --settings test/CodeCoverage.runsettings --server-mode --background
+
+    - run: dotnet coverage connect docfx_coverage "dotnet test -c Release -f net8.0 --no-build -- --seed ${{ env.seed }}"
       id: test-net80
 
-    - run: dotnet test -c Release -f net9.0 --no-build --collect:"XPlat Code Coverage" --consoleLoggerParameters:"Summary;Verbosity=Minimal" -- --seed ${{ env.seed }}
+    - run: dotnet coverage connect docfx_coverage "dotnet test -c Release -f net9.0 --no-build -- --seed ${{ env.seed }}"
       if: matrix.os == 'ubuntu-latest'
       id: test-net90
 
     - run: npm i -g @percy/cli
       if: matrix.os == 'ubuntu-latest'
 
-    - run: percy exec -- dotnet test -c Release -f net8.0 --no-build --collect:"XPlat Code Coverage" -- --filter-trait "Stage=Percy"
+    - run: dotnet coverage connect docfx_coverage "percy exec -- dotnet test -c Release -f net8.0 --no-build -- --filter-trait "Stage=Percy" --seed ${{ env.seed }}"
       if: matrix.os == 'ubuntu-latest'
       env:
         PERCY_TOKEN: ${{ secrets.PERCY_TOKEN }}
 
+    - name: Shutdown dotnet-coverage server.
+      run: dotnet coverage shutdown docfx_coverage  --timeout 60000
+
     - uses: codecov/codecov-action@v5
       if: matrix.os == 'ubuntu-latest'
       with:
         fail_ci_if_error: false
         token: ${{ secrets.CODECOV_TOKEN }}
+        directory: test/TestResults/code-coverages
 
     - run: echo "DOTNET_DbgEnableMiniDump=1" >> $GITHUB_ENV
       if: matrix.os == 'ubuntu-latest'

Directory.Packages.props

@@ -43,6 +43,6 @@
   </ItemGroup>
 
   <ItemGroup>
-    <GlobalPackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" />
+    <GlobalPackageVersion Include="Microsoft.SourceLink.GitHub" Version="8.0.0" />
   </ItemGroup>
 </Project>

docfx.sln

@@ -15,6 +15,7 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{926A0726-B806-4215-82EF-AF8E22D0FACF}"
 	ProjectSection(SolutionItems) = preProject
 		test\Directory.Build.props = test\Directory.Build.props
+		test\CodeCoverage.runsettings = test\CodeCoverage.runsettings
 		test\Directory.Packages.props = test\Directory.Packages.props
 		test\xunit.runner.json = test\xunit.runner.json
 	EndProjectSection

test/.editorconfig

@@ -6,5 +6,4 @@ csharp_style_unused_value_expression_statement_preference = discard_variable:sil
 csharp_style_unused_value_assignment_preference           = discard_variable:silent # IDE0059: Remove unnecessary value assignment
 dotnet_diagnostic.SYSLIB1045.severity = silent  # SYSLIB1045: Convert to 'GeneratedRegexAttribute'.
 
-[*.runsettings]
 indent_size = 2

test/CodeCoverage.runsettings

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Configuration>
+  <!-- Available Options: https://github.com/microsoft/codecoverage/blob/main/docs/configuration.md -->
+  <CoverageFileName>coverage.cobertura.xml</CoverageFileName>
+  <Format>cobertura</Format>
+  <IncludeTestAssembly>false</IncludeTestAssembly>
+  <DeterministicReport>true</DeterministicReport>
+  <CollectFromChildProcesses>true</CollectFromChildProcesses>
+  <CodeCoverage>
+    <ModulePaths>
+      <Include>
+        <ModulePath>.*Docfx.*\.dll$</ModulePath>
+      </Include>
+      <Exclude>
+        <!-- Exclude test DLLs -->
+        <ModulePath>.*Docfx\.Tests\.Common\.dll$</ModulePath>
+        <ModulePath>.*\.Tests\.dll$</ModulePath>
+
+        <!-- Exclude third party DLLs -->
+        <ModulePath>.*ICSharpCode\.Decompiler\.dll$</ModulePath>
+        <ModulePath>.*Spectre\.Console\.Cli\.dll$</ModulePath>
+        <ModulePath>.*Spectre\.Console\.dll$</ModulePath>
+        <ModulePath>.*DiffEngine\.dll$</ModulePath>
+
+        <!-- Following DLLs are included when using `dotnet coverage` commands -->
+        <ModulePath>.*Argon\.dll$</ModulePath>
+        <ModulePath>.*EmptyFiles\.dll$</ModulePath>
+        <ModulePath>.*Verify\.dll$</ModulePath>
+        <ModulePath>.*Verify\.DiffPlex\.dll$</ModulePath>
+        <ModulePath>.*Verify\.XunitV3\.dll$</ModulePath>
+      </Exclude>
+    </ModulePaths>
+    <Attributes>
+      <Exclude>
+        <Attribute>^System\.CodeDom\.Compiler\.GeneratedCodeAttribute$</Attribute>
+      </Exclude>
+    </Attributes>
+    <Sources>
+      <Exclude>
+        <Source>.*\\[^\\]*\.g\.cs</Source>
+      </Exclude>
+    </Sources>
+  </CodeCoverage>
+</Configuration>

test/docfx.Snapshot.Tests/PercyTest.cs

@@ -1,7 +1,6 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-using System.Diagnostics;
 using System.Net.Http.Json;
 using System.Net.NetworkInformation;
 using System.Text.RegularExpressions;