@Test(expected=...)
support@Deprecated
public abstract class AssertThrows
extends java.lang.Object
Used like so:
// the class under test public class Foo { public void someBusinessLogic(String name) { if (name == null) { throw new IllegalArgumentException("The 'name' argument is required"); } // rest of business logic here... } }The test for the above bad argument path can be expressed using the
AssertThrows
class like so:
public class FooTest { public void testSomeBusinessLogicBadArgumentPath() { new AssertThrows(IllegalArgumentException.class) { public void test() { new Foo().someBusinessLogic(null); } }.runTest(); } }This will result in the test passing if the
Foo.someBusinessLogic(..)
method threw an IllegalArgumentException
; if it did not, the
test would fail with the following message:
"Must have thrown a [class java.lang.IllegalArgumentException]"If the wrong type of
Exception
was thrown, the
test will also fail, this time with a message similar to the following:
"junit.framework.AssertionFailedError: Was expecting a [class java.lang.UnsupportedOperationException] to be thrown, but instead a [class java.lang.IllegalArgumentException] was thrown"The test for the correct
Exception
respects polymorphism,
so you can test that any old Exception
is thrown like so:
public class FooTest { public void testSomeBusinessLogicBadArgumentPath() { // any Exception will do... new AssertThrows(Exception.class) { public void test() { new Foo().someBusinessLogic(null); } }.runTest(); } }Intended for use with JUnit 4 and TestNG (as of Spring 3.0). You might want to compare this class with the
junit.extensions.ExceptionTestCase
class.Modifier and Type | Field and Description |
---|---|
private java.lang.Exception |
actualException
Deprecated.
|
private java.lang.Class |
expectedException
Deprecated.
|
private java.lang.String |
failureMessage
Deprecated.
|
Constructor and Description |
---|
AssertThrows(java.lang.Class expectedException)
Deprecated.
Create a new instance of the
AssertThrows class. |
AssertThrows(java.lang.Class expectedException,
java.lang.String failureMessage)
Deprecated.
Create a new instance of the
AssertThrows class. |
Modifier and Type | Method and Description |
---|---|
protected void |
checkExceptionExpectations(java.lang.Exception actualException)
Deprecated.
Does the donkey work of checking (verifying) that the
Exception that was thrown in the body of a test is
an instance of the getExpectedException() class (or an
instance of a subclass). |
protected java.lang.String |
createMessageForNoExceptionThrown()
Deprecated.
Creates the failure message used if the test fails
(i.e.
|
protected java.lang.String |
createMessageForWrongThrownExceptionType(java.lang.Exception actualException)
Deprecated.
Creates the failure message used if the wrong type
of
Exception is thrown in the body of the test. |
protected void |
doFail()
Deprecated.
Template method called when the test fails; i.e.
|
java.lang.Exception |
getActualException()
Deprecated.
Expose the actual exception thrown from
test() , if any. |
protected java.lang.Class |
getExpectedException()
Deprecated.
Return the
Exception expected to be thrown during
the execution of the surrounding test. |
protected java.lang.String |
getFailureMessage()
Deprecated.
Return the extra, contextual failure message that will be included
in the failure text if the text fails.
|
void |
runTest()
Deprecated.
The main template method that drives the running of the
test logic and the
checking of the
resulting (expected) Exception . |
void |
setFailureMessage(java.lang.String failureMessage)
Deprecated.
Set the extra, contextual failure message that will be included
in the failure text if the text fails.
|
abstract void |
test()
Deprecated.
Subclass must override this
abstract method and
provide the test logic. |
private final java.lang.Class expectedException
private java.lang.String failureMessage
private java.lang.Exception actualException
public AssertThrows(java.lang.Class expectedException)
AssertThrows
class.expectedException
- the Exception
expected to be
thrown during the execution of the surrounding testjava.lang.IllegalArgumentException
- if the supplied expectedException
is
null
; or if said argument is not an Exception
-derived classpublic AssertThrows(java.lang.Class expectedException, java.lang.String failureMessage)
AssertThrows
class.expectedException
- the Exception
expected to be
thrown during the execution of the surrounding testfailureMessage
- the extra, contextual failure message that will be
included in the failure text if the text fails (can be null
)java.lang.IllegalArgumentException
- if the supplied expectedException
is
null
; or if said argument is not an Exception
-derived classprotected java.lang.Class getExpectedException()
Exception
expected to be thrown during
the execution of the surrounding test.public void setFailureMessage(java.lang.String failureMessage)
protected java.lang.String getFailureMessage()
public abstract void test() throws java.lang.Exception
abstract
method and
provide the test logic.java.lang.Exception
- if an error occurs during the execution of the
aformentioned test logicpublic void runTest()
test logic
and the
checking
of the
resulting (expected) Exception
.test()
,
doFail()
,
checkExceptionExpectations(Exception)
protected void doFail()
Exception
is not thrown.
The default implementation simply fails the test via a call to
org.junit.Assert#fail(String)
.
If you want to customise the failure message, consider overriding
createMessageForNoExceptionThrown()
, and / or supplying an
extra, contextual failure message via the appropriate constructor overload.
getFailureMessage()
protected java.lang.String createMessageForNoExceptionThrown()
getFailureMessage()
protected void checkExceptionExpectations(java.lang.Exception actualException)
Exception
that was thrown in the body of a test is
an instance of the getExpectedException()
class (or an
instance of a subclass).
If you want to customise the failure message, consider overriding
createMessageForWrongThrownExceptionType(Exception)
.
actualException
- the Exception
that has been thrown
in the body of a test method (will never be null
)protected java.lang.String createMessageForWrongThrownExceptionType(java.lang.Exception actualException)
Exception
is thrown in the body of the test.actualException
- the actual exception thrownpublic final java.lang.Exception getActualException()
test()
, if any.null
if none