Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thomhurst/TUnit
A modern, fast and flexible .NET testing framework
https://github.com/thomhurst/TUnit
Last synced: 4 days ago
JSON representation
A modern, fast and flexible .NET testing framework
- Host: GitHub
- URL: https://github.com/thomhurst/TUnit
- Owner: thomhurst
- License: mit
- Created: 2024-01-24T13:00:36.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-10-29T09:32:48.000Z (3 months ago)
- Last Synced: 2024-10-29T09:55:11.622Z (3 months ago)
- Language: C#
- Homepage:
- Size: 7.3 MB
- Stars: 2,173
- Watchers: 13
- Forks: 37
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-reference-tools - TUnit
README
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:
- Unit
- Integration
- Acceptance
- and more!
 [](https://github.com/sponsors/thomhurst)
[](https://www.nuget.org/packages/TUnit/) [](https://www.nuget.org/packages/TUnit/)
  
## Documentation
See here:
## Modern and Fast
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.
## Hooks, Events and Lifecycles
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.
## Built in Analyzers
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.
## 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. The "Use testing platform server mode" option must be selected in Tools > Manage Preview Features.
### Rider
Rider is supported. The [Enable Testing Platform support](https://www.jetbrains.com/help/rider/Reference__Options__Tools__Unit_Testing__VSTest.html) option must be selected in Settings > Build, Execution, Deployment > Unit Testing > VSTest.
## VS Code
Visual Studio Code is supported.
- Install the extension Name: [C# Dev Kit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit)
- 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!
## Packages
### TUnit.Core
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.
### TUnit.Engine
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.
### TUnit.Assertions
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.
### TUnit
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!
### TUnit.Playwright
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`.
## 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](https://thomhurst.github.io/TUnit/docs/tutorial-extras/class-constructors))
- Ability to view and interrogate metadata and results from various assembly/class/test context objects
## Installation
`dotnet add package TUnit --prerelease`
## Example test
```csharp
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
```csharp
[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]
[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 ShouldSkip(TestContext testContext)
{
return Task.FromResult(!OperatingSystem.IsWindows());
}
}
public class RetryHttpServiceUnavailableAttribute : RetryAttribute
{
public RetryHttpServiceUnavailableAttribute(int times) : base(times)
{
}
public override Task 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.
[Read more here](https://thomhurst.github.io/TUnit/docs/comparison/framework-differences)
## 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.2 (23H311) [Darwin 23.6.0]
Apple M1 (Virtual), 1 CPU, 3 logical and 3 physical cores
.NET SDK 9.0.101
[Host] : .NET 9.0.0 (9.0.24.52809), Arm64 RyuJIT AdvSIMD
.NET 9.0 : .NET 9.0.0 (9.0.24.52809), Arm64 RyuJIT AdvSIMD
Job=.NET 9.0 Runtime=.NET 9.0
```
| Method | Mean | Error | StdDev |
|------------- |-----------:|---------:|---------:|
| Build_TUnit | 1,003.6 ms | 19.74 ms | 24.25 ms |
| Build_NUnit | 845.4 ms | 14.13 ms | 13.22 ms |
| Build_xUnit | 865.6 ms | 16.82 ms | 18.70 ms |
| Build_MSTest | 900.7 ms | 17.45 ms | 22.68 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.101
[Host] : .NET 9.0.0 (9.0.24.52809), X64 RyuJIT AVX2
.NET 9.0 : .NET 9.0.0 (9.0.24.52809), X64 RyuJIT AVX2
Job=.NET 9.0 Runtime=.NET 9.0
```
| Method | Mean | Error | StdDev |
|------------- |--------:|---------:|---------:|
| Build_TUnit | 1.829 s | 0.0359 s | 0.0384 s |
| Build_NUnit | 1.497 s | 0.0241 s | 0.0226 s |
| Build_xUnit | 1.502 s | 0.0283 s | 0.0291 s |
| Build_MSTest | 1.567 s | 0.0126 s | 0.0105 s |
#### windows-latest
```
BenchmarkDotNet v0.14.0, Windows 10 (10.0.20348.2966) (Hyper-V)
AMD EPYC 7763, 1 CPU, 4 logical and 2 physical cores
.NET SDK 9.0.101
[Host] : .NET 9.0.0 (9.0.24.52809), X64 RyuJIT AVX2
.NET 9.0 : .NET 9.0.0 (9.0.24.52809), X64 RyuJIT AVX2
Job=.NET 9.0 Runtime=.NET 9.0
```
| Method | Mean | Error | StdDev |
|------------- |--------:|---------:|---------:|
| Build_TUnit | 1.838 s | 0.0351 s | 0.0431 s |
| Build_NUnit | 1.507 s | 0.0288 s | 0.0320 s |
| Build_xUnit | 1.528 s | 0.0221 s | 0.0206 s |
| Build_MSTest | 1.570 s | 0.0218 s | 0.0204 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.2 (23H311) [Darwin 23.6.0]
Apple M1 (Virtual), 1 CPU, 3 logical and 3 physical cores
.NET SDK 9.0.101
[Host] : .NET 9.0.0 (9.0.24.52809), Arm64 RyuJIT AdvSIMD
.NET 9.0 : .NET 9.0.0 (9.0.24.52809), Arm64 RyuJIT AdvSIMD
Job=.NET 9.0 Runtime=.NET 9.0
```
| Method | Mean | Error | StdDev |
|---------- |----------:|----------:|----------:|
| TUnit_AOT | 81.74 ms | 1.372 ms | 1.832 ms |
| TUnit | 519.70 ms | 10.231 ms | 15.929 ms |
| NUnit | 751.01 ms | 10.674 ms | 9.463 ms |
| xUnit | 769.82 ms | 12.237 ms | 10.848 ms |
| MSTest | 673.89 ms | 8.399 ms | 7.857 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.101
[Host] : .NET 9.0.0 (9.0.24.52809), X64 RyuJIT AVX2
.NET 9.0 : .NET 9.0.0 (9.0.24.52809), X64 RyuJIT AVX2
Job=.NET 9.0 Runtime=.NET 9.0
```
| Method | Mean | Error | StdDev |
|---------- |------------:|----------:|----------:|
| TUnit_AOT | 46.60 ms | 0.921 ms | 1.661 ms |
| TUnit | 852.07 ms | 16.497 ms | 26.165 ms |
| NUnit | 1,307.76 ms | 11.020 ms | 9.769 ms |
| xUnit | 1,366.43 ms | 14.481 ms | 13.545 ms |
| MSTest | 1,156.89 ms | 12.453 ms | 10.399 ms |
#### windows-latest
```
BenchmarkDotNet v0.14.0, Windows 10 (10.0.20348.2966) (Hyper-V)
AMD EPYC 7763, 1 CPU, 4 logical and 2 physical cores
.NET SDK 9.0.101
[Host] : .NET 9.0.0 (9.0.24.52809), X64 RyuJIT AVX2
.NET 9.0 : .NET 9.0.0 (9.0.24.52809), X64 RyuJIT AVX2
Job=.NET 9.0 Runtime=.NET 9.0
```
| Method | Mean | Error | StdDev |
|---------- |------------:|----------:|----------:|
| TUnit_AOT | 56.10 ms | 1.876 ms | 5.531 ms |
| TUnit | 847.54 ms | 16.821 ms | 27.638 ms |
| NUnit | 1,283.10 ms | 6.313 ms | 5.905 ms |
| xUnit | 1,337.54 ms | 14.829 ms | 13.871 ms |
| MSTest | 1,141.95 ms | 11.965 ms | 11.192 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.2 (23H311) [Darwin 23.6.0]
Apple M1 (Virtual), 1 CPU, 3 logical and 3 physical cores
.NET SDK 9.0.101
[Host] : .NET 9.0.0 (9.0.24.52809), Arm64 RyuJIT AdvSIMD
.NET 9.0 : .NET 9.0.0 (9.0.24.52809), Arm64 RyuJIT AdvSIMD
Job=.NET 9.0 Runtime=.NET 9.0
```
| Method | Mean | Error | StdDev |
|---------- |------------:|----------:|----------:|
| TUnit_AOT | 246.9 ms | 15.42 ms | 45.48 ms |
| TUnit | 640.4 ms | 20.15 ms | 58.79 ms |
| NUnit | 13,847.6 ms | 273.09 ms | 526.16 ms |
| xUnit | 14,083.6 ms | 257.74 ms | 215.22 ms |
| MSTest | 14,385.8 ms | 281.76 ms | 542.85 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.101
[Host] : .NET 9.0.0 (9.0.24.52809), X64 RyuJIT AVX2
.NET 9.0 : .NET 9.0.0 (9.0.24.52809), X64 RyuJIT AVX2
Job=.NET 9.0 Runtime=.NET 9.0
```
| Method | Mean | Error | StdDev |
|---------- |------------:|----------:|----------:|
| TUnit_AOT | 77.52 ms | 0.491 ms | 0.383 ms |
| TUnit | 929.63 ms | 18.527 ms | 28.844 ms |
| NUnit | 6,538.95 ms | 28.311 ms | 23.641 ms |
| xUnit | 6,579.27 ms | 26.933 ms | 23.876 ms |
| MSTest | 6,451.82 ms | 25.273 ms | 23.640 ms |
#### windows-latest
```
BenchmarkDotNet v0.14.0, Windows 10 (10.0.20348.2966) (Hyper-V)
AMD EPYC 7763, 1 CPU, 4 logical and 2 physical cores
.NET SDK 9.0.101
[Host] : .NET 9.0.0 (9.0.24.52809), X64 RyuJIT AVX2
.NET 9.0 : .NET 9.0.0 (9.0.24.52809), X64 RyuJIT AVX2
Job=.NET 9.0 Runtime=.NET 9.0
```
| Method | Mean | Error | StdDev | Median |
|---------- |-----------:|---------:|---------:|-----------:|
| TUnit_AOT | 137.3 ms | 2.73 ms | 6.37 ms | 140.2 ms |
| TUnit | 907.3 ms | 17.53 ms | 24.57 ms | 903.2 ms |
| NUnit | 7,491.5 ms | 21.77 ms | 20.36 ms | 7,498.4 ms |
| xUnit | 7,531.1 ms | 19.66 ms | 17.43 ms | 7,536.9 ms |
| MSTest | 7,428.2 ms | 25.21 ms | 22.35 ms | 7,423.7 ms |