Assert Class

Definition

Namespace:

Microsoft.VisualStudio.TestTools.UnitTesting

Assembly:

MSTest.TestFramework.dll

Package:

MSTest.TestFramework v4.2.3

Source:

Assert.cs

A collection of helper classes to test various conditions within unit tests. If the condition being tested is not met, an exception is thrown.

[System.Runtime.CompilerServices.Nullable(0)]
public sealed class Assert

[<System.Runtime.CompilerServices.Nullable(0)>]
type Assert = class

Public NotInheritable Class Assert

Inheritance

Object

Assert

Attributes

NullableAttribute

Properties

Name	Description
That	Gets the singleton instance of the Assert functionality.

Methods

Name	Description
AreEqual(Decimal, Decimal, Decimal, Assert+AssertNonGenericAreEqualInterpolatedStringHandler, String, String)	Tests whether the specified decimals are equal and throws an exception if they are not equal.
AreEqual(Decimal, Decimal, Decimal, String, String, String)	Tests whether the specified decimals are equal and throws an exception if they are not equal.
AreEqual(Double, Double, Double, Assert+AssertNonGenericAreEqualInterpolatedStringHandler, String, String)	Tests whether the specified doubles are equal and throws an exception if they are not equal.
AreEqual(Double, Double, Double, String, String, String)	Tests whether the specified doubles are equal and throws an exception if they are not equal.
AreEqual(Int64, Int64, Int64, Assert+AssertNonGenericAreEqualInterpolatedStringHandler, String, String)	Tests whether the specified longs are equal and throws an exception if they are not equal.
AreEqual(Int64, Int64, Int64, String, String, String)	Tests whether the specified longs are equal and throws an exception if they are not equal.
AreEqual(Single, Single, Single, Assert+AssertNonGenericAreEqualInterpolatedStringHandler, String, String)	Tests whether the specified floats are equal and throws an exception if they are not equal.
AreEqual(Single, Single, Single, String, String, String)	Tests whether the specified floats are equal and throws an exception if they are not equal.
AreEqual(String, String, Boolean, Assert+AssertNonGenericAreEqualInterpolatedStringHandler, String, String)	Tests whether the specified strings are equal and throws an exception if they are not equal. The invariant culture is used for the comparison.
AreEqual(String, String, Boolean, CultureInfo, Assert+AssertNonGenericAreEqualInterpolatedStringHandler, String, String)	Tests whether the specified strings are equal and throws an exception if they are not equal.
AreEqual(String, String, Boolean, CultureInfo, String, String, String)	Tests whether the specified strings are equal and throws an exception if they are not equal.
AreEqual(String, String, Boolean, String, String, String)	Tests whether the specified strings are equal and throws an exception if they are not equal. The invariant culture is used for the comparison.
AreEqual<T>(T, T, Assert.AssertAreEqualInterpolatedStringHandler<T>, String, String)	Tests whether the specified values are equal and throws an exception if the two values are not equal. The equality is computed using the default EqualityComparer<T>.
AreEqual<T>(T, T, IEqualityComparer<T>, Assert.AssertAreEqualInterpolatedStringHandler<T>, String, String)	Tests whether the specified values are equal and throws an exception if the two values are not equal. The equality is computed using the provided comparer parameter.
AreEqual<T>(T, T, IEqualityComparer<T>, String, String, String)	Tests whether the specified values are equal and throws an exception if the two values are not equal. The equality is computed using the provided comparer parameter.
AreEqual<T>(T, T, String, String, String)	Tests whether the specified values are equal and throws an exception if the two values are not equal. The equality is computed using the default EqualityComparer<T>.
AreNotEqual(Decimal, Decimal, Decimal, Assert+AssertNonGenericAreNotEqualInterpolatedStringHandler, String, String)	Tests whether the specified decimals are unequal and throws an exception if they are equal.
AreNotEqual(Decimal, Decimal, Decimal, String, String, String)	Tests whether the specified decimals are unequal and throws an exception if they are equal.
AreNotEqual(Double, Double, Double, Assert+AssertNonGenericAreNotEqualInterpolatedStringHandler, String, String)	Tests whether the specified doubles are unequal and throws an exception if they are equal.
AreNotEqual(Double, Double, Double, String, String, String)	Tests whether the specified doubles are unequal and throws an exception if they are equal.
AreNotEqual(Int64, Int64, Int64, Assert+AssertNonGenericAreNotEqualInterpolatedStringHandler, String, String)	Tests whether the specified longs are unequal and throws an exception if they are equal.
AreNotEqual(Int64, Int64, Int64, String, String, String)	Tests whether the specified longs are unequal and throws an exception if they are equal.
AreNotEqual(Single, Single, Single, Assert+AssertNonGenericAreNotEqualInterpolatedStringHandler, String, String)	Tests whether the specified floats are unequal and throws an exception if they are equal.
AreNotEqual(Single, Single, Single, String, String, String)	Tests whether the specified floats are unequal and throws an exception if they are equal.
AreNotEqual(String, String, Boolean, Assert+AssertNonGenericAreNotEqualInterpolatedStringHandler, String, String)	Tests whether the specified strings are unequal and throws an exception if they are equal. The invariant culture is used for the comparison.
AreNotEqual(String, String, Boolean, CultureInfo, Assert+AssertNonGenericAreNotEqualInterpolatedStringHandler, String, String)	Tests whether the specified strings are unequal and throws an exception if they are equal.
AreNotEqual(String, String, Boolean, CultureInfo, String, String, String)	Tests whether the specified strings are unequal and throws an exception if they are equal.
AreNotEqual(String, String, Boolean, String, String, String)	Tests whether the specified strings are unequal and throws an exception if they are equal. The invariant culture is used for the comparison.
AreNotEqual<T>(T, T, Assert.AssertAreNotEqualInterpolatedStringHandler<T>, String, String)	Tests whether the specified values are unequal and throws an exception if the two values are equal. The equality is computed using the default EqualityComparer<T>.
AreNotEqual<T>(T, T, IEqualityComparer<T>, Assert.AssertAreNotEqualInterpolatedStringHandler<T>, String, String)	Tests whether the specified values are unequal and throws an exception if the two values are equal. The equality is computed using the default EqualityComparer<T>.
AreNotEqual<T>(T, T, IEqualityComparer<T>, String, String, String)	Tests whether the specified values are unequal and throws an exception if the two values are equal. The equality is computed using the provided comparer parameter.
AreNotEqual<T>(T, T, String, String, String)	Tests whether the specified values are unequal and throws an exception if the two values are equal. The equality is computed using the default EqualityComparer<T>.
AreNotSame<T>(T, T, Assert.AssertAreNotSameInterpolatedStringHandler<T>, String, String)	Tests whether the specified objects refer to different objects and throws an exception if the two inputs refer to the same object.
AreNotSame<T>(T, T, String, String, String)	Tests whether the specified objects refer to different objects and throws an exception if the two inputs refer to the same object.
AreSame<T>(T, T, Assert.AssertAreSameInterpolatedStringHandler<T>, String, String)	Tests whether the specified objects both refer to the same object and throws an exception if the two inputs do not refer to the same object.
AreSame<T>(T, T, String, String, String)	Tests whether the specified objects both refer to the same object and throws an exception if the two inputs do not refer to the same object.
Contains(Func<Object,Boolean>, IEnumerable, String, String, String)	Tests whether the specified collection contains the given element.
Contains(Object, IEnumerable, IEqualityComparer, String, String, String)	Tests whether the specified collection contains the given element.
Contains(Object, IEnumerable, String, String, String)	Tests whether the specified collection contains the given element.
Contains(String, String, String, String, String)	Tests whether the specified string contains the specified substring and throws an exception if the substring does not occur within the test string.
Contains(String, String, StringComparison, String, String, String)	Tests whether the specified string contains the specified substring and throws an exception if the substring does not occur within the test string.
Contains<T>(Func<T,Boolean>, IEnumerable<T>, String, String, String)	Tests whether the specified collection contains the given element.
Contains<T>(T, IEnumerable<T>, IEqualityComparer<T>, String, String, String)	Tests whether the specified collection contains the given element.
Contains<T>(T, IEnumerable<T>, String, String, String)	Tests whether the specified collection contains the given element.
ContainsSingle(Func<Object,Boolean>, IEnumerable, String, String, String)	Tests whether the specified collection contains exactly one element that matches the given predicate.
ContainsSingle(IEnumerable, String, String)	Tests whether the specified collection contains exactly one element.
ContainsSingle<T>(Func<T,Boolean>, IEnumerable<T>, String, String, String)	Tests whether the specified collection contains exactly one element that matches the given predicate.
ContainsSingle<T>(IEnumerable<T>, Assert.AssertSingleInterpolatedStringHandler<T>, String)	Tests whether the specified collection contains exactly one element.
ContainsSingle<T>(IEnumerable<T>, String, String)	Tests whether the specified collection contains exactly one element.
DoesNotContain(Func<Object,Boolean>, IEnumerable, String, String, String)	Tests whether the specified collection does not contain the specified item.
DoesNotContain(Object, IEnumerable, IEqualityComparer, String, String, String)	Tests whether the specified collection does not contain the specified item.
DoesNotContain(Object, IEnumerable, String, String, String)	Tests whether the specified collection does not contain the specified item.
DoesNotContain(String, String, String, String, String)	Tests whether the specified string does not contain the specified substring and throws an exception if the substring occurs within the test string.
DoesNotContain(String, String, StringComparison, String, String, String)	Tests whether the specified string does not contain the specified substring and throws an exception if the substring occurs within the test string.
DoesNotContain<T>(Func<T,Boolean>, IEnumerable<T>, String, String, String)	Tests whether the specified collection does not contain the specified item.
DoesNotContain<T>(T, IEnumerable<T>, IEqualityComparer<T>, String, String, String)	Tests whether the specified collection does not contain the specified item.
DoesNotContain<T>(T, IEnumerable<T>, String, String, String)	Tests whether the specified collection does not contain the specified item.
DoesNotEndWith(String, String, String, String, String)	Tests whether the specified string does not end with the specified unexpected suffix and throws an exception if the test string ends with the suffix.
DoesNotEndWith(String, String, StringComparison, String, String, String)	Tests whether the specified string does not end with the specified unexpected suffix and throws an exception if the test string does ends with the suffix.
DoesNotMatchRegex(Regex, String, String, String, String)	Tests whether the specified string does not match a regular expression and throws an exception if the string MatchesRegex the expression.
DoesNotMatchRegex(String, String, String, String, String)	Tests whether the specified string does not match a regular expression and throws an exception if the string MatchesRegex the expression.
DoesNotStartWith(String, String, String, String, String)	Tests whether the specified string does not begin with the specified unexpected prefix and throws an exception if the test string does start with the prefix.
DoesNotStartWith(String, String, StringComparison, String, String, String)	Tests whether the specified string does not begin with the specified unexpected prefix and throws an exception if the test string does start with the prefix.
EndsWith(String, String, String, String, String)	Tests whether the specified string ends with the specified suffix and throws an exception if the test string does not end with the suffix.
EndsWith(String, String, StringComparison, String, String, String)	Tests whether the specified string ends with the specified suffix and throws an exception if the test string does not end with the suffix.
Equals(Object, Object)	Obsolete. Static equals overloads are used for comparing instances of two types for reference equality. This method should not be used for comparison of two instances for equality. Please use Assert.AreEqual and associated overloads in your unit tests.
Fail(String)	Throws an AssertFailedException.
HasCount(Int32, IEnumerable, String, String)	Tests whether the collection has the expected count/length.
HasCount<T>(Int32, IEnumerable<T>, Assert.AssertCountInterpolatedStringHandler<T>, String)	Tests whether the collection has the expected count/length.
HasCount<T>(Int32, IEnumerable<T>, String, String)	Tests whether the collection has the expected count/length.
Inconclusive(String)	Throws an AssertInconclusiveException.
IsEmpty(IEnumerable, String, String)	Tests that the collection is empty.
IsEmpty<T>(IEnumerable<T>, Assert.AssertCountInterpolatedStringHandler<T>, String)	Tests that the collection is empty.
IsEmpty<T>(IEnumerable<T>, String, String)	Tests that the collection is empty.
IsExactInstanceOfType(Object, Type, Assert+AssertIsExactInstanceOfTypeInterpolatedStringHandler, String)	Tests whether the specified object is exactly an instance of the expected type and throws an exception if the expected type does not match exactly.
IsExactInstanceOfType(Object, Type, String, String)	Tests whether the specified object is exactly an instance of the expected type and throws an exception if the expected type does not match exactly.
IsExactInstanceOfType<T>(Object, Assert.AssertGenericIsExactInstanceOfTypeInterpolatedStringHandler<T>, String)	Tests whether the specified object is exactly an instance of the generic type and throws an exception if the generic type does not match exactly.
IsExactInstanceOfType<T>(Object, String, String)	Tests whether the specified object is exactly an instance of the generic type and throws an exception if the generic type does not match exactly.
IsFalse(Nullable<Boolean>, Assert+AssertIsFalseInterpolatedStringHandler, String)	Tests whether the specified condition is false and throws an exception if the condition is true.
IsFalse(Nullable<Boolean>, String, String)	Tests whether the specified condition is false and throws an exception if the condition is true.
IsGreaterThan<T>(T, T, String, String, String)	Tests whether the value is greater than the lower bound and throws an exception if it is not.
IsGreaterThanOrEqualTo<T>(T, T, String, String, String)	Tests whether the value is greater than or equal to the lower bound and throws an exception if it is not.
IsInRange<T>(T, T, T, String, String, String, String)	Tests whether the specified value is within the expected range (inclusive). The range includes both the minimum and maximum values.
IsInstanceOfType(Object, Type, Assert+AssertIsInstanceOfTypeInterpolatedStringHandler, String)	Tests whether the specified object is an instance of the expected type and throws an exception if the expected type is not in the inheritance hierarchy of the object.
IsInstanceOfType(Object, Type, String, String)	Tests whether the specified object is an instance of the expected type and throws an exception if the expected type is not in the inheritance hierarchy of the object.
IsInstanceOfType<T>(Object, Assert.AssertGenericIsInstanceOfTypeInterpolatedStringHandler<T>, String)	Tests whether the specified object is an instance of the generic type and throws an exception if the generic type is not in the inheritance hierarchy of the object.
IsInstanceOfType<T>(Object, String, String)	Tests whether the specified object is an instance of the generic type and throws an exception if the generic type is not in the inheritance hierarchy of the object.
IsLessThan<T>(T, T, String, String, String)	Tests whether the value is less than the upper bound and throws an exception if it is not.
IsLessThanOrEqualTo<T>(T, T, String, String, String)	Tests whether the value is less than or equal to the upper bound and throws an exception if it is not.
IsNegative<T>(T, String, String)	Tests whether the specified value is negative and throws an exception if it is not.
IsNotEmpty(IEnumerable, String, String)	Tests that the collection is not empty.
IsNotEmpty<T>(IEnumerable<T>, Assert.AssertIsNotEmptyInterpolatedStringHandler<T>, String)	Tests that the collection is not empty.
IsNotEmpty<T>(IEnumerable<T>, String, String)	Tests that the collection is not empty.
IsNotExactInstanceOfType(Object, Type, Assert+AssertIsNotExactInstanceOfTypeInterpolatedStringHandler, String)	Tests whether the specified object is not exactly an instance of the wrong type and throws an exception if the specified type matches exactly.
IsNotExactInstanceOfType(Object, Type, String, String)	Tests whether the specified object is not exactly an instance of the wrong type and throws an exception if the specified type matches exactly.
IsNotExactInstanceOfType<T>(Object, Assert.AssertGenericIsNotExactInstanceOfTypeInterpolatedStringHandler<T>, String)	Tests whether the specified object is not exactly an instance of the wrong generic type and throws an exception if the specified type matches exactly.
IsNotExactInstanceOfType<T>(Object, String, String)	Tests whether the specified object is not exactly an instance of the wrong generic type and throws an exception if the specified type matches exactly.
IsNotInstanceOfType(Object, Type, Assert+AssertIsNotInstanceOfTypeInterpolatedStringHandler, String)	Tests whether the specified object is not an instance of the wrong type and throws an exception if the specified type is in the inheritance hierarchy of the object.
IsNotInstanceOfType(Object, Type, String, String)	Tests whether the specified object is not an instance of the wrong type and throws an exception if the specified type is in the inheritance hierarchy of the object.
IsNotInstanceOfType<T>(Object, Assert.AssertGenericIsNotInstanceOfTypeInterpolatedStringHandler<T>, String)	Tests whether the specified object is not an instance of the wrong generic type and throws an exception if the specified type is in the inheritance hierarchy of the object.
IsNotInstanceOfType<T>(Object, String, String)	Tests whether the specified object is not an instance of the wrong generic type and throws an exception if the specified type is in the inheritance hierarchy of the object.
IsNotNull(Object, Assert+AssertIsNotNullInterpolatedStringHandler, String)	Tests whether the specified object is null and throws an exception if it is not.
IsNotNull(Object, String, String)	Tests whether the specified object is non-null and throws an exception if it is null.
IsNull(Object, Assert+AssertIsNullInterpolatedStringHandler, String)	Tests whether the specified object is null and throws an exception if it is not.
IsNull(Object, String, String)	Tests whether the specified object is null and throws an exception if it is not.
IsPositive<T>(T, String, String)	Tests whether the specified value is positive and throws an exception if it is not.
IsTrue(Nullable<Boolean>, Assert+AssertIsTrueInterpolatedStringHandler, String)	Tests whether the specified condition is true and throws an exception if the condition is false.
IsTrue(Nullable<Boolean>, String, String)	Tests whether the specified condition is true and throws an exception if the condition is false.
MatchesRegex(Regex, String, String, String, String)	Tests whether the specified string MatchesRegex a regular expression and throws an exception if the string does not match the expression.
MatchesRegex(String, String, String, String, String)	Tests whether the specified string MatchesRegex a regular expression and throws an exception if the string does not match the expression.
ReferenceEquals(Object, Object)	Obsolete. Static ReferenceEquals overloads are used for comparing instances of two types for reference equality. This method should not be used for comparison of two instances for reference equality. Please use Assert.AreSame and associated overloads in your unit tests.
StartsWith(String, String, String, String, String)	Tests whether the specified string begins with the specified prefix and throws an exception if the test string does not start with the prefix.
StartsWith(String, String, StringComparison, String, String, String)	Tests whether the specified string begins with the specified prefix and throws an exception if the test string does not start with the prefix.
Throws<TException>(Action, Assert.AssertNonStrictThrowsInterpolatedStringHandler<TException>, String)	Asserts that the delegate action throws an exception of type TException (or derived type) and throws AssertFailedException if code does not throw exception or throws exception of type other than TException.
Throws<TException>(Action, Func<Exception,String>, String)	Asserts that the delegate action throws an exception of type TException (or derived type) and throws AssertFailedException if code does not throw exception or throws exception of type other than TException.
Throws<TException>(Action, String, String)	Asserts that the delegate action throws an exception of type TException (or derived type) and throws AssertFailedException if code does not throw exception or throws exception of type other than TException.
Throws<TException>(Func<Object>, Assert.AssertNonStrictThrowsInterpolatedStringHandler<TException>, String)	Asserts that the delegate action throws an exception of type TException (or derived type) and throws AssertFailedException if code does not throw exception or throws exception of type other than TException.
Throws<TException>(Func<Object>, Func<Exception,String>, String)	Asserts that the delegate action throws an exception of type TException (or derived type) and throws AssertFailedException if code does not throw exception or throws exception of type other than TException.
Throws<TException>(Func<Object>, String, String)	Asserts that the delegate action throws an exception of type TException (or derived type) and throws AssertFailedException if code does not throw exception or throws exception of type other than TException.
ThrowsAsync<TException>(Func<Task>, Func<Exception,String>, String)	Asserts that the delegate action throws an exception of type TException (or derived type) and throws AssertFailedException if code does not throw exception or throws exception of type other than TException.
ThrowsAsync<TException>(Func<Task>, String, String)	Asserts that the delegate action throws an exception of type TException (or derived type) and throws AssertFailedException if code does not throw exception or throws exception of type other than TException.
ThrowsExactly<TException>(Action, Assert.AssertThrowsExactlyInterpolatedStringHandler<TException>, String)	Asserts that the delegate action throws an exception of type TException (and not of derived type) and throws AssertFailedException if code does not throw exception or throws exception of type other than TException.
ThrowsExactly<TException>(Action, Func<Exception,String>, String)	Asserts that the delegate action throws an exception of type TException (and not of derived type) and throws AssertFailedException if code does not throw exception or throws exception of type other than TException.
ThrowsExactly<TException>(Action, String, String)	Asserts that the delegate action throws an exception of type TException (and not of derived type) and throws AssertFailedException if code does not throw exception or throws exception of type other than TException.
ThrowsExactly<TException>(Func<Object>, Assert.AssertThrowsExactlyInterpolatedStringHandler<TException>, String)	Asserts that the delegate action throws an exception of type TException (and not of derived type) and throws AssertFailedException if code does not throw exception or throws exception of type other than TException.
ThrowsExactly<TException>(Func<Object>, Func<Exception,String>, String)	Asserts that the delegate action throws an exception of type TException (and not of derived type) and throws AssertFailedException if code does not throw exception or throws exception of type other than TException.
ThrowsExactly<TException>(Func<Object>, String, String)	Asserts that the delegate action throws an exception of type TException (and not of derived type) and throws AssertFailedException if code does not throw exception or throws exception of type other than TException.
ThrowsExactlyAsync<TException>(Func<Task>, Func<Exception,String>, String)	Asserts that the delegate action throws an exception of type TException (and not of derived type) and throws AssertFailedException if code does not throw exception or throws exception of type other than TException.
ThrowsExactlyAsync<TException>(Func<Task>, String, String)	Asserts that the delegate action throws an exception of type TException (and not of derived type) and throws AssertFailedException if code does not throw exception or throws exception of type other than TException.