NUnit

This article is about the C# unit testing framework. For the NGINX web application server, see NGINX Unit.

NUnit

NUnit 2.4.6 GUI on Windows
Original author(s)	Charlie Poole, James Newkirk, Alexei Vorontsov, Michael Two, Philip Craig, Rob Prouse, Simone Busoli, Neil Colvin
Developer(s)	The NUnit Project, .NET Foundation
Stable release	4.0.0 / 26 November 2023;1 day ago (2023-11-26)
Repository	github.com/nunit
Written in	C#
Operating system	.NET Framework, Mono
Type	Unit testing tool
License	MIT License for 3.0, BSD-style (modified zlib license) for 2.x
Website	www.nunit.org

NUnit is an open-source unit testing framework for the .NET Framework and Mono. It serves the same purpose as JUnit does in the Java world, and is one of many programs in the xUnit family.^{[ citation needed ]}

Features

• Tests can be run from a console runner, within Visual Studio through a Test Adapter, ^[1] or through 3rd party runners.
• Tests can be run in parallel. ^[2]
• Strong support for data driven tests. ^[3]
• Supports multiple platforms including .NET Core, ^[4] Xamarin Mobile, ^[5] Compact Framework ^[6] and Silverlight. ^[7]
• Every test case can be added to one or more categories, to allow for selective running. ^[8]

NUnit provides a console runner (nunit3-console.exe), which is used for batch execution of tests. The console runner works through the NUnit Test Engine, which provides it with the ability to load, explore and execute tests. When tests are to be run in a separate process, the engine makes use of the nunit-agent program to run them.^{[ citation needed ]}

The NUnitLite runner may be used in situations where a simpler runner is more suitable. It allows developers to create self-executing tests.^{[ citation needed ]}

Assertions

NUnit provides a rich set of assertions as static methods of the Assert class. If an assertion fails, the method call does not return and an error is reported. If a test contains multiple assertions, any that follow the one that failed will not be executed. For this reason, it's usually best to try for one assertion per test.^{[ citation needed ]}

Nunit 3.x is supporting multiple assertions.

[Test]publicvoidComplexNumberTest(){ComplexNumberresult=SomeCalculation();Assert.Multiple(()=>{Assert.AreEqual(5.2,result.RealPart,"Real part");Assert.AreEqual(3.9,result.ImaginaryPart,"Imaginary part");});}

Classical

Before NUnit 2.4, a separate method of the Assert class was used for each different assertion. It continues to be supported in NUnit, since many people prefer it.^{[ citation needed ]}

Each assert method may be called without a message, with a simple text message or with a message and arguments. In the last case the message is formatted using the provided text and arguments.^{[ citation needed ]}

// Equality assertsAssert.AreEqual(objectexpected,objectactual);Assert.AreEqual(objectexpected,objectactual,stringmessage,paramsobject[]parms);Assert.AreNotEqual(objectexpected,objectactual);Assert.AreNotEqual(objectexpected,objectactual,stringmessage,paramsobject[]parms);// Identity assertsAssert.AreSame(objectexpected,objectactual);Assert.AreSame(objectexpected,objectactual,stringmessage,paramsobject[]parms);Assert.AreNotSame(objectexpected,objectactual);Assert.AreNotSame(objectexpected,objectactual,stringmessage,paramsobject[]parms);// Condition asserts// (For simplicity, methods with message signatures are omitted.)Assert.IsTrue(boolcondition);Assert.IsFalse(boolcondition);Assert.IsNull(objectanObject);Assert.IsNotNull(objectanObject);Assert.IsNaN(doubleaDouble);Assert.IsEmpty(stringaString);Assert.IsNotEmpty(stringaString);Assert.IsEmpty(ICollectioncollection);Assert.IsNotEmpty(ICollectioncollection);

Constraint based

Beginning with NUnit 2.4, a new Constraint-based model was introduced. This approach uses a single method of the Assert class for all assertions, passing a Constraint object that specifies the test to be performed. This constraint-based model is now used internally by NUnit for all assertions. The methods of the classic approach have been re-implemented on top of this new model.^{[ citation needed ]}

Example

Example of an NUnit test fixture:^{[ citation needed ]}

