TUnit v0.1.773 — nugetz
thomhurst/ TUnit v0.1.773 ✓ Verified .NET 8.0 .NET 9.0 .NET 10.0 .NET Std2.0
A .NET Testing Framework
Get Started dotnet CLI PackageReference Package Manager
$ dotnet add package TUnitReadme 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.
Rider
Rider is supported. The Enable Testing Platform support option must be selected in Settings > Build, Execution, Deployment > Unit Testing > VSTest.
<img src="/docs/static/img/rider.png" height="300px">
<img src="/docs/static/img/visual-studio-code.png" height="300px">
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 798.8 ms 13.24 ms 29.35 ms Build_NUnit 707.8 ms 14.03 ms 12.44 ms Build_xUnit 722.4 ms 14.24 ms 22.59 ms Build_MSTest 755.2 ms 14.14 ms 12.53 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.549 s 0.0215 s 0.0191 s Build_NUnit 1.424 s 0.0261 s 0.0244 s Build_xUnit 1.420 s 0.0173 s 0.0153 s Build_MSTest 1.440 s 0.0156 s 0.0139 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.423 s 0.0283 s 0.0291 s Build_NUnit 1.319 s 0.0224 s 0.0210 s Build_xUnit 1.322 s 0.0250 s 0.0245 s Build_MSTest 1.329 s 0.0172 s 0.0161 s
Scenario: A single test that completes instantly (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 45.46 ms 0.950 ms 2.800 ms TUnit 764.17 ms 14.856 ms 18.788 ms NUnit 1,337.41 ms 9.119 ms 8.530 ms xUnit 1,337.12 ms 16.501 ms 15.435 ms MSTest 1,212.66 ms 15.302 ms 14.313 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 Median TUnit_AOT 91.70 ms 6.381 ms 18.61 ms 86.39 ms TUnit 452.29 ms 9.792 ms 28.09 ms 449.81 ms NUnit 767.17 ms 15.253 ms 28.27 ms 757.32 ms xUnit 887.88 ms 17.739 ms 22.43 ms 888.10 ms MSTest 815.06 ms 14.916 ms 13.95 ms 813.81 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 TUnit_AOT 78.01 ms 0.104 ms 0.081 ms TUnit 741.51 ms 14.811 ms 20.764 ms NUnit 1,278.42 ms 5.574 ms 5.214 ms xUnit 1,260.15 ms 7.394 ms 6.916 ms MSTest 1,146.89 ms 10.461 ms 9.785 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 81.22 ms 1.601 ms 3.047 ms TUnit 813.37 ms 16.105 ms 25.073 ms NUnit 6,312.54 ms 10.358 ms 9.689 ms xUnit 6,377.62 ms 20.924 ms 18.549 ms MSTest 6,312.25 ms 21.691 ms 20.290 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 131.6 ms 2.93 ms 8.65 ms 132.5 ms TUnit 827.9 ms 16.48 ms 24.67 ms 828.9 ms NUnit 8,833.3 ms 20.37 ms 19.06 ms 8,832.5 ms xUnit 8,710.4 ms 170.91 ms 312.51 ms 8,809.7 ms MSTest 8,604.5 ms 169.55 ms 375.71 ms 8,759.2 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 251.3 ms 13.05 ms 38.26 ms TUnit 780.8 ms 31.00 ms 88.95 ms NUnit 14,197.4 ms 280.04 ms 660.08 ms xUnit 14,367.0 ms 286.47 ms 551.93 ms MSTest 14,422.7 ms 286.90 ms 455.06 ms
Compatibility .NET 8.0
.NET 9.0
.NET 10.0
.NET Std2.0
