Annotation Interface TestExecutionListeners
TestExecutionListeners defines class-level metadata for configuring
which TestExecutionListeners should be
registered with a TestContextManager.
Typically, @TestExecutionListeners will be used in conjunction
with @ContextConfiguration.
This annotation may be used as a meta-annotation to create custom composed annotations.
As of Spring Framework 5.3, this annotation will be inherited from an
enclosing test class by default. See
@NestedTestConfiguration for details.
- Since:
- 2.5
- Author:
- Sam Brannen
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumEnumeration of modes that dictate whether or not explicitly declared listeners are merged with the default listeners when@TestExecutionListenersis declared on a class that does not inherit listeners from a superclass. -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionbooleanWhether or notTestExecutionListenersfrom superclasses should be inherited.Class<? extends TestExecutionListener>[]TheTestExecutionListenersto register with theTestContextManager.The merge mode to use when@TestExecutionListenersis declared on a class that does not inherit listeners from a superclass.Class<? extends TestExecutionListener>[]Alias forlisteners().
-
Element Details
-
value
Alias forlisteners().This attribute may not be used in conjunction with
listeners(), but it may be used instead oflisteners().- Default:
- {}
-
listeners
TheTestExecutionListenersto register with theTestContextManager.This attribute may not be used in conjunction with
value(), but it may be used instead ofvalue().- See Also:
- Default:
- {}
-
inheritListeners
boolean inheritListenersWhether or notTestExecutionListenersfrom superclasses should be inherited.The default value is
true, which means that an annotated class will inherit the listeners defined by an annotated superclass. Specifically, the listeners for an annotated class will be appended to the list of listeners defined by an annotated superclass. Thus, subclasses have the option of extending the list of listeners. In the following example,AbstractBaseTestwill be configured withDependencyInjectionTestExecutionListenerandDirtiesContextTestExecutionListener; whereas,TransactionalTestwill be configured withDependencyInjectionTestExecutionListener,DirtiesContextTestExecutionListener, andTransactionalTestExecutionListener, in that order.@TestExecutionListeners({ DependencyInjectionTestExecutionListener.class, DirtiesContextTestExecutionListener.class }) public abstract class AbstractBaseTest { // ... } @TestExecutionListeners(TransactionalTestExecutionListener.class) public class TransactionalTest extends AbstractBaseTest { // ... }If
inheritListenersis set tofalse, the listeners for the annotated class will shadow and effectively replace any listeners defined by a superclass.- Default:
- true
-
mergeMode
TestExecutionListeners.MergeMode mergeModeThe merge mode to use when@TestExecutionListenersis declared on a class that does not inherit listeners from a superclass.Can be set to
MERGE_WITH_DEFAULTSto have locally declared listeners merged with the default listeners.The mode is ignored if listeners are inherited from a superclass.
Defaults to
REPLACE_DEFAULTSfor backwards compatibility.- Since:
- 4.1
- See Also:
- Default:
- REPLACE_DEFAULTS
-