TUnit

A modern, flexible and fast testing framework for .NET 8 and up. With Native AOT and Trimmed Single File application support included!

TUnit is designed to aid with all testing types:

Unit
Integration
Acceptance
and more!

Documentation

See here: https://thomhurst.github.io/TUnit/

IDE

TUnit is built on top of the newer Microsoft.Testing.Platform, as opposed to the older VSTest platform. Because the infrastructure behind the scenes is new and different, you may need to enable some settings. This should just be a one time thing.

Visual Studio

Visual Studio is supported on the Preview version currently.

Install the latest preview version
Open Visual Studio and go to Tools > Manage Preview Features
Enable "Use testing platform server mode"

Rider

Rider is supported. The Enable Testing Platform support option must be selected in Settings > Build, Execution, Deployment > Unit Testing > VSTest.

VS Code

Visual Studio Code is supported.

Install the extension Name: C# Dev Kit
Go to the C# Dev Kit extension's settings
Enable Dotnet > Test Window > Use Testing Platform Protocol

CLI

dotnet CLI - Fully supported. Tests should be runnable with dotnet test, dotnet run, dotnet exec or executing an executable directly. See the docs for more information!

Features

Native AOT / Trimmed Single File application support
Source generated tests
Dependency injection support (See here)
Full async support
Parallel by default, with mechanisms to:
- Run specific tests completely on their own
- Run specific tests not in parallel with other specific tests
- Limit the parallel limit on a per-test, class or assembly level
Tests can depend on other tests to form chains, useful for if one test depends on state from another action. While not recommended for unit tests, this can be useful in integration testing where state matters
Easy to read assertions - though you're also free to use whichever assertion library you like
Injectable test data via classes, methods, compile-time args, or matrices
Hooks before and after:
- TestDiscover
- TestSession
- Assembly
- Class
- Test
Designed to avoid common pitfalls such as leaky test states
Ability to view and interrogate metadata and results from various assembly/class/test context objects

Installation

dotnet add package TUnit --prerelease

Example test

    private static readonly TimeOnly Midnight = TimeOnly.FromTimeSpan(TimeSpan.Zero);
    private static readonly TimeOnly Noon = TimeOnly.FromTimeSpan(TimeSpan.FromHours(12));
    
    [Test]
    public async Task IsMorning()
    {
        var time = GetTime();

        await Assert.That(time).IsAfterOrEqualTo(Midnight)
            .And.IsBefore(Noon);
    }

or with more complex test orchestration needs

    [Before(Class)]
    public static async Task ClearDatabase(ClassHookContext context) { ... }

    [After(Class)]
    public static async Task AssertDatabaseIsAsExpected(ClassHookContext context) { ... }

    [Before(Test)]
    public async Task CreatePlaywrightBrowser(TestContext context) { ... }

    [After(Test)]
    public async Task DisposePlaywrightBrowser(TestContext context) { ... }

    [Retry(3)]
    [Test, DisplayName("Register an account")]
    [MethodData(nameof(GetAuthDetails))]
    public async Task Register(string username, string password) { ... }

    [Repeat(5)]
    [Test, DependsOn(nameof(Register))]
    [MethodData(nameof(GetAuthDetails))]
    public async Task Login(string username, string password) { ... }

    [Test, DependsOn(nameof(Login), [typeof(string), typeof(string)])]
    [MethodData(nameof(GetAuthDetails))]
    public async Task DeleteAccount(string username, string password) { ... }

    [Category("Downloads")]
    [Timeout(300_000)]
    [Test, NotInParallel(Order = 1)]
    public async Task DownloadFile1() { ... }

    [Category("Downloads")]
    [Timeout(300_000)]
    [Test, NotInParallel(Order = 2)]
    public async Task DownloadFile2() { ... }

    [Repeat(10)]
    [Test]
    [Arguments(1)]
    [Arguments(2)]
    [Arguments(3)]
    [DisplayName("Go to the page numbered $page")]
    public async Task GoToPage(int page) { ... }

    [Category("Cookies")]
    [Test, Skip("Not yet built!")]
    public async Task CheckCookies() { ... }

    [Test, Explicit, WindowsOnlyTest, RetryHttpServiceUnavailable(5)]
    [Property("Some Key", "Some Value")]
    public async Task Ping() { ... }

    [Test]
    [ParallelLimit<LoadTestParallelLimit>]
    [Repeat(1000)]
    public async Task LoadHomepage() { ... }

    public static IEnumerable<(string Username, string Password)> GetAuthDetails()
    {
        yield return ("user1", "password1");
        yield return ("user2", "password2");
        yield return ("user3", "password3");
    }

    public class WindowsOnlyTestAttribute : SkipAttribute
    {
        public WindowsOnlyTestAttribute() : base("Windows only test")
        {
        }

        public override Task<bool> ShouldSkip(TestContext testContext)
        {
            return Task.FromResult(!OperatingSystem.IsWindows());
        }
    }

    public class RetryHttpServiceUnavailableAttribute : RetryAttribute
    {
        public RetryHttpServiceUnavailableAttribute(int times) : base(times)
        {
        }

        public override Task<bool> ShouldRetry(TestInformation testInformation, Exception exception, int currentRetryCount)
        {
            return Task.FromResult(exception is HttpRequestException { StatusCode: HttpStatusCode.ServiceUnavailable });
        }
    }

    public class LoadTestParallelLimit : IParallelLimit
    {
        public int Limit => 50;
    }

