Readme

TUnit

A modern, flexible and fast testing framework for .NET

Documentation

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

IDE

TUnit is built on top of newer Microsoft.Testing.Platform libraries, as opposed to older legacy VSTest libraries. As of July 2024, IDEs do not fully support this testing platform yet.

Visual Studio Preview versions can run the new tests by enabling the new testing platform server mode, within Visual Studio preview/experimental features. You will have to opt in to this manually.

For Rider, it is not yet supported. I believe they are working on it so we just have to wait for now.

dotnet CLI - Fully supported. Tests should be runnable with both dotnet test or dotnet run. dotnet run should give you a better experience and make it simpler to pass in test flags!

Features

Source generated tests
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 a 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

    [Test]
    public async Task Test1()
    {
        var value = "Hello world!";

        await Assert.That(value)
            .Is.Not.Null
            .And.Does.StartWith("H")
            .And.Has.Count().EqualTo(12)
            .And.Is.EqualTo("hello world!", StringComparison.InvariantCultureIgnoreCase);
    }

[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")] [EnumerableMethodData(nameof(GetAuthDetails))] public async Task Register(string username, string password) { ... } [Repeat(5)] [Test, DependsOn(nameof(Register))] [EnumerableMethodData(nameof(GetAuthDetails))] public async Task Login(string username, string password) { ... } [Test, DependsOn(nameof(Login), [typeof(string), typeof(string)])] [EnumerableMethodData(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; }

Method	Mean	Error	StdDev
TUnit	828.4 ms	16.40 ms	30.40 ms
NUnit	1,395.0 ms	21.09 ms	19.73 ms
xUnit	1,387.4 ms	25.13 ms	23.51 ms
MSTest	1,238.4 ms	16.66 ms	15.58 ms

Method	Mean	Error	StdDev
TUnit	801.1 ms	15.97 ms	20.76 ms
NUnit	1,339.5 ms	24.16 ms	21.42 ms
xUnit	1,297.0 ms	13.62 ms	12.74 ms
MSTest	1,179.0 ms	21.63 ms	19.18 ms

Method	Mean	Error	StdDev	Median
TUnit	631.8 ms	20.82 ms	60.73 ms	622.5 ms
NUnit	916.4 ms	55.96 ms	165.01 ms	889.6 ms
xUnit	798.3 ms	30.83 ms	89.43 ms	770.6 ms
MSTest	651.7 ms	12.97 ms	19.02 ms	649.8 ms

Method	Mean	Error	StdDev
TUnit	887.8 ms	17.43 ms	37.51 ms
NUnit	6,538.8 ms	20.73 ms	18.38 ms
xUnit	6,537.6 ms	16.60 ms	14.72 ms
MSTest	6,492.6 ms	17.43 ms	15.45 ms

Method	Mean	Error	StdDev	Median
TUnit	838.1 ms	16.26 ms	20.57 ms	844.3 ms
NUnit	8,672.9 ms	171.25 ms	329.94 ms	8,780.3 ms
xUnit	8,658.8 ms	171.24 ms	308.78 ms	8,761.5 ms
MSTest	8,591.4 ms	170.03 ms	369.63 ms	8,733.6 ms

thomhurst/TUnit.Enginev0.1.575

Get Started

Readme

TUnit

Documentation

IDE

Features

Installation

Example test

Motivations

Benchmark

Scenario: A single test that completes instantly

ubuntu-latest

windows-latest

macos-latest

Scenario: A test that takes 50ms to execute, repeated 100 times

ubuntu-latest

windows-latest

macos-latest

Method	Mean	Error	StdDev
TUnit	605.8 ms	21.82 ms	63.64 ms
NUnit	14,117.4 ms	276.87 ms	540.02 ms
xUnit	14,324.2 ms	283.41 ms	518.23 ms
MSTest	14,440.2 ms	286.21 ms	462.18 ms