org.springframework.test

Class AssertThrows

java.lang.Object

org.springframework.test.AssertThrows

Deprecated.

Favor use of JUnit's @Test(expected=...) or @Rule ExpectedException support or TestNG's @Test(expectedExceptions=...) support

@Deprecated
public abstract class AssertThrows
extends Object

AssertThrows is a simple method object that encapsulates the 'test-for-exception' scenario for unit testing. Intended for use with JUnit or TestNG.

Given the following business class...

 // 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 AssertThrows 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 Throwable was thrown, the test will also fail, this time with a message similar to the following:

"java.lang.AssertionError: Was expecting a [class java.lang.UnsupportedOperationException] to be thrown, but instead a [class java.lang.IllegalArgumentException] was thrown"

The test for the correct Throwable 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();
    }
 }

Since:

2.0

Author:

Rick Evans, Juergen Hoeller, Sam Brannen

Constructor Summary

Constructors

Constructor and Description
AssertThrows(Class<? extends Throwable> expectedException) Deprecated. Create a new instance of the AssertThrows class.
AssertThrows(Class<? extends Throwable> expectedException, String failureMessage) Deprecated. Create a new instance of the AssertThrows class.

Method Summary

Modifier and Type	Method and Description
protected void	checkExceptionExpectations(Throwable actualException) Deprecated. Does the donkey work of checking (verifying) that the Throwable that was thrown in the body of the test is an instance of the getExpectedException() class (or an instance of a subclass).
protected String	createMessageForNoExceptionThrown() Deprecated. Creates the failure message used if the test fails (i.e.
protected String	createMessageForWrongThrownExceptionType(Throwable actualException) Deprecated. Creates the failure message used if the wrong type of Throwable is thrown in the body of the test.
protected void	doFail() Deprecated. Template method called when the test fails; i.e.
Throwable	getActualException() Deprecated. Expose the actual exception thrown from test(), if any.
protected Class<? extends Throwable>	getExpectedException() Deprecated. Return the Throwable expected to be thrown during the execution of the surrounding test.
protected 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) Throwable.
void	setFailureMessage(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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssertThrows

public AssertThrows(Class<? extends Throwable> expectedException)

Deprecated.

Create a new instance of the AssertThrows class.

Parameters:

expectedException - the Throwable expected to be thrown during the execution of the surrounding test

Throws:

IllegalArgumentException - if the supplied expectedException is null; or if said argument is not a Throwable-derived class

AssertThrows

public AssertThrows(Class<? extends Throwable> expectedException,
                    String failureMessage)

Deprecated.

Create a new instance of the AssertThrows class.

Parameters:

expectedException - the Throwable expected to be thrown during the execution of the surrounding test

failureMessage - the extra, contextual failure message that will be included in the failure text if the text fails (can be null)

Throws:

IllegalArgumentException - if the supplied expectedException is null; or if said argument is not a Throwable-derived class

Method Detail

getExpectedException

protected Class<? extends Throwable> getExpectedException()

Deprecated.

Return the Throwable expected to be thrown during the execution of the surrounding test.

setFailureMessage

public void setFailureMessage(String failureMessage)

Deprecated.

Set the extra, contextual failure message that will be included in the failure text if the text fails.

getFailureMessage

protected String getFailureMessage()

Deprecated.

Return the extra, contextual failure message that will be included in the failure text if the text fails.

test

public abstract void test()
                   throws Throwable

Deprecated.

Subclass must override this abstract method and provide the test logic.

Throws:

Throwable - if an error occurs during the execution of the aforementioned test logic

runTest

public void runTest()

Deprecated.

The main template method that drives the running of the test logic and the checking of the resulting (expected) Throwable.

See Also:

test(), doFail(), checkExceptionExpectations(Throwable)

doFail

protected void doFail()

Deprecated.

Template method called when the test fails; i.e. the expected Throwable is not thrown.

The default implementation simply fails the test by throwing an AssertionError.

If you want to customize the failure message, consider overriding createMessageForNoExceptionThrown(), and / or supplying an extra, contextual failure message via the appropriate constructor.

See Also:

getFailureMessage(), createMessageForNoExceptionThrown()

createMessageForNoExceptionThrown

protected String createMessageForNoExceptionThrown()

Deprecated.

Creates the failure message used if the test fails (i.e. the expected exception is not thrown in the body of the test).

Returns:

the failure message used if the test fails

See Also:

getFailureMessage()

checkExceptionExpectations

protected void checkExceptionExpectations(Throwable actualException)

Deprecated.

Does the donkey work of checking (verifying) that the Throwable that was thrown in the body of the test is an instance of the getExpectedException() class (or an instance of a subclass).

If you want to customize the failure message, consider overriding createMessageForWrongThrownExceptionType(Throwable).

Parameters:

actualException - the Throwable that has been thrown in the body of a test method (will never be null)

createMessageForWrongThrownExceptionType

protected String createMessageForWrongThrownExceptionType(Throwable actualException)

Deprecated.

Creates the failure message used if the wrong type of Throwable is thrown in the body of the test.

Parameters:

actualException - the actual exception thrown

Returns:

the message for the given exception

getActualException

public final Throwable getActualException()

Deprecated.

Expose the actual exception thrown from test(), if any.

Returns:

the actual exception, or null if none