Polish ContextCustomizer support in the TCF

Issue: SPR-13998

Author: sbrannen

spring-test/src/main/java/org/springframework/test/context/ContextCustomizer.java

@@ -16,34 +16,34 @@
 
 package org.springframework.test.context;
 
-import org.springframework.context.ApplicationContext;
 import org.springframework.context.ConfigurableApplicationContext;
 
 /**
- * Strategy interface for customizing {@link ApplicationContext application contexts} that
- * are created and managed by the Spring TestContext Framework.
+ * Strategy interface for customizing {@link ConfigurableApplicationContext
+ * application contexts} that are created and managed by the <em>Spring
+ * TestContext Framework</em>.
  *
- * <p>Customizers are loaded via {@link ContextCustomizerFactory} classes registered in
- * {@code spring.factories}.
+ * <p>Customizers are created by {@link ContextCustomizerFactory} implementations.
  *
- * <p>Implementations should take care to implement correct {@code equals} and
- * {@code hashCode} methods since customizers form part of the
- * {@link MergedContextConfiguration} which is used as a cache key.
+ * <p>Implementations must implement correct {@code equals} and {@code hashCode}
+ * methods since customizers form part of the {@link MergedContextConfiguration}
+ * which is used as a cache key.
  *
  * @author Phillip Webb
+ * @author Sam Brannen
  * @since 4.3
  * @see ContextCustomizerFactory
- * @see org.springframework.test.context.support.AbstractContextLoader
+ * @see org.springframework.test.context.support.AbstractContextLoader#customizeContext
  */
 public interface ContextCustomizer {
 
 	/**
-	 * Called <i>before</i> bean definitions are read to customize the
-	 * {@link ConfigurableApplicationContext}.
-	 * @param context the context that should be prepared
-	 * @param mergedContextConfiguration the merged context configuration
+	 * Customize the supplied {@code ConfigurableApplicationContext} <em>after</em>
+	 * bean definitions have been loaded into the context but <em>before</em> the
+	 * context has been refreshed.
+	 * @param context the context to customize
+	 * @param mergedConfig the merged context configuration
 	 */
-	void customizeContext(ConfigurableApplicationContext context,
-			MergedContextConfiguration mergedContextConfiguration);
+	void customizeContext(ConfigurableApplicationContext context, MergedContextConfiguration mergedConfig);
 
 }

spring-test/src/main/java/org/springframework/test/context/ContextCustomizerFactory.java

@@ -18,29 +18,35 @@
 
 import java.util.List;
 
-import org.springframework.context.ConfigurableApplicationContext;
-
 /**
- * Factory registered in {@code spring.factories} that is used to create
- * {@link ContextCustomizer ContextCustomizers}. Factories are called after
- * {@link ContextLoader ContextLoaders} have been triggered but before the
+ * Factory for creating {@link ContextCustomizer ContextCustomizers}.
+ *
+ * <p>Factories are invoked after {@link ContextLoader ContextLoaders} have
+ * processed context configuration attributes but before the
  * {@link MergedContextConfiguration} is created.
  *
+ * <p>By default, the Spring TestContext Framework will use the
+ * {@link org.springframework.core.io.support.SpringFactoriesLoader SpringFactoriesLoader}
+ * mechanism for loading factories configured in all {@code META-INF/spring.factories}
+ * files on the classpath.
+ *
  * @author Phillip Webb
+ * @author Sam Brannen
  * @since 4.3
  */
 public interface ContextCustomizerFactory {
 
 	/**
-	 * Get the {@link ContextCustomizer} (if any) that should be used to customize the
-	 * {@link ConfigurableApplicationContext} when it is created.
+	 * Create a {@link ContextCustomizer} that should be used to customize a
+	 * {@link org.springframework.context.ConfigurableApplicationContext ConfigurableApplicationContext}
+	 * before it is refreshed.
 	 * @param testClass the test class
-	 * @param configurationAttributes he list of context configuration attributes for the
-	 * test class, ordered <em>bottom-up</em> (i.e., as if we were traversing up the class
-	 * hierarchy); never {@code null} or empty.
-	 * @return a {@link ContextCustomizer} or {@code null}
+	 * @param configAttributes the list of context configuration attributes for
+	 * the test class, ordered <em>bottom-up</em> (i.e., as if we were traversing
+	 * up the class hierarchy); never {@code null} or empty
+	 * @return a {@link ContextCustomizer} or {@code null} if no customizer should
+	 * be used
 	 */
-	ContextCustomizer getContextCustomizer(Class<?> testClass,
-			List<ContextConfigurationAttributes> configurationAttributes);
+	ContextCustomizer createContextCustomizer(Class<?> testClass, List<ContextConfigurationAttributes> configAttributes);
 
 }

spring-test/src/main/java/org/springframework/test/context/MergedContextConfiguration.java

@@ -55,6 +55,7 @@
  * that was loaded using properties of this {@code MergedContextConfiguration}.
  *
  * @author Sam Brannen
+ * @author Phillip Webb
  * @since 3.1
  * @see ContextConfiguration
  * @see ContextHierarchy
@@ -74,6 +75,8 @@ public class MergedContextConfiguration implements Serializable {
 	private static final Set<Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>> EMPTY_INITIALIZER_CLASSES =
 			Collections.<Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>> emptySet();
 
+	private static final Set<ContextCustomizer> EMPTY_CONTEXT_CUSTOMIZERS = Collections.<ContextCustomizer> emptySet();
+
 
 	private final Class<?> testClass;
 
@@ -113,6 +116,11 @@ private static Set<Class<? extends ApplicationContextInitializer<? extends Confi
 				Collections.unmodifiableSet(contextInitializerClasses) : EMPTY_INITIALIZER_CLASSES);
 	}
 
+	private static Set<ContextCustomizer> processContextCustomizers(Set<ContextCustomizer> contextCustomizers) {
+		return (contextCustomizers != null ?
+				Collections.unmodifiableSet(contextCustomizers) : EMPTY_CONTEXT_CUSTOMIZERS);
+	}
+
 	private static String[] processActiveProfiles(String[] activeProfiles) {
 		if (activeProfiles == null) {
 			return EMPTY_STRING_ARRAY;
@@ -247,8 +255,8 @@ Collections.<ContextCustomizer> emptySet(), contextLoader,
 	 * <p>If a {@code null} value is supplied for {@code locations},
 	 * {@code classes}, {@code activeProfiles}, {@code propertySourceLocations},
 	 * or {@code propertySourceProperties} an empty array will be stored instead.
-	 * If a {@code null} value is supplied for the
-	 * {@code contextInitializerClasses} an empty set will be stored instead.
+	 * If a {@code null} value is supplied for {@code contextInitializerClasses}
+	 * or {@code contextCustomizers}, an empty set will be stored instead.
 	 * Furthermore, active profiles will be sorted, and duplicate profiles
 	 * will be removed.
 	 * @param testClass the test class for which the configuration was merged
@@ -258,11 +266,12 @@ Collections.<ContextCustomizer> emptySet(), contextLoader,
 	 * @param activeProfiles the merged active bean definition profiles
 	 * @param propertySourceLocations the merged {@code PropertySource} locations
 	 * @param propertySourceProperties the merged {@code PropertySource} properties
+	 * @param contextCustomizers the context customizers
 	 * @param contextLoader the resolved {@code ContextLoader}
 	 * @param cacheAwareContextLoaderDelegate a cache-aware context loader
 	 * delegate with which to retrieve the parent context
 	 * @param parent the parent configuration or {@code null} if there is no parent
-	 * @since 4.2
+	 * @since 4.3
 	 */
 	public MergedContextConfiguration(Class<?> testClass, String[] locations, Class<?>[] classes,
 			Set<Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>> contextInitializerClasses,
@@ -277,7 +286,7 @@ public MergedContextConfiguration(Class<?> testClass, String[] locations, Class<
 		this.activeProfiles = processActiveProfiles(activeProfiles);
 		this.propertySourceLocations = processStrings(propertySourceLocations);
 		this.propertySourceProperties = processStrings(propertySourceProperties);
-		this.contextCustomizers = Collections.unmodifiableSet(contextCustomizers);
+		this.contextCustomizers = processContextCustomizers(contextCustomizers);
 		this.contextLoader = contextLoader;
 		this.cacheAwareContextLoaderDelegate = cacheAwareContextLoaderDelegate;
 		this.parent = parent;
@@ -390,7 +399,7 @@ public String[] getPropertySourceProperties() {
 	 * when the application context is loaded.
 	 */
 	public Set<ContextCustomizer> getContextCustomizers() {
-		return contextCustomizers;
+		return this.contextCustomizers;
 	}
 
 	/**
@@ -515,6 +524,7 @@ public int hashCode() {
 	 * {@linkplain #getActiveProfiles() active profiles},
 	 * {@linkplain #getPropertySourceLocations() property source locations},
 	 * {@linkplain #getPropertySourceProperties() property source properties},
+	 * {@linkplain #getContextCustomizers() context customizers},
 	 * the name of the {@link #getContextLoader() ContextLoader}, and the
 	 * {@linkplain #getParent() parent configuration}.
 	 */
@@ -528,6 +538,7 @@ public String toString() {
 				.append("activeProfiles", ObjectUtils.nullSafeToString(this.activeProfiles))
 				.append("propertySourceLocations", ObjectUtils.nullSafeToString(this.propertySourceLocations))
 				.append("propertySourceProperties", ObjectUtils.nullSafeToString(this.propertySourceProperties))
+				.append("contextCustomizers", this.contextCustomizers)
 				.append("contextLoader", nullSafeToString(this.contextLoader))
 				.append("parent", this.parent)
 				.toString();

spring-test/src/main/java/org/springframework/test/context/support/AbstractContextLoader.java

@@ -28,7 +28,6 @@
 import org.springframework.context.ApplicationContextException;
 import org.springframework.context.ApplicationContextInitializer;
 import org.springframework.context.ConfigurableApplicationContext;
-import org.springframework.context.support.GenericApplicationContext;
 import org.springframework.core.GenericTypeResolver;
 import org.springframework.core.annotation.AnnotationAwareOrderComparator;
 import org.springframework.core.env.PropertySource;
@@ -58,10 +57,13 @@
  *
  * @author Sam Brannen
  * @author Juergen Hoeller
+ * @author Phillip Webb
  * @since 2.5
  * @see #generateDefaultLocations
  * @see #getResourceSuffixes
  * @see #modifyLocations
+ * @see #prepareContext
+ * @see #customizeContext
  */
 public abstract class AbstractContextLoader implements SmartContextLoader {
 
@@ -109,8 +111,6 @@ public void processContextConfiguration(ContextConfigurationAttributes configAtt
 	 * {@linkplain MergedContextConfiguration#getPropertySourceProperties()
 	 * inlined properties} from the supplied {@code MergedContextConfiguration}
 	 * to the {@code Environment} of the context.</li>
-	 * <li>Calls any {@link MergedContextConfiguration#getContextCustomizers()
-	 * ContextCustomizers} that are part of the {@link MergedContextConfiguration}.</li>
 	 * <li>Determines what (if any) context initializer classes have been supplied
 	 * via the {@code MergedContextConfiguration} and instantiates and
 	 * {@linkplain ApplicationContextInitializer#initialize invokes} each with the
@@ -173,18 +173,16 @@ private void invokeApplicationContextInitializers(ConfigurableApplicationContext
 
 	/**
 	 * Customize the {@link ConfigurableApplicationContext} created by this
-	 * {@code ContextLoader} <i>after</i> bean definitions have been
-	 * loaded into the context but <i>before</i> the context is refreshed.
-	 *
-	 * <p>The default implementation triggers all the
-	 * {@link MergedContextConfiguration#getContextCustomizers() context customizers} that
-	 * have been registered with the {@code mergedConfig}.
-	 *
+	 * {@code ContextLoader} <em>after</em> bean definitions have been loaded
+	 * into the context but <em>before</em> the context has been refreshed.
+	 * <p>The default implementation delegates to all
+	 * {@link MergedContextConfiguration#getContextCustomizers context customizers}
+	 * that have been registered with the supplied {@code mergedConfig}.
 	 * @param context the newly created application context
 	 * @param mergedConfig the merged context configuration
 	 * @since 4.3
 	 */
-	protected void customizeContext(GenericApplicationContext context, MergedContextConfiguration mergedConfig) {
+	protected void customizeContext(ConfigurableApplicationContext context, MergedContextConfiguration mergedConfig) {
 		for (ContextCustomizer contextCustomizer : mergedConfig.getContextCustomizers()) {
 			contextCustomizer.customizeContext(context, mergedConfig);
 		}

spring-test/src/main/java/org/springframework/test/context/support/AbstractDelegatingSmartContextLoader.java

@@ -253,7 +253,8 @@ public ApplicationContext loadContext(MergedContextConfiguration mergedConfig) t
 		}
 
 		// If neither of the candidates supports the mergedConfig based on resources but
-		// ACIs were declared, then delegate to the annotation config loader.
+		// ACIs or customizers were declared, then delegate to the annotation config
+		// loader.
 		if (!mergedConfig.getContextInitializerClasses().isEmpty() || !mergedConfig.getContextCustomizers().isEmpty()) {
 			return delegateLoading(getAnnotationConfigLoader(), mergedConfig);
 		}

spring-test/src/main/java/org/springframework/test/context/support/AbstractGenericContextLoader.java

@@ -16,7 +16,6 @@
 
 package org.springframework.test.context.support;
 
-
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
@@ -53,6 +52,7 @@
  *
  * @author Sam Brannen
  * @author Juergen Hoeller
+ * @author Phillip Webb
  * @since 2.5
  * @see #loadContext(MergedContextConfiguration)
  * @see #loadContext(String...)
@@ -92,6 +92,8 @@ public abstract class AbstractGenericContextLoader extends AbstractContextLoader
 	 * annotation configuration processors.</li>
 	 * <li>Calls {@link #customizeContext(GenericApplicationContext)} to allow for customizing the context
 	 * before it is refreshed.</li>
+	 * <li>Calls {@link #customizeContext(ConfigurableApplicationContext, MergedContextConfiguration)} to
+	 * allow for customizing the context before it is refreshed.</li>
 	 * <li>{@link ConfigurableApplicationContext#refresh Refreshes} the
 	 * context and registers a JVM shutdown hook for it.</li>
 	 * </ul>
@@ -206,6 +208,7 @@ public final ConfigurableApplicationContext loadContext(String... locations) thr
 	 * @see GenericApplicationContext#setAllowBeanDefinitionOverriding
 	 * @see GenericApplicationContext#setResourceLoader
 	 * @see GenericApplicationContext#setId
+	 * @see #prepareContext(ConfigurableApplicationContext, MergedContextConfiguration)
 	 * @since 2.5
 	 */
 	protected void prepareContext(GenericApplicationContext context) {
@@ -279,6 +282,7 @@ protected void loadBeanDefinitions(GenericApplicationContext context, MergedCont
 	 * @param context the newly created application context
 	 * @see #loadContext(MergedContextConfiguration)
 	 * @see #loadContext(String...)
+	 * @see #customizeContext(ConfigurableApplicationContext, MergedContextConfiguration)
 	 * @since 2.5
 	 */
 	protected void customizeContext(GenericApplicationContext context) {

spring-test/src/main/java/org/springframework/test/context/support/AbstractTestContextBootstrapper.java

@@ -410,12 +410,16 @@ private MergedContextConfiguration buildMergedContextConfiguration(Class<?> test
 		return processMergedContextConfiguration(mergedConfig);
 	}
 
+	/**
+	 * @since 4.3
+	 */
 	private Set<ContextCustomizer> getContextCustomizers(Class<?> testClass,
-			List<ContextConfigurationAttributes> configurationAttributes) {
-		List<ContextCustomizerFactory> factories = geContextCustomizerFactories();
+			List<ContextConfigurationAttributes> configAttributes) {
+
+		List<ContextCustomizerFactory> factories = getContextCustomizerFactories();
 		Set<ContextCustomizer> customizers = new LinkedHashSet<ContextCustomizer>(factories.size());
 		for (ContextCustomizerFactory factory : factories) {
-			ContextCustomizer customizer = factory.getContextCustomizer(testClass, configurationAttributes);
+			ContextCustomizer customizer = factory.createContextCustomizer(testClass, configAttributes);
 			if (customizer != null) {
 				customizers.add(customizer);
 			}
@@ -424,13 +428,20 @@ private Set<ContextCustomizer> getContextCustomizers(Class<?> testClass,
 	}
 
 	/**
-	 * Get the default {@link ContextCustomizerFactory} instances for this bootstrapper.
+	 * Get the {@link ContextCustomizerFactory} instances for this bootstrapper.
+	 * <p>The default implementation uses the {@link SpringFactoriesLoader} mechanism
+	 * for loading factories configured in all {@code META-INF/spring.factories}
+	 * files on the classpath.
+	 * @since 4.3
+	 * @see SpringFactoriesLoader#loadFactories
 	 */
-	protected List<ContextCustomizerFactory> geContextCustomizerFactories() {
-		return SpringFactoriesLoader.loadFactories(ContextCustomizerFactory.class,
-				getClass().getClassLoader());
+	protected List<ContextCustomizerFactory> getContextCustomizerFactories() {
+		return SpringFactoriesLoader.loadFactories(ContextCustomizerFactory.class, getClass().getClassLoader());
 	}
 
+	/**
+	 * @since 4.3
+	 */
 	private boolean areAllEmpty(Collection<?>... collections) {
 		for (Collection<?> collection : collections) {
 			if (!collection.isEmpty()) {

spring-test/src/main/java/org/springframework/test/context/web/AbstractGenericWebContextLoader.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2016 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -53,6 +53,7 @@
  * {@link #loadBeanDefinitions}.
  *
  * @author Sam Brannen
+ * @author Phillip Webb
  * @since 3.2
  * @see #loadContext(MergedContextConfiguration)
  * @see #loadContext(String...)
@@ -256,10 +257,14 @@ protected abstract void loadBeanDefinitions(GenericWebApplicationContext context
 	 * loader <i>after</i> bean definitions have been loaded into the context but
 	 * <i>before</i> the context is refreshed.
 	 *
+	 * <p>The default implementation simply delegates to
+	 * {@link AbstractContextLoader#customizeContext(ConfigurableApplicationContext, MergedContextConfiguration)}.
+	 *
 	 * @param context the newly created web application context
 	 * @param webMergedConfig the merged context configuration to use to load the
 	 * web application context
 	 * @see #loadContext(MergedContextConfiguration)
+	 * @see #customizeContext(ConfigurableApplicationContext, MergedContextConfiguration)
 	 */
 	protected void customizeContext(GenericWebApplicationContext context, WebMergedContextConfiguration webMergedConfig) {
 		super.customizeContext(context, webMergedConfig);