ExpectedExceptionAttribute Class
This page is specific to:.NET Framework Version:
2.03.54
Team Test API
ExpectedExceptionAttribute Class

Indicates that an exception is expected during test method execution. This class cannot be inherited.

Namespace: Microsoft.VisualStudio.TestTools.UnitTesting
Assembly: Microsoft.VisualStudio.QualityTools.UnitTestFramework (in microsoft.visualstudio.qualitytools.unittestframework.dll)

Syntax

'Usage

Dim instance As ExpectedExceptionAttribute


'Declaration

<AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple:=False)> _
Public NotInheritable Class ExpectedExceptionAttribute
	Inherits Attribute

/** @attribute AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple=false) */ 
public final class ExpectedExceptionAttribute extends Attribute

Remarks

This attribute is used to test whether an expected exception is thrown. The test method will pass if the expected exception is thrown. The test will fail if the thrown exception inherits from the expected exception.

If a test has both an ExpectedException attribute and an Assert statement, either one can cause the test to fail. To determine whether the attribute or the statement caused the test to fail, double-click the test result to open the Results Details page for the test. For more information about test results, see Test Results Reported.

This attribute can be specified on a method. There can be only one instance of this attribute on a method.

For more information about how to use attributes, see Extending Metadata Using Attributes.

Example

The following class contains the method to test:

Public Class DivisionClass
   Public Function Divide(ByVal numerator As Integer, ByVal denominator As Integer) As Integer
      Return numerator \ denominator
   End Function
End Class

The following test method tests the Divide method of the DivisionClass object. It tests for the existence of a DivideByZeroException.

Imports Microsoft.VisualStudio.TestTools.UnitTesting
Imports MyVBProject

<TestClass()> _
Public Class DivisionClassTest
    <TestMethod()> _
    <<b>ExpectedException</b>(GetType(System.DivideByZeroException), "MyMessage")> _
    Public Sub DivideTest()
        Dim target As DivisionClass = New DivisionClass
        Dim numerator As Integer = 4
        Dim denominator As Integer = 0
        Dim actual As Integer
        actual = target.Divide(numerator, denominator)
    End Sub
End Class
Inheritance Hierarchy

System.Object
   System.Attribute
    Microsoft.VisualStudio.TestTools.UnitTesting.ExpectedExceptionAttribute
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Community Content

Does not work in VS 2005 and VS 2008
Added by:Vaccanoll
This attribute does not work in 2005 or 2008. Not sure why, but it does not.

See this link for info about it (compared to NUnit)
http://mvwood.com/blog/8789/

See this link for a somewhat klugey work around:
http://blog.typemock.com/2009/03/how-to-check-exception-message-using-ms.html


This seems like it may work in VS 2010:
http://weblogs.asp.net/gunnarpeipman/archive/2009/07/25/expectedexception-attribute-in-visual-studio-2008-and-visual-studio- 2010.aspx
© 2010 Microsoft Corporation. All rights reserved.   Terms of Use | Trademarks | Privacy Statement
Page view tracker
Rate the Lightweight library
x
Lightweight builds on ScriptFree (loband) by adding features you've requested: a SearchBox and default code language selection.
Do you like the SearchBox?
Do you like the tabbed code blocks?
How useful is this topic?
Tell us more.
Thanks
x
You're helping to improve MSDN Online.
Feedback
Switch View
Classic
Lightweight Beta
ScriptFree
Switch View