A .NET Testing Framework
$ dotnet add package TUnit.Playwright
A modern, flexible and fast testing framework for C#. With Native AOT and Trimmed Single File application support included!
TUnit is designed to aid with all testing types:
Assuming you have the .NET SDK installed, simply run:
dotnet new install TUnit.Templates
dotnet new TUnit -n "YourProjectName"
A new test project will be created for you with some samples of different test types and tips. When you're ready to get going, delete them and create your own!
See here: https://thomhurst.github.io/TUnit/
TUnit leverages source generators to locate and register your tests as opposed to reflection. You'll have a slight bump in build time, but a speedier runtime.
TUnit also builds upon the newer Microsoft.Testing.Platform, whereas most other frameworks you'll have used will use VSTest. The new platform was reconstructed from the ground up to address pain points, be more extensible, and be faster.
One of the most powerful parts of TUnit is the information you have available to you because of the source generation and the events you can subscribe to. Because tests are constructed at the point of discovery, and not at runtime, you know all your arguments, properties, etc. upfront.
You can then register to be notified about various events such as test registered (scheduled to run in this test session at some point in the future), test started, test finished, etc.
Say we injected an external object into our tests: By knowing how many tests are registered, we could count them up, and then on a test end event, we could decrease the count. When hitting 0, we know our object isn't going to be used by any other tests, so we can dispose of it. We know when we can handle the lifecycle, and this prevents it from living till the end of the test session where it could be hanging on to precious resources.
One popular feature of TUnit is the [ClassDataSource<T>] attribute - Allowing you to inject in classes to your tests with specific lifetimes, such as Per Test Session, or Per Test Class.
Or if you want to run a combination of lots of different inputs, you can use a [MatrixDataSource] and annotate your parameters with [Matrix(...)] values.
But guess what? Those features are built on top of a DataSourceGenerator<T> class - Which is exposed directly to you.
That means that that functionality can be extended greatly. If they didn't exist already, you could implement them yourself!
So if you've got creative or complex ways to generate new data, this gives you the flexibility to do it. You create a class which will end up being an attribute you place on your test - So your test classes remain simple and readable!
TUnit tries to help you write your tests correctly with analyzers. If something isn't quite right, an analyzer should tell you what's wrong.
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 is fully supported from 2022 17.13 onwards. The "Use testing platform server mode" option is not present from 2022 17.13 onwards.
For prior versions, the "Use testing platform server mode" option must be selected in Tools > Manage Preview Features.
Rider is supported. The Enable Testing Platform support option must be selected in Settings > Build, Execution, Deployment > Unit Testing > VSTest.
Visual Studio Code is supported.
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!
To be used when you want to define re-useable components, such as a test library, but it wouldn't be run as its own test suite.
For test suites. This contains the test execution logic and test adapter. Only install this on actual test projects you intend to run, not class libraries.
This is independent from the framework and can be used wherever - Even in other test frameworks. It is just an assertion library used to assert data is as you expect. It uses an asychronous syntax which may be different to other assertion libraries you may have used.
This is a helper package to combine the above 3 packages. If you just want a standard test app where you can write, run and assert tests, just install this!
This provides you base classes, similarly to Microsoft.Playwright.NUnit or Microsoft.Playwright.MSTest, to automatically create and dispose of Playwright objects in tests, to make it easier for you to write tests without worrying about lifecycles or disposing. The base classes are named the same as the other libraries: PageTest, ContextTest, BrowserTest, and PlaywrightTest.
Native AOT / Trimmed Single File application support
Source generated tests
Property injection
Full async support
Parallel by default, with mechanisms to:
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:
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
dotnet add package TUnit --prerelease
[Test]
public async Task Create_User_Has_Expected_Creation_Time()
{
var user = await CreateUser();
await Assert.That(user.CreatedAt)
.IsEqualTo(DateTime.Now)
.Within(TimeSpan.FromMinutes(1));
}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")]
[MethodDataSource(nameof(GetAuthDetails))]
public async Task Register(string username, string password) { ... }
[Repeat(5)]
[Test, DependsOn(nameof(Register))]
[MethodDataSource(nameof(GetAuthDetails))]
public async Task Login(string username, string password) { ... }
[Test, DependsOn(nameof(Login), [typeof(string), typeof(string)])]
[MethodDataSource(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;
}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.
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:
As such, the API may change. I'll try to limit this but it's a possibility.
BenchmarkDotNet v0.14.0, macOS Sonoma 14.7.4 (23H420) [Darwin 23.6.0]
Apple M1 (Virtual), 1 CPU, 3 logical and 3 physical cores
.NET SDK 9.0.200
[Host] : .NET 9.0.2 (9.0.225.6610), Arm64 RyuJIT AdvSIMD
.NET 9.0 : .NET 9.0.2 (9.0.225.6610), Arm64 RyuJIT AdvSIMD
Job=.NET 9.0 Runtime=.NET 9.0
| Method | Mean | Error | StdDev |
|---|---|---|---|
| Build_TUnit | 1.798 s | 0.1753 s | 0.5113 s |
| Build_NUnit | 1.081 s | 0.0525 s | 0.1524 s |
| Build_xUnit | 1.255 s | 0.0704 s | 0.2066 s |
| Build_MSTest | 1.344 s | 0.0639 s | 0.1864 s |
BenchmarkDotNet v0.14.0, Ubuntu 24.04.2 LTS (Noble Numbat)
AMD EPYC 7763, 1 CPU, 4 logical and 2 physical cores
.NET SDK 9.0.200
[Host] : .NET 9.0.2 (9.0.225.6610), X64 RyuJIT AVX2
.NET 9.0 : .NET 9.0.2 (9.0.225.6610), X64 RyuJIT AVX2
Job=.NET 9.0 Runtime=.NET 9.0
| Method | Mean | Error | StdDev |
|---|---|---|---|
| Build_TUnit | 1.895 s | 0.0284 s | 0.0251 s |
| Build_NUnit | 1.467 s | 0.0166 s | 0.0147 s |
| Build_xUnit | 1.486 s | 0.0112 s | 0.0099 s |
| Build_MSTest | 1.497 s | 0.0120 s | 0.0107 s |
BenchmarkDotNet v0.14.0, Windows 10 (10.0.20348.3207) (Hyper-V)
AMD EPYC 7763, 1 CPU, 4 logical and 2 physical cores
.NET SDK 9.0.200
[Host] : .NET 9.0.2 (9.0.225.6610), X64 RyuJIT AVX2
.NET 9.0 : .NET 9.0.2 (9.0.225.6610), X64 RyuJIT AVX2
Job=.NET 9.0 Runtime=.NET 9.0
| Method | Mean | Error | StdDev | Median |
|---|---|---|---|---|
| Build_TUnit | 2.075 s | 0.0415 s | 0.1026 s | 2.110 s |
| Build_NUnit | 1.480 s | 0.0189 s | 0.0177 s | 1.485 s |
| Build_xUnit | 1.481 s | 0.0181 s | 0.0161 s | 1.480 s |
| Build_MSTest | 1.516 s | 0.0181 s | 0.0170 s | 1.517 s |
BenchmarkDotNet v0.14.0, macOS Sonoma 14.7.4 (23H420) [Darwin 23.6.0]
Apple M1 (Virtual), 1 CPU, 3 logical and 3 physical cores
.NET SDK 9.0.200
[Host] : .NET 9.0.2 (9.0.225.6610), Arm64 RyuJIT AdvSIMD
.NET 9.0 : .NET 9.0.2 (9.0.225.6610), Arm64 RyuJIT AdvSIMD
Job=.NET 9.0 Runtime=.NET 9.0
| Method | Mean | Error | StdDev |
|---|---|---|---|
| TUnit_AOT | 189.9 ms | 18.14 ms | 53.50 ms |
| TUnit | 1,059.1 ms | 70.81 ms | 207.66 ms |
| NUnit | 1,515.8 ms | 60.31 ms | 175.93 ms |
| xUnit | 1,639.7 ms | 73.28 ms | 213.77 ms |
| MSTest | 1,460.3 ms | 74.26 ms | 216.63 ms |
BenchmarkDotNet v0.14.0, Ubuntu 24.04.2 LTS (Noble Numbat)
AMD EPYC 7763, 1 CPU, 4 logical and 2 physical cores
.NET SDK 9.0.200
[Host] : .NET 9.0.2 (9.0.225.6610), X64 RyuJIT AVX2
.NET 9.0 : .NET 9.0.2 (9.0.225.6610), X64 RyuJIT AVX2
Job=.NET 9.0 Runtime=.NET 9.0
| Method | Mean | Error | StdDev |
|---|---|---|---|
| TUnit_AOT | 45.17 ms | 0.900 ms | 1.402 ms |
| TUnit | 806.30 ms | 15.842 ms | 18.858 ms |
| NUnit | 1,298.39 ms | 9.849 ms | 9.213 ms |
| xUnit | 1,357.56 ms | 8.449 ms | 7.903 ms |
| MSTest | 1,146.12 ms | 8.939 ms | 7.924 ms |
BenchmarkDotNet v0.14.0, Windows 10 (10.0.20348.3207) (Hyper-V)
AMD EPYC 7763, 1 CPU, 4 logical and 2 physical cores
.NET SDK 9.0.200
[Host] : .NET 9.0.2 (9.0.225.6610), X64 RyuJIT AVX2
.NET 9.0 : .NET 9.0.2 (9.0.225.6610), X64 RyuJIT AVX2
Job=.NET 9.0 Runtime=.NET 9.0
| Method | Mean | Error | StdDev | Median |
|---|---|---|---|---|
| TUnit_AOT | 76.45 ms | 1.519 ms | 2.620 ms | 77.90 ms |
| TUnit | 841.25 ms | 16.402 ms | 24.043 ms | 851.11 ms |
| NUnit | 1,286.76 ms | 11.033 ms | 9.781 ms | 1,284.02 ms |
| xUnit | 1,336.33 ms | 7.647 ms | 6.779 ms | 1,335.67 ms |
| MSTest | 1,201.96 ms | 18.546 ms | 17.348 ms | 1,197.02 ms |
BenchmarkDotNet v0.14.0, macOS Sonoma 14.7.4 (23H420) [Darwin 23.6.0]
Apple M1 (Virtual), 1 CPU, 3 logical and 3 physical cores
.NET SDK 9.0.200
[Host] : .NET 9.0.2 (9.0.225.6610), Arm64 RyuJIT AdvSIMD
.NET 9.0 : .NET 9.0.2 (9.0.225.6610), Arm64 RyuJIT AdvSIMD
Job=.NET 9.0 Runtime=.NET 9.0
| Method | Mean | Error | StdDev |
|---|---|---|---|
| TUnit_AOT | 297.3 ms | 27.28 ms | 80.45 ms |
| TUnit | 858.7 ms | 47.87 ms | 140.38 ms |
| NUnit | 14,301.6 ms | 284.45 ms | 483.01 ms |
| xUnit | 14,507.7 ms | 286.69 ms | 604.72 ms |
| MSTest | 14,215.0 ms | 279.81 ms | 475.15 ms |
BenchmarkDotNet v0.14.0, Ubuntu 24.04.2 LTS (Noble Numbat)
AMD EPYC 7763, 1 CPU, 4 logical and 2 physical cores
.NET SDK 9.0.200
[Host] : .NET 9.0.2 (9.0.225.6610), X64 RyuJIT AVX2
.NET 9.0 : .NET 9.0.2 (9.0.225.6610), X64 RyuJIT AVX2
Job=.NET 9.0 Runtime=.NET 9.0
| Method | Mean | Error | StdDev |
|---|---|---|---|
| TUnit_AOT | 76.95 ms | 1.527 ms | 2.091 ms |
| TUnit | 912.33 ms | 17.924 ms | 22.668 ms |
| NUnit | 6,311.47 ms | 17.171 ms | 16.062 ms |
| xUnit | 6,426.33 ms | 18.845 ms | 16.706 ms |
| MSTest | 6,268.52 ms | 21.212 ms | 19.841 ms |
BenchmarkDotNet v0.14.0, Windows 10 (10.0.20348.3207) (Hyper-V)
AMD EPYC 7763, 1 CPU, 4 logical and 2 physical cores
.NET SDK 9.0.200
[Host] : .NET 9.0.2 (9.0.225.6610), X64 RyuJIT AVX2
.NET 9.0 : .NET 9.0.2 (9.0.225.6610), X64 RyuJIT AVX2
Job=.NET 9.0 Runtime=.NET 9.0
| Method | Mean | Error | StdDev |
|---|---|---|---|
| TUnit_AOT | 120.5 ms | 2.48 ms | 7.20 ms |
| TUnit | 931.7 ms | 18.53 ms | 26.57 ms |
| NUnit | 7,498.3 ms | 29.98 ms | 28.05 ms |
| xUnit | 7,570.8 ms | 20.34 ms | 19.03 ms |
| MSTest | 7,450.4 ms | 25.03 ms | 23.41 ms |