Enhance documentation for TUnit integration and usage #50094

thomhurst · 2025-11-22T16:40:31Z

This pull request expands documentation for TUnit, a .NET testing framework built on Microsoft.Testing.Platform, and clarifies its support for various extensibility features and workflows. The changes improve coverage of TUnit in comparison to other frameworks, add practical examples for advanced scenarios (such as filtering, ordering, code coverage, and mutation testing), and update documentation to show that Microsoft.Testing.Platform extensions work with TUnit.

TUnit documentation enhancements:

Added detailed description of TUnit, including its use of source generation, parallel test execution, and links to official documentation and language-specific guides. [1] [2]
Added comprehensive examples for filtering TUnit tests with dotnet test --filter, including supported attributes and operator usage. [1] [2]
Provided an example of ordering TUnit tests using the [DependsOn] attribute, covering dependency handling, failure behavior, and method overloads.

Integration with Microsoft.Testing.Platform extensions:

Clarified that Microsoft.Testing.Platform extensions for output, test reports, code coverage, and architecture work with TUnit, in addition to MSTest, NUnit, and xUnit. [1] [2] [3] [4]

Advanced testing scenarios with TUnit:

Added sections on using code coverage tools (e.g., Coverlet, ReportGenerator) and mutation testing (Stryker.NET) with TUnit, including async test patterns and project setup instructions. [1] [2] [3]

Internal previews

📄 File	🔗 Preview link
docs/core/testing/index.md	Testing in .NET
docs/core/testing/microsoft-testing-platform-intro.md	Microsoft.Testing.Platform overview
docs/core/testing/order-unit-tests.md	Order unit tests
docs/core/testing/selective-unit-tests.md	Run selected unit tests
docs/core/testing/unit-testing-code-coverage.md	docs/core/testing/unit-testing-code-coverage
docs/core/testing/unit-testing-csharp-with-tunit.md	Unit testing C# in .NET using dotnet test and TUnit
docs/core/testing/unit-testing-fsharp-with-tunit.md	Unit testing F# in .NET Core with dotnet test and TUnit
docs/core/testing/unit-testing-visual-basic-with-tunit.md	Unit testing Visual Basic .NET Core libraries using dotnet test and TUnit
docs/zone-pivot-groups.yml	docs/zone-pivot-groups

…nit tests documentation with TUnit filter syntax

…tion

… for TUnit

…overy details

Copilot

Pull request overview

This PR enhances documentation for TUnit, a .NET testing framework built entirely on Microsoft.Testing.Platform, by adding comprehensive tutorials, examples, and integration guides across multiple languages and scenarios.

Adds complete TUnit getting-started tutorials for C#, F#, and Visual Basic with test-driven development (TDD) workflows.
Expands Microsoft.Testing.Platform documentation to show that extensions work with TUnit alongside MSTest, NUnit, and xUnit.
Provides practical examples for filtering tests, ordering with dependencies, code coverage setup, and mutation testing with TUnit.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
docs/core/testing/unit-testing-visual-basic-with-tunit.md	New tutorial for unit testing Visual Basic with TUnit, including project setup, test creation, and parameterized tests.
docs/core/testing/unit-testing-fsharp-with-tunit.md	New tutorial for unit testing F# with TUnit, demonstrating the test-driven development approach for functional code.
docs/core/testing/unit-testing-csharp-with-tunit.md	New tutorial for unit testing C# with TUnit, showing async test patterns and source generation features.
docs/core/testing/unit-testing-code-coverage.md	Added section on using code coverage with TUnit, including project setup and Microsoft.Testing.Extensions.CodeCoverage integration.
docs/core/testing/selective-unit-tests.md	Added TUnit examples for filtering tests using `--treenode-filter` flag with path-based syntax and attribute filtering.
docs/core/testing/order-unit-tests.md	Added TUnit section demonstrating `[DependsOn]` attribute for controlling test execution order through explicit dependencies.
docs/core/testing/mutation-testing.md	Added TUnit examples for mutation testing with Stryker.NET using async test patterns.
docs/core/testing/microsoft-testing-platform-intro.md	Updated TUnit description to clarify it only supports Microsoft.Testing.Platform and added link to getting started guide.
docs/core/testing/index.md	Enhanced TUnit section with detailed feature description and links to language-specific tutorials.

