Package org.springframework.boot.test.context

Class SpringBootTestContextBootstrapper

java.lang.Object

org.springframework.test.context.support.AbstractTestContextBootstrapper

org.springframework.test.context.support.DefaultTestContextBootstrapper

org.springframework.boot.test.context.SpringBootTestContextBootstrapper

All Implemented Interfaces:

TestContextBootstrapper

public class SpringBootTestContextBootstrapper
extends DefaultTestContextBootstrapper

TestContextBootstrapper for Spring Boot. Provides support for @SpringBootTest and may also be used directly or subclassed. Provides the following features over and above DefaultTestContextBootstrapper:

• Uses SpringBootContextLoader as the default context loader.
• Automatically searches for a @SpringBootConfiguration when required.
• Allows custom Environment getProperties(Class) to be defined.
• Provides support for different webEnvironment modes.

Since:

1.4.0

Author:

Phillip Webb, Andy Wilkinson, Brian Clozel, Madhura Bhave, Lorenzo Dee

See Also:

• SpringBootTest
• TestConfiguration

Constructor Summary

Constructors

Constructor	Description
SpringBootTestContextBootstrapper()

Method Summary

Modifier and Type	Method	Description
TestContext	buildTestContext()
protected final MergedContextConfiguration	createModifiedConfig(MergedContextConfiguration mergedConfig, Class<?>[] classes)	Create a new MergedContextConfiguration with different classes.
protected final MergedContextConfiguration	createModifiedConfig(MergedContextConfiguration mergedConfig, Class<?>[] classes, String[] propertySourceProperties)	Create a new MergedContextConfiguration with different classes and properties.
protected String	determineResourceBasePath(MergedContextConfiguration configuration)	Determines the resource base path for web applications using the value of @WebAppConfiguration, if any, on the test class of the given configuration.
protected SpringBootTest	getAnnotation(Class<?> testClass)
protected Class<?>[]	getClasses(Class<?> testClass)
protected Class<? extends ContextLoader>	getDefaultContextLoaderClass(Class<?> testClass)
protected Set<Class<? extends TestExecutionListener>>	getDefaultTestExecutionListenerClasses()
protected String	getDifferentiatorPropertySourceProperty()	Return a "differentiator" property to ensure that there is something to differentiate regular tests and bootstrapped tests.
protected Class<?>[]	getOrFindConfigurationClasses(MergedContextConfiguration mergedConfig)
protected String[]	getProperties(Class<?> testClass)
protected SpringBootTest.WebEnvironment	getWebEnvironment(Class<?> testClass)	Return the SpringBootTest.WebEnvironment type for this test or null if undefined.
protected MergedContextConfiguration	processMergedContextConfiguration(MergedContextConfiguration mergedConfig)
protected void	processPropertySourceProperties(MergedContextConfiguration mergedConfig, List<String> propertySourceProperties)	Post process the property source properties, adding or removing elements as required.
protected ContextLoader	resolveContextLoader(Class<?> testClass, List<ContextConfigurationAttributes> configAttributesList)
protected void	verifyConfiguration(Class<?> testClass)

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

buildMergedContextConfiguration, getBootstrapContext, getCacheAwareContextLoaderDelegate, getContextCustomizerFactories, getDefaultTestExecutionListenerClassNames, getTestExecutionListeners, resolveExplicitContextLoaderClass, setBootstrapContext

Methods inherited from class java.lang.Object

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

Constructor Details

SpringBootTestContextBootstrapper

public SpringBootTestContextBootstrapper()

Method Details

buildTestContext

public TestContext buildTestContext()

Specified by:

buildTestContext in interface TestContextBootstrapper

Overrides:

buildTestContext in class AbstractTestContextBootstrapper

getDefaultTestExecutionListenerClasses

protected Set<Class<? extends TestExecutionListener>> getDefaultTestExecutionListenerClasses()

Overrides:

getDefaultTestExecutionListenerClasses in class AbstractTestContextBootstrapper

resolveContextLoader

protected ContextLoader resolveContextLoader(Class<?> testClass,
 List<ContextConfigurationAttributes> configAttributesList)

Overrides:

resolveContextLoader in class AbstractTestContextBootstrapper

getDefaultContextLoaderClass

protected Class<? extends ContextLoader> getDefaultContextLoaderClass(Class<?> testClass)

Overrides:

getDefaultContextLoaderClass in class DefaultTestContextBootstrapper

processMergedContextConfiguration

protected MergedContextConfiguration processMergedContextConfiguration(MergedContextConfiguration mergedConfig)

Overrides:

processMergedContextConfiguration in class AbstractTestContextBootstrapper

determineResourceBasePath

protected String determineResourceBasePath(MergedContextConfiguration configuration)

Determines the resource base path for web applications using the value of @WebAppConfiguration, if any, on the test class of the given configuration. Defaults to src/main/webapp in its absence.

Parameters:

configuration - the configuration to examine

Returns:

the resource base path

Since:

2.1.6

getOrFindConfigurationClasses

protected Class<?>[] getOrFindConfigurationClasses(MergedContextConfiguration mergedConfig)

getDifferentiatorPropertySourceProperty

protected String getDifferentiatorPropertySourceProperty()

Return a "differentiator" property to ensure that there is something to differentiate regular tests and bootstrapped tests. Without this property a cached context could be returned that wasn't created by this bootstrapper. By default uses the bootstrapper class as a property.

Returns:

the differentiator or null

processPropertySourceProperties

protected void processPropertySourceProperties(MergedContextConfiguration mergedConfig,
 List<String> propertySourceProperties)

Post process the property source properties, adding or removing elements as required.

Parameters:

mergedConfig - the merged context configuration

propertySourceProperties - the property source properties to process

getWebEnvironment

protected SpringBootTest.WebEnvironment getWebEnvironment(Class<?> testClass)

Return the SpringBootTest.WebEnvironment type for this test or null if undefined.

Parameters:

testClass - the source test class

Returns:

the SpringBootTest.WebEnvironment or null

getClasses

protected Class<?>[] getClasses(Class<?> testClass)

getProperties

protected String[] getProperties(Class<?> testClass)

getAnnotation

protected SpringBootTest getAnnotation(Class<?> testClass)

verifyConfiguration

protected void verifyConfiguration(Class<?> testClass)

createModifiedConfig

protected final MergedContextConfiguration createModifiedConfig(MergedContextConfiguration mergedConfig,
 Class<?>[] classes)

Create a new MergedContextConfiguration with different classes.

Parameters:

mergedConfig - the source config

classes - the replacement classes

Returns:

a new MergedContextConfiguration

createModifiedConfig

protected final MergedContextConfiguration createModifiedConfig(MergedContextConfiguration mergedConfig,
 Class<?>[] classes,
 String[] propertySourceProperties)

Create a new MergedContextConfiguration with different classes and properties.

Parameters:

mergedConfig - the source config

classes - the replacement classes

propertySourceProperties - the replacement properties

Returns:

a new MergedContextConfiguration