thomhurst/ TUnit.Engine v0.1.720 docs d <> code . compare c
✓ 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 TUnit.EngineReadme 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. As of September 2024, IDEs do not fully support this testing platform yet.
Visual Studio 17.10 onwards 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 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 [Test]
public async Task Test1()
{
var value = "Hello world!";
await Assert.That(value).IsNotNull()
.And.IsEqualTo("hello world!", StringComparison.InvariantCultureIgnoreCase);
}
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")]
[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;
}
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: 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 82.05 ms 0.289 ms 0.225 ms TUnit 420.05 ms 5.913 ms 5.242 ms NUnit 692.55 ms 6.447 ms 5.384 ms xUnit 678.63 ms 8.906 ms 7.895 ms MSTest 616.34 ms 5.068 ms 4.232 ms
ubuntu-latest
BenchmarkDotNet v0.14.0, Ubuntu 22.04.4 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.60 ms 1.020 ms 3.008 ms TUnit 822.46 ms 16.402 ms 41.451 ms NUnit 1,376.72 ms 20.414 ms 19.095 ms xUnit 1,369.33 ms 14.996 ms 14.027 ms MSTest 1,230.40 ms 21.880 ms 26.046 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 81.04 ms 1.579 ms 2.595 ms TUnit 768.09 ms 15.359 ms 21.023 ms NUnit 1,289.66 ms 7.908 ms 7.397 ms xUnit 1,267.90 ms 5.706 ms 4.764 ms MSTest 1,180.52 ms 23.250 ms 26.775 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.4 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 89.23 ms 1.779 ms 4.016 ms TUnit 891.58 ms 17.530 ms 34.603 ms NUnit 6,573.11 ms 22.209 ms 19.687 ms xUnit 6,553.42 ms 14.237 ms 13.318 ms MSTest 6,546.51 ms 28.670 ms 26.818 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 142.5 ms 2.83 ms 7.74 ms 142.3 ms TUnit 840.5 ms 16.60 ms 22.16 ms 846.0 ms NUnit 8,693.6 ms 171.89 ms 351.12 ms 8,826.5 ms xUnit 8,804.0 ms 171.34 ms 216.69 ms 8,848.8 ms MSTest 8,738.8 ms 174.21 ms 291.07 ms 8,820.3 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 247.6 ms 15.41 ms 45.44 ms TUnit 592.0 ms 20.82 ms 61.37 ms NUnit 14,110.9 ms 281.70 ms 562.58 ms xUnit 14,579.2 ms 290.49 ms 631.49 ms MSTest 14,481.6 ms 285.95 ms 633.64 ms
Compatibility .NET 8.0
.NET 9.0
.NET 10.0
.NET Std2.0
