thomhurst/ TUnit.Engine v0.1.997 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 href="https://trendshift.io/repositories/11781" target="_blank"><img src="https://trendshift.io/api/badge/repositories/11781" alt="thomhurst%2FTUnit | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
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"
<img src="/docs/static/img/visual-studio.png" height="300px">
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
Property injection
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
Dependency injection support (See here )
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.7 (23H124) [Darwin 23.6.0]
Apple M1 (Virtual), 1 CPU, 3 logical and 3 physical cores
.NET SDK 9.0.100-rc.2.24474.11
[Host] : .NET 9.0.0 (9.0.24.47305), Arm64 RyuJIT AdvSIMD
.NET 8.0 : .NET 8.0.10 (8.0.1024.46610), Arm64 RyuJIT AdvSIMD
Job=.NET 8.0 Runtime=.NET 8.0
Method Mean Error StdDev Median Build_TUnit 904.6 ms 18.01 ms 45.52 ms 889.1 ms Build_NUnit 802.6 ms 14.81 ms 13.13 ms 803.5 ms Build_xUnit 801.5 ms 10.59 ms 9.91 ms 799.0 ms Build_MSTest 839.3 ms 16.59 ms 17.04 ms 838.5 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 9.0.100-rc.2.24474.11
[Host] : .NET 9.0.0 (9.0.24.47305), X64 RyuJIT AVX2
.NET 8.0 : .NET 8.0.10 (8.0.1024.46610), X64 RyuJIT AVX2
Job=.NET 8.0 Runtime=.NET 8.0
Method Mean Error StdDev Build_TUnit 1.669 s 0.0332 s 0.0466 s Build_NUnit 1.505 s 0.0259 s 0.0242 s Build_xUnit 1.504 s 0.0125 s 0.0105 s Build_MSTest 1.586 s 0.0235 s 0.0220 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 9.0.100-rc.2.24474.11
[Host] : .NET 9.0.0 (9.0.24.47305), X64 RyuJIT AVX2
.NET 8.0 : .NET 8.0.10 (8.0.1024.46610), X64 RyuJIT AVX2
Job=.NET 8.0 Runtime=.NET 8.0
Method Mean Error StdDev Build_TUnit 1.817 s 0.0317 s 0.0281 s Build_NUnit 1.678 s 0.0294 s 0.0275 s Build_xUnit 1.677 s 0.0325 s 0.0288 s Build_MSTest 1.727 s 0.0333 s 0.0327 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.7 (23H124) [Darwin 23.6.0]
Apple M1 (Virtual), 1 CPU, 3 logical and 3 physical cores
.NET SDK 9.0.100-rc.2.24474.11
[Host] : .NET 9.0.0 (9.0.24.47305), Arm64 RyuJIT AdvSIMD
.NET 8.0 : .NET 8.0.10 (8.0.1024.46610), Arm64 RyuJIT AdvSIMD
Job=.NET 8.0 Runtime=.NET 8.0
Method Mean Error StdDev TUnit_AOT 77.11 ms 1.271 ms 0.992 ms TUnit 551.97 ms 10.996 ms 17.441 ms NUnit 846.57 ms 11.506 ms 8.983 ms xUnit 835.88 ms 6.044 ms 5.047 ms MSTest 764.42 ms 14.646 ms 14.385 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 9.0.100-rc.2.24474.11
[Host] : .NET 9.0.0 (9.0.24.47305), X64 RyuJIT AVX2
.NET 8.0 : .NET 8.0.10 (8.0.1024.46610), X64 RyuJIT AVX2
Job=.NET 8.0 Runtime=.NET 8.0
Method Mean Error StdDev TUnit_AOT 32.22 ms 0.945 ms 2.771 ms TUnit 871.99 ms 16.976 ms 23.797 ms NUnit 1,374.09 ms 26.904 ms 25.166 ms xUnit 1,358.62 ms 25.247 ms 23.616 ms MSTest 1,240.26 ms 13.978 ms 13.075 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 9.0.100-rc.2.24474.11
[Host] : .NET 9.0.0 (9.0.24.47305), X64 RyuJIT AVX2
.NET 8.0 : .NET 8.0.10 (8.0.1024.46610), X64 RyuJIT AVX2
Job=.NET 8.0 Runtime=.NET 8.0
Method Mean Error StdDev TUnit_AOT 88.78 ms 1.733 ms 3.036 ms TUnit 924.03 ms 17.877 ms 28.868 ms NUnit 1,458.05 ms 18.761 ms 17.549 ms xUnit 1,432.98 ms 13.908 ms 12.329 ms MSTest 1,290.16 ms 10.583 ms 9.899 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.7 (23H124) [Darwin 23.6.0]
Apple M1 (Virtual), 1 CPU, 3 logical and 3 physical cores
.NET SDK 9.0.100-rc.2.24474.11
[Host] : .NET 9.0.0 (9.0.24.47305), Arm64 RyuJIT AdvSIMD
.NET 8.0 : .NET 8.0.10 (8.0.1024.46610), Arm64 RyuJIT AdvSIMD
Job=.NET 8.0 Runtime=.NET 8.0
Method Mean Error StdDev TUnit_AOT 252.1 ms 15.81 ms 46.63 ms TUnit 625.9 ms 21.42 ms 62.83 ms NUnit 14,424.0 ms 288.20 ms 353.93 ms xUnit 14,702.3 ms 264.00 ms 271.10 ms MSTest 14,308.5 ms 284.68 ms 443.21 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 9.0.100-rc.2.24474.11
[Host] : .NET 9.0.0 (9.0.24.47305), X64 RyuJIT AVX2
.NET 8.0 : .NET 8.0.10 (8.0.1024.46610), X64 RyuJIT AVX2
Job=.NET 8.0 Runtime=.NET 8.0
Method Mean Error StdDev TUnit_AOT 102.0 ms 1.98 ms 2.84 ms TUnit 938.4 ms 18.75 ms 29.74 ms NUnit 6,587.7 ms 41.38 ms 36.69 ms xUnit 6,538.8 ms 21.05 ms 19.69 ms MSTest 6,498.4 ms 15.90 ms 14.10 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 9.0.100-rc.2.24474.11
[Host] : .NET 9.0.0 (9.0.24.47305), X64 RyuJIT AVX2
.NET 8.0 : .NET 8.0.10 (8.0.1024.46610), X64 RyuJIT AVX2
Job=.NET 8.0 Runtime=.NET 8.0
Method Mean Error StdDev TUnit_AOT 140.4 ms 0.25 ms 0.19 ms TUnit 917.4 ms 18.00 ms 26.95 ms NUnit 7,528.4 ms 15.10 ms 14.12 ms xUnit 7,526.6 ms 16.95 ms 15.86 ms MSTest 7,483.9 ms 14.73 ms 13.77 ms
Compatibility .NET 8.0
.NET 9.0
.NET 10.0
.NET Std2.0
