Table of Contents

Class Assume

Namespace
NUnit.Framework
Assembly
nunit.framework.dll

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.

public abstract class Assume
Inheritance
Assume
Inherited Members

Constructors

Assume()

protected Assume()

Methods

ReferenceEquals(object, object)

DO NOT USE! The ReferenceEquals method throws an InvalidOperationException. This is done to make sure there is no mistake by calling this function.

public static void ReferenceEquals(object a, object b)

Parameters

a object

The left object.

b object

The right object.

That(bool, NUnitString, string)

Asserts that a condition is true. If the condition is false, the method throws an InconclusiveException.

public static void That(bool condition, NUnitString message = default, string actualExpression = "")

Parameters

condition bool

The evaluated condition

message NUnitString

The message to display if the condition is false

actualExpression string

That(bool, FormattableString, string)

Asserts that a condition is true. If the condition is false, the method throws an InconclusiveException.

public static void That(bool condition, FormattableString message, string actualExpression = "")

Parameters

condition bool

The evaluated condition

message FormattableString

The message to display if the condition is false

actualExpression string

That(bool, Func<string>, string)

Asserts that a condition is true. If the condition is false, the method throws an InconclusiveException.

public static void That(bool condition, Func<string> getExceptionMessage, string actualExpression = "")

Parameters

condition bool

The evaluated condition

getExceptionMessage Func<string>

A function to build the message included with the Exception

actualExpression string

That(Func<bool>, NUnitString, string)

Asserts that a condition is true. If the condition is false, the method throws an InconclusiveException.

public static void That(Func<bool> condition, NUnitString message = default, string actualExpression = "")

Parameters

condition Func<bool>

A lambda that returns a Boolean

message NUnitString

The message to display if the condition is false

actualExpression string

That(Func<bool>, FormattableString, string)

Asserts that a condition is true. If the condition is false, the method throws an InconclusiveException.

public static void That(Func<bool> condition, FormattableString message, string actualExpression = "")

Parameters

condition Func<bool>

A lambda that returns a Boolean

message FormattableString

The message to display if the condition is false

actualExpression string

That(Func<bool>, Func<string>, string)

Asserts that a condition is true. If the condition is false, the method throws an InconclusiveException.

public static void That(Func<bool> condition, Func<string> getExceptionMessage, string actualExpression = "")

Parameters

condition Func<bool>

A lambda that returns a Boolean

getExceptionMessage Func<string>

A function to build the message included with the Exception

actualExpression string

That<TActual>(ActualValueDelegate<TActual>, IResolveConstraint, NUnitString, string, string)

Apply a constraint to an actual value, succeeding if the constraint is satisfied and throwing an InconclusiveException on failure.

public static void That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint expr, NUnitString message = default, string actualExpression = "", string constraintExpression = "")

Parameters

del ActualValueDelegate<TActual>

An ActualValueDelegate returning the value to be tested

expr IResolveConstraint

A Constraint expression to be applied

message NUnitString

The message that will be displayed on failure

actualExpression string
constraintExpression string

Type Parameters

TActual

The Type being compared.

That<TActual>(ActualValueDelegate<TActual>, IResolveConstraint, FormattableString, string, string)

Apply a constraint to an actual value, succeeding if the constraint is satisfied and throwing an InconclusiveException on failure.

public static void That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint expr, FormattableString message, string actualExpression = "", string constraintExpression = "")

Parameters

del ActualValueDelegate<TActual>

An ActualValueDelegate returning the value to be tested

expr IResolveConstraint

A Constraint expression to be applied

message FormattableString

The message that will be displayed on failure

actualExpression string
constraintExpression string

Type Parameters

TActual

The Type being compared.

That<TActual>(ActualValueDelegate<TActual>, IResolveConstraint, Func<string>, string, string)

Apply a constraint to an actual value, succeeding if the constraint is satisfied and throwing an InconclusiveException on failure.

public static void That<TActual>(ActualValueDelegate<TActual> del, IResolveConstraint expr, Func<string> getExceptionMessage, string actualExpression = "", string constraintExpression = "")

Parameters

del ActualValueDelegate<TActual>

An ActualValueDelegate returning the value to be tested

expr IResolveConstraint

A Constraint expression to be applied

getExceptionMessage Func<string>

A function to build the message included with the Exception

actualExpression string
constraintExpression string

Type Parameters

TActual

The Type being compared.

That<TActual>(TActual, IResolveConstraint, NUnitString, string, string)

Apply a constraint to an actual value, succeeding if the constraint is satisfied and throwing an InconclusiveException on failure.

public static void That<TActual>(TActual actual, IResolveConstraint expression, NUnitString message = default, string actualExpression = "", string constraintExpression = "")

Parameters

actual TActual

The actual value to test

expression IResolveConstraint

A Constraint expression to be applied

message NUnitString

The message that will be displayed on failure

actualExpression string
constraintExpression string

Type Parameters

TActual

The Type being compared.

That<TActual>(TActual, IResolveConstraint, FormattableString, string, string)

Apply a constraint to an actual value, succeeding if the constraint is satisfied and throwing an InconclusiveException on failure.

public static void That<TActual>(TActual actual, IResolveConstraint expression, FormattableString message, string actualExpression = "", string constraintExpression = "")

Parameters

actual TActual

The actual value to test

expression IResolveConstraint

A Constraint expression to be applied

message FormattableString

The message that will be displayed on failure

actualExpression string
constraintExpression string

Type Parameters

TActual

The Type being compared.

That<TActual>(TActual, IResolveConstraint, Func<string>, string, string)

Apply a constraint to an actual value, succeeding if the constraint is satisfied and throwing an InconclusiveException on failure.

public static void That<TActual>(TActual actual, IResolveConstraint expression, Func<string> getExceptionMessage, string actualExpression = "", string constraintExpression = "")

Parameters

actual TActual

The actual value to test

expression IResolveConstraint

A Constraint expression to be applied

getExceptionMessage Func<string>

A function to build the message included with the Exception

actualExpression string
constraintExpression string

Type Parameters

TActual

The Type being compared.