Package org.springframework.boot.test.context

Class SpringBootContextLoader

java.lang.Object

org.springframework.test.context.support.AbstractContextLoader

org.springframework.boot.test.context.SpringBootContextLoader

All Implemented Interfaces:

AotContextLoader, ContextLoader, SmartContextLoader

public class SpringBootContextLoader
extends AbstractContextLoader
implements AotContextLoader

A ContextLoader that can be used to test Spring Boot applications (those that normally startup using SpringApplication). Although this loader can be used directly, most test will instead want to use it with @SpringBootTest.

The loader supports both standard MergedContextConfiguration as well as WebMergedContextConfiguration. If WebMergedContextConfiguration is used the context will either use a mock servlet environment, or start the full embedded web server.

If @ActiveProfiles are provided in the test class they will be used to create the application context.

Since:

1.4.0

Author:

Dave Syer, Phillip Webb, Andy Wilkinson, Stephane Nicoll, Madhura Bhave, Scott Frederick

See Also:

• SpringBootTest

Constructor Summary

Constructors

Constructor	Description
SpringBootContextLoader()

Method Summary

Modifier and Type	Method	Description
protected Class<?>[]	detectDefaultConfigurationClasses(Class<?> declaringClass)	Detect the default configuration classes for the supplied test class.
protected ApplicationContextFactory	getApplicationContextFactory(MergedContextConfiguration mergedConfig)	Return the ApplicationContextFactory that should be used for the test.
protected ConfigurableEnvironment	getEnvironment()	Returns the ConfigurableEnvironment instance that should be applied to SpringApplication or null to use the default.
protected List<ApplicationContextInitializer<?>>	getInitializers(MergedContextConfiguration mergedConfig, SpringApplication application)	Return the initializers that will be applied to the context.
protected String[]	getInlinedProperties(MergedContextConfiguration mergedConfig)
protected String	getResourceSuffix()
protected String[]	getResourceSuffixes()
protected SpringApplication	getSpringApplication()	Builds new SpringApplication instance.
ApplicationContext	loadContext(MergedContextConfiguration mergedConfig)
ApplicationContext	loadContextForAotProcessing(MergedContextConfiguration mergedConfig)
ApplicationContext	loadContextForAotRuntime(MergedContextConfiguration mergedConfig, ApplicationContextInitializer<ConfigurableApplicationContext> initializer)
void	processContextConfiguration(ContextConfigurationAttributes configAttributes)

Methods inherited from class org.springframework.test.context.support.AbstractContextLoader

customizeContext, generateDefaultLocations, isGenerateDefaultLocations, modifyLocations, prepareContext, processLocations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.test.context.SmartContextLoader

loadContext, processLocations

Constructor Details

SpringBootContextLoader

public SpringBootContextLoader()

Method Details

loadContext

public ApplicationContext loadContext(MergedContextConfiguration mergedConfig)
                               throws Exception

Specified by:

loadContext in interface SmartContextLoader

Throws:

Exception

loadContextForAotProcessing

public ApplicationContext loadContextForAotProcessing(MergedContextConfiguration mergedConfig)
                                               throws Exception

Specified by:

loadContextForAotProcessing in interface AotContextLoader

Throws:

Exception

loadContextForAotRuntime

public ApplicationContext loadContextForAotRuntime(MergedContextConfiguration mergedConfig,
 ApplicationContextInitializer<ConfigurableApplicationContext> initializer)
                                            throws Exception

Specified by:

loadContextForAotRuntime in interface AotContextLoader

Throws:

Exception

getApplicationContextFactory

protected ApplicationContextFactory getApplicationContextFactory(MergedContextConfiguration mergedConfig)

Return the ApplicationContextFactory that should be used for the test. By default this method will return a factory that will create an appropriate ApplicationContext for the WebApplicationType.

Parameters:

mergedConfig - the merged context configuration

Returns:

the application context factory to use

Since:

3.2.0

getSpringApplication

protected SpringApplication getSpringApplication()

Builds new SpringApplication instance. This method is only called when a main method isn't being used to create the SpringApplication.

Returns:

a SpringApplication instance

getEnvironment

protected ConfigurableEnvironment getEnvironment()

Returns the ConfigurableEnvironment instance that should be applied to SpringApplication or null to use the default. You can override this method if you need a custom environment.

Returns:

a ConfigurableEnvironment instance

getInlinedProperties

protected String[] getInlinedProperties(MergedContextConfiguration mergedConfig)

getInitializers

protected List<ApplicationContextInitializer<?>> getInitializers(MergedContextConfiguration mergedConfig,
 SpringApplication application)

Return the initializers that will be applied to the context. By default this method will adapt context customizers, add application initializers and add initializers specified on the test.

Parameters:

mergedConfig - the source context configuration

application - the application instance

Returns:

the initializers to apply

Since:

2.0.0

processContextConfiguration

public void processContextConfiguration(ContextConfigurationAttributes configAttributes)

Specified by:

processContextConfiguration in interface SmartContextLoader

Overrides:

processContextConfiguration in class AbstractContextLoader

detectDefaultConfigurationClasses

protected Class<?>[] detectDefaultConfigurationClasses(Class<?> declaringClass)

Detect the default configuration classes for the supplied test class. By default simply delegates to AnnotationConfigContextLoaderUtils.detectDefaultConfigurationClasses(java.lang.Class<?>).

Parameters:

declaringClass - the test class that declared @ContextConfiguration

Returns:

an array of default configuration classes, potentially empty but never null

See Also:

• AnnotationConfigContextLoaderUtils

getResourceSuffixes

protected String[] getResourceSuffixes()

Overrides:

getResourceSuffixes in class AbstractContextLoader

getResourceSuffix

protected String getResourceSuffix()

Specified by:

getResourceSuffix in class AbstractContextLoader