19 |
23 | NUnit tests may be written using any .NET language that supports attributes. 31 | 32 |
Attributes are used to indicate 33 | test classes and methods and to modify their behavior in various ways. 34 | 35 |
Assertions test an actual value 36 | against one or more Constraints and result in either a successful test or a failure. 37 | 38 |
User code may acquire information about the test and it's environment by 39 | use of the Test Context. 40 | 41 |
19 |
23 | | C# | 38 |https://github.com/nunit/nunit-csharp-samples | 39 |
|---|---|
| F# | 42 |https://github.com/nunit/nunit-fsharp-samples | 43 |
| VB.NET | 46 |https://github.com/nunit/nunit-vb-samples | 47 |
| C++ | 50 |https://github.com/nunit/nunit-cpp-samples | 51 |
19 |
23 | This documentation covers the NUnit 2.6.4 release, 31 | a bugfix release to NUnit 2.6.4. This is expected to be the last release of NUnit 32 | version 2, with all future work being done on NUnit 3.0. 33 | 34 |
Where applicable, we have marked sections with the version in which a feature 35 | first appeared.
36 | 37 |If you are new to NUnit, we suggest you begin by reading the 38 | Getting Started section of this site. 39 | Those who have used earlier releases may want to begin with the 40 | Upgrading section.
41 | 42 |See the 43 | Release Notes for more information on this release.
44 | 45 |All documentation is included in the release packages of NUnit. Beginning with NUnit 46 | 2.4.2, you may choose to download the documentation 47 | separately.
48 | 49 |
19 |
23 | NUnit is designed to be extended in a number of ways.
31 | 32 |Extensions to the NUnit framework - the part of NUnit that is referenced 33 | by tests - usually take the form of 34 | Custom Constraints, written by users to 35 | encapsulate tests that pertain to their specific projects.
36 | 37 |Extending the features found within NUnit itself depends on the use of 38 | NUnit Addins. 39 | Currently, The Addin mechanism only supports extensions to the NUnit core - 40 | the part of NUnit that builds and executes test suites. However, the API that 41 | is used provides for the future ability to extend the client side of NUnit, 42 | including the GUI.
43 | 44 | 45 |
19 |
23 | If you haven't already done so, go to our Download page, select a version of NUnit and download it. The 31 | Installation page 32 | contains instructions for installing on your system.
33 | 34 |To get started using NUnit, read the Quick Start page. This article demonstrates the development process with NUnit in the 35 | context of a C# banking application. Check the 36 | Samples page for additional examples, 37 | including some in VB.Net, J# and managed C++.
38 | 39 |NUnit has two different ways to run your tests. The 42 | console runner, nunit-console.exe, 43 | is the fastest to launch, but is not interactive. 44 | The gui runner, 45 | nunit.exe, is a Windows Forms application that allows you to work 46 | selectively with your tests and provides graphical feedback.
47 | 48 |
19 |
23 | In general, there are two approaches to running tests built against earlier 31 | versions of the NUnit framework from 2.0 through 2.5.10: 32 | 33 |
Note: 43 | NUnit 2.6 no longer recognizes "old style" test cases - those 44 | identified by a name beginning with "Test". If you have such tests, you will 45 | need to convert them to use the TestAttribute and recompile your tests. In such cases, it makes sense to recompile against 46 | the latest framework. 47 | 48 |
Tests originally compiled against a version of NUnit prior to 2.0 will need 51 | to be rewritten and recompiled in order to run under NUnit 2.6. 52 | 53 | 54 |
19 |
23 | Copyright © 2012-2014 Charlie Poole 31 | 32 |
Permission is hereby granted, free of charge, to any person obtaining 33 | a copy of this software and associated documentation files (the 34 | "Software"), to deal in the Software without restriction, including 35 | without limitation the rights to use, copy, modify, merge, publish, 36 | distribute, sublicense, and/or sell copies of the Software, and to 37 | permit persons to whom the Software is furnished to do so, subject to 38 | the following conditions: 39 | 40 |
The above copyright notice and this permission notice shall be 41 | included in all copies or substantial portions of the Software. 42 | 43 |
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 44 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 45 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 46 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 47 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 48 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 49 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 50 | 51 |
NUnit 2.6 assemblies distributed with this adapter are subject to the 54 | NUnit license. 55 | 56 | 57 |
19 |
23 | A SuiteBuilder is an addin used to build a test fixture from a type. NUnit itself 32 | uses a SuiteBuilder to recognize and build TestFixtures. 33 | 34 |
An addin may use the host to access this extension point by name: 36 | 37 |
38 | IExtensionPoint suiteBuilders = host.GetExtensionPoint( "SuiteBuilders" );39 | 40 |
The extension object passed to Install must implement the ISuiteBuilder interface: 42 | 43 |
44 | public interface ISuiteBuilder
45 | {
46 | bool CanBuildFrom( Type type );
47 | Test BuildFrom( Type type );
48 | }
49 |
50 |
51 | CanBuildFrom should return true if the specified Type is one from which 52 | the builder is able to create a fixture. This usually involve examining 53 | the Type and its attriutes. 54 | 55 |
The BuildFrom method should return a test fixture completely populated 56 | with its contained test cases. Return null if it is not possible to 57 | build a fixture using the provided Type. 58 | 59 | 60 |
19 |
23 | Assertions are central to unit testing in any of the xUnit frameworks, and NUnit 31 | is no exception. NUnit provides a rich set of assertions as static methods of 32 | the Assert class.
33 | 34 |If an assertion fails, the method call does not return and an error is reported. 35 | If a test contains multiple assertions, any that follow the one that failed 36 | will not be executed. For this reason, it's usually best to try for one 37 | assertion per test.
38 | 39 |Each method may be called without a message, with a simple text message or with 40 | a message and arguments. In the last case the message is formatted using the 41 | provided text and arguments.
42 | 43 |Before NUnit 2.4, a separate method of the Assert class was used for each 46 | different assertion. We call this the 47 | classic model. 48 | It continues to be supported in NUnit, since many people prefer it.
49 | 50 |Beginning with NUnit 2.4, a new 51 | constraint-based model was introduced. This approach uses a single method of the Assert class 52 | for all assertions, passing a Constraint object that specifies 53 | the test to be performed. 54 | 55 |
This constraint-based model is now used internally by NUnit 56 | for all assertions. The methods of the classic approach have been 57 | re-implemented on top of this new model. 58 | 59 | 65 | 66 |
19 |
23 | EventListeners are able to respond to events that occur in the course 32 | of a test run, usually by recording information of some kind. Note that 33 | EventListeners called asynchronously with respect to test execution and 34 | are not able to affect the actual execution of the test. 35 | 36 |
Addins use the host to access this extension point by name: 38 | 39 |
40 | IExtensionPoint listeners = host.GetExtensionPoint( "EventListeners" );41 | 42 |
The extension object passed to Install must implement the EventListener interface: 44 | 45 |
46 | public interface EventListener
47 | {
48 | void RunStarted( string name, int testCount );
49 | void RunFinished( TestResult result );
50 | void RunFinished( Exception exception );
51 | void TestStarted(TestName testName);
52 | void TestFinished(TestResult result);
53 | void SuiteStarted(TestName testName);
54 | void SuiteFinished(TestResult result);
55 | void UnhandledException( Exception exception );
56 | void TestOutput(TestOutput testOutput);
57 | }
58 |
59 |
60 | You must provide all the methods, but the body may be empty for any 61 | that you have no need of. 62 | 63 | 64 |
19 |
23 | The nunit-agent.exe program is used by other runners when the tests are being 31 | run in a separate process. It is not intended for direct execution by users. 32 | 33 |
NUnit runs tests in a separate process in several situations: 34 | 35 |
When debugging tests that are run in a separate process, it is 45 | not possible to do so by simply running the console or gui runner 46 | under the debugger. Rather, it is necessary to attach the debugger 47 | to the nunit-agent process after the tests have been loaded. 48 | 49 |
When running under the Gui, NUnit will continue to use the same 50 | process to reload tests so that it is not normally necessary to 51 | re-attach to a new process. However, if the settings are changed 52 | in a way that requires a different process - for example, by changing 53 | the version of the runtime that is being used - the old process will 54 | be terminated and a new one created. In that case, it's necessary 55 | to re-attach to the new process. 56 | 57 | 58 |
19 |
23 |
31 | Copyright © 2002-2014 Charlie Poole
32 | Copyright © 2002-2004 James W. Newkirk, Michael C. Two, Alexei A. Vorontsov
33 | Copyright © 2000-2002 Philip A. Craig
34 |
35 |
This software is provided 'as-is', without any express or implied warranty. In 36 | no event will the authors be held liable for any damages arising from the use 37 | of this software. 38 | 39 |
Permission is granted to anyone to use this software for any purpose, including 40 | commercial applications, and to alter it and redistribute it freely, subject to 41 | the following restrictions: 42 | 43 |
This license is based on 60 | the open source zlib/libpng license. The idea was to keep the license 61 | as simple as possible to encourage use of NUnit in free and commercial 62 | applications and libraries, but to keep the source code together and to give 63 | credit to the NUnit contributors for their efforts. While this license allows 64 | shipping NUnit in source and binary form, if shipping a NUnit variant is the 65 | sole purpose of your product, please let 66 | us know.
67 | 68 |
19 |
23 | The Addins Dialog is displayed using the Tools | Addins menu item on the main 31 | menu. It lists all addins that have been found and loaded by NUnit.
32 | 33 |
This column lists the name of the addin, as defined by its author. 39 | 40 |
This column shows the status of each addin. Possible values are 43 |
If the author of an addin has provided a description, it is 54 | shown here when the addin is selected. 55 | 56 |
If the addin failed to load, its status will be shown as Error 59 | and any error message displayed here when that addin is selected. 60 | 61 |
19 |
23 | An Extenders Guide will be published in the future. At the moment, writing an 31 | extension is a bit of an adventure. Extension authors are advised to join the 32 | nunit-developer list and post questions and comments there. 33 | 34 |
For the moment, the following tips may be of assistance. 35 |
19 |
23 | TestDecorators are able to modify a test after it has been constructed. 32 | 33 |
Addins use the host to access this extension point by name: 35 | 36 |
37 | IExtensionPoint testDecorators = host.GetExtensionPoint( "TestDecorators" );38 | 39 |
The extension object passed to Install must implement the ITestDecorator interface: 41 | 42 |
43 | public interface ITestDecorator
44 | {
45 | Test Decorate( Test test, MemberInfo member );
46 | }
47 |
48 |
49 | The Decorate method may do several things, depending on what it needs 50 | to accomplish: 51 |
Depending on what the decorator does, it may need to run 59 | ahead of other decorators or after them. Decorators should 60 | be installed using the Install method overload that takes 61 | a priority. The priorities range from 1 to 9 and decorators 62 | with lower priority values are installed first. The following 63 | standard values are defined for use if desired: 64 |