Class SpringExtension

java.lang.Object

org.springframework.test.context.junit.jupiter.SpringExtension

All Implemented Interfaces:

AfterAllCallback, AfterEachCallback, AfterTestExecutionCallback, BeforeAllCallback, BeforeEachCallback, BeforeTestExecutionCallback, Extension, ParameterResolver, TestInstancePostProcessor, TestInstantiationAwareExtension

public class SpringExtension
extends Object
implements BeforeAllCallback, AfterAllCallback, TestInstancePostProcessor, BeforeEachCallback, AfterEachCallback, BeforeTestExecutionCallback, AfterTestExecutionCallback, ParameterResolver

SpringExtension integrates the Spring TestContext Framework into the JUnit Jupiter testing framework.

To use this extension, annotate a JUnit Jupiter based test class with @ExtendWith(SpringExtension.class), @SpringJUnitConfig, @SpringJUnitWebConfig, or any other annotation that is meta-annotated with @ExtendWith(SpringExtension.class) such as @SpringBootTest, etc.

As of Spring Framework 7.0, the SpringExtension is configured to use a test-method scoped ExtensionContext, which enables consistent dependency injection into fields and constructors from the ApplicationContext for the current test method in a @Nested test class hierarchy. However, if a third-party TestExecutionListener is not compatible with the semantics associated with a test-method scoped extension context — or if a developer wishes to switch to test-class scoped semantics — the SpringExtension can be configured by annotating a top-level test class with @SpringExtensionConfig(useTestClassScopedExtensionContext = true) or by setting the "spring.test.extension.context.scope" property to test_class. Note that an explicit @SpringExtensionConfig declaration overrides the globally configured property. Furthermore, the SpringExtension will always use a test-class scoped ExtensionContext for a test class that is configured to use JUnit Jupiter’s @TestInstance(Lifecycle.PER_CLASS) semantics.

NOTE: This class requires JUnit Jupiter 6.0 or higher.

Since:

5.0

Author:

Sam Brannen, Simon Baslé

See Also:

• @ExtendWith
• @SpringExtensionConfig
• @SpringJUnitConfig
• @SpringJUnitWebConfig
• @EnabledIf
• @DisabledIf
• TestContextManager

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SpringExtension.ExtensionContextScope	Enumeration of extension context scopes for configuring how the SpringExtension resolves an ExtensionContext within @Nested test class hierarchies.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXTENSION_CONTEXT_SCOPE_PROPERTY_NAME	JVM system property used to configure the default SpringExtension.ExtensionContextScope for the SpringExtension: "spring.test.extension.context.scope".

Constructor Summary

Constructors

Constructor	Description
SpringExtension()

Method Summary

Modifier and Type	Method	Description
void	afterAll(ExtensionContext context)	Delegates to TestContextManager.afterTestClass().
void	afterEach(ExtensionContext context)	Delegates to TestContextManager.afterTestMethod(Object, Method, Throwable).
void	afterTestExecution(ExtensionContext context)	Delegates to TestContextManager.afterTestExecution(Object, Method, Throwable).
void	beforeAll(ExtensionContext context)	Delegates to TestContextManager.beforeTestClass().
void	beforeEach(ExtensionContext context)	Delegates to TestContextManager.beforeTestMethod(Object, Method).
void	beforeTestExecution(ExtensionContext context)	Delegates to TestContextManager.beforeTestExecution(Object, Method).
static ApplicationContext	getApplicationContext(ExtensionContext context)	Get the ApplicationContext associated with the supplied ExtensionContext.
TestInstantiationAwareExtension.ExtensionContextScope	getTestInstantiationExtensionContextScope(ExtensionContext rootContext)	Returns ExtensionContextScope.TEST_METHOD.
void	postProcessTestInstance(Object testInstance, ExtensionContext context)	Delegates to TestContextManager.prepareTestInstance(Object).
@Nullable Object	resolveParameter(ParameterContext parameterContext, ExtensionContext extensionContext)	Resolve a value for the Parameter in the supplied ParameterContext by retrieving the corresponding dependency from the test's ApplicationContext.
boolean	supportsParameter(ParameterContext parameterContext, ExtensionContext extensionContext)	Determine if the value for the Parameter in the supplied ParameterContext should be autowired from the test's ApplicationContext.

Methods inherited from class Object

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

Field Details

EXTENSION_CONTEXT_SCOPE_PROPERTY_NAME

public static final String EXTENSION_CONTEXT_SCOPE_PROPERTY_NAME

JVM system property used to configure the default SpringExtension.ExtensionContextScope for the SpringExtension: "spring.test.extension.context.scope".

Acceptable values include enum constants defined in ExtensionContextScope, ignoring case. For example, the default may be changed to SpringExtension.ExtensionContextScope.TEST_CLASS by supplying the following JVM system property via the command line.

-Dspring.test.extension.context.scope=test_class

If the property is not set, SpringExtension.ExtensionContextScope.TEST_METHOD semantics will apply. Note, however, that @SpringExtensionConfig takes precedence over this property.

May alternatively be configured via the SpringProperties mechanism or as a JUnit Platform configuration parameter.

Since:

7.0.7

See Also:

• SpringExtension.ExtensionContextScope
• SpringExtensionConfig
• Constant Field Values

Constructor Details

SpringExtension

public SpringExtension()

Method Details

getTestInstantiationExtensionContextScope

public TestInstantiationAwareExtension.ExtensionContextScope getTestInstantiationExtensionContextScope(ExtensionContext rootContext)

Returns ExtensionContextScope.TEST_METHOD.

This can be overridden locally via the @SpringExtensionConfig annotation or globally via the "spring.test.extension.context.scope" property. See the class-level Javadoc for further details.

Specified by:

getTestInstantiationExtensionContextScope in interface TestInstantiationAwareExtension

Since:

7.0

See Also:

• SpringExtensionConfig.useTestClassScopedExtensionContext()
• EXTENSION_CONTEXT_SCOPE_PROPERTY_NAME
• SpringExtension.ExtensionContextScope

beforeAll

public void beforeAll(ExtensionContext context)
               throws Exception

Delegates to TestContextManager.beforeTestClass().

Specified by:

beforeAll in interface BeforeAllCallback

Throws:

Exception

afterAll

public void afterAll(ExtensionContext context)
              throws Exception

Delegates to TestContextManager.afterTestClass().

Specified by:

afterAll in interface AfterAllCallback

Throws:

Exception

postProcessTestInstance

public void postProcessTestInstance(Object testInstance,
 ExtensionContext context)
                             throws Exception

Delegates to TestContextManager.prepareTestInstance(Object).

This method also validates that test methods and test lifecycle methods are not annotated with @Autowired.

Specified by:

postProcessTestInstance in interface TestInstancePostProcessor

Throws:

Exception

beforeEach

public void beforeEach(ExtensionContext context)
                throws Exception

Delegates to TestContextManager.beforeTestMethod(Object, Method).

Specified by:

beforeEach in interface BeforeEachCallback

Throws:

Exception

beforeTestExecution

public void beforeTestExecution(ExtensionContext context)
                         throws Exception

Delegates to TestContextManager.beforeTestExecution(Object, Method).

Specified by:

beforeTestExecution in interface BeforeTestExecutionCallback

Throws:

Exception

afterTestExecution

public void afterTestExecution(ExtensionContext context)
                        throws Exception

Delegates to TestContextManager.afterTestExecution(Object, Method, Throwable).

Specified by:

afterTestExecution in interface AfterTestExecutionCallback

Throws:

Exception

afterEach

public void afterEach(ExtensionContext context)
               throws Exception

Delegates to TestContextManager.afterTestMethod(Object, Method, Throwable).

Specified by:

afterEach in interface AfterEachCallback

Throws:

Exception

supportsParameter

public boolean supportsParameter(ParameterContext parameterContext,
 ExtensionContext extensionContext)

Determine if the value for the Parameter in the supplied ParameterContext should be autowired from the test's ApplicationContext.

A parameter is considered to be autowirable if one of the following conditions is true.

1. The declaring executable is a Constructor and TestConstructorUtils.isAutowirableConstructor(Executable, PropertyProvider) returns true. Note that isAutowirableConstructor() will be invoked with a fallback PropertyProvider that delegates its lookup to ExtensionContext.getConfigurationParameter(String).
2. The parameter is of type ApplicationContext or a sub-type thereof.
3. The parameter is of type ApplicationEvents or a sub-type thereof.
4. ParameterResolutionDelegate.isAutowirable(Parameter, int) returns true.

This method does not load the ApplicationContext or verify that the application context actually contains a matching candidate bean, since doing so would potentially load an application context too early or unnecessarily.

WARNING: If a test class Constructor is annotated with @Autowired or automatically autowirable (see @TestConstructor), Spring will assume the responsibility for resolving all parameters in the constructor. Consequently, no other registered ParameterResolver will be able to resolve parameters.

Specified by:

supportsParameter in interface ParameterResolver

See Also:

• resolveParameter(ParameterContext, ExtensionContext)
• TestConstructorUtils.isAutowirableConstructor(Executable, PropertyProvider)
• ParameterResolutionDelegate.isAutowirable(Parameter, int)

resolveParameter

public @Nullable Object resolveParameter(ParameterContext parameterContext,
 ExtensionContext extensionContext)

Resolve a value for the Parameter in the supplied ParameterContext by retrieving the corresponding dependency from the test's ApplicationContext.

Delegates to ParameterResolutionDelegate.resolveDependency(Parameter, int, Class, AutowireCapableBeanFactory).

Specified by:

resolveParameter in interface ParameterResolver

See Also:

• supportsParameter(ParameterContext, ExtensionContext)
• ParameterResolutionDelegate.resolveDependency(Parameter, int, Class, AutowireCapableBeanFactory)

getApplicationContext

public static ApplicationContext getApplicationContext(ExtensionContext context)

Get the ApplicationContext associated with the supplied ExtensionContext.

NOTE: As of Spring Framework 7.0, the supplied ExtensionContext may not be properly scoped. See the class-level Javadoc for further details.

WARNING: Invoking this method ensures that the corresponding ApplicationContext is loaded. Consequently, this method should not be used if eager loading of the application context is undesired. For example, supportsParameter(ParameterContext, ExtensionContext) intentionally does not invoke this method, since doing so would potentially load an application context too early or unnecessarily.

Parameters:

context - the current ExtensionContext (never null)

Returns:

the application context

Throws:

IllegalStateException - if an error occurs while retrieving the application context

See Also:

• TestContext.getApplicationContext()