usingNUnit.Framework;[TestFixture]publicclassExampleTestOfNUnit{[Test]publicvoidTestMultiplication(){Assert.AreEqual(4,2*2,"Multiplication");// Equivalently, since version 2.4 NUnit offers a new and// more intuitive assertion syntax based on constraint objects// [http://www.nunit.org/index.php?p=constraintModel&r=2.4.7]:Assert.That(2*2,Is.EqualTo(4),"Multiplication constraint-based");}}// The following example shows different ways of writing the same exception test.[TestFixture]publicclassAssertThrowsTests{[Test]publicvoidTests(){// .NET 1.xAssert.Throws(typeof(ArgumentException),newTestDelegate(MethodThatThrows));// .NET 2.0Assert.Throws<ArgumentException>(MethodThatThrows);Assert.Throws<ArgumentException>(delegate{thrownewArgumentException();});// Using C# 3.0     Assert.Throws<ArgumentException>(()=>{thrownewArgumentException();});}voidMethodThatThrows(){thrownewArgumentException();}}// This example shows use of the return value to perform additional verification of the exception.[TestFixture]publicclassUsingReturnValue{[Test]publicvoidTestException(){MyExceptionex=Assert.Throws<MyException>(delegate{thrownewMyException("message",42);});Assert.That(ex.Message,Is.EqualTo("message"));Assert.That(ex.MyParam,Is.EqualTo(42));}}// This example does the same thing using the overload that includes a constraint.[TestFixture]publicclassUsingConstraint{[Test]publicvoidTestException(){Assert.Throws(Is.Typeof<MyException>().And.Message.EqualTo("message").And.Property("MyParam").EqualTo(42),delegate{thrownewMyException("message",42);});}}

The NUnit framework discovers the method ExampleTestOfNUnit.TestMultiplication() automatically by reflection.^{[ citation needed ]}

Extensions

FireBenchmarks is an addin able to record execution time of unit tests and generate XML, CSV, XHTML performances reports with charts and history tracking. Its main purpose is to enable a developer or a team that work with an agile methodology to integrate performance metrics and analysis into the unit testing environment, to easily control and monitor the evolution of a software system in terms of algorithmic complexity and system resources load.^{[ citation needed ]}

NUnit.Forms is an expansion to the core NUnit framework and is also open source. It specifically looks at expanding NUnit to be able to handle testing user interface elements in Windows Forms. As of January 2013, Nunit.Forms is in Alpha release, and no versions have been released since May 2006.^{[ citation needed ]}

NUnit.ASP is a discontinued ^[9] expansion to the core NUnit framework and is also open source. It specifically looks at expanding NUnit to be able to handle testing user interface elements in ASP.Net.^{[ citation needed ]}

See also

• Free and open-source software portal

• Test automation
• List of unit testing frameworks for .NET programming languages (includes column indicating which are based on xUnit)
• XUnit.net
• JUnit

References

1. "NUnit 3 Test Adapter".
2. "Parallelizable Attribute". GitHub .
3. "TestCaseData". GitHub .
4. Prouse, Rob (2015-11-04). "Testing .NET Core using NUnit 3".
5. Prouse, Rob (2015-03-25). "NUnit 3.0 Test Runner for Android and iOS".
6. "NUnit Version 3 for Compact Framework".
7. "NUnit Version 3 for SilverLight 5.0".
8. "CategoryAttribute". GitHub . Retrieved 2015-12-15.
9. "NUnit.ASP website main page". SourceForge . Retrieved 2008-04-15.

Bibliography

• Hunt, Andrew; Thomas, David (2007). Pragmatic Unit Testing in C# with NUnit, 2nd Ed. The Pragmatic Bookshelf (Raleigh), 2007. ISBN   0-9776166-7-3.
• Newkirk, Jim; Vorontsov, Alexei (2004). Test-Driven Development in Microsoft .NET. Microsoft Press (Redmond), 2004. ISBN   0-7356-1948-4.
• Hamilton, Bill (2004). NUnit Pocket Reference. O'Reilly (Cambridge), 2004. ISBN   0-596-00739-6.

External links

• Official website
• GitHub Site
• Launchpad Site (no longer maintained)
• Test-driven Development with NUnit & Test-driven.NET video demonstration
• NUnit.Forms home page
• NUnitAsp homepage
• Article Improving Application Quality Using Test-Driven Development provides an introduction to TDD with concrete examples using Nunit
• Open source tool, which can execute nunit tests in parallel
• Charlie Poole, co-developer
• Rob Prouse, co-developer
• Simone Busoli, co-developer