docs/core/testing/order-unit-tests.md

docs/core/testing/microsoft-testing-platform-intro.md

docs/core/testing/unit-testing-csharp-with-tunit.md

docs/core/testing/unit-testing-visual-basic-with-tunit.md

Co-authored-by: Copilot <[email protected]>

BillWagner · 2025-11-24T16:31:21Z

@YoushanMicrosoft @Evangelink

Please take a look.

Evangelink

@Youssef1313 and @nohwnd for extra reviews.

Evangelink · 2025-11-25T10:01:24Z

docs/core/testing/microsoft-testing-platform-intro.md

 * NUnit. In NUnit, the support of `Microsoft.Testing.Platform` is done via [NUnit runner](unit-testing-nunit-runner-intro.md).
 * xUnit.net: In xUnit.net, the support of `Microsoft.Testing.Platform` is done via [xUnit.net runner](https://xunit.net/docs/getting-started/v3/microsoft-testing-platform).
-* TUnit: entirely constructed on top of the `Microsoft.Testing.Platform`, for more information, see [TUnit documentation](https://tunit.dev/).
+* TUnit: Built entirely on Microsoft.Testing.Platform and doesn't support VSTest. Unlike MSTest, NUnit, and xUnit which support both VSTest and MTP, TUnit only supports MTP. For more information, see [TUnit documentation](https://tunit.dev/) and [Getting started with TUnit](unit-testing-csharp-with-tunit.md).


I wonder if we should skip the part Unlike MSTest, NUnit, and xUnit which support both VSTest and MTP, TUnit only supports MTP.

I agree. I would focus more on info about TUnit rather than making it more of a comparison.

Evangelink · 2025-11-25T10:02:47Z

docs/core/testing/selective-unit-tests.md

  | xUnit          | `FullyQualifiedName`<br>`DisplayName`<br>`Traits` |
-  | Nunit          | `FullyQualifiedName`<br>`Name`<br>`Priority`<br>`TestCategory` |
+  | NUnit          | `FullyQualifiedName`<br>`Name`<br>`Priority`<br>`TestCategory` |
+  | TUnit          | `FullyQualifiedName`<br>`Name`<br>`Category`<br>`Property` |


Let's take this opportunity to reorder by name the test framework please.

Does TUnit implement the VSTest-based filter syntax? 👀

Err ignore that 😅 Fixed it.

Evangelink · 2025-11-25T10:03:34Z

docs/core/testing/unit-testing-code-coverage.md


+## Using code coverage with TUnit
+
+TUnit is built on Microsoft.Testing.Platform and uses Microsoft.Testing.Extensions.CodeCoverage for code coverage.


I think we could link MTP and MTP CC pages here.

Evangelink · 2025-11-25T10:04:31Z

docs/core/testing/unit-testing-csharp-with-tunit.md

+
+## Configure Microsoft.Testing.Platform mode
+
+TUnit only supports Microsoft.Testing.Platform and doesn't support VSTest. To use `dotnet test` with TUnit, add the following configuration to your `global.json` file in the solution root:


Let's mention this is only available when .NET10+ SDK is installed.

Youssef1313 · 2025-11-25T10:17:13Z

docs/core/testing/microsoft-testing-platform-intro.md

 * NUnit. In NUnit, the support of `Microsoft.Testing.Platform` is done via [NUnit runner](unit-testing-nunit-runner-intro.md).
 * xUnit.net: In xUnit.net, the support of `Microsoft.Testing.Platform` is done via [xUnit.net runner](https://xunit.net/docs/getting-started/v3/microsoft-testing-platform).
-* TUnit: entirely constructed on top of the `Microsoft.Testing.Platform`, for more information, see [TUnit documentation](https://tunit.dev/).
+* TUnit: Built entirely on Microsoft.Testing.Platform and doesn't support VSTest. Unlike MSTest, NUnit, and xUnit which support both VSTest and MTP, TUnit only supports MTP. For more information, see [TUnit documentation](https://tunit.dev/) and [Getting started with TUnit](unit-testing-csharp-with-tunit.md).


I agree. I would focus more on info about TUnit rather than making it more of a comparison.

Youssef1313 · 2025-11-25T10:19:10Z

docs/core/testing/mutation-testing.md


+## Using mutation testing with TUnit
+
+Mutation testing with Stryker.NET works with TUnit. The examples above can be written using TUnit's async testing syntax:


How does it work? I thought MTP isn't yet supported by Stryker.NET stryker-mutator/stryker-net#3094

This is what I get for using AI. It hallucinated that! Removed!

Youssef1313 · 2025-11-25T10:22:08Z

docs/core/testing/order-unit-tests.md

 :::code language="csharp" source="snippets/order-unit-tests/csharp/NUnit.TestProject/ByOrder.cs":::

+:::zone-end
+:::zone pivot="tunit"


You need to update docs/zone-pivot-groups.yml for this to work, I think.

Updated them

Youssef1313 · 2025-11-25T10:24:36Z

docs/core/testing/selective-unit-tests.md

  | xUnit          | `FullyQualifiedName`<br>`DisplayName`<br>`Traits` |
-  | Nunit          | `FullyQualifiedName`<br>`Name`<br>`Priority`<br>`TestCategory` |
+  | NUnit          | `FullyQualifiedName`<br>`Name`<br>`Priority`<br>`TestCategory` |
+  | TUnit          | `FullyQualifiedName`<br>`Name`<br>`Category`<br>`Property` |


Does TUnit implement the VSTest-based filter syntax? 👀

Youssef1313 · 2025-11-25T10:25:47Z

docs/core/testing/unit-testing-code-coverage.md

+dotnet new install TUnit.Templates
+dotnet new tunit -n TUnit.CodeCoverage.Test


Does the template add/update global.json to set test runner as MTP?

Youssef1313 · 2025-11-25T10:32:33Z

docs/core/testing/unit-testing-visual-basic-with-tunit.md

+
+## Configure Microsoft.Testing.Platform mode
+
+TUnit only supports Microsoft.Testing.Platform and doesn't support VSTest. To use `dotnet test` with TUnit, add the following configuration to your `global.json` file in the solution root:


It's best IMO to let TUnit templates do this on its own.

I'll make a note to update TUnit templates

Youssef1313 · 2025-11-25T10:36:11Z

docs/core/testing/unit-testing-visual-basic-with-tunit.md

+    Return Task.Run(Async Function()
+        Dim result As Boolean = _primeService.IsPrime(1)
+        Await Assert.That(result).IsFalse()
+    End Function)


Why this complexity? I think you should be able to declare the function as async, and await in it directly instead of returning a task created by Task.Run?

Youssef1313 · 2025-11-25T10:36:43Z

docs/core/testing/unit-testing-visual-basic-with-tunit.md

+
+```vb
+<Test>
+Function IsPrime_InputIs1_ReturnFalse() As Task


Probably better to be explicit about the accessibility and add Public.

Youssef1313 · 2025-11-25T10:38:06Z

docs/core/testing/unit-testing-visual-basic-with-tunit.md

+Imports TUnit.Assertions.Extensions
+Imports TUnit.Core
+
+Namespace PrimeService.Tests


Can you please ensure that this doesn't duplicate the namespace?

IIRC, VB already uses RootNamespace, and having explicit namespace is duplicating it. But I might be misremembering.

Sorry what do you mean RootNamespace? I think this should be consistent with other VB examples?

Youssef1313 · 2025-11-25T10:38:34Z

docs/core/testing/unit-testing-visual-basic-with-tunit.md

+
+Namespace PrimeService.Tests
+    Public Class PrimeService_IsPrimeShould
+        Private ReadOnly _primeService As Prime.Services.PrimeService


Why not add Imports Prime.Services instead of fully qualifying?

….Platform and adjust related content across multiple files

…and VB documentation

thomhurst · 2025-12-10T17:55:42Z

Thanks for the comments @Evangelink and @Youssef1313 - Have made changes

…nks in C# and VB documentation

thomhurst added 6 commits November 22, 2025 16:18

Enhance documentation for TUnit integration and usage

0b498f8

Remove TUnit-specific notes from various documentation files

890c2d7

Refactor mutation testing examples for clarity and update selective u…

8b3ae55

…nit tests documentation with TUnit filter syntax

Update TUnit documentation for code coverage support and project crea…

55dc4ba

…tion

Refactor documentation to simplify test project configuration details…

8b21a13

… for TUnit

Update TUnit documentation to clarify source generation and test disc…

a877e80

…overy details

Copilot AI review requested due to automatic review settings November 22, 2025 16:40

thomhurst requested review from a team and IEvangelist as code owners November 22, 2025 16:40

dotnetrepoman bot added this to the November 2025 milestone Nov 22, 2025

dotnet-policy-service bot added dotnet-fundamentals/svc community-contribution Indicates PR is created by someone from the .NET community. labels Nov 22, 2025

Copilot started reviewing on behalf of thomhurst November 22, 2025 16:41 View session

Copilot finished reviewing on behalf of thomhurst November 22, 2025 16:44

Copilot AI reviewed Nov 22, 2025

View reviewed changes

thomhurst and others added 2 commits November 22, 2025 16:45

Update docs/core/testing/unit-testing-csharp-with-tunit.md

95c9bb7

Co-authored-by: Copilot <[email protected]>

Update docs/core/testing/unit-testing-visual-basic-with-tunit.md

29a5730

Co-authored-by: Copilot <[email protected]>

Evangelink reviewed Nov 25, 2025

View reviewed changes

Youssef1313 reviewed Nov 25, 2025

View reviewed changes

BillWagner modified the milestones: November 2025, December 2025 Dec 3, 2025

thomhurst added 3 commits December 10, 2025 17:12

Remove TUnit examples from mutation testing documentation

3edb4a6

Update documentation to clarify TUnit's support for Microsoft.Testing…

acc0203

….Platform and adjust related content across multiple files

Add note about .NET 10 SDK requirement for TUnit configuration in F# …

7277b01

…and VB documentation

Add TUnit dependency ordering example and update solution creation li…

cd1f6c2

…nks in C# and VB documentation


		## Using code coverage with TUnit

		TUnit is built on Microsoft.Testing.Platform and uses Microsoft.Testing.Extensions.CodeCoverage for code coverage.


		## Configure Microsoft.Testing.Platform mode

		TUnit only supports Microsoft.Testing.Platform and doesn't support VSTest. To use `dotnet test` with TUnit, add the following configuration to your `global.json` file in the solution root:


		## Using mutation testing with TUnit

		Mutation testing with Stryker.NET works with TUnit. The examples above can be written using TUnit's async testing syntax:

		dotnet new install TUnit.Templates
		dotnet new tunit -n TUnit.CodeCoverage.Test

Enhance documentation for TUnit integration and usage #50094

Are you sure you want to change the base?

Enhance documentation for TUnit integration and usage #50094

Uh oh!

Conversation

thomhurst commented Nov 22, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Internal previews

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BillWagner commented Nov 24, 2025

Uh oh!

Evangelink left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thomhurst commented Dec 10, 2025

Uh oh!

Reviewers

Assignees

Labels

thomhurst commented Nov 22, 2025 •

edited by github-actions bot

Loading