About xUnit.net

xUnit.net is a free, open source, community-focused unit testing tool for the .NET Framework. Written by the original inventor of NUnit v2, xUnit.net is the latest technology for unit testing C#, F#, VB.NET and other .NET languages. xUnit.net works with command line tools, Visual Studio, Visual Studio Code, ReSharper/Rider, CodeRush, and NCrunch. It is part of the .NET Foundation, and operates under their code of conduct. It is licensed under Apache 2 (an OSI approved license).

Follow: xUnit.net on Mastodon, xUnit.net on BlueSky, James Newkirk, Brad Wilson, Claire Novotny
Discussions are held on our discussions site.
Resharper/Rider support is provided and supported by JetBrains.
CodeRush support is provided and supported by DevExpress.
NCrunch support is provided and supported by Remco Software.
The xUnit.net logo was designed by Nathan Young.

Table of Contents

• Current Releases
• Documentation
• Test Runner Compatibility
• Github Projects
• Links to Resources
• Sponsors
• Additional copyrights

Current Releases

	Stable	Latest CI (how to use)	Build status
v3 core framework
v2 core framework
xunit.analyzers
xunit.runner.visualstudio

Latest Release Notes

	Stable	Prerelease
v3 core framework	2.0.3	3.0.0-pre.40	(all releases)
v2 core framework	2.9.3		(all releases)
xunit.analyzers	1.22.0	1.23.0-pre.3	(all releases)
xunit.runner.visualstudio	3.1.1		(all releases)

Documentation

Getting Started

New to xUnit.net? These guides will help you get started.

v3 Core Framework (.NET 8+ and .NET Framework 4.7.2+, cross-platform)

• Getting started with the .NET SDK command line
  Includes running tests from the command line, Visual Studio, Visual Studio Code, and JetBrains Rider
• API Documentation
• Migrating from xUnit.net v2 for unit test authors and extensibility authors
• What’s new in xUnit.net v3
• Microsoft Testing Platform support in v3
• Code Coverage with Microsoft Testing Platform
• Query Filter Language
• Serialization with IXunitSerializer and IXunitSerializable
• Writing a custom Runner Reporter for xUnit.net v3
• NuGet packages for xUnit.v3

v2 Core Framework

• .NET Core & .NET 5+ – cross-platform applications, including ASP.NET Core
  • Using command line (cross-platform)
  • Using Visual Studio (Windows)
• .NET Framework – Windows desktop & server applications, including ASP.NET
  • Using command line (cross-platform)
  • Using Visual Studio (Windows)
  • Using JetBrains Rider (cross-platform)
• Migrating from xUnit.net v1
• NuGet packages for xUnit.net v2

Source Analyzers

• xUnit.net analyzer documentation

Configuration

• Configuration files (aka xunit.runner.json)
• What is the JSON schema for xunit.runner.json?
• Using testconfig.json with Microsoft Testing Platform
• RunSettings and xunit.runner.visualstudio

Unit Test Parallelism

• Running tests in parallel
• Sharing context between tests (class, collection, and assembly fixtures)

Frequently Asked Questions

• Why did we build xUnit 1.0?
• How do I use a CI build NuGet package?
• What is the format of the XML generated by the test runners?
• How does xUnit.net compare to other frameworks?
• How do I build xUnit.net?
• Why doesn’t xUnit.net support netstandard?
• What is “theory data stability”?
• Where do I find code that used to live in xunit.extensions?

Other Topics

• Multi-targeting on non-Windows OSes
• Sample projects (including testing and extensibility)
• Capturing output
• Equality with hash sets vs. linear containers
• Running tests in MSBuild
• Getting Test Results in TeamCity
• Getting Test Results in CruiseControl.NET
• Getting Test Results in Azure DevOps

Test Runner Compatibility

The following target frameworks are current supported:

	xUnit.net	Console	MSBuild	TestDriven.NET 2	Visual Studio 3
.NET Framework (Windows)	v1, v2, v3	✔ 4a	✔ 4a	✔ 4a	✔ 4b
.NET Core & .NET 5+ (Windows, Linux, macOS)	v2 (2.2+), v3				✔ 4b

The following target frameworks have been deprecated and are no longer supported:

	xUnit.net	Visual Studio 2	Devices
Universal Application (Win/WinPhone 8.1)	v2 (2.0 - 2.1)	✔ 4b	✔ 4c
Universal Windows Platform	v2 (2.1 - 2.4.2)	✔ 4b	✔ 4c
Windows Phone 8 (Silverlight)	v2 (2.0 - 2.1)		✔ 4c
Xamarin iOS Unified 1	v2 (2.0 - 2.4.2)		✔ 4c
Xamarin MonoAndroid 1	v2 (2.0 - 2.4.2)		✔ 4c
Xamarin MonoTouch (iOS Classic) 1	v2 (2.0 - 2.1)		✔ 4c

1. Requires Xamarin for Visual Studio or Xamarin Studio.
2. TestDriven.NET is no longer officially supported in v3 Core Framework, and is only available in Visual Studio 2019 and earlier.
3. Visual Studio support includes the Visual Studio Test Explorer, Visual Studio Code, vstest.console.exe, and dotnet test. Express editions of Visual Studio are not supported. Minimum target frameworks for are higher for v2 Core Framework users: NET Framework 4.6.2+ and .NET 8+.
4. Test runner source code availability:
   a. https://github.com/xunit/xunit
   b. https://github.com/xunit/visualstudio.xunit
   c. https://github.com/xunit/devices.xunit

Github Projects

For information on contributing to xUnit.net, please read the governance document.

• xUnit.net (core framework, built-in runners)
• Assertion library
• Analyzers
• Visual Studio runner (Visual Studio, Visual Studio Code, dotnet test)
• Media files
• This site

Links to Resources

• Visual Studio Community
• MSBuild Reference

Sponsors

Help support this project by becoming a sponsor through GitHub Sponsors.

Additional copyrights

Portions copyright The Legion Of The Bouncy Castle

Copyright © .NET Foundation. Contributions welcomed at https://github.com/xunit/xunit/tree/gh-pages.