NUnit 3 Console and Engine

NUnit is a unit-testing framework for all .NET languages. Initially ported from JUnit, the current production release, version 3, has been completely rewritten with many new features and support for a wide range of .NET platforms.

Table of Contents

• Downloads
• Documentation
• Contributing
• License
• NUnit Projects

Downloads

The latest stable release of the NUnit Console is available on NuGet, Chocolatey, or can be downloaded from GitHub. Pre-release builds are available on MyGet.

The Console/Engine are available in various packages:

• NUnit.ConsoleRunner: The NUnit Console, with no extensions.
• NUnit.Console: The NUnit Console, with key extensions additionally packaged. Also available as an msi installer, you may need to add your actual msi install location to the Path environment variable after installing, for example: C:\Program Files (x86)\NUnit.org\nunit-console.
• NUnit.Engine & NUnit.Engine.Api: Packages intended for custom runners integrating directly with the NUnit Engine.

Documentation

Documentation for all NUnit projects are hosted on GitHub at https://github.com/nunit/docs/wiki.

• NUnit Documentation
• Installation
• Release Notes
• Code Samples

Contributing

For more information on contributing to the NUnit project, please see CONTRIBUTING.md and the Developer Docs.

NUnit 3.0 was created by Charlie Poole, Rob Prouse, Simone Busoli, Neil Colvin and numerous community contributors. A complete list of contributors since the nunit-console repository was created can be found on GitHub.

Earlier versions of NUnit were developed by Charlie Poole, James W. Newkirk, Alexei A. Vorontsov, Michael C. Two and Philip A. Craig.

License

NUnit is Open Source software and NUnit 3 is released under the MIT license. Earlier releases used the NUnit license. Both of these licenses allow the use of NUnit in free and commercial applications and libraries without restrictions.

NUnit Projects

NUnit is made up of several projects. When reporting issues, please try to report issues in the correct project.

Core Projects

• NUnit Test Framework - The test framework used to write NUnit tests
• NUnit Console and Engine - Runs unit tests from the command line and provides the engine that is used by other test runners to run NUnit tests

Visual Studio Extensions

• NUnit 3 Visual Studio Adapter - Visual Studio adapter for running NUnit 3 tests in Visual Studio and in VSTS/TFS builds
• NUnit Visual Studio Templates - Project templates and snippets for writing unit tests in Visual Studio
• Visual Studio Test Generator - Generates NUnit tests in Visual Studio
• NUnit 2 Visual Studio Adapter - Visual Studio adapter for running older NUnit 2.x tests in Visual Studio and in VSTS/TFS builds

Other Projects

• NUnit Xamarin Runner - Runs NUnit 3 tests on mobile devices using the Xamarin framework

NUnit Engine Extensions

• NUnit 2 Driver - Allows the NUnit 3 engine to run NUnit 2 tests
• NUnit 2 Result Writer - Writes test results in the legacy NUnit 2 format
• Visual Studio Project Loader - Loads and parses Visual Studio projects and solutions
• NUnit Project Loader - Loads NUnit projects
• TeamCity Event Listener - Allows you to run and integrate NUnit tests into TeamCity