Table of Contents

Namespace NUnit.Framework

Classes

Assert

The Assert class contains a collection of static methods that implement the most common assertions used in NUnit.

AssertionException

Thrown when an assertion failed.

AssertionHelper

AssertionHelper is an optional base class for user tests, allowing the use of shorter ids for constraints and asserts and avoiding conflict with the definition of Is, from which it inherits much of its behavior, in certain mock object frameworks.

Assume

Provides static methods to express the assumptions that must be met for a test to give a meaningful result. If an assumption is not met, the test should produce an inconclusive result.

AuthorAttribute

Provides the Author of a test or test fixture.

CategoryAttribute

Attribute used to apply a category to a test

CollectionAssert

A set of Assert methods operationg on one or more collections

CombinatorialAttribute

Marks a test to use a combinatorial join of any argument data provided. Since this is the default, the attribute is optional.

CombiningStrategyAttribute

Marks a test to use a particular CombiningStrategy to join any parameter data provided. Since this is the default, the attribute is optional.

Contains

Helper class with properties and methods that supply a number of constraints used in Asserts.

CultureAttribute

CultureAttribute is used to mark a test fixture or an individual method as applying to a particular Culture only.

DataAttribute

The abstract base class for all data-providing attributes defined by NUnit. Used to select all data sources for a method, class or parameter.

DatapointAttribute

Used to mark a field for use as a datapoint when executing a theory within the same fixture that requires an argument of the field's Type.

DatapointSourceAttribute

Used to mark a field, property or method providing a set of datapoints to be used in executing any theories within the same fixture that require an argument of the Type provided. The data source may provide an array of the required Type or an IEnumerable<T>. Synonymous with DatapointsAttribute.

DatapointsAttribute

Used to mark a field, property or method providing a set of datapoints to be used in executing any theories within the same fixture that require an argument of the Type provided. The data source may provide an array of the required Type or an IEnumerable<T>. Synonymous with DatapointSourceAttribute.

DescriptionAttribute

Attribute used to provide descriptive text about a test case or fixture.

DirectoryAssert

Asserts on Directories

Does

Helper class with properties and methods that supply a number of constraints used in Asserts.

ExplicitAttribute

ExplicitAttribute marks a test or test fixture so that it will only be run if explicitly executed from the gui or command line or if it is included by use of a filter. The test will not be run simply because an enclosing suite is run.

FileAssert

Asserts on Files

FixtureBuilderAttribute

The abstract base class for all NUnit attributes that build fixtures. The derived class should implement IFixtureBuilder. It is not implemented by this class to allow for future fixture-building interfaces.

GlobalSettings

GlobalSettings is a place for setting default _values used by the framework in performing asserts.

Has

Helper class with properties and methods that supply a number of constraints used in Asserts.

IgnoreAttribute

Attribute used to mark a test that is to be ignored. Ignored tests result in a warning message when the tests are run.

IgnoreException

Thrown when an assertion failed.

IncludeExcludeAttribute

Abstract base for Attributes that are used to include tests in the test run based on environmental settings.

InconclusiveException

Thrown when a test executes inconclusively.

Is

Helper class with properties and methods that supply a number of constraints used in Asserts.

Iz

The Iz class is a synonym for Is intended for use in VB, which regards Is as a keyword.

LevelOfParallelizationAttribute

LevelOfParallelizationAttribute is used to set the number of worker threads that may be allocated by the framework for running tests.

List

The List class is a helper class with properties and methods that supply a number of constraints used with lists and collections.

ListMapper

ListMapper is used to transform a collection used as an actual argument producing another collection to be used in the assertion.

MaxTimeAttribute

Summary description for MaxTimeAttribute.

NUnitAttribute

The abstract base class for all custom attributes defined by NUnit.

OneTimeSetUpAttribute

Attribute used to identify a method that is called once to perform setup before any child tests are run.

OneTimeTearDownAttribute

Attribute used to identify a method that is called once after all the child tests have run. The method is guaranteed to be called, even if an exception is thrown.

PairwiseAttribute

Marks a test to use a pairwise join of any argument data provided. Arguments will be combined in such a way that all possible pairs of arguments are used.

ParallelizableAttribute

ParallelizableAttribute is used to mark tests that may be run in parallel.

PlatformAttribute

PlatformAttribute is used to mark a test fixture or an individual method as applying to a particular platform only.

PostTestAttribute

Attribute used to mark a class that contains one-time SetUp and/or TearDown methods that apply to all the tests in a namespace or an assembly.

PreTestAttribute

Attribute used to mark a class that contains one-time SetUp and/or TearDown methods that apply to all the tests in a namespace or an assembly.

PropertyAttribute

PropertyAttribute is used to attach information to a test as a name/value pair..

RandomAttribute

RandomAttribute is used to supply a set of random _values to a single parameter of a parameterized test.

RangeAttribute

RangeAttribute is used to supply a range of _values to an individual parameter of a parameterized test.

RequiresMTAAttribute

Marks a test that must run in the MTA, causing it to run in a separate thread if necessary.

On methods, you may also use MTAThreadAttribute to serve the same purpose.

RequiresSTAAttribute

Marks a test that must run in the STA, causing it to run in a separate thread if necessary.

RequiresThreadAttribute

Marks a test that must run on a separate thread.

ResultStateException

Abstract base for Exceptions that terminate a test and provide a ResultState.

SequentialAttribute

Marks a test to use a Sequential join of any argument data provided. Arguments will be combined into test cases, taking the next value of each argument until all are used.

SetCultureAttribute

Summary description for SetCultureAttribute.

SetUICultureAttribute

Summary description for SetUICultureAttribute.

SetUpAttribute

Attribute used to mark a class that contains one-time SetUp and/or TearDown methods that apply to all the tests in a namespace or an assembly.

SetUpFixtureAttribute

SetUpFixtureAttribute is used to identify a SetUpFixture

StringAssert

Basic Asserts on strings.

SuccessException

Thrown when an assertion failed.

TearDownAttribute

Attribute used to identify a method that is called immediately after each test is run. The method is guaranteed to be called, even if an exception is thrown.

TestActionAttribute

Provide actions to execute before and after tests.

TestAttribute

Adding this attribute to a method within a TestFixtureAttribute class makes the method callable from the NUnit test runner. There is a property called Description which is optional which you can provide a more detailed test description. This class cannot be inherited.

TestCaseAttribute

TestCaseAttribute is used to mark parameterized test cases and provide them with their arguments.

TestCaseBuilderAttribute

The abstract base class for all NUnit attributes that build test cases. The derived class should implement one of the test builder interfaces.

TestCaseData

The TestCaseData class represents a set of arguments and other parameter info to be used for a parameterized test case. It is derived from ParameterSet and adds a fluent syntax for use in initializing the test case.

TestCaseSourceAttribute

TestCaseSourceAttribute indicates the source to be used to provide test cases for a test method.

TestContext

Provide the context information of the current test. This is an adapter for the internal ExecutionContext class, hiding the internals from the user test.

TestContext.ResultAdapter

ResultAdapter adapts a TestResult for consumption by the user test code.

TestContext.TestAdapter

TestAdapter adapts a Test for consumption by the user test code.

TestFixtureAttribute
TestFixtureSetUpAttribute

Attribute used to identify a method that is called before any tests in a fixture are run.

TestFixtureTearDownAttribute

Attribute used to identify a method that is called after all the tests in a fixture have run. The method is guaranteed to be called, even if an exception is thrown.

TestOfAttribute

Indicates which class the test or test fixture is testing

TheoryAttribute

Adding this attribute to a method within a TestFixtureAttribute class makes the method callable from the NUnit test runner. There is a property called Description which is optional which you can provide a more detailed test description. This class cannot be inherited.

Throws

Helper class with properties and methods that supply constraints that operate on exceptions.

TimeoutAttribute

Used on a method, marks the test with a timeout value in milliseconds. The test will be run in a separate thread and is cancelled if the timeout is exceeded. Used on a class or assembly, sets the default timeout for all contained test methods.

ValueSourceAttribute

ValueSourceAttribute indicates the source to be used to provide data for one parameter of a test method.

ValuesAttribute

ValuesAttribute is used to provide literal arguments for an individual parameter of a test.

Interfaces

ITestAction

When implemented by an attribute, this interface implemented to provide actions to execute before and after tests.

Enums

ActionTargets

The different targets a test action attribute can be applied to

MessageMatch

Enumeration indicating how the expected message parameter is to be used

ParallelScope

The ParallelScope enumeration permits specifying the degree to which a test and its descendants may be run in parallel.

SpecialValue

The SpecialValue enum is used to represent TestCase arguments that cannot be used as arguments to an Attribute.

Delegates

TestDelegate

Delegate used by tests that execute code and capture any thrown exception.