TUnit

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

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
Test ordering (if running not in parallel)
Tests can depend on other tests to form chains, useful for if one test depends on state from another action
Easy to read assertions
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.

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.401
  [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	789.9 ms	15.52 ms	21.25 ms
Build_NUnit	698.8 ms	13.66 ms	14.61 ms
Build_xUnit	704.7 ms	12.12 ms	10.74 ms
Build_MSTest	750.6 ms	9.60 ms	8.02 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.401
  [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.503 s	0.0283 s	0.0251 s
Build_NUnit	1.370 s	0.0234 s	0.0218 s
Build_xUnit	1.388 s	0.0190 s	0.0178 s
Build_MSTest	1.403 s	0.0228 s	0.0202 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.401
  [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.494 s	0.0241 s	0.0367 s
Build_NUnit	1.376 s	0.0262 s	0.0205 s
Build_xUnit	1.366 s	0.0185 s	0.0164 s
Build_MSTest	1.362 s	0.0243 s	0.0227 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.401
  [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	76.04 ms	0.355 ms	0.277 ms
TUnit	413.09 ms	7.514 ms	8.945 ms
NUnit	697.87 ms	13.502 ms	14.447 ms
xUnit	684.04 ms	13.438 ms	12.570 ms
MSTest	620.61 ms	8.842 ms	7.384 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.401
  [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.20 ms	0.993 ms	2.927 ms
TUnit	743.61 ms	14.401 ms	16.584 ms
NUnit	1,321.12 ms	16.244 ms	14.399 ms
xUnit	1,304.20 ms	8.261 ms	7.728 ms
MSTest	1,172.70 ms	9.551 ms	8.466 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.401
  [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	77.96 ms	1.014 ms	0.792 ms	78.05 ms
TUnit	743.45 ms	14.752 ms	22.968 ms	731.22 ms
NUnit	1,340.19 ms	10.394 ms	9.214 ms	1,338.25 ms
xUnit	1,332.42 ms	16.103 ms	15.063 ms	1,329.85 ms
MSTest	1,207.03 ms	9.262 ms	8.210 ms	1,206.23 ms

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

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.401
  [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	83.69 ms	1.646 ms	3.715 ms
TUnit	858.64 ms	16.981 ms	23.243 ms
NUnit	6,397.03 ms	30.366 ms	28.405 ms
xUnit	6,339.82 ms	20.647 ms	19.314 ms
MSTest	6,371.36 ms	56.639 ms	52.981 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.401
  [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	129.9 ms	2.59 ms	7.56 ms	132.4 ms
TUnit	818.3 ms	15.87 ms	21.72 ms	818.5 ms
NUnit	8,612.7 ms	170.58 ms	437.27 ms	8,795.4 ms
xUnit	8,663.2 ms	173.12 ms	333.54 ms	8,774.9 ms
MSTest	8,622.5 ms	171.07 ms	345.57 ms	8,752.7 ms

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.401
  [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	245.0 ms	11.77 ms	34.71 ms
TUnit	668.3 ms	35.67 ms	105.19 ms
NUnit	14,239.5 ms	280.96 ms	492.07 ms
xUnit	14,527.3 ms	285.07 ms	491.73 ms
MSTest	14,468.8 ms	287.86 ms	547.69 ms

Name		Name	Last commit message	Last commit date
Latest commit History 1,856 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
global.json		global.json
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

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)

ubuntu-latest

windows-latest

macos-latest

About

Releases

Packages

Languages

License

eltociear/TUnit

Folders and files

Latest commit

History

Repository files navigation

TUnit

Documentation

IDE

Visual Studio

Rider

VS Code

CLI

Features

Installation

Example test

Motivations

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)

ubuntu-latest

windows-latest

macos-latest

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages