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:

org.springframework.test.context.ContextLoader, org.springframework.test.context.SmartContextLoader

public class SpringBootContextLoader
extends org.springframework.test.context.support.AbstractContextLoader

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

See Also:

SpringBootTest

Constructor Summary

Constructors

Constructor and Description
SpringBootContextLoader()

Method Summary

Modifier and Type	Method and Description
protected java.lang.Class<?>[]	detectDefaultConfigurationClasses(java.lang.Class<?> declaringClass) Detect the default configuration classes for the supplied test class.
protected org.springframework.core.env.ConfigurableEnvironment	getEnvironment() Returns the ConfigurableEnvironment instance that should be applied to SpringApplication or null to use the default.
protected java.util.List<org.springframework.context.ApplicationContextInitializer<?>>	getInitializers(org.springframework.test.context.MergedContextConfiguration config, org.springframework.boot.SpringApplication application) Return the initializers that will be applied to the context.
protected java.lang.String[]	getInlinedProperties(org.springframework.test.context.MergedContextConfiguration config)
protected java.lang.String	getResourceSuffix()
protected java.lang.String[]	getResourceSuffixes()
protected org.springframework.boot.SpringApplication	getSpringApplication() Builds new SpringApplication instance.
org.springframework.context.ApplicationContext	loadContext(org.springframework.test.context.MergedContextConfiguration config)
org.springframework.context.ApplicationContext	loadContext(java.lang.String... locations)
void	processContextConfiguration(org.springframework.test.context.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

Constructor Detail

SpringBootContextLoader

public SpringBootContextLoader()

Method Detail

loadContext

public org.springframework.context.ApplicationContext loadContext(org.springframework.test.context.MergedContextConfiguration config)
                                                           throws java.lang.Exception

Throws:

java.lang.Exception

getSpringApplication

protected org.springframework.boot.SpringApplication getSpringApplication()

Builds new SpringApplication instance. You can override this method to add custom behavior

Returns:

SpringApplication instance

getEnvironment

protected org.springframework.core.env.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 java.lang.String[] getInlinedProperties(org.springframework.test.context.MergedContextConfiguration config)

getInitializers

protected java.util.List<org.springframework.context.ApplicationContextInitializer<?>> getInitializers(org.springframework.test.context.MergedContextConfiguration config,
                                                                                                       org.springframework.boot.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:

config - the source context configuration

application - the application instance

Returns:

the initializers to apply

Since:

2.0.0

processContextConfiguration

public void processContextConfiguration(org.springframework.test.context.ContextConfigurationAttributes configAttributes)

Specified by:

processContextConfiguration in interface org.springframework.test.context.SmartContextLoader

Overrides:

processContextConfiguration in class org.springframework.test.context.support.AbstractContextLoader

detectDefaultConfigurationClasses

protected java.lang.Class<?>[] detectDefaultConfigurationClasses(java.lang.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

loadContext

public org.springframework.context.ApplicationContext loadContext(java.lang.String... locations)
                                                           throws java.lang.Exception

Throws:

java.lang.Exception

getResourceSuffixes

protected java.lang.String[] getResourceSuffixes()

Overrides:

getResourceSuffixes in class org.springframework.test.context.support.AbstractContextLoader

getResourceSuffix

protected java.lang.String getResourceSuffix()

Specified by:

getResourceSuffix in class org.springframework.test.context.support.AbstractContextLoader