chore: Update xUnit related package version to v3

.github/workflows/ci.yml

@@ -6,6 +6,9 @@ on:
     branches: [ main, feature/*, hotfix/* ]
   workflow_dispatch:
 
+env:
+  NO_COLOR: true
+
 jobs:
   test:
     runs-on: ${{ matrix.os }}
@@ -31,26 +34,43 @@ jobs:
       shell: bash
       working-directory: templates
 
-    - run: dotnet test -c Release -f net8.0 --no-build --collect:"XPlat Code Coverage" --consoleLoggerParameters:"Summary;Verbosity=Minimal"
+    - name: Install Chromium headless shell
+      shell: pwsh
+      working-directory: src/docfx/bin/Release/net8.0
+      run: |
+        $env:PLAYWRIGHT_NODEJS_PATH = (Get-Command node).Path
+        ./playwright.ps1 install chromium --only-shell
+
+    - 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"
       id: test-net80
 
-    - run: dotnet test -c Release -f net9.0 --no-build --collect:"XPlat Code Coverage" --consoleLoggerParameters:"Summary;Verbosity=Minimal"
+    - run: dotnet coverage connect docfx_coverage "dotnet test -c Release -f net9.0 --no-build"
       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 --filter Stage=Percy --no-build --collect:"XPlat Code Coverage"
+    - run: dotnet coverage connect docfx_coverage "percy exec -- dotnet test -c Release -f net8.0 --no-build -- --filter-trait "Stage=Percy""
       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'
@@ -70,8 +90,10 @@ jobs:
         name: logs-${{ matrix.os }}
         path: |
           msbuild.binlog
+          test/**/TestResults/*.log
           test/**/TestResults/*.trx
           test/**/TestResults/*.html
+          test/**/TestResults/*.ctrf
 
     - uses: actions/upload-artifact@v4
       if: ${{ failure() && matrix.os == 'ubuntu-latest' }}

global.json

@@ -0,0 +1,5 @@
+{
+  "test": {
+    "runner": "Microsoft.Testing.Platform"
+  }
+}

samples/Directory.Packages.props

@@ -0,0 +1,2 @@
+<Project>
+</Project>

test/CodeCoverage.runsettings

@@ -0,0 +1,47 @@
+<?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>
+    <!-- Disable following settings. Because C++ code is not contained (See: https://github.com/microsoft/codecoverage/blob/main/README.md#get-started)-->
+    <EnableStaticNativeInstrumentation>False</EnableStaticNativeInstrumentation>
+    <EnableDynamicNativeInstrumentation>False</EnableDynamicNativeInstrumentation>
+  </CodeCoverage>
+</Configuration>

test/Directory.Build.props

@@ -1,37 +1,69 @@
 <Project>
+  <Import Project="$([MSBuild]::GetPathOfFileAbove('$(MSBuildThisFile)', '$(MSBuildThisFileDirectory)../'))" />
+
   <PropertyGroup>
     <IsPackable>false</IsPackable>
     <SatelliteResourceLanguages>en</SatelliteResourceLanguages>
   </PropertyGroup>
 
+  <!-- .NET 9 or later run tests per TargetFramework in parallel by default.
+        It is necessary to disable this feature because there are tests that need to be executed sequentially that are marked with `[Collection("docfx STA")]`. -->
   <PropertyGroup>
-    <!--
-    .NET 9 preview 2 or later run tests in parallel by default.
-    It is necessary to disable this feature because there are tests that need to be executed sequentially that are marked with `[Collection("docfx STA")]`.
-    -->
     <TestTfmsInParallel>false</TestTfmsInParallel>
   </PropertyGroup>
 
-  <Import Project="$([MSBuild]::GetPathOfFileAbove('$(MSBuildThisFile)', '$(MSBuildThisFileDirectory)../'))" />
+  <!-- Configure `Microsoft.Testing.Platform` mode behaviors (https://learn.microsoft.com/en-us/dotnet/core/testing/unit-testing-platform-integration-dotnet-test)-->
 
-  <ItemGroup>
-    <None Include="TestData\**" CopyToOutputDirectory="PreserveNewest" />
-  </ItemGroup>
+  <!-- Following settings are required for .NET 9 SDK and earlier -->
+  <PropertyGroup Condition="'$(TargetFramework)'=='net9.0' OR '$(TargetFramework)'=='net8.0'">
+    <TestingPlatformDotnetTestSupport>true</TestingPlatformDotnetTestSupport>
+    <TestingPlatformCaptureOutput>false</TestingPlatformCaptureOutput>
+    <TestingPlatformShowTestsFailure>true</TestingPlatformShowTestsFailure>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <!-- Use `Microsoft.Testing.Platform` entrypoint -->
+    <UseMicrosoftTestingPlatformRunner>true</UseMicrosoftTestingPlatformRunner>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <!-- Show xUnit.net headers and information -->
+    <TestingPlatformCommandLineArguments>$(TestingPlatformCommandLineArguments) --xunit-info</TestingPlatformCommandLineArguments>
 
+    <!-- Change TestResults output directory. And enable detailed log outputs -->
+    <TestingPlatformCommandLineArguments>$(TestingPlatformCommandLineArguments) --results-directory "$(MSBuildThisFileDirectory)TestResults"</TestingPlatformCommandLineArguments>
+
+    <!-- Ignore exit code 8 (the test session run zero tests) -->
+    <TestingPlatformCommandLineArguments>$(TestingPlatformCommandLineArguments) --ignore-exit-code 8</TestingPlatformCommandLineArguments>
+
+    <!-- Enable output for passed tests -->
+    <TestingPlatformCommandLineArguments>$(TestingPlatformCommandLineArguments) --output Detailed</TestingPlatformCommandLineArguments>
+  </PropertyGroup>
+
+  <!-- Settings for CI environment -->
   <PropertyGroup Condition="'$(ContinuousIntegrationBuild)' == 'true' AND '$(PERCY_TOKEN)' == ''">
-    <VSTestResultsDirectory>$(MSBuildThisFileDirectory)TestResults</VSTestResultsDirectory>
-    <VSTestLogger>$(VSTestLogger);trx%3BLogFileName=TestResults-$(MSBuildProjectName)-$(TargetFramework)-$(RUNNER_OS).trx</VSTestLogger>
-    <VSTestLogger>$(VSTestLogger);html%3BLogFileName=TestResults-$(MSBuildProjectName)-$(TargetFramework)-$(RUNNER_OS).html</VSTestLogger>
+    <!-- Disable progress reports -->
+    <TestingPlatformCommandLineArguments>$(TestingPlatformCommandLineArguments) --no-progress</TestingPlatformCommandLineArguments>
+
+    <!-- Enable reporters (trx/html/ctrf ) -->
+    <TestingPlatformCommandLineArguments>$(TestingPlatformCommandLineArguments) --report-xunit-trx  --report-xunit-trx-filename  TestResults-$(MSBuildProjectName)-$(TargetFramework)-$(RUNNER_OS).trx</TestingPlatformCommandLineArguments>
+    <TestingPlatformCommandLineArguments>$(TestingPlatformCommandLineArguments) --report-xunit-html --report-xunit-html-filename TestResults-$(MSBuildProjectName)-$(TargetFramework)-$(RUNNER_OS).html</TestingPlatformCommandLineArguments>
+    <TestingPlatformCommandLineArguments>$(TestingPlatformCommandLineArguments) --report-ctrf       --report-ctrf-filename       TestResults-$(MSBuildProjectName)-$(TargetFramework)-$(RUNNER_OS).ctrf</TestingPlatformCommandLineArguments>
   </PropertyGroup>
 
   <ItemGroup Condition="'$(IsTestProject)' == 'true'">
+
+    <!-- Set [assembly:CaptureConsole] attribute to assembly -->
+    <AssemblyAttribute Include="Xunit.CaptureConsole" />
+
+    <None Include="TestData\**" CopyToOutputDirectory="PreserveNewest" />
+    <None Include="$(MSBuildThisFileDirectory)xunit.runner.json" CopyToOutputDirectory="PreserveNewest" />
+
+    <!-- Add Docfx.Tests.Common` project reference to test projects -->
     <ProjectReference Include="$(MSBuildThisFileDirectory)Docfx.Tests.Common/Docfx.Tests.Common.csproj" />
-  </ItemGroup>
 
-  <ItemGroup>
     <PackageReference Include="AwesomeAssertions" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" />
-    <PackageReference Include="xunit.runner.visualstudio" />
-    <PackageReference Include="xunit" />
+    <PackageReference Include="xunit.v3.mtp-v2" />
+
   </ItemGroup>
 </Project>

test/Directory.Packages.props

@@ -4,14 +4,12 @@
 
   <ItemGroup>
     <PackageVersion Include="AwesomeAssertions" Version="9.3.0" />
-    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.0.0" />
     <PackageVersion Include="Verify.DiffPlex" Version="3.1.2" />
-    <PackageVersion Include="Verify.Xunit" Version="31.5.1" />
-    <PackageVersion Include="xunit.runner.visualstudio" Version="3.1.5" />
-    <PackageVersion Include="xunit" Version="2.9.3" />
-  </ItemGroup>
-
-  <ItemGroup>
-    <GlobalPackageReference Include="coverlet.collector" Version="6.0.4" />
+    <PackageVersion Include="Verify.XunitV3" Version="31.4.3" />
+    <PackageVersion Include="xunit.v3" Version="3.2.0" />
+    <PackageVersion Include="xunit.v3.assert" Version="3.2.0" />
+    <PackageVersion Include="xunit.v3.extensibility.core" Version="3.2.0" />
+    <PackageVersion Include="xunit.v3.mtp-v2" Version="3.2.0" />
   </ItemGroup>
+
 </Project>

test/Docfx.Build.Common.Tests/Docfx.Build.Common.Tests.csproj

@@ -1,4 +1,9 @@
 <Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <IsTestProject>true</IsTestProject>
+  </PropertyGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\..\src\Docfx.Build.Common\Docfx.Build.Common.csproj" />
     <ProjectReference Include="..\..\src\Docfx.Build\Docfx.Build.csproj" />

test/Docfx.Build.ManagedReference.Tests/Docfx.Build.ManagedReference.Tests.csproj

@@ -1,4 +1,9 @@
 <Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <IsTestProject>true</IsTestProject>
+  </PropertyGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\..\src\Docfx.Build\Docfx.Build.csproj" />
     <ProjectReference Include="..\..\src\Docfx.Build.ManagedReference\Docfx.Build.ManagedReference.csproj" />

test/Docfx.Build.OverwriteDocuments.Tests/Docfx.Build.OverwriteDocuments.Tests.csproj

@@ -1,7 +1,13 @@
 <Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <IsTestProject>true</IsTestProject>
+  </PropertyGroup>
+
   <ItemGroup>
     <PackageReference Include="Markdig" />
   </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\..\src\Docfx.Build.OverwriteDocuments\Docfx.Build.OverwriteDocuments.csproj" />
   </ItemGroup>

test/Docfx.Build.RestApi.Tests/Docfx.Build.RestApi.Tests.csproj

@@ -1,4 +1,9 @@
 <Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <IsTestProject>true</IsTestProject>
+  </PropertyGroup>
+
   <ItemGroup>
     <None Include="TestData\**" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>

test/Docfx.Build.RestApi.WithPlugins.Tests/Docfx.Build.RestApi.WithPlugins.Tests.csproj

@@ -1,4 +1,9 @@
 <Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <IsTestProject>true</IsTestProject>
+  </PropertyGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\..\src\Docfx.Build.OperationLevelRestApi\Docfx.Build.OperationLevelRestApi.csproj" />
     <ProjectReference Include="..\..\src\Docfx.Build.TagLevelRestApi\Docfx.Build.TagLevelRestApi.csproj" />

test/Docfx.Build.SchemaDriven.Tests/Docfx.Build.SchemaDriven.Tests.csproj

@@ -1,4 +1,9 @@
 <Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <IsTestProject>true</IsTestProject>
+  </PropertyGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\..\src\Docfx.Build.Common\Docfx.Build.Common.csproj" />
     <ProjectReference Include="..\..\src\Docfx.Build\Docfx.Build.csproj" />

test/Docfx.Build.Tests/Docfx.Build.Tests.csproj

@@ -1,4 +1,9 @@
 <Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <IsTestProject>true</IsTestProject>
+  </PropertyGroup>
+
   <ItemGroup>
     <Compile Remove="TestData\snippets\dataflowdegreeofparallelism.cs" />
   </ItemGroup>

test/Docfx.Build.Tests/ExtractSearchIndexFromHtmlTest.cs

@@ -284,7 +284,7 @@ This is article title
         manifest.Files.Add(manifestItem);
 
         // process the fake manifest, using tempTestFolder as the output folder
-        _extractor.Process(manifest, tempTestFolder);
+        _extractor.Process(manifest, tempTestFolder, TestContext.Current.CancellationToken);
 
         var expectedIndexJSON = @"{
   ""index.html"": {

test/Docfx.Build.Tests/PostProcessors/SitemapGeneratorTests.cs

@@ -50,7 +50,7 @@ public void TestSitemapGenerator()
         var sitemapPath = Path.Combine(outputFolder, "sitemap.xml");
 
         // Act
-        manifest = sitemapGenerator.Process(manifest, outputFolder);
+        manifest = sitemapGenerator.Process(manifest, outputFolder, TestContext.Current.CancellationToken);
 
         // Assert
         Assert.Equal("https://example.com/", manifest.Sitemap.BaseUrl);

test/Docfx.Build.Tests/RemoveDebugInfoTest.cs

@@ -43,7 +43,7 @@ public void TestBasicFeature()
         new HtmlPostProcessor
         {
             Handlers = { new RemoveDebugInfo() }
-        }.Process(manifest, _outputFolder);
+        }.Process(manifest, _outputFolder, TestContext.Current.CancellationToken);
 
         var actual = File.ReadAllText(Path.Combine(_outputFolder, "a.html"));
         Assert.Equal("<p id='b1'>section<a href='http://bing.com#top'>Microsoft Bing</a></p>", actual);

test/Docfx.Build.Tests/ValidateBookmarkTest.cs

@@ -63,7 +63,7 @@ public void TestBasicFeature()
             new HtmlPostProcessor
             {
                 Handlers = { new ValidateBookmark() }
-            }.Process(manifest, _outputFolder);
+            }.Process(manifest, _outputFolder, TestContext.Current.CancellationToken);
         }
         finally
         {
@@ -107,7 +107,7 @@ public void TestNoCheck()
             new HtmlPostProcessor
             {
                 Handlers = { new ValidateBookmark() }
-            }.Process(manifest, _outputFolder);
+            }.Process(manifest, _outputFolder, TestContext.Current.CancellationToken);
         }
         finally
         {
@@ -150,7 +150,7 @@ public void TestLinkThatContainsNonAsciiChars()
             new HtmlPostProcessor
             {
                 Handlers = { new ValidateBookmark() }
-            }.Process(manifest, _outputFolder);
+            }.Process(manifest, _outputFolder, TestContext.Current.CancellationToken);
         }
         finally
         {

test/Docfx.Build.Tests/XRefArchiveBuilderTest.cs

@@ -20,7 +20,7 @@ public async Task TestDownload()
         // sorted: true
         // references: []
         // ```
-        Assert.True(await builder.DownloadAsync(new Uri("http://dotnet.github.io/docfx/xrefmap.yml"), ZipFile));
+        Assert.True(await builder.DownloadAsync(new Uri("http://dotnet.github.io/docfx/xrefmap.yml"), ZipFile, TestContext.Current.CancellationToken));
 
         using (var xar = XRefArchive.Open(ZipFile, XRefArchiveMode.Read))
         {