Package org.springframework.test.context

Annotation Interface TestExecutionListeners

@Target(TYPE)
@Retention(RUNTIME)
@Documented
@Inherited
public @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:

• TestExecutionListener
• TestContextManager
• ContextConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TestExecutionListeners.MergeMode	Enumeration of modes that dictate whether or not explicitly declared listeners are merged with the default listeners when @TestExecutionListeners is declared on a class that does not inherit listeners from a superclass.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	inheritListeners	Whether or not TestExecutionListeners from superclasses should be inherited.
Class<? extends TestExecutionListener>[]	listeners	The TestExecutionListeners to register with the TestContextManager.
TestExecutionListeners.MergeMode	mergeMode	The merge mode to use when @TestExecutionListeners is declared on a class that does not inherit listeners from a superclass.
Class<? extends TestExecutionListener>[]	value	Alias for listeners().

Element Details

value

@AliasFor("listeners")
Class<? extends TestExecutionListener>[] value

Alias for listeners().

This attribute may not be used in conjunction with listeners(), but it may be used instead of listeners().

Default:

{}

listeners

@AliasFor("value")
Class<? extends TestExecutionListener>[] listeners

The TestExecutionListeners to register with the TestContextManager.

This attribute may not be used in conjunction with value(), but it may be used instead of value().

See Also:

• ServletTestExecutionListener
• DirtiesContextBeforeModesTestExecutionListener
• ApplicationEventsTestExecutionListener
• DependencyInjectionTestExecutionListener
• DirtiesContextTestExecutionListener
• TransactionalTestExecutionListener
• SqlScriptsTestExecutionListener
• EventPublishingTestExecutionListener

Default:

{}

inheritListeners

boolean inheritListeners

Whether or not TestExecutionListeners from 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, AbstractBaseTest will be configured with DependencyInjectionTestExecutionListener and DirtiesContextTestExecutionListener; whereas, TransactionalTest will be configured with DependencyInjectionTestExecutionListener, DirtiesContextTestExecutionListener, and TransactionalTestExecutionListener, in that order.

 @TestExecutionListeners({
     DependencyInjectionTestExecutionListener.class,
     DirtiesContextTestExecutionListener.class
 })
 public abstract class AbstractBaseTest {
         // ...
 }

 @TestExecutionListeners(TransactionalTestExecutionListener.class)
 public class TransactionalTest extends AbstractBaseTest {
         // ...
 }

If inheritListeners is set to false, the listeners for the annotated class will shadow and effectively replace any listeners defined by a superclass.

Default:

true

mergeMode

TestExecutionListeners.MergeMode mergeMode

The merge mode to use when @TestExecutionListeners is declared on a class that does not inherit listeners from a superclass.

Can be set to MERGE_WITH_DEFAULTS to have locally declared listeners merged with the default listeners.

The mode is ignored if listeners are inherited from a superclass.

Defaults to REPLACE_DEFAULTS for backwards compatibility.

Since:

4.1

See Also:

• TestExecutionListeners.MergeMode

Default:

REPLACE_DEFAULTS