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:

ContextLoader, SmartContextLoader

public class SpringBootContextLoader
extends 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 servlet container.

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

Author:

Dave Syer, Phillip Webb, Andy Wilkinson, Stephane Nicoll

See Also:

SpringBootTest

Constructor Summary

Constructors

Constructor and Description
SpringBootContextLoader()

Method Summary

Modifier and Type	Method and Description
protected Class<?>[]	detectDefaultConfigurationClasses(Class<?> declaringClass) Detect the default configuration classes for the supplied test class.
protected String[]	getInlinedProperties(MergedContextConfiguration config)
protected String	getResourceSuffix()
protected String[]	getResourceSuffixes()
protected SpringApplication	getSpringApplication() Builds new SpringApplication instance.
ApplicationContext	loadContext(MergedContextConfiguration config)
ApplicationContext	loadContext(String... locations)
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

Constructor Detail

SpringBootContextLoader

public SpringBootContextLoader()

Method Detail

loadContext

public ApplicationContext loadContext(MergedContextConfiguration config)
                               throws Exception

Throws:

Exception

getSpringApplication

protected SpringApplication getSpringApplication()

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

Returns:

SpringApplication instance

getInlinedProperties

protected String[] getInlinedProperties(MergedContextConfiguration config)

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

loadContext

public ApplicationContext loadContext(String... locations)
                               throws Exception

Throws:

Exception

getResourceSuffixes

protected String[] getResourceSuffixes()

Overrides:

getResourceSuffixes in class AbstractContextLoader

getResourceSuffix

protected String getResourceSuffix()

Specified by:

getResourceSuffix in class AbstractContextLoader