org.springframework.test.context.event

Class EventPublishingTestExecutionListener

java.lang.Object

org.springframework.test.context.support.AbstractTestExecutionListener

org.springframework.test.context.event.EventPublishingTestExecutionListener

All Implemented Interfaces:

Ordered, TestExecutionListener

public class EventPublishingTestExecutionListener
extends AbstractTestExecutionListener

TestExecutionListener that publishes test execution events to the ApplicationContext for the currently executing test.

Supported Events

• BeforeTestClassEvent
• PrepareTestInstanceEvent
• BeforeTestMethodEvent
• BeforeTestExecutionEvent
• AfterTestExecutionEvent
• AfterTestMethodEvent
• AfterTestClassEvent

These events may be consumed for various reasons, such as resetting mock beans or tracing test execution. One advantage of consuming test events rather than implementing a custom TestExecutionListener is that test events may be consumed by any Spring bean registered in the test ApplicationContext, and such beans may benefit directly from dependency injection and other features of the ApplicationContext. In contrast, a TestExecutionListener is not a bean in the ApplicationContext.

Note that the EventPublishingTestExecutionListener is registered by default; however, it only publishes events if the ApplicationContext has already been loaded. This prevents the ApplicationContext from being loaded unnecessarily or too early. Consequently, a BeforeTestClassEvent will not be published until after the ApplicationContext has been loaded by another TestExecutionListener. For example, with the default set of TestExecutionListeners registered, a BeforeTestClassEvent will not be published for the first test class that uses a particular test ApplicationContext, but a BeforeTestClassEvent will be published for any subsequent test class in the same test suite that uses the same test ApplicationContext since the context will already have been loaded when subsequent test classes run (as long as the context has not been removed from the ContextCache via @DirtiesContext or the max-size eviction policy). If you wish to ensure that a BeforeTestClassEvent is published for every test class, you need to register a TestExecutionListener that loads the ApplicationContext in the beforeTestClass callback, and that TestExecutionListener must be registered before the EventPublishingTestExecutionListener. Similarly, if @DirtiesContext is used to remove the ApplicationContext from the context cache after the last test method in a given test class, the AfterTestClassEvent will not be published for that test class.

Exception Handling

By default, if a test event listener throws an exception while consuming a test event, that exception will propagate to the underlying testing framework in use. For example, if the consumption of a BeforeTestMethodEvent results in an exception, the corresponding test method will fail as a result of the exception. In contrast, if an asynchronous test event listener throws an exception, the exception will not propagate to the underlying testing framework. For further details on asynchronous exception handling, consult the class-level Javadoc for @EventListener.

Asynchronous Listeners

If you want a particular test event listener to process events asynchronously, you can use Spring's @Async support. For further details, consult the class-level Javadoc for @EventListener.

Since:

5.2

Author:

Sam Brannen, Frank Scheffler

See Also:

@BeforeTestClass, @PrepareTestInstance, @BeforeTestMethod, @BeforeTestExecution, @AfterTestExecution, @AfterTestMethod, @AfterTestClass

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
EventPublishingTestExecutionListener()

Method Summary

Modifier and Type	Method and Description
void	afterTestClass(TestContext testContext) Publish an AfterTestClassEvent to the ApplicationContext for the supplied TestContext.
void	afterTestExecution(TestContext testContext) Publish an AfterTestExecutionEvent to the ApplicationContext for the supplied TestContext.
void	afterTestMethod(TestContext testContext) Publish an AfterTestMethodEvent to the ApplicationContext for the supplied TestContext.
void	beforeTestClass(TestContext testContext) Publish a BeforeTestClassEvent to the ApplicationContext for the supplied TestContext.
void	beforeTestExecution(TestContext testContext) Publish a BeforeTestExecutionEvent to the ApplicationContext for the supplied TestContext.
void	beforeTestMethod(TestContext testContext) Publish a BeforeTestMethodEvent to the ApplicationContext for the supplied TestContext.
int	getOrder() Returns 10000.
void	prepareTestInstance(TestContext testContext) Publish a PrepareTestInstanceEvent to the ApplicationContext for the supplied TestContext.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventPublishingTestExecutionListener

public EventPublishingTestExecutionListener()

Method Detail

getOrder

public final int getOrder()

Returns 10000.

Specified by:

getOrder in interface Ordered

Overrides:

getOrder in class AbstractTestExecutionListener

Returns:

the order value

See Also:

Ordered.HIGHEST_PRECEDENCE, Ordered.LOWEST_PRECEDENCE

beforeTestClass

public void beforeTestClass(TestContext testContext)

Publish a BeforeTestClassEvent to the ApplicationContext for the supplied TestContext.

Specified by:

beforeTestClass in interface TestExecutionListener

Overrides:

beforeTestClass in class AbstractTestExecutionListener

Parameters:

testContext - the test context for the test; never null

prepareTestInstance

public void prepareTestInstance(TestContext testContext)

Publish a PrepareTestInstanceEvent to the ApplicationContext for the supplied TestContext.

Specified by:

prepareTestInstance in interface TestExecutionListener

Overrides:

prepareTestInstance in class AbstractTestExecutionListener

Parameters:

testContext - the test context for the test; never null

beforeTestMethod

public void beforeTestMethod(TestContext testContext)

Publish a BeforeTestMethodEvent to the ApplicationContext for the supplied TestContext.

Specified by:

beforeTestMethod in interface TestExecutionListener

Overrides:

beforeTestMethod in class AbstractTestExecutionListener

Parameters:

testContext - the test context in which the test method will be executed; never null

See Also:

TestExecutionListener.afterTestMethod(org.springframework.test.context.TestContext), TestExecutionListener.beforeTestExecution(org.springframework.test.context.TestContext), TestExecutionListener.afterTestExecution(org.springframework.test.context.TestContext)

beforeTestExecution

public void beforeTestExecution(TestContext testContext)

Publish a BeforeTestExecutionEvent to the ApplicationContext for the supplied TestContext.

Specified by:

beforeTestExecution in interface TestExecutionListener

Overrides:

beforeTestExecution in class AbstractTestExecutionListener

Parameters:

testContext - the test context in which the test method will be executed; never null

See Also:

TestExecutionListener.beforeTestMethod(org.springframework.test.context.TestContext), TestExecutionListener.afterTestMethod(org.springframework.test.context.TestContext), TestExecutionListener.afterTestExecution(org.springframework.test.context.TestContext)

afterTestExecution

public void afterTestExecution(TestContext testContext)

Publish an AfterTestExecutionEvent to the ApplicationContext for the supplied TestContext.

Specified by:

afterTestExecution in interface TestExecutionListener

Overrides:

afterTestExecution in class AbstractTestExecutionListener

Parameters:

testContext - the test context in which the test method will be executed; never null

See Also:

TestExecutionListener.beforeTestMethod(org.springframework.test.context.TestContext), TestExecutionListener.afterTestMethod(org.springframework.test.context.TestContext), TestExecutionListener.beforeTestExecution(org.springframework.test.context.TestContext)

afterTestMethod

public void afterTestMethod(TestContext testContext)

Publish an AfterTestMethodEvent to the ApplicationContext for the supplied TestContext.

Specified by:

afterTestMethod in interface TestExecutionListener

Overrides:

afterTestMethod in class AbstractTestExecutionListener

Parameters:

testContext - the test context in which the test method was executed; never null

See Also:

TestExecutionListener.beforeTestMethod(org.springframework.test.context.TestContext), TestExecutionListener.beforeTestExecution(org.springframework.test.context.TestContext), TestExecutionListener.afterTestExecution(org.springframework.test.context.TestContext)

afterTestClass

public void afterTestClass(TestContext testContext)

Publish an AfterTestClassEvent to the ApplicationContext for the supplied TestContext.

Specified by:

afterTestClass in interface TestExecutionListener

Overrides:

afterTestClass in class AbstractTestExecutionListener

Parameters:

testContext - the test context for the test; never null