Motivations

TUnit is inspired by NUnit and xUnit - two of the most popular testing frameworks for .NET.

It aims to build upon the useful features of both while trying to address any pain points that they may have.

Prerelease

You'll notice that version 1.0 isn't out yet. While this framework is mostly feature complete, I'm waiting for a few things:

Full Rider support for all features
Full VS support for all features
Open to feedback on existing features
Open to ideas on new features

As such, the API may change. I'll try to limit this but it's a possibility.

Benchmark

Scenario: Building the test project

macos-latest


BenchmarkDotNet v0.14.0, macOS Sonoma 14.6.1 (23G93) [Darwin 23.6.0]
Apple M1 (Virtual), 1 CPU, 3 logical and 3 physical cores
.NET SDK 8.0.402
  [Host]     : .NET 8.0.8 (8.0.824.36612), Arm64 RyuJIT AdvSIMD
  DefaultJob : .NET 8.0.8 (8.0.824.36612), Arm64 RyuJIT AdvSIMD

Method	Mean	Error	StdDev
Build_TUnit	827.6 ms	16.51 ms	37.59 ms
Build_NUnit	793.7 ms	24.07 ms	67.49 ms
Build_xUnit	765.1 ms	15.07 ms	35.53 ms
Build_MSTest	753.3 ms	9.69 ms	8.59 ms

ubuntu-latest


BenchmarkDotNet v0.14.0, Ubuntu 22.04.5 LTS (Jammy Jellyfish)
AMD EPYC 7763, 1 CPU, 4 logical and 2 physical cores
.NET SDK 8.0.402
  [Host]     : .NET 8.0.8 (8.0.824.36612), X64 RyuJIT AVX2
  DefaultJob : .NET 8.0.8 (8.0.824.36612), X64 RyuJIT AVX2

Method	Mean	Error	StdDev
Build_TUnit	1.513 s	0.0299 s	0.0293 s
Build_NUnit	1.386 s	0.0195 s	0.0182 s
Build_xUnit	1.399 s	0.0221 s	0.0207 s
Build_MSTest	1.414 s	0.0269 s	0.0276 s

windows-latest


BenchmarkDotNet v0.14.0, Windows 10 (10.0.20348.2700) (Hyper-V)
AMD EPYC 7763, 1 CPU, 4 logical and 2 physical cores
.NET SDK 8.0.402
  [Host]     : .NET 8.0.8 (8.0.824.36612), X64 RyuJIT AVX2
  DefaultJob : .NET 8.0.8 (8.0.824.36612), X64 RyuJIT AVX2

Method	Mean	Error	StdDev
Build_TUnit	1.409 s	0.0253 s	0.0346 s
Build_NUnit	1.315 s	0.0262 s	0.0269 s
Build_xUnit	1.333 s	0.0222 s	0.0208 s
Build_MSTest	1.346 s	0.0210 s	0.0197 s

Scenario: A single test that completes instantly (including spawning a new process and initialising the test framework)

macos-latest


BenchmarkDotNet v0.14.0, macOS Sonoma 14.6.1 (23G93) [Darwin 23.6.0]
Apple M1 (Virtual), 1 CPU, 3 logical and 3 physical cores
.NET SDK 8.0.402
  [Host]     : .NET 8.0.8 (8.0.824.36612), Arm64 RyuJIT AdvSIMD
  DefaultJob : .NET 8.0.8 (8.0.824.36612), Arm64 RyuJIT AdvSIMD

Method	Mean	Error	StdDev	Median
TUnit_AOT	73.61 ms	1.424 ms	2.709 ms	72.44 ms
TUnit	408.43 ms	7.656 ms	7.162 ms	408.50 ms
NUnit	700.88 ms	11.464 ms	10.163 ms	698.17 ms
xUnit	681.71 ms	11.440 ms	10.141 ms	680.87 ms
MSTest	618.92 ms	6.635 ms	5.180 ms	620.42 ms

ubuntu-latest


BenchmarkDotNet v0.14.0, Ubuntu 22.04.5 LTS (Jammy Jellyfish)
AMD EPYC 7763, 1 CPU, 4 logical and 2 physical cores
.NET SDK 8.0.402
  [Host]     : .NET 8.0.8 (8.0.824.36612), X64 RyuJIT AVX2
  DefaultJob : .NET 8.0.8 (8.0.824.36612), X64 RyuJIT AVX2

Method	Mean	Error	StdDev
TUnit_AOT	46.40 ms	0.923 ms	2.574 ms
TUnit	727.09 ms	14.243 ms	16.403 ms
NUnit	1,311.79 ms	9.631 ms	8.043 ms
xUnit	1,306.00 ms	17.970 ms	16.809 ms
MSTest	1,170.26 ms	9.711 ms	8.109 ms

windows-latest


BenchmarkDotNet v0.14.0, Windows 10 (10.0.20348.2700) (Hyper-V)
AMD EPYC 7763, 1 CPU, 4 logical and 2 physical cores
.NET SDK 8.0.402
  [Host]     : .NET 8.0.8 (8.0.824.36612), X64 RyuJIT AVX2
  DefaultJob : .NET 8.0.8 (8.0.824.36612), X64 RyuJIT AVX2

Method	Mean	Error	StdDev
TUnit_AOT	77.60 ms	1.225 ms	0.957 ms
TUnit	741.11 ms	14.627 ms	19.526 ms
NUnit	1,309.73 ms	16.954 ms	15.859 ms
xUnit	1,278.94 ms	8.409 ms	7.866 ms
MSTest	1,157.60 ms	4.754 ms	3.970 ms

Scenario: A test that takes 50ms to execute, repeated 100 times (including spawning a new process and initialising the test framework)

macos-latest


BenchmarkDotNet v0.14.0, macOS Sonoma 14.6.1 (23G93) [Darwin 23.6.0]
Apple M1 (Virtual), 1 CPU, 3 logical and 3 physical cores
.NET SDK 8.0.402
  [Host]     : .NET 8.0.8 (8.0.824.36612), Arm64 RyuJIT AdvSIMD
  DefaultJob : .NET 8.0.8 (8.0.824.36612), Arm64 RyuJIT AdvSIMD

Method	Mean	Error	StdDev
TUnit_AOT	239.2 ms	15.08 ms	44.22 ms
TUnit	571.1 ms	24.09 ms	71.02 ms
NUnit	14,037.8 ms	278.61 ms	543.40 ms
xUnit	14,491.1 ms	288.88 ms	609.35 ms
MSTest	14,320.7 ms	282.52 ms	544.33 ms

ubuntu-latest


BenchmarkDotNet v0.14.0, Ubuntu 22.04.5 LTS (Jammy Jellyfish)
AMD EPYC 7763, 1 CPU, 4 logical and 2 physical cores
.NET SDK 8.0.402
  [Host]     : .NET 8.0.8 (8.0.824.36612), X64 RyuJIT AVX2
  DefaultJob : .NET 8.0.8 (8.0.824.36612), X64 RyuJIT AVX2

Method	Mean	Error	StdDev
TUnit_AOT	86.20 ms	1.930 ms	5.690 ms
TUnit	794.35 ms	15.503 ms	18.455 ms
NUnit	6,318.54 ms	17.745 ms	15.730 ms
xUnit	6,372.80 ms	16.608 ms	15.535 ms
MSTest	6,304.72 ms	12.107 ms	11.324 ms

windows-latest


BenchmarkDotNet v0.14.0, Windows 10 (10.0.20348.2700) (Hyper-V)
AMD EPYC 7763, 1 CPU, 4 logical and 2 physical cores
.NET SDK 8.0.402
  [Host]     : .NET 8.0.8 (8.0.824.36612), X64 RyuJIT AVX2
  DefaultJob : .NET 8.0.8 (8.0.824.36612), X64 RyuJIT AVX2

Method	Mean	Error	StdDev	Median
TUnit_AOT	133.5 ms	2.64 ms	6.97 ms	132.7 ms
TUnit	805.6 ms	15.91 ms	23.82 ms	804.5 ms
NUnit	8,666.2 ms	173.12 ms	387.20 ms	8,812.8 ms
xUnit	8,752.0 ms	166.60 ms	216.62 ms	8,792.3 ms
MSTest	8,608.1 ms	171.72 ms	362.22 ms	8,753.0 ms

Name		Name	Last commit message	Last commit date
Latest commit History 1,903 Commits
.github		.github
.idea/.idea.TUnit/.idea		.idea/.idea.TUnit/.idea
.vscode		.vscode
TUnit.Analyzers.Tests		TUnit.Analyzers.Tests
TUnit.Analyzers		TUnit.Analyzers
TUnit.Assertions.Analyzers.Tests		TUnit.Assertions.Analyzers.Tests
TUnit.Assertions.Analyzers		TUnit.Assertions.Analyzers
TUnit.Assertions.UnitTests		TUnit.Assertions.UnitTests
TUnit.Assertions		TUnit.Assertions
TUnit.Core		TUnit.Core
TUnit.Engine.SourceGenerator.Tests		TUnit.Engine.SourceGenerator.Tests
TUnit.Engine.SourceGenerator		TUnit.Engine.SourceGenerator
TUnit.Engine		TUnit.Engine
TUnit.Pipeline		TUnit.Pipeline
TUnit.TestProject.Library		TUnit.TestProject.Library
TUnit.TestProject		TUnit.TestProject
TUnit		TUnit
docs		docs
tools		tools
.editorconfig		.editorconfig
.gitignore		.gitignore
Directory.Build.props		Directory.Build.props
Directory.Packages.props		Directory.Packages.props
GitVersion.yml		GitVersion.yml
LICENSE		LICENSE
README.md		README.md
README_Template.md		README_Template.md
TUnit.sln		TUnit.sln
renovate.json		renovate.json
rider.png		rider.png

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

TUnit

Documentation

IDE

Visual Studio

Rider

VS Code

CLI

Features

Installation

Example test

Motivations

Prerelease

Benchmark

Scenario: Building the test project

macos-latest

ubuntu-latest

windows-latest

Scenario: A single test that completes instantly (including spawning a new process and initialising the test framework)

macos-latest

ubuntu-latest

windows-latest

Scenario: A test that takes 50ms to execute, repeated 100 times (including spawning a new process and initialising the test framework)

macos-latest

ubuntu-latest

windows-latest

About

Releases

Sponsor this project

Packages

Contributors 10

Languages

License

thomhurst/TUnit

Folders and files

Latest commit

History

Repository files navigation

TUnit

Documentation

IDE

Visual Studio

Rider

VS Code

CLI

Features

Installation

Example test

Motivations

Prerelease

Benchmark

Scenario: Building the test project

macos-latest

ubuntu-latest

windows-latest

Scenario: A single test that completes instantly (including spawning a new process and initialising the test framework)

macos-latest

ubuntu-latest

windows-latest

Scenario: A test that takes 50ms to execute, repeated 100 times (including spawning a new process and initialising the test framework)

macos-latest

ubuntu-latest

windows-latest

About

Resources

License

Stars

Watchers

Forks

Releases

Sponsor this project

Packages 0

Contributors 10

Languages

Packages