Package org.springframework.test.context.junit.jupiter

Class SpringExtension

java.lang.Object

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

All Implemented Interfaces:

org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.AfterTestExecutionCallback, org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.BeforeTestExecutionCallback, org.junit.jupiter.api.extension.Extension, org.junit.jupiter.api.extension.ParameterResolver, org.junit.jupiter.api.extension.TestInstancePostProcessor

public class SpringExtension
extends Object
implements org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.TestInstancePostProcessor, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.BeforeTestExecutionCallback, org.junit.jupiter.api.extension.AfterTestExecutionCallback, org.junit.jupiter.api.extension.ParameterResolver

SpringExtension integrates the Spring TestContext Framework into JUnit 5's Jupiter programming model.

To use this extension, simply annotate a JUnit Jupiter based test class with @ExtendWith(SpringExtension.class), @SpringJUnitConfig, or @SpringJUnitWebConfig.

Since:

5.0

Author:

Sam Brannen

See Also:

• EnabledIf
• DisabledIf
• SpringJUnitConfig
• SpringJUnitWebConfig
• TestContextManager

Constructor Summary

Constructors

Constructor	Description
SpringExtension()

Method Summary

Modifier and Type	Method	Description
void	afterAll(org.junit.jupiter.api.extension.ExtensionContext context)	Delegates to TestContextManager.afterTestClass().
void	afterEach(org.junit.jupiter.api.extension.ExtensionContext context)	Delegates to TestContextManager.afterTestMethod(java.lang.Object, java.lang.reflect.Method, java.lang.Throwable).
void	afterTestExecution(org.junit.jupiter.api.extension.ExtensionContext context)	Delegates to TestContextManager.afterTestExecution(java.lang.Object, java.lang.reflect.Method, java.lang.Throwable).
void	beforeAll(org.junit.jupiter.api.extension.ExtensionContext context)	Delegates to TestContextManager.beforeTestClass().
void	beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)	Delegates to TestContextManager.beforeTestMethod(java.lang.Object, java.lang.reflect.Method).
void	beforeTestExecution(org.junit.jupiter.api.extension.ExtensionContext context)	Delegates to TestContextManager.beforeTestExecution(java.lang.Object, java.lang.reflect.Method).
static ApplicationContext	getApplicationContext(org.junit.jupiter.api.extension.ExtensionContext context)	Get the ApplicationContext associated with the supplied ExtensionContext.
void	postProcessTestInstance(Object testInstance, org.junit.jupiter.api.extension.ExtensionContext context)	Delegates to TestContextManager.prepareTestInstance(java.lang.Object).
Object	resolveParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)	Resolve a value for the Parameter in the supplied ParameterContext by retrieving the corresponding dependency from the test's ApplicationContext.
boolean	supportsParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.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 java.lang.Object

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

Constructor Details

SpringExtension

public SpringExtension()

Method Details

beforeAll

public void beforeAll(org.junit.jupiter.api.extension.ExtensionContext context)
               throws Exception

Delegates to TestContextManager.beforeTestClass().

Specified by:

beforeAll in interface org.junit.jupiter.api.extension.BeforeAllCallback

Throws:

Exception

afterAll

public void afterAll(org.junit.jupiter.api.extension.ExtensionContext context)
              throws Exception

Delegates to TestContextManager.afterTestClass().

Specified by:

afterAll in interface org.junit.jupiter.api.extension.AfterAllCallback

Throws:

Exception

postProcessTestInstance

public void postProcessTestInstance(Object testInstance,
 org.junit.jupiter.api.extension.ExtensionContext context)
                             throws Exception

Delegates to TestContextManager.prepareTestInstance(java.lang.Object).

As of Spring Framework 5.3.2, this method also validates that test methods and test lifecycle methods are not annotated with @Autowired.

Specified by:

postProcessTestInstance in interface org.junit.jupiter.api.extension.TestInstancePostProcessor

Throws:

Exception

beforeEach

public void beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)
                throws Exception

Delegates to TestContextManager.beforeTestMethod(java.lang.Object, java.lang.reflect.Method).

Specified by:

beforeEach in interface org.junit.jupiter.api.extension.BeforeEachCallback

Throws:

Exception

beforeTestExecution

public void beforeTestExecution(org.junit.jupiter.api.extension.ExtensionContext context)
                         throws Exception

Delegates to TestContextManager.beforeTestExecution(java.lang.Object, java.lang.reflect.Method).

Specified by:

beforeTestExecution in interface org.junit.jupiter.api.extension.BeforeTestExecutionCallback

Throws:

Exception

afterTestExecution

public void afterTestExecution(org.junit.jupiter.api.extension.ExtensionContext context)
                        throws Exception

Delegates to TestContextManager.afterTestExecution(java.lang.Object, java.lang.reflect.Method, java.lang.Throwable).

Specified by:

afterTestExecution in interface org.junit.jupiter.api.extension.AfterTestExecutionCallback

Throws:

Exception

afterEach

public void afterEach(org.junit.jupiter.api.extension.ExtensionContext context)
               throws Exception

Delegates to TestContextManager.afterTestMethod(java.lang.Object, java.lang.reflect.Method, java.lang.Throwable).

Specified by:

afterEach in interface org.junit.jupiter.api.extension.AfterEachCallback

Throws:

Exception

supportsParameter

public boolean supportsParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext,
 org.junit.jupiter.api.extension.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(Constructor, Class, 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(java.lang.reflect.Parameter, int) returns true.

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 org.junit.jupiter.api.extension.ParameterResolver

See Also:

• resolveParameter(org.junit.jupiter.api.extension.ParameterContext, org.junit.jupiter.api.extension.ExtensionContext)
• TestConstructorUtils.isAutowirableConstructor(Constructor, Class)
• ParameterResolutionDelegate.isAutowirable(java.lang.reflect.Parameter, int)

resolveParameter

@Nullable
public Object resolveParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext,
 org.junit.jupiter.api.extension.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(java.lang.reflect.Parameter, int, java.lang.Class<?>, org.springframework.beans.factory.config.AutowireCapableBeanFactory).

Specified by:

resolveParameter in interface org.junit.jupiter.api.extension.ParameterResolver

See Also:

• supportsParameter(org.junit.jupiter.api.extension.ParameterContext, org.junit.jupiter.api.extension.ExtensionContext)
• ParameterResolutionDelegate.resolveDependency(java.lang.reflect.Parameter, int, java.lang.Class<?>, org.springframework.beans.factory.config.AutowireCapableBeanFactory)

getApplicationContext

public static ApplicationContext getApplicationContext(org.junit.jupiter.api.extension.ExtensionContext context)

Get the ApplicationContext associated with the supplied ExtensionContext.

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()