[SPR-8387] Introduced supports(MergedContextConfiguration) method in the SmartContextLoader SPI; updated existing loaders accordingly; and fleshed out implementation of and tests for the new DelegatingSmartContextLoader.

sbrannen · sbrannen · commit 4cbe2ae00aae · 2011-06-26T16:46:18.000Z
diff --git a/org.springframework.test/src/main/java/org/springframework/test/context/SmartContextLoader.java b/org.springframework.test/src/main/java/org/springframework/test/context/SmartContextLoader.java
@@ -95,6 +95,14 @@ public interface SmartContextLoader extends ContextLoader {
 	 */
 	void processContextConfiguration(ContextConfigurationAttributes configAttributes);
 
+	/**
+	 * TODO Document supports(MergedContextConfiguration).
+	 *
+	 * @param mergedConfig
+	 * @return
+	 */
+	boolean supports(MergedContextConfiguration mergedConfig);
+
 	/**
 	 * Loads a new {@link ApplicationContext context} based on the supplied
 	 * {@link MergedContextConfiguration merged context configuration},
diff --git a/org.springframework.test/src/main/java/org/springframework/test/context/support/AbstractContextLoader.java b/org.springframework.test/src/main/java/org/springframework/test/context/support/AbstractContextLoader.java
@@ -23,6 +23,7 @@
 import org.springframework.core.io.support.ResourcePatternUtils;
 import org.springframework.test.context.ContextConfigurationAttributes;
 import org.springframework.test.context.ContextLoader;
+import org.springframework.test.context.MergedContextConfiguration;
 import org.springframework.test.context.SmartContextLoader;
 import org.springframework.util.Assert;
 import org.springframework.util.ClassUtils;
@@ -90,6 +91,13 @@ public void processContextConfiguration(ContextConfigurationAttributes configAtt
 		configAttributes.setLocations(processedLocations);
 	}
 
+	/**
+	 * TODO Document default supports(MergedContextConfiguration) implementation.
+	 */
+	public boolean supports(MergedContextConfiguration mergedConfig) {
+		return !ObjectUtils.isEmpty(mergedConfig.getLocations());
+	}
+
 	// --- ContextLoader -------------------------------------------------------
 
 	/**
diff --git a/org.springframework.test/src/main/java/org/springframework/test/context/support/AnnotationConfigContextLoader.java b/org.springframework.test/src/main/java/org/springframework/test/context/support/AnnotationConfigContextLoader.java
@@ -81,6 +81,14 @@ public void processContextConfiguration(ContextConfigurationAttributes configAtt
 		}
 	}
 
+	/**
+	 * TODO Document overridden supports(MergedContextConfiguration) implementation.
+	 */
+	@Override
+	public boolean supports(MergedContextConfiguration mergedConfig) {
+		return ObjectUtils.isEmpty(mergedConfig.getLocations()) && !ObjectUtils.isEmpty(mergedConfig.getClasses());
+	}
+
 	// --- AnnotationConfigContextLoader ---------------------------------------
 
 	private boolean isStaticNonPrivateAndNonFinal(Class<?> clazz) {
diff --git a/org.springframework.test/src/main/java/org/springframework/test/context/support/DelegatingSmartContextLoader.java b/org.springframework.test/src/main/java/org/springframework/test/context/support/DelegatingSmartContextLoader.java
@@ -26,6 +26,7 @@
 import org.springframework.test.context.ContextLoader;
 import org.springframework.test.context.MergedContextConfiguration;
 import org.springframework.test.context.SmartContextLoader;
+import org.springframework.util.ObjectUtils;
 
 /**
  * TODO Document DelegatingSmartContextLoader.
@@ -62,6 +63,11 @@ public boolean generatesDefaults() {
 	 * TODO Document processContextConfiguration() implementation.
 	 */
 	public void processContextConfiguration(ContextConfigurationAttributes configAttributes) {
+
+		final String[] originalLocations = configAttributes.getLocations();
+		final Class<?>[] originalClasses = configAttributes.getClasses();
+		final boolean emptyResources = ObjectUtils.isEmpty(originalLocations) && ObjectUtils.isEmpty(originalClasses);
+
 		for (SmartContextLoader loader : candidates) {
 			if (logger.isDebugEnabled()) {
 				logger.debug(String.format("Delegating to loader [%s] to process context configuration [%s].",
@@ -73,7 +79,9 @@ public void processContextConfiguration(ContextConfigurationAttributes configAtt
 			// If the original locations and classes are not empty, there's no
 			// need to bother with default generation checks; just let each
 			// loader process the configuration.
-			//
+			if (!emptyResources) {
+				loader.processContextConfiguration(configAttributes);
+			}
 			// Otherwise, if a loader claims to generate defaults, let it
 			// process the configuration, and then verify that it actually did
 			// generate defaults.
@@ -83,9 +91,26 @@ public void processContextConfiguration(ContextConfigurationAttributes configAtt
 			// 1) stop iterating
 			// 2) mark the current loader as the winning candidate (?)
 			// 3) log an info message.
+			else {
+				if (loader.generatesDefaults()) {
+					loader.processContextConfiguration(configAttributes);
+				}
+			}
+		}
+		// If any loader claims to generate defaults but none actually did,
+		// throw an exception.
+	}
 
-			loader.processContextConfiguration(configAttributes);
+	/**
+	 * TODO Document supports(MergedContextConfiguration) implementation.
+	 */
+	public boolean supports(MergedContextConfiguration mergedConfig) {
+		for (SmartContextLoader loader : candidates) {
+			if (loader.supports(mergedConfig)) {
+				return true;
+			}
 		}
+		return false;
 	}
 
 	/**
@@ -99,21 +124,16 @@ public ApplicationContext loadContext(MergedContextConfiguration mergedConfig) t
 					loader.getClass().getName(), mergedConfig));
 			}
 
-			// TODO Implement loadContext(MergedContextConfiguration).
-			//
-			// Ask each loader if it _can_ load a context from the mergedConfig.
+			// Ask each loader if it can load a context from the mergedConfig.
 			// If a loader can, let it; otherwise, continue iterating over all
 			// remaining candidates.
-			//
-			// If no candidate can load a context from the mergedConfig, throw
-			// an exception.
+			if (loader.supports(mergedConfig)) {
+				return loader.loadContext(mergedConfig);
+			}
 		}
 
-		// TODO Implement delegation logic.
-		//
-		// Proof of concept: ensuring that hard-coded delegation to
-		// GenericXmlContextLoader works "as is".
-		return candidates.get(0).loadContext(mergedConfig);
+		throw new IllegalStateException(String.format("None of the candidate SmartContextLoaders [%s] "
+				+ "was able to load an ApplicationContext from [%s].", candidates, mergedConfig));
 	}
 
 	// --- ContextLoader -------------------------------------------------------
diff --git a/org.springframework.test/src/test/java/org/springframework/test/context/junit4/SpringJUnit4SuiteTests.java b/org.springframework.test/src/test/java/org/springframework/test/context/junit4/SpringJUnit4SuiteTests.java
@@ -26,6 +26,13 @@
 import org.springframework.test.context.junit4.annotation.BeanOverridingExplicitConfigClassesInheritedTests;
 import org.springframework.test.context.junit4.annotation.DefaultConfigClassesBaseTests;
 import org.springframework.test.context.junit4.annotation.DefaultConfigClassesInheritedTests;
+import org.springframework.test.context.junit4.annotation.DefaultLoaderBeanOverridingDefaultConfigClassesInheritedTests;
+import org.springframework.test.context.junit4.annotation.DefaultLoaderBeanOverridingExplicitConfigClassesInheritedTests;
+import org.springframework.test.context.junit4.annotation.DefaultLoaderDefaultConfigClassesBaseTests;
+import org.springframework.test.context.junit4.annotation.DefaultLoaderDefaultConfigClassesInheritedTests;
+import org.springframework.test.context.junit4.annotation.DefaultLoaderExplicitConfigClassesBaseTests;
+import org.springframework.test.context.junit4.annotation.DefaultLoaderExplicitConfigClassesInheritedTests;
+import org.springframework.test.context.junit4.annotation.ExplicitConfigClassesBaseTests;
 import org.springframework.test.context.junit4.annotation.ExplicitConfigClassesInheritedTests;
 import org.springframework.test.context.junit4.orm.HibernateSessionFlushingTests;
 import org.springframework.test.context.junit4.profile.annotation.DefaultProfileAnnotationConfigTests;
@@ -58,12 +65,19 @@
 	DefaultConfigClassesBaseTests.class,//
 	DefaultConfigClassesInheritedTests.class,//
 	BeanOverridingDefaultConfigClassesInheritedTests.class,//
+	ExplicitConfigClassesBaseTests.class,//
 	ExplicitConfigClassesInheritedTests.class,//
 	BeanOverridingExplicitConfigClassesInheritedTests.class,//
+	DefaultLoaderDefaultConfigClassesBaseTests.class,//
+	DefaultLoaderDefaultConfigClassesInheritedTests.class,//
+	DefaultLoaderBeanOverridingDefaultConfigClassesInheritedTests.class,//
+	DefaultLoaderExplicitConfigClassesBaseTests.class,//
+	DefaultLoaderExplicitConfigClassesInheritedTests.class,//
+	DefaultLoaderBeanOverridingExplicitConfigClassesInheritedTests.class,//
 	DefaultProfileAnnotationConfigTests.class,//
-	DevProfileAnnotationConfigTests.class, //
+	DevProfileAnnotationConfigTests.class,//
 	DefaultProfileXmlConfigTests.class,//
-	DevProfileXmlConfigTests.class, //
+	DevProfileXmlConfigTests.class,//
 	ExpectedExceptionSpringRunnerTests.class,//
 	TimedSpringRunnerTests.class,//
 	RepeatedSpringRunnerTests.class,//
diff --git a/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/AnnotationConfigSpringJUnit4ClassRunnerAppCtxTests.java b/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/AnnotationConfigSpringJUnit4ClassRunnerAppCtxTests.java
@@ -18,7 +18,6 @@
 
 import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.context.junit4.SpringJUnit4ClassRunnerAppCtxTests;
-import org.springframework.test.context.support.AnnotationConfigContextLoader;
 
 /**
  * Integration tests that verify support for configuration classes in
@@ -34,7 +33,7 @@
  * @author Sam Brannen
  * @since 3.1
  */
-@ContextConfiguration(loader = AnnotationConfigContextLoader.class, classes = PojoAndStringConfig.class, inheritLocations = false)
+@ContextConfiguration(classes = PojoAndStringConfig.class, inheritLocations = false)
 public class AnnotationConfigSpringJUnit4ClassRunnerAppCtxTests extends SpringJUnit4ClassRunnerAppCtxTests {
 	/* all tests are in the parent class. */
 }
diff --git a/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/AnnotationConfigTestSuite.java b/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/AnnotationConfigTestSuite.java
@@ -34,8 +34,15 @@
 	DefaultConfigClassesBaseTests.class,//
 	DefaultConfigClassesInheritedTests.class,//
 	BeanOverridingDefaultConfigClassesInheritedTests.class,//
+	ExplicitConfigClassesBaseTests.class,//
+	ExplicitConfigClassesInheritedTests.class,//
 	BeanOverridingExplicitConfigClassesInheritedTests.class,//
-	ExplicitConfigClassesInheritedTests.class //
+	DefaultLoaderDefaultConfigClassesBaseTests.class,//
+	DefaultLoaderDefaultConfigClassesInheritedTests.class,//
+	DefaultLoaderBeanOverridingDefaultConfigClassesInheritedTests.class,//
+	DefaultLoaderExplicitConfigClassesBaseTests.class,//
+	DefaultLoaderExplicitConfigClassesInheritedTests.class,//
+	DefaultLoaderBeanOverridingExplicitConfigClassesInheritedTests.class //
 })
 public class AnnotationConfigTestSuite {
 }
diff --git a/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/BeanOverridingDefaultConfigClassesInheritedTests.java b/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/BeanOverridingDefaultConfigClassesInheritedTests.java
@@ -29,8 +29,8 @@
  * Integration tests that verify support for configuration classes in
  * the Spring TestContext Framework.
  * 
- * <p>Configuration will be loaded from {@link DefaultConfigClassesBaseTestsConfig}
- * and {@link BeanOverridingDefaultConfigClassesInheritedTestsConfig}.
+ * <p>Configuration will be loaded from {@link DefaultConfigClassesBaseTests.ContextConfiguration}
+ * and {@link BeanOverridingDefaultConfigClassesInheritedTests.ContextConfiguration}.
  * 
  * @author Sam Brannen
  * @since 3.1
diff --git a/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/BeanOverridingExplicitConfigClassesInheritedTests.java b/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/BeanOverridingExplicitConfigClassesInheritedTests.java
@@ -26,8 +26,8 @@
  * Integration tests that verify support for configuration classes in
  * the Spring TestContext Framework.
  * 
- * <p>Configuration will be loaded from {@link DefaultConfigClassesBaseTestsConfig}
- * and {@link BeanOverridingDefaultConfigClassesInheritedTestsConfig}.
+ * <p>Configuration will be loaded from {@link DefaultConfigClassesBaseTests.ContextConfiguration}
+ * and {@link BeanOverridingDefaultConfigClassesInheritedTests.ContextConfiguration}.
  * 
  * @author Sam Brannen
  * @since 3.1
diff --git a/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/DefaultConfigClassesBaseTests.java b/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/DefaultConfigClassesBaseTests.java
@@ -33,7 +33,7 @@
  * Integration tests that verify support for configuration classes in
  * the Spring TestContext Framework.
  * 
- * <p>Configuration will be loaded from {@link DefaultConfigClassesBaseTestsConfig}.
+ * <p>Configuration will be loaded from {@link DefaultConfigClassesBaseTests.ContextConfiguration}.
  * 
  * @author Sam Brannen
  * @since 3.1
diff --git a/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/DefaultConfigClassesInheritedTests.java b/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/DefaultConfigClassesInheritedTests.java
@@ -30,8 +30,8 @@
  * Integration tests that verify support for configuration classes in
  * the Spring TestContext Framework.
  * 
- * <p>Configuration will be loaded from {@link DefaultConfigClassesBaseTestsConfig}
- * and {@link DefaultConfigClassesInheritedTestsConfig}.
+ * <p>Configuration will be loaded from {@link DefaultConfigClassesBaseTests.ContextConfiguration}
+ * and {@link DefaultConfigClassesInheritedTests.ContextConfiguration}.
  * 
  * @author Sam Brannen
  * @since 3.1
diff --git a/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/DefaultLoaderBeanOverridingDefaultConfigClassesInheritedTests.java b/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/DefaultLoaderBeanOverridingDefaultConfigClassesInheritedTests.java
@@ -0,0 +1,62 @@
+/*
+ * Copyright 2002-2011 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.test.context.junit4.annotation;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+import org.junit.Test;
+import org.springframework.beans.Employee;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.support.DelegatingSmartContextLoader;
+
+/**
+ * Integration tests that verify support for configuration classes in
+ * the Spring TestContext Framework in conjunction with the
+ * {@link DelegatingSmartContextLoader}.
+ * 
+ * @author Sam Brannen
+ * @since 3.1
+ */
+@ContextConfiguration
+public class DefaultLoaderBeanOverridingDefaultConfigClassesInheritedTests extends
+		DefaultLoaderDefaultConfigClassesBaseTests {
+
+	@Configuration
+	static class Config {
+
+		@Bean
+		public Employee employee() {
+			Employee employee = new Employee();
+			employee.setName("Yoda");
+			employee.setAge(900);
+			employee.setCompany("The Force");
+			return employee;
+		}
+	}
+
+
+	@Test
+	@Override
+	public void verifyEmployeeSetFromBaseContextConfig() {
+		assertNotNull("The employee should have been autowired.", this.employee);
+		assertEquals("The employee bean should have been overridden.", "Yoda", this.employee.getName());
+	}
+
+}
diff --git a/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/DefaultLoaderBeanOverridingExplicitConfigClassesInheritedTests.java b/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/DefaultLoaderBeanOverridingExplicitConfigClassesInheritedTests.java
@@ -0,0 +1,45 @@
+/*
+ * Copyright 2002-2011 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.test.context.junit4.annotation;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+import org.junit.Test;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.support.DelegatingSmartContextLoader;
+
+/**
+ * Integration tests that verify support for configuration classes in
+ * the Spring TestContext Framework in conjunction with the
+ * {@link DelegatingSmartContextLoader}.
+ * 
+ * @author Sam Brannen
+ * @since 3.1
+ */
+@ContextConfiguration(classes = DefaultLoaderBeanOverridingDefaultConfigClassesInheritedTests.Config.class)
+public class DefaultLoaderBeanOverridingExplicitConfigClassesInheritedTests extends
+		DefaultLoaderExplicitConfigClassesBaseTests {
+
+	@Test
+	@Override
+	public void verifyEmployeeSetFromBaseContextConfig() {
+		assertNotNull("The employee should have been autowired.", this.employee);
+		assertEquals("The employee bean should have been overridden.", "Yoda", this.employee.getName());
+	}
+
+}
diff --git a/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/DefaultLoaderDefaultConfigClassesBaseTests.java b/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/DefaultLoaderDefaultConfigClassesBaseTests.java
diff --git a/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/DefaultLoaderDefaultConfigClassesInheritedTests.java b/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/DefaultLoaderDefaultConfigClassesInheritedTests.java
diff --git a/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/DefaultLoaderExplicitConfigClassesBaseTests.java b/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/DefaultLoaderExplicitConfigClassesBaseTests.java
diff --git a/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/DefaultLoaderExplicitConfigClassesInheritedTests.java b/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/DefaultLoaderExplicitConfigClassesInheritedTests.java
diff --git a/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/ExplicitConfigClassesBaseTests.java b/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/ExplicitConfigClassesBaseTests.java
diff --git a/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/ExplicitConfigClassesInheritedTests.java b/org.springframework.test/src/test/java/org/springframework/test/context/junit4/annotation/ExplicitConfigClassesInheritedTests.java

Original file line number	Diff line number	Diff line change
`@@ -81,6 +81,14 @@ public void processContextConfiguration(ContextConfigurationAttributes configAtt`
`81`	`81`	`}`
`82`	`82`	`}`
`83`	`83`
	`84`	`+ /**`
	`85`	`+ * TODO Document overridden supports(MergedContextConfiguration) implementation.`
	`86`	`+ */`
	`87`	`+ @Override`
	`88`	`+ public boolean supports(MergedContextConfiguration mergedConfig) {`
	`89`	`+ return ObjectUtils.isEmpty(mergedConfig.getLocations()) && !ObjectUtils.isEmpty(mergedConfig.getClasses());`
	`90`	`+ }`
	`91`	`+`
`84`	`92`	`// --- AnnotationConfigContextLoader ---------------------------------------`
`85`	`93`
`86`	`94`	`private boolean isStaticNonPrivateAndNonFinal(Class<?> clazz) {`
Original file line number	Diff line number	Diff line change
`@@ -29,8 +29,8 @@`
`29`	`29`	`* Integration tests that verify support for configuration classes in`
`30`	`30`	`* the Spring TestContext Framework.`
`31`	`31`	`*`
`32`		`- * <p>Configuration will be loaded from {@link DefaultConfigClassesBaseTestsConfig}`
`33`		`- * and {@link BeanOverridingDefaultConfigClassesInheritedTestsConfig}.`
	`32`	`+ * <p>Configuration will be loaded from {@link DefaultConfigClassesBaseTests.ContextConfiguration}`
	`33`	`+ * and {@link BeanOverridingDefaultConfigClassesInheritedTests.ContextConfiguration}.`
`34`	`34`	`*`
`35`	`35`	`* @author Sam Brannen`
`36`	`36`	`* @since 3.1`
Original file line number	Diff line number	Diff line change
`@@ -26,8 +26,8 @@`
`26`	`26`	`* Integration tests that verify support for configuration classes in`
`27`	`27`	`* the Spring TestContext Framework.`
`28`	`28`	`*`
`29`		`- * <p>Configuration will be loaded from {@link DefaultConfigClassesBaseTestsConfig}`
`30`		`- * and {@link BeanOverridingDefaultConfigClassesInheritedTestsConfig}.`
	`29`	`+ * <p>Configuration will be loaded from {@link DefaultConfigClassesBaseTests.ContextConfiguration}`
	`30`	`+ * and {@link BeanOverridingDefaultConfigClassesInheritedTests.ContextConfiguration}.`
`31`	`31`	`*`
`32`	`32`	`* @author Sam Brannen`
`33`	`33`	`* @since 3.1`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@`
`33`	`33`	`* Integration tests that verify support for configuration classes in`
`34`	`34`	`* the Spring TestContext Framework.`
`35`	`35`	`*`
`36`		`- * <p>Configuration will be loaded from {@link DefaultConfigClassesBaseTestsConfig}.`
	`36`	`+ * <p>Configuration will be loaded from {@link DefaultConfigClassesBaseTests.ContextConfiguration}.`
`37`	`37`	`*`
`38`	`38`	`* @author Sam Brannen`
`39`	`39`	`* @since 3.1`