GitHub - thomhurst/TUnit: A modern, fast and flexible .NET testing framework

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!

Documentation

See here: https://thomhurst.github.io/TUnit/

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 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
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)
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")]
    [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;
    }

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.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	Median
Build_TUnit	945.8 ms	17.02 ms	23.86 ms	942.6 ms
Build_NUnit	804.7 ms	7.30 ms	5.70 ms	804.0 ms
Build_xUnit	1,022.9 ms	43.72 ms	128.91 ms	1,038.7 ms
Build_MSTest	923.5 ms	26.15 ms	72.46 ms	903.1 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.865 s	0.0361 s	0.0354 s
Build_NUnit	1.528 s	0.0272 s	0.0254 s
Build_xUnit	1.541 s	0.0233 s	0.0194 s
Build_MSTest	1.603 s	0.0313 s	0.0322 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.810 s	0.0346 s	0.0385 s
Build_NUnit	1.475 s	0.0181 s	0.0170 s
Build_xUnit	1.489 s	0.0252 s	0.0236 s
Build_MSTest	1.510 s	0.0169 s	0.0141 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	Median
TUnit_AOT	72.95 ms	1.328 ms	2.394 ms	71.95 ms
TUnit	479.56 ms	9.410 ms	14.085 ms	474.94 ms
NUnit	708.31 ms	13.299 ms	27.165 ms	697.25 ms
xUnit	720.87 ms	12.783 ms	11.957 ms	719.53 ms
MSTest	631.86 ms	10.365 ms	14.865 ms	625.72 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	32.87 ms	1.033 ms	3.046 ms
TUnit	837.16 ms	16.591 ms	25.336 ms
NUnit	1,291.41 ms	7.341 ms	6.130 ms
xUnit	1,357.03 ms	20.628 ms	18.286 ms
MSTest	1,142.88 ms	6.835 ms	5.708 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	67.86 ms	1.838 ms	5.391 ms	69.55 ms
TUnit	829.04 ms	16.562 ms	26.269 ms	823.46 ms
NUnit	1,276.95 ms	9.411 ms	8.803 ms	1,279.87 ms
xUnit	1,324.48 ms	14.468 ms	13.534 ms	1,321.53 ms
MSTest	1,136.04 ms	12.419 ms	11.009 ms	1,137.90 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	234.3 ms	14.78 ms	43.10 ms
TUnit	622.7 ms	20.14 ms	59.39 ms
NUnit	14,216.5 ms	283.83 ms	573.36 ms
xUnit	14,226.3 ms	282.47 ms	537.42 ms
MSTest	14,019.1 ms	279.04 ms	400.19 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	Median
TUnit_AOT	78.21 ms	1.541 ms	2.445 ms	76.79 ms
TUnit	905.25 ms	17.528 ms	26.767 ms	900.04 ms
NUnit	6,477.29 ms	23.716 ms	22.184 ms	6,479.20 ms
xUnit	6,539.65 ms	14.714 ms	13.764 ms	6,539.84 ms
MSTest	6,424.47 ms	21.770 ms	20.364 ms	6,420.04 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	118.0 ms	2.35 ms	6.66 ms
TUnit	904.5 ms	17.69 ms	20.37 ms
NUnit	7,528.5 ms	23.71 ms	22.18 ms
xUnit	7,631.7 ms	17.21 ms	16.10 ms
MSTest	7,504.5 ms	18.42 ms	16.33 ms

Name		Name	Last commit message	Last commit date
Latest commit History 2,657 Commits
.github		.github
.idea/.idea.TUnit/.idea		.idea/.idea.TUnit/.idea
.vscode		.vscode
TUnit.Analyzers.Roslyn44		TUnit.Analyzers.Roslyn44
TUnit.Analyzers.Roslyn47		TUnit.Analyzers.Roslyn47
TUnit.Analyzers.Tests		TUnit.Analyzers.Tests
TUnit.Analyzers		TUnit.Analyzers
TUnit.Assertions.Analyzers.CodeFixers		TUnit.Assertions.Analyzers.CodeFixers
TUnit.Assertions.Analyzers.Tests		TUnit.Assertions.Analyzers.Tests
TUnit.Assertions.Analyzers		TUnit.Assertions.Analyzers
TUnit.Assertions.Tests		TUnit.Assertions.Tests
TUnit.Assertions.UnitTests		TUnit.Assertions.UnitTests
TUnit.Assertions		TUnit.Assertions
TUnit.Core.SourceGenerator.Roslyn44		TUnit.Core.SourceGenerator.Roslyn44
TUnit.Core.SourceGenerator.Roslyn47		TUnit.Core.SourceGenerator.Roslyn47
TUnit.Core.SourceGenerator.Tests		TUnit.Core.SourceGenerator.Tests
TUnit.Core.SourceGenerator		TUnit.Core.SourceGenerator
TUnit.Core		TUnit.Core
TUnit.Engine.Tests		TUnit.Engine.Tests
TUnit.Engine		TUnit.Engine
TUnit.Example.WebProject.Tests		TUnit.Example.WebProject.Tests
TUnit.Example.WebProject		TUnit.Example.WebProject
TUnit.Pipeline		TUnit.Pipeline
TUnit.Playwright.Tests		TUnit.Playwright.Tests
TUnit.Playwright		TUnit.Playwright
TUnit.RpcTests		TUnit.RpcTests
TUnit.TestProject.Library		TUnit.TestProject.Library
TUnit.TestProject		TUnit.TestProject
TUnit.UnitTests		TUnit.UnitTests
TUnit		TUnit
assets		assets
docs		docs
tools		tools
.editorconfig		.editorconfig
.gitattributes		.gitattributes
.gitignore		.gitignore
Directory.Build.props		Directory.Build.props
Directory.Build.targets		Directory.Build.targets
Directory.Packages.props		Directory.Packages.props
GitVersion.yml		GitVersion.yml
LICENSE		LICENSE
Polyfill.props		Polyfill.props
README.md		README.md
README_Template.md		README_Template.md
TUnit.sln		TUnit.sln
renovate.json		renovate.json
rider.png		rider.png

License

thomhurst/TUnit

Folders and files

Latest commit

History

Repository files navigation

Documentation

Modern and Fast

Hooks, Events and Lifecycles

Built in Analyzers

IDE

Visual Studio

Rider

VS Code

CLI

Packages

TUnit.Core

TUnit.Engine

TUnit.Assertions

TUnit

TUnit.Playwright

Features

Installation

Example test

Motivations

Prerelease

Benchmark

Scenario: Building the test project

macos-latest

ubuntu-latest

windows-latest

Scenario: A single test that completes instantly (including spawning a new process and initialising the test framework)

macos-latest

ubuntu-latest

windows-latest

Scenario: A test that takes 50ms to execute, repeated 100 times (including spawning a new process and initialising the test framework)

macos-latest

ubuntu-latest

windows-latest

About

Resources

License

Stars

Watchers

Forks

Releases

Sponsor this project

Packages 0

Contributors 21

Languages

Packages