org.springframework.test.context.support

Class AbstractTestContextBootstrapper

java.lang.Object

org.springframework.test.context.support.AbstractTestContextBootstrapper

All Implemented Interfaces:

TestContextBootstrapper

Direct Known Subclasses:

DefaultTestContextBootstrapper

public abstract class AbstractTestContextBootstrapper
extends java.lang.Object
implements TestContextBootstrapper

Abstract implementation of the TestContextBootstrapper interface which provides most of the behavior required by a bootstrapper.

Concrete subclasses typically will only need to provide implementations for the following methods:

• getDefaultContextLoaderClass(java.lang.Class<?>)
• processMergedContextConfiguration(org.springframework.test.context.MergedContextConfiguration)

To plug in custom ContextCache support, override getCacheAwareContextLoaderDelegate().

Since:

4.1

Author:

Sam Brannen, Juergen Hoeller, Phillip Webb

Field Summary

Fields

Modifier and Type	Field and Description
private BootstrapContext	bootstrapContext
private Log	logger

Constructor Summary

Constructors

Constructor and Description
AbstractTestContextBootstrapper()

Method Summary

Modifier and Type	Method and Description
private static boolean	areAllEmpty(java.util.Collection<?>... collections)
private MergedContextConfiguration	buildDefaultMergedContextConfiguration(java.lang.Class<?> testClass, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate)
MergedContextConfiguration	buildMergedContextConfiguration() Build the merged context configuration for the test class in the BootstrapContext associated with this bootstrapper.
private MergedContextConfiguration	buildMergedContextConfiguration(java.lang.Class<?> testClass, java.util.List<ContextConfigurationAttributes> configAttributesList, MergedContextConfiguration parentConfig, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, boolean requireLocationsClassesOrInitializers) Build the merged context configuration for the supplied testClass, context configuration attributes, and parent context configuration.
TestContext	buildTestContext() Build a new DefaultTestContext using the test class in the BootstrapContext associated with this bootstrapper and by delegating to buildMergedContextConfiguration() and getCacheAwareContextLoaderDelegate().
BootstrapContext	getBootstrapContext() Get the BootstrapContext associated with this bootstrapper.
protected CacheAwareContextLoaderDelegate	getCacheAwareContextLoaderDelegate() Get the CacheAwareContextLoaderDelegate to use for transparent interaction with the ContextCache.
protected java.util.List<ContextCustomizerFactory>	getContextCustomizerFactories() Get the ContextCustomizerFactory instances for this bootstrapper.
private java.util.Set<ContextCustomizer>	getContextCustomizers(java.lang.Class<?> testClass, java.util.List<ContextConfigurationAttributes> configAttributes)
protected abstract java.lang.Class<? extends ContextLoader>	getDefaultContextLoaderClass(java.lang.Class<?> testClass) Determine the default ContextLoader class to use for the supplied test class.
protected java.util.Set<java.lang.Class<? extends TestExecutionListener>>	getDefaultTestExecutionListenerClasses() Get the default TestExecutionListener classes for this bootstrapper.
protected java.util.List<java.lang.String>	getDefaultTestExecutionListenerClassNames() Get the names of the default TestExecutionListener classes for this bootstrapper.
java.util.List<TestExecutionListener>	getTestExecutionListeners() Get a list of newly instantiated TestExecutionListeners for the test class in the BootstrapContext associated with this bootstrapper.
private java.util.List<TestExecutionListener>	instantiateListeners(java.util.List<java.lang.Class<? extends TestExecutionListener>> classesList)
protected MergedContextConfiguration	processMergedContextConfiguration(MergedContextConfiguration mergedConfig) Process the supplied, newly instantiated MergedContextConfiguration instance.
protected ContextLoader	resolveContextLoader(java.lang.Class<?> testClass, java.util.List<ContextConfigurationAttributes> configAttributesList) Resolve the ContextLoader class to use for the supplied list of ContextConfigurationAttributes and then instantiate and return that ContextLoader.
protected java.lang.Class<? extends ContextLoader>	resolveExplicitContextLoaderClass(java.util.List<ContextConfigurationAttributes> configAttributesList) Resolve the ContextLoader class to use for the supplied list of ContextConfigurationAttributes.
void	setBootstrapContext(BootstrapContext bootstrapContext) Set the BootstrapContext to be used by this bootstrapper.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private final Log logger

bootstrapContext

private BootstrapContext bootstrapContext

Constructor Detail

AbstractTestContextBootstrapper

public AbstractTestContextBootstrapper()

Method Detail

setBootstrapContext

public void setBootstrapContext(BootstrapContext bootstrapContext)

Set the BootstrapContext to be used by this bootstrapper.

Specified by:

setBootstrapContext in interface TestContextBootstrapper

getBootstrapContext

public BootstrapContext getBootstrapContext()

Get the BootstrapContext associated with this bootstrapper.

Specified by:

getBootstrapContext in interface TestContextBootstrapper

buildTestContext

public TestContext buildTestContext()

Build a new DefaultTestContext using the test class in the BootstrapContext associated with this bootstrapper and by delegating to buildMergedContextConfiguration() and getCacheAwareContextLoaderDelegate().

Concrete subclasses may choose to override this method to return a custom TestContext implementation.

Specified by:

buildTestContext in interface TestContextBootstrapper

Returns:

a new TestContext, never null

Since:

4.2

See Also:

TestContextBootstrapper.buildMergedContextConfiguration()

getTestExecutionListeners

public final java.util.List<TestExecutionListener> getTestExecutionListeners()

Get a list of newly instantiated TestExecutionListeners for the test class in the BootstrapContext associated with this bootstrapper.

If @TestExecutionListeners is not present on the test class in the BootstrapContext, default listeners should be returned. Furthermore, default listeners must be sorted using AnnotationAwareOrderComparator.

Concrete implementations are free to determine what comprises the set of default listeners. However, by default, the Spring TestContext Framework will use the SpringFactoriesLoader mechanism to look up all TestExecutionListener class names configured in all META-INF/spring.factories files on the classpath.

The inheritListeners flag of @TestExecutionListeners must be taken into consideration. Specifically, if the inheritListeners flag is set to true, listeners declared for a given test class must be appended to the end of the list of listeners declared in superclasses.

Specified by:

getTestExecutionListeners in interface TestContextBootstrapper

Returns:

a list of TestExecutionListener instances

instantiateListeners

private java.util.List<TestExecutionListener> instantiateListeners(java.util.List<java.lang.Class<? extends TestExecutionListener>> classesList)

getDefaultTestExecutionListenerClasses

protected java.util.Set<java.lang.Class<? extends TestExecutionListener>> getDefaultTestExecutionListenerClasses()

Get the default TestExecutionListener classes for this bootstrapper.

This method is invoked by getTestExecutionListeners() and delegates to getDefaultTestExecutionListenerClassNames() to retrieve the class names.

If a particular class cannot be loaded, a DEBUG message will be logged, but the associated exception will not be rethrown.

getDefaultTestExecutionListenerClassNames

protected java.util.List<java.lang.String> getDefaultTestExecutionListenerClassNames()

Get the names of the default TestExecutionListener classes for this bootstrapper.

The default implementation looks up all org.springframework.test.context.TestExecutionListener entries configured in all META-INF/spring.factories files on the classpath.

This method is invoked by getDefaultTestExecutionListenerClasses().

Returns:

an unmodifiable list of names of default TestExecutionListener classes

See Also:

SpringFactoriesLoader.loadFactoryNames(java.lang.Class<?>, java.lang.ClassLoader)

buildMergedContextConfiguration

public final MergedContextConfiguration buildMergedContextConfiguration()

Build the merged context configuration for the test class in the BootstrapContext associated with this bootstrapper.

Implementations must take the following into account when building the merged configuration:

• Context hierarchies declared via @ContextHierarchy and @ContextConfiguration
• Active bean definition profiles declared via @ActiveProfiles
• Context initializers declared via ContextConfiguration.initializers()
• Test property sources declared via @TestPropertySource

Consult the Javadoc for the aforementioned annotations for details on the required semantics.

Note that the implementation of TestContextBootstrapper.buildTestContext() should typically delegate to this method when constructing the TestContext.

When determining which ContextLoader to use for a given test class, the following algorithm should be used:

1. If a ContextLoader class has been explicitly declared via ContextConfiguration.loader(), use it.
2. Otherwise, concrete implementations are free to determine which ContextLoader class to use as a default.

Specified by:

buildMergedContextConfiguration in interface TestContextBootstrapper

Returns:

the merged context configuration, never null

See Also:

TestContextBootstrapper.buildTestContext()

buildDefaultMergedContextConfiguration

private MergedContextConfiguration buildDefaultMergedContextConfiguration(java.lang.Class<?> testClass,
                                                                          CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate)

buildMergedContextConfiguration

private MergedContextConfiguration buildMergedContextConfiguration(java.lang.Class<?> testClass,
                                                                   java.util.List<ContextConfigurationAttributes> configAttributesList,
                                                                   MergedContextConfiguration parentConfig,
                                                                   CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
                                                                   boolean requireLocationsClassesOrInitializers)

Build the merged context configuration for the supplied testClass, context configuration attributes, and parent context configuration.

Parameters:

testClass - the test class for which the MergedContextConfiguration should be built (must not be null)

configAttributesList - the list of context configuration attributes for the specified test class, ordered bottom-up (i.e., as if we were traversing up the class hierarchy); never null or empty

parentConfig - the merged context configuration for the parent application context in a context hierarchy, or null if there is no parent

cacheAwareContextLoaderDelegate - the cache-aware context loader delegate to be passed to the MergedContextConfiguration constructor

requireLocationsClassesOrInitializers - whether locations, classes, or initializers are required; typically true but may be set to false if the configured loader supports empty configuration

Returns:

the merged context configuration

See Also:

resolveContextLoader(java.lang.Class<?>, java.util.List<org.springframework.test.context.ContextConfigurationAttributes>), ContextLoaderUtils.resolveContextConfigurationAttributes(java.lang.Class<?>), SmartContextLoader.processContextConfiguration(org.springframework.test.context.ContextConfigurationAttributes), ContextLoader.processLocations(java.lang.Class<?>, java.lang.String...), ActiveProfilesUtils.resolveActiveProfiles(java.lang.Class<?>), ApplicationContextInitializerUtils.resolveInitializerClasses(java.util.List<org.springframework.test.context.ContextConfigurationAttributes>), MergedContextConfiguration

getContextCustomizers

private java.util.Set<ContextCustomizer> getContextCustomizers(java.lang.Class<?> testClass,
                                                               java.util.List<ContextConfigurationAttributes> configAttributes)

getContextCustomizerFactories

protected java.util.List<ContextCustomizerFactory> getContextCustomizerFactories()

Get the ContextCustomizerFactory instances for this bootstrapper.

The default implementation uses the SpringFactoriesLoader mechanism for loading factories configured in all META-INF/spring.factories files on the classpath.

Since:

4.3

See Also:

SpringFactoriesLoader.loadFactories(java.lang.Class<T>, java.lang.ClassLoader)

resolveContextLoader

protected ContextLoader resolveContextLoader(java.lang.Class<?> testClass,
                                             java.util.List<ContextConfigurationAttributes> configAttributesList)

Resolve the ContextLoader class to use for the supplied list of ContextConfigurationAttributes and then instantiate and return that ContextLoader.

If the user has not explicitly declared which loader to use, the value returned from getDefaultContextLoaderClass(java.lang.Class<?>) will be used as the default context loader class. For details on the class resolution process, see resolveExplicitContextLoaderClass(java.util.List<org.springframework.test.context.ContextConfigurationAttributes>) and getDefaultContextLoaderClass(java.lang.Class<?>).

Parameters:

testClass - the test class for which the ContextLoader should be resolved; must not be null

configAttributesList - the list of configuration attributes to process; must not be null; must be ordered bottom-up (i.e., as if we were traversing up the class hierarchy)

Returns:

the resolved ContextLoader for the supplied testClass (never null)

Throws:

java.lang.IllegalStateException - if getDefaultContextLoaderClass(Class) returns null

resolveExplicitContextLoaderClass

protected java.lang.Class<? extends ContextLoader> resolveExplicitContextLoaderClass(java.util.List<ContextConfigurationAttributes> configAttributesList)

Resolve the ContextLoader class to use for the supplied list of ContextConfigurationAttributes.

Beginning with the first level in the context configuration attributes hierarchy:

1. If the contextLoaderClass property of ContextConfigurationAttributes is configured with an explicit class, that class will be returned.
2. If an explicit ContextLoader class is not specified at the current level in the hierarchy, traverse to the next level in the hierarchy and return to step #1.

Parameters:

configAttributesList - the list of configuration attributes to process; must not be null; must be ordered bottom-up (i.e., as if we were traversing up the class hierarchy)

Returns:

the ContextLoader class to use for the supplied configuration attributes, or null if no explicit loader is found

Throws:

java.lang.IllegalArgumentException - if supplied configuration attributes are null or empty

getCacheAwareContextLoaderDelegate

protected CacheAwareContextLoaderDelegate getCacheAwareContextLoaderDelegate()

Get the CacheAwareContextLoaderDelegate to use for transparent interaction with the ContextCache.

The default implementation simply delegates to getBootstrapContext().getCacheAwareContextLoaderDelegate().

Concrete subclasses may choose to override this method to return a custom CacheAwareContextLoaderDelegate implementation with custom ContextCache support.

Returns:

the context loader delegate (never null)

getDefaultContextLoaderClass

protected abstract java.lang.Class<? extends ContextLoader> getDefaultContextLoaderClass(java.lang.Class<?> testClass)

Determine the default ContextLoader class to use for the supplied test class.

The class returned by this method will only be used if a ContextLoader class has not been explicitly declared via ContextConfiguration.loader().

Parameters:

testClass - the test class for which to retrieve the default ContextLoader class

Returns:

the default ContextLoader class for the supplied test class (never null)

processMergedContextConfiguration

protected MergedContextConfiguration processMergedContextConfiguration(MergedContextConfiguration mergedConfig)

Process the supplied, newly instantiated MergedContextConfiguration instance.

The returned MergedContextConfiguration instance may be a wrapper around or a replacement for the original.

The default implementation simply returns the supplied instance unmodified.

Concrete subclasses may choose to return a specialized subclass of MergedContextConfiguration based on properties in the supplied instance.

Parameters:

mergedConfig - the MergedContextConfiguration to process; never null

Returns:

a fully initialized MergedContextConfiguration; never null

areAllEmpty

private static boolean areAllEmpty(java.util.Collection<?>... collections)