Always supply test class to ContextLoaders in TCF

Prior to this commit, the following methods in ContextLoaderUtils
treated a composed @ContextConfiguration annotation (i.e., a custom
annotation that is meta-annotated with @ContextConfiguration) as the
"declaring class" instead of the actual test class.

- resolveContextConfigurationAttributes()
- resolveContextHierarchyAttributes()

As a consequence, if @ContextConfiguration is used as a
meta-annotation, the meta-annotated class is stored as the
"declaringClass" in ContextConfigurationAttributes. Thus, when a
ContextLoader (or SmartContextLoader) attempts to detect default
resource locations or configuration classes, it does so for the
composed annotation class instead of for the declaring test class.

This commit ensures that ContextLoaders are supplied the declaring test
class instead of the composed annotation class in such use cases.

Issue: SPR-11455

Author: sbrannen

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

@@ -261,9 +261,9 @@ private static void convertAnnotationAttributesToConfigAttributesAndAddToList(An
 	 * never {@code null}
 	 * @throws IllegalArgumentException if the supplied class is {@code null}; if
 	 * neither {@code @ContextConfiguration} nor {@code @ContextHierarchy} is
-	 * <em>present</em> on the supplied class; or if a given class in the class hierarchy
-	 * declares both {@code @ContextConfiguration} and {@code @ContextHierarchy} as
-	 * top-level annotations.
+	 * <em>present</em> on the supplied class; or if a test class or composed annotation
+	 * in the class hierarchy declares both {@code @ContextConfiguration} and
+	 * {@code @ContextHierarchy} as top-level annotations.
 	 * @throws IllegalStateException if no class in the class hierarchy declares
 	 * {@code @ContextHierarchy}.
 	 *
@@ -296,7 +296,7 @@ static List<List<ContextConfigurationAttributes>> resolveContextHierarchyAttribu
 			if (contextConfigDeclaredLocally && contextHierarchyDeclaredLocally) {
 				String msg = String.format("Class [%s] has been configured with both @ContextConfiguration "
 						+ "and @ContextHierarchy. Only one of these annotations may be declared on a test class "
-						+ "or custom stereotype annotation.", declaringClass.getName());
+						+ "or composed annotation.", declaringClass.getName());
 				logger.error(msg);
 				throw new IllegalStateException(msg);
 			}
@@ -305,12 +305,12 @@ static List<List<ContextConfigurationAttributes>> resolveContextHierarchyAttribu
 
 			if (contextConfigDeclaredLocally) {
 				convertAnnotationAttributesToConfigAttributesAndAddToList(descriptor.getAnnotationAttributes(),
-					declaringClass, configAttributesList);
+					rootDeclaringClass, configAttributesList);
 			}
 			else if (contextHierarchyDeclaredLocally) {
 				ContextHierarchy contextHierarchy = getAnnotation(declaringClass, contextHierarchyType);
 				for (ContextConfiguration contextConfiguration : contextHierarchy.value()) {
-					convertContextConfigToConfigAttributesAndAddToList(contextConfiguration, declaringClass,
+					convertContextConfigToConfigAttributesAndAddToList(contextConfiguration, rootDeclaringClass,
 						configAttributesList);
 				}
 			}
@@ -428,7 +428,7 @@ static List<ContextConfigurationAttributes> resolveContextConfigurationAttribute
 
 		while (descriptor != null) {
 			convertAnnotationAttributesToConfigAttributesAndAddToList(descriptor.getAnnotationAttributes(),
-				descriptor.getDeclaringClass(), attributesList);
+				descriptor.getRootDeclaringClass(), attributesList);
 			descriptor = findAnnotationDescriptor(descriptor.getRootDeclaringClass().getSuperclass(), annotationType);
 		}
 

spring-test/src/test/java/org/springframework/test/context/AbstractContextLoaderUtilsTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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.
@@ -47,11 +47,11 @@ abstract class AbstractContextLoaderUtilsTests {
 	void assertAttributes(ContextConfigurationAttributes attributes, Class<?> expectedDeclaringClass,
 			String[] expectedLocations, Class<?>[] expectedClasses,
 			Class<? extends ContextLoader> expectedContextLoaderClass, boolean expectedInheritLocations) {
-		assertEquals(expectedDeclaringClass, attributes.getDeclaringClass());
-		assertArrayEquals(expectedLocations, attributes.getLocations());
-		assertArrayEquals(expectedClasses, attributes.getClasses());
-		assertEquals(expectedInheritLocations, attributes.isInheritLocations());
-		assertEquals(expectedContextLoaderClass, attributes.getContextLoaderClass());
+		assertEquals("declaring class", expectedDeclaringClass, attributes.getDeclaringClass());
+		assertArrayEquals("locations", expectedLocations, attributes.getLocations());
+		assertArrayEquals("classes", expectedClasses, attributes.getClasses());
+		assertEquals("inherit locations", expectedInheritLocations, attributes.isInheritLocations());
+		assertEquals("context loader", expectedContextLoaderClass, attributes.getContextLoaderClass());
 	}
 
 	void assertMergedConfig(MergedContextConfiguration mergedConfig, Class<?> expectedTestClass,

spring-test/src/test/java/org/springframework/test/context/ContextLoaderUtilsConfigurationAttributesTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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.
@@ -59,11 +59,12 @@ public void resolveConfigAttributesWithConflictingLocations() {
 
 	@Test
 	public void resolveConfigAttributesWithBareAnnotations() {
-		List<ContextConfigurationAttributes> attributesList = resolveContextConfigurationAttributes(BareAnnotations.class);
+		Class<BareAnnotations> testClass = BareAnnotations.class;
+		List<ContextConfigurationAttributes> attributesList = resolveContextConfigurationAttributes(testClass);
 		assertNotNull(attributesList);
 		assertEquals(1, attributesList.size());
-		assertAttributes(attributesList.get(0), BareAnnotations.class, EMPTY_STRING_ARRAY, EMPTY_CLASS_ARRAY,
-			ContextLoader.class, true);
+		assertAttributes(attributesList.get(0), testClass, EMPTY_STRING_ARRAY, EMPTY_CLASS_ARRAY, ContextLoader.class,
+			true);
 	}
 
 	@Test
@@ -76,39 +77,43 @@ public void resolveConfigAttributesWithLocalAnnotationAndLocations() {
 
 	@Test
 	public void resolveConfigAttributesWithMetaAnnotationAndLocations() {
-		List<ContextConfigurationAttributes> attributesList = resolveContextConfigurationAttributes(MetaLocationsFoo.class);
+		Class<MetaLocationsFoo> testClass = MetaLocationsFoo.class;
+		List<ContextConfigurationAttributes> attributesList = resolveContextConfigurationAttributes(testClass);
 		assertNotNull(attributesList);
 		assertEquals(1, attributesList.size());
-		assertAttributes(attributesList.get(0), MetaLocationsFooConfig.class, new String[] { "/foo.xml" },
-			EMPTY_CLASS_ARRAY, ContextLoader.class, true);
+		assertAttributes(attributesList.get(0), testClass, new String[] { "/foo.xml" }, EMPTY_CLASS_ARRAY,
+			ContextLoader.class, true);
 	}
 
 	@Test
 	public void resolveConfigAttributesWithMetaAnnotationAndLocationsAndOverrides() {
-		List<ContextConfigurationAttributes> attributesList = resolveContextConfigurationAttributes(MetaLocationsFooWithOverrides.class);
+		Class<MetaLocationsFooWithOverrides> testClass = MetaLocationsFooWithOverrides.class;
+		List<ContextConfigurationAttributes> attributesList = resolveContextConfigurationAttributes(testClass);
 		assertNotNull(attributesList);
 		assertEquals(1, attributesList.size());
-		assertAttributes(attributesList.get(0), MetaLocationsFooConfigWithOverrides.class, new String[] { "/foo.xml" },
-			EMPTY_CLASS_ARRAY, ContextLoader.class, true);
+		assertAttributes(attributesList.get(0), testClass, new String[] { "/foo.xml" }, EMPTY_CLASS_ARRAY,
+			ContextLoader.class, true);
 	}
 
 	@Test
 	public void resolveConfigAttributesWithMetaAnnotationAndLocationsAndOverriddenAttributes() {
-		List<ContextConfigurationAttributes> attributesList = resolveContextConfigurationAttributes(MetaLocationsFooWithOverriddenAttributes.class);
+		Class<MetaLocationsFooWithOverriddenAttributes> testClass = MetaLocationsFooWithOverriddenAttributes.class;
+		List<ContextConfigurationAttributes> attributesList = resolveContextConfigurationAttributes(testClass);
 		assertNotNull(attributesList);
 		assertEquals(1, attributesList.size());
-		assertAttributes(attributesList.get(0), MetaLocationsFooConfigWithOverrides.class, new String[] { "foo1.xml",
-			"foo2.xml" }, EMPTY_CLASS_ARRAY, ContextLoader.class, true);
+		assertAttributes(attributesList.get(0), testClass, new String[] { "foo1.xml", "foo2.xml" }, EMPTY_CLASS_ARRAY,
+			ContextLoader.class, true);
 	}
 
 	@Test
 	public void resolveConfigAttributesWithMetaAnnotationAndLocationsInClassHierarchy() {
-		List<ContextConfigurationAttributes> attributesList = resolveContextConfigurationAttributes(MetaLocationsBar.class);
+		Class<MetaLocationsBar> testClass = MetaLocationsBar.class;
+		List<ContextConfigurationAttributes> attributesList = resolveContextConfigurationAttributes(testClass);
 		assertNotNull(attributesList);
 		assertEquals(2, attributesList.size());
-		assertAttributes(attributesList.get(0), MetaLocationsBarConfig.class, new String[] { "/bar.xml" },
-			EMPTY_CLASS_ARRAY, ContextLoader.class, true);
-		assertAttributes(attributesList.get(1), MetaLocationsFooConfig.class, new String[] { "/foo.xml" },
+		assertAttributes(attributesList.get(0), testClass, new String[] { "/bar.xml" }, EMPTY_CLASS_ARRAY,
+			ContextLoader.class, true);
+		assertAttributes(attributesList.get(1), MetaLocationsFoo.class, new String[] { "/foo.xml" },
 			EMPTY_CLASS_ARRAY, ContextLoader.class, true);
 	}
 

spring-test/src/test/java/org/springframework/test/context/ContextLoaderUtilsContextHierarchyTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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.
@@ -71,15 +71,16 @@ public void resolveContextHierarchyAttributesForSingleTestClassWithSingleLevelCo
 
 	@Test
 	public void resolveContextHierarchyAttributesForSingleTestClassWithSingleLevelContextHierarchyFromMetaAnnotation() {
-		List<List<ContextConfigurationAttributes>> hierarchyAttributes = resolveContextHierarchyAttributes(SingleTestClassWithSingleLevelContextHierarchyFromMetaAnnotation.class);
+		Class<SingleTestClassWithSingleLevelContextHierarchyFromMetaAnnotation> testClass = SingleTestClassWithSingleLevelContextHierarchyFromMetaAnnotation.class;
+		List<List<ContextConfigurationAttributes>> hierarchyAttributes = resolveContextHierarchyAttributes(testClass);
 		assertEquals(1, hierarchyAttributes.size());
 
 		List<ContextConfigurationAttributes> configAttributesList = hierarchyAttributes.get(0);
 		assertNotNull(configAttributesList);
 		assertEquals(1, configAttributesList.size());
 		debugConfigAttributes(configAttributesList);
-		assertAttributes(configAttributesList.get(0), ContextHierarchyA.class, new String[] { "A.xml" },
-			EMPTY_CLASS_ARRAY, ContextLoader.class, true);
+		assertAttributes(configAttributesList.get(0), testClass, new String[] { "A.xml" }, EMPTY_CLASS_ARRAY,
+			ContextLoader.class, true);
 	}
 
 	@Test
@@ -131,22 +132,26 @@ public void resolveContextHierarchyAttributesForTestClassHierarchyWithSingleLeve
 		debugConfigAttributes(configAttributesListClassLevel1);
 		assertEquals(1, configAttributesListClassLevel1.size());
 		assertThat(configAttributesListClassLevel1.get(0).getLocations()[0], equalTo("A.xml"));
-		assertAttributes(configAttributesListClassLevel1.get(0), ContextHierarchyA.class, new String[] { "A.xml" },
+		assertAttributes(configAttributesListClassLevel1.get(0),
+			TestClass1WithSingleLevelContextHierarchyFromMetaAnnotation.class, new String[] { "A.xml" },
 			EMPTY_CLASS_ARRAY, ContextLoader.class, true);
 
 		List<ContextConfigurationAttributes> configAttributesListClassLevel2 = hierarchyAttributes.get(1);
 		debugConfigAttributes(configAttributesListClassLevel2);
 		assertEquals(1, configAttributesListClassLevel2.size());
 		assertArrayEquals(new String[] { "B-one.xml", "B-two.xml" },
 			configAttributesListClassLevel2.get(0).getLocations());
-		assertAttributes(configAttributesListClassLevel2.get(0), ContextHierarchyB.class, new String[] { "B-one.xml",
+		assertAttributes(configAttributesListClassLevel2.get(0),
+			TestClass2WithSingleLevelContextHierarchyFromMetaAnnotation.class,
+			new String[] { "B-one.xml",
 			"B-two.xml" }, EMPTY_CLASS_ARRAY, ContextLoader.class, true);
 
 		List<ContextConfigurationAttributes> configAttributesListClassLevel3 = hierarchyAttributes.get(2);
 		debugConfigAttributes(configAttributesListClassLevel3);
 		assertEquals(1, configAttributesListClassLevel3.size());
 		assertThat(configAttributesListClassLevel3.get(0).getLocations()[0], equalTo("C.xml"));
-		assertAttributes(configAttributesListClassLevel3.get(0), ContextHierarchyC.class, new String[] { "C.xml" },
+		assertAttributes(configAttributesListClassLevel3.get(0),
+			TestClass3WithSingleLevelContextHierarchyFromMetaAnnotation.class, new String[] { "C.xml" },
 			EMPTY_CLASS_ARRAY, ContextLoader.class, true);
 	}
 

spring-test/src/test/java/org/springframework/test/context/junit4/annotation/meta/ConfigClassesAndProfileResolverWithCustomDefaultsMetaConfig.java

@@ -0,0 +1,89 @@
+/*
+ * Copyright 2002-2014 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.meta;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Profile;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.ActiveProfilesResolver;
+import org.springframework.test.context.ContextConfiguration;
+
+/**
+ * Custom configuration annotation with meta-annotation attribute overrides for
+ * {@link ContextConfiguration#classes} and {@link ActiveProfiles#resolver} and
+ * with default configuration local to the composed annotation.
+ *
+ * @author Sam Brannen
+ * @since 4.0.3
+ */
+@ContextConfiguration
+@ActiveProfiles
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+public @interface ConfigClassesAndProfileResolverWithCustomDefaultsMetaConfig {
+
+	@Configuration
+	@Profile("dev")
+	static class DevConfig {
+
+		@Bean
+		public String foo() {
+			return "Dev Foo";
+		}
+	}
+
+	@Configuration
+	@Profile("prod")
+	static class ProductionConfig {
+
+		@Bean
+		public String foo() {
+			return "Production Foo";
+		}
+	}
+
+	@Configuration
+	@Profile("resolver")
+	static class ResolverConfig {
+
+		@Bean
+		public String foo() {
+			return "Resolver Foo";
+		}
+	}
+
+	static class CustomResolver implements ActiveProfilesResolver {
+
+		@Override
+		public String[] resolve(Class<?> testClass) {
+			return testClass.getSimpleName().equals("ConfigClassesAndProfileResolverWithCustomDefaultsMetaConfigTests") ? new String[] { "resolver" }
+					: new String[] {};
+		}
+	}
+
+
+	Class<?>[] classes() default { DevConfig.class, ProductionConfig.class, ResolverConfig.class };
+
+	Class<? extends ActiveProfilesResolver> resolver() default CustomResolver.class;
+
+}

spring-test/src/test/java/org/springframework/test/context/junit4/annotation/meta/ConfigClassesAndProfileResolverWithCustomDefaultsMetaConfigTests.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2002-2014 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.meta;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+
+import static org.junit.Assert.*;
+
+/**
+ * Integration tests for meta-annotation attribute override support, relying on
+ * default attribute values defined in {@link ConfigClassesAndProfileResolverWithCustomDefaultsMetaConfig}.
+ *
+ * @author Sam Brannen
+ * @since 4.0.3
+ */
+@RunWith(SpringJUnit4ClassRunner.class)
+@ConfigClassesAndProfileResolverWithCustomDefaultsMetaConfig
+public class ConfigClassesAndProfileResolverWithCustomDefaultsMetaConfigTests {
+
+	@Autowired
+	private String foo;
+
+
+	@Test
+	public void foo() {
+		assertEquals("Resolver Foo", foo);
+	}
+}