This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Framework 6.1.11! |
Test Execution Events
The EventPublishingTestExecutionListener
introduced in Spring Framework 5.2 offers an
alternative approach to implementing a custom TestExecutionListener
. Components in the
test’s ApplicationContext
can listen to the following events published by the
EventPublishingTestExecutionListener
, each of which corresponds to a method in the
TestExecutionListener
API.
-
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 execution events rather than implementing
a custom TestExecutionListener
is that test execution 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
.
The Consequently, a If you wish to ensure that a Similarly, if |
In order to listen to test execution events, a Spring bean may choose to implement the
org.springframework.context.ApplicationListener
interface. Alternatively, listener
methods can be annotated with @EventListener
and configured to listen to one of the
particular event types listed above (see
Annotation-based Event Listeners).
Due to the popularity of this approach, Spring provides the following dedicated
@EventListener
annotations to simplify registration of test execution event listeners.
These annotations reside in the org.springframework.test.context.event.annotation
package.
-
@BeforeTestClass
-
@PrepareTestInstance
-
@BeforeTestMethod
-
@BeforeTestExecution
-
@AfterTestExecution
-
@AfterTestMethod
-
@AfterTestClass
Exception Handling
By default, if a test execution event listener throws an exception while consuming an
event, that exception will propagate to the underlying testing framework in use (such as
JUnit or TestNG). 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 execution 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 execution event listener to process events asynchronously,
you can use Spring’s regular @Async
support
. For further details, consult the class-level javadoc for
@EventListener
.