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 ReSharper, CodeRush, TestDriven.NET and Xamarin. 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 on Twitter: @xunit, @jamesnewkirk, @bradwilson, @onovotny
Discussions are held on Slack. Not a member yet? Sign up now!
Resharper 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

• Latest Builds
• Documentation
• Release Notes
• Test Runner Compatibility
• Github Projects
• Links to Resources
• Additional copyrights
• Laptop stickers!

Latest Builds

	Core framework	Visual Studio runner	Analyzers	Devices runner
Stable
Pre-Release (on NuGet)
CI Build (on MyGet)
For information about features and bug fixes, see the release notes.

Documentation

Getting Started

New to xUnit.net? These guides will help you get started. (If you're not sure which tutorial to use, start with the Desktop CLR tutorial.)

• Desktop CLR (traditional applications, including ASP.NET)
• .NET Core (including ASP.NET Core)
• Universal Windows Applications (Windows 10, Windows Phone 10)
• Devices (UWP, Windows 8.1, Windows Phone, Xamarin Android and Xamarin iOS)
• What NuGet packages should I use?

Configuration

• Configuring xUnit.net with JSON (all project types)
• Configuring xUnit.net with XML (desktop CLR projects only)
• What is the JSON schema for xunit.runner.json?

Unit Test Parallelism

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

Other Topics

• Capturing output
• Running tests in MSBuild
• Getting Test Results in TeamCity
• Getting Test Results in CruiseControl.NET
• Getting Test Results in Visual Studio Team Services (VSTS)

Frequently Asked Questions

• Why did we build xUnit 1.0?
• What is the format of the XML generated by the test runners?
• Comparing xUnit.net to other frameworks
• Getting the source and building xUnit.net

Migration

• Migrating unit tests from v1 to v2
• Where to find code that used to live in xunit.extensions

Release Notes

Version	Releases
2.3	Beta 3 Beta 2 Beta 1
2.2	RTM Beta 4 Beta 3 Beta 2 Beta 1
2.1	RTM RC 2 RC 1 Beta 4 Beta 3 Beta 2 Beta 1
2.0.1	RTM RC 1
2.0	RTM RC 4 RC 3 RC 2 RC 1 Beta 5

Test Runner Compatibility

	xUnit.net	xunit.console	dotnet xunit 2	MSBuild	TestDriven.NET	Visual Studio 3	Devices
Desktop Class Library	1.9.2+	✓ 5a	✓ 5a	✓ 5a	✓ 5a	✓ 5b (2012+)
.NET Core (Windows, Linux, OS X)	2.2+		✓ 5a	✓ 2,4a		✓ 5b (2017+)
Universal Windows Platform	2.1+					✓ 5b (2015+)	✓ 5c
Xamarin MonoAndroid 1	2.0+						✓ 5c
Xamarin iOS Unified 1	2.0+						✓ 5c
	↓ The project types below are supported but generally discouraged 4 ↓
Portable Class Library	2.0+	✓ 5a		✓ 5a	✓ 5a		✓ 5c
.NET Standard Class Library 1.1+	2.2+	✓ 5a		✓ 5a	✓ 5a		✓ 5c
	↓ The project types below have been officially deprecated ↓
Universal Application (Windows 8.1, Windows Phone 8.1)	2.0 - 2.1					✓ 5b (2013+)	✓ 5c
Windows Phone 8 (Silverlight)	2.0 - 2.1						✓ 5c
Xamarin MonoTouch (iOS Classic) 1	2.0 - 2.1						✓ 5c
Requires Xamarin for Visual Studio or Xamarin Studio. dotnet xunit and the .NET Core MSBuild runner only support xUnit.net v2.3 beta 2 and later. Visual Studio support includes the VS UI, vstest.console.exe, and dotnet test. Express editions are not supported. PCLs and netstandard libraries are linked against API sets, not frameworks, so several runners (Visual Studio, dotnet xunit, and dotnet test, plus potentially multi-framework third party runners) cannot determine the desired execution environment. Instead, your unit test projects should target platform-specific frameworks (like desktop CLR or netcoreapp). You can use multi-targeting when testing against multiple frameworks. Note that the library under test can still be a PCL or netstandard, and these suggestions only apply to the unit test project itself. 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)
• Resharper runner
• Visual Studio runner
• Devices runner
• Media files
• This site

Links to Resources

• Visual Studio Community
• .NET Framework 4.5.2
• TestDriven.NET
• ReSharper
• TeamCity
• MSBuild Reference

Additional copyrights

Portions copyright The Legion Of The Bouncy Castle

Laptop stickers!

Show your love for xUnit.net with one of our two laptop stickers, available from Sticker Mule.

Copyright © 2017 .NET Foundation. Contributions welcomed at https://github.com/xunit/xunit.github.io.