Enhance documentation for TUnit integration and usage by thomhurst · Pull Request #50094 · dotnet/docs

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

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

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

@YoushanMicrosoft @Evangelink

Please take a look.

Evangelink

@Youssef1313 and @nohwnd for extra reviews.

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

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

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

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

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

docs/core/testing/mutation-testing.md

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

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

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

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

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?

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

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?

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

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

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

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

Youssef1313 · 2026-01-08T10:15:36Z

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

This whole page will be confusing for MTP. I think it needs a bit of general re-work. Best in a separate PR. I'll try to handle it soon.

I was wondering if these pages should be moved under each framework instead of being general with tabs per framework and potentially per platform.

You're probably right. Currently different frameworks have different syntaxes and switches

…nit tests documentation with TUnit filter syntax

…tion

… for TUnit

…overy details

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

….Platform and adjust related content across multiple files

…and VB documentation

…nks in C# and VB documentation

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

… language - Remove links to xUnit samples from C# and VB TUnit tutorials - Fix VB tutorial to use <Test> attribute syntax instead of [Test] - Add missing ASP.NET Core include to C# and VB TUnit tutorials - Alphabetize MTP frameworks lists in code coverage page - Add missing xUnit runner link to framework-specific docs - Use void instead of async Task for empty test bodies in selective-unit-tests - Neutralize promotional language in TUnit description - Remove biased "modern" and "traditional" labels for test platforms Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

…syntax - Alphabetize TUnit before xUnit in MTP intro framework list - Use period instead of colon for TUnit entry consistency - Add missing using TUnit.Core in C# tutorial test example - Remove link to wrong F# sample repository - Use VB <Arguments> syntax instead of C# [Arguments] in VB tutorial - Remove residual promotional "parallel by default" claim Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Evangelink · 2026-03-10T06:18:37Z

@thomhurst there are a few more updates and fixes to do, I can help with linters one if you need help.

- Add blank lines before lists to fix MD032 markdownlint errors - Fix broken link to unit-testing-mstest-runner-intro.md - Use empty method bodies in TUnit order examples per review

thomhurst · 2026-03-15T17:46:01Z

Thanks @Evangelink - Pushed again

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

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

Youssef1313 reviewed Jan 8, 2026

View reviewed changes

docs/core/testing/order-unit-tests.md Outdated Show resolved Hide resolved

Youssef1313 reviewed Jan 8, 2026

View reviewed changes

docs/core/testing/order-unit-tests.md Outdated Show resolved Hide resolved

Youssef1313 reviewed Jan 8, 2026

View reviewed changes

thomhurst requested a review from meaghanlewis as a code owner February 15, 2026 21:34

thomhurst and others added 11 commits February 15, 2026 21:36

Enhance documentation for TUnit integration and usage

0654040

Remove TUnit-specific notes from various documentation files

5f3be68

Refactor mutation testing examples for clarity and update selective u…

fcbee88

…nit tests documentation with TUnit filter syntax

Update TUnit documentation for code coverage support and project crea…

725bc9f

…tion

Refactor documentation to simplify test project configuration details…

b577dbd

… for TUnit

Update TUnit documentation to clarify source generation and test disc…

7bedba0

…overy details

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

bbb029e

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

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

4c7ae20

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Remove TUnit examples from mutation testing documentation

572d958

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

c3b9bf2

….Platform and adjust related content across multiple files

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

08f579f

…and VB documentation

thomhurst and others added 2 commits February 15, 2026 21:36

Add TUnit dependency ordering example and update solution creation li…

5d27294

…nks in C# and VB documentation

Simplify test ordering examples to use void instead of async Task

5845aa4

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

thomhurst force-pushed the docs/tunit branch from dba7848 to 5845aa4 Compare February 15, 2026 21:36

thomhurst and others added 2 commits February 15, 2026 21:41

thomhurst added 2 commits March 15, 2026 17:38

Merge branch 'main' into docs/tunit

c432bb7

Fix lint errors, broken link, and address review feedback

093ee06

- Add blank lines before lists to fix MD032 markdownlint errors - Fix broken link to unit-testing-mstest-runner-intro.md - Use empty method bodies in TUnit order examples per review

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Youssef1313 Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

thomhurst Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Youssef1313 Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

thomhurst Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

thomhurst commented Dec 10, 2025

Uh oh!

Uh oh!

Uh oh!

Youssef1313 Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Evangelink Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

thomhurst Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

Evangelink commented Mar 10, 2026

Uh oh!

thomhurst commented Mar 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

thomhurst commented Nov 22, 2025 •

edited by github-actions bot

Loading

Youssef1313 Jan 8, 2026 •

edited

Loading