Switch the default @NestedTestConfiguration mode to INHERIT.

See gh-19930

Author: sbrannen

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

@@ -30,13 +30,13 @@
  *
  * <p>If {@code @NestedTestConfiguration} is not <em>present</em> or
  * <em>meta-present</em> on a test class, configuration from the test class will
- * not propagate to inner test classes (see {@link EnclosingConfiguration#OVERRIDE}).
- * Consequently, inner test classes will have to declare their own Spring test
- * configuration annotations. If you wish for an inner test class to inherit
- * configuration from its enclosing class, annotate either the inner test class
- * or the enclosing class with
- * {@code @NestedTestConfiguration(EnclosingConfiguration.INHERIT)}. Note that
- * a {@code @NestedTestConfiguration(...)} declaration is inherited within the
+ * propagate to inner test classes (see {@link EnclosingConfiguration#INHERIT}).
+ * If {@code @NestedTestConfiguration(OVERRIDE)} is used to switch the mode,
+ * inner test classes will have to declare their own Spring test configuration
+ * annotations. If you wish to explicitly configure the mode, annotate either
+ * the inner test class or the enclosing class with
+ * {@code @NestedTestConfiguration(...}. Note that a
+ * {@code @NestedTestConfiguration(...)} declaration is inherited within the
  * superclass hierarchy as well as within the enclosing class hierarchy. Thus,
  * there is no need to redeclare the annotation unless you wish to switch the
  * mode.

spring-test/src/main/java/org/springframework/test/util/MetaAnnotationUtils.java

@@ -68,8 +68,8 @@
  */
 public abstract class MetaAnnotationUtils {
 
-	private static final ConcurrentLruCache<Class<?>, SearchStrategy> cachedSearchStrategies =
-			new ConcurrentLruCache<>(32, MetaAnnotationUtils::lookUpSearchStrategy);
+	private static final ConcurrentLruCache<Class<?>, EnclosingConfiguration> cachedSearchStrategies =
+			new ConcurrentLruCache<>(32, MetaAnnotationUtils::lookUpEnclosingConfiguration);
 
 
 	/**
@@ -301,35 +301,29 @@ private static UntypedAnnotationDescriptor findAnnotationDescriptorForTypes(@Nul
 	 * class should be searched
 	 * @since 5.3
 	 * @see ClassUtils#isInnerClass(Class)
-	 * @see #getSearchStrategy(Class)
 	 */
 	public static boolean searchEnclosingClass(Class<?> clazz) {
 		return (ClassUtils.isInnerClass(clazz) &&
-				getSearchStrategy(clazz) == SearchStrategy.TYPE_HIERARCHY_AND_ENCLOSING_CLASSES);
+				getEnclosingConfiguration(clazz) == EnclosingConfiguration.INHERIT);
 	}
 
 	/**
-	 * Get the {@link SearchStrategy} for the supplied class.
+	 * Get the {@link EnclosingConfiguration} mode for the supplied class.
 	 * @param clazz the class for which the search strategy should be resolved
 	 * @return the resolved search strategy
 	 * @since 5.3
 	 */
-	private static SearchStrategy getSearchStrategy(Class<?> clazz) {
+	private static EnclosingConfiguration getEnclosingConfiguration(Class<?> clazz) {
 		return cachedSearchStrategies.get(clazz);
 	}
 
-	private static SearchStrategy lookUpSearchStrategy(Class<?> clazz) {
-		EnclosingConfiguration enclosingConfiguration =
-			MergedAnnotations.from(clazz, SearchStrategy.TYPE_HIERARCHY_AND_ENCLOSING_CLASSES)
+	private static EnclosingConfiguration lookUpEnclosingConfiguration(Class<?> clazz) {
+		// TODO Make the default EnclosingConfiguration mode globally configurable via SpringProperties.
+		return MergedAnnotations.from(clazz, SearchStrategy.TYPE_HIERARCHY_AND_ENCLOSING_CLASSES)
 				.stream(NestedTestConfiguration.class)
 				.map(mergedAnnotation -> mergedAnnotation.getEnum("value", EnclosingConfiguration.class))
 				.findFirst()
-				.orElse(EnclosingConfiguration.OVERRIDE);
-		// TODO Switch the default EnclosingConfiguration mode to INHERIT.
-		// TODO Make the default EnclosingConfiguration mode globally configurable via SpringProperties.
-		return (enclosingConfiguration == EnclosingConfiguration.INHERIT ?
-				SearchStrategy.TYPE_HIERARCHY_AND_ENCLOSING_CLASSES :
-				SearchStrategy.TYPE_HIERARCHY);
+				.orElse(EnclosingConfiguration.INHERIT);
 	}
 
 	private static void assertNonEmptyAnnotationTypeArray(Class<?>[] annotationTypes, String message) {
@@ -505,10 +499,12 @@ public AnnotationDescriptor<T> next() {
 		 */
 		@SuppressWarnings("unchecked")
 		public Set<T> findAllLocalMergedAnnotations() {
-			Class<T> annotationType = (Class<T>) getAnnotationType();
-			SearchStrategy searchStrategy = getSearchStrategy(getRootDeclaringClass());
+			SearchStrategy searchStrategy =
+					(getEnclosingConfiguration(getRootDeclaringClass()) == EnclosingConfiguration.INHERIT ?
+							SearchStrategy.TYPE_HIERARCHY_AND_ENCLOSING_CLASSES :
+							SearchStrategy.TYPE_HIERARCHY);
 			return MergedAnnotations.from(getRootDeclaringClass(), searchStrategy, RepeatableContainers.none())
-					.stream(annotationType)
+					.stream((Class<T>) getAnnotationType())
 					.filter(MergedAnnotationPredicates.firstRunOf(MergedAnnotation::getAggregateIndex))
 					.collect(MergedAnnotationCollectors.toAnnotationSet());
 		}

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/nested/ActiveProfilesNestedTests.java

@@ -46,6 +46,7 @@
  */
 @SpringJUnitConfig(Config1.class)
 @ActiveProfiles("1")
+@NestedTestConfiguration(OVERRIDE) // since INHERIT is now the global default
 class ActiveProfilesNestedTests {
 
 	@Autowired

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/nested/ConstructorInjectionNestedTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2020 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.
@@ -25,12 +25,14 @@
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.test.context.NestedTestConfiguration;
 import org.springframework.test.context.junit.SpringJUnitJupiterTestSuite;
 import org.springframework.test.context.junit.jupiter.SpringExtension;
 import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
 import org.springframework.test.context.junit.jupiter.nested.ConstructorInjectionNestedTests.TopLevelConfig;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.springframework.test.context.NestedTestConfiguration.EnclosingConfiguration.OVERRIDE;
 
 /**
  * Integration tests that verify support for {@code @Nested} test classes in conjunction
@@ -47,6 +49,7 @@
  * @see org.springframework.test.context.junit4.nested.NestedTestsWithSpringRulesTests
  */
 @SpringJUnitConfig(TopLevelConfig.class)
+@NestedTestConfiguration(OVERRIDE) // since INHERIT is now the global default
 class ConstructorInjectionNestedTests {
 
 	final String foo;

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/nested/ContextConfigurationNestedTests.java

@@ -44,6 +44,7 @@
  * @see org.springframework.test.context.junit4.nested.NestedTestsWithSpringRulesTests
  */
 @SpringJUnitConfig(TopLevelConfig.class)
+@NestedTestConfiguration(OVERRIDE) // since INHERIT is now the global default
 class ContextConfigurationNestedTests {
 
 	private static final String FOO = "foo";

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/nested/ContextHierarchyNestedTests.java

@@ -45,6 +45,7 @@
  */
 @ExtendWith(SpringExtension.class)
 @ContextHierarchy(@ContextConfiguration(classes = ParentConfig.class))
+@NestedTestConfiguration(OVERRIDE) // since INHERIT is now the global default
 class ContextHierarchyNestedTests {
 
 	private static final String FOO = "foo";

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/nested/SqlScriptNestedTests.java

@@ -67,12 +67,6 @@ private int countRowsInTable(String tableName) {
 	}
 
 	@Nested
-	// NOTE: the following @SpringJUnitConfig declaration must NOT be removed.
-	// This was added before the TestContext framework looked up configuration
-	// on enclosing classes for @Nested test classes. As such, this serves as a
-	// regression test and cannot be changed.
-	@SpringJUnitConfig(PopulatedSchemaDatabaseConfig.class)
-	@Transactional
 	class NestedTests {
 
 		@Autowired

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/nested/TestConstructorNestedTests.java

@@ -43,6 +43,7 @@
  */
 @SpringJUnitConfig
 @TestConstructor(autowireMode = ALL)
+@NestedTestConfiguration(OVERRIDE) // since INHERIT is now the global default
 class TestConstructorNestedTests {
 
 	TestConstructorNestedTests(String text) {

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/nested/TestExecutionListenersNestedTests.java

@@ -46,6 +46,7 @@
  */
 @SpringJUnitConfig
 @TestExecutionListeners(FooTestExecutionListener.class)
+@NestedTestConfiguration(OVERRIDE) // since INHERIT is now the global default
 class TestExecutionListenersNestedTests {
 
 	private static final String FOO = "foo";

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/nested/TestPropertySourceNestedTests.java

@@ -42,6 +42,7 @@
  */
 @SpringJUnitConfig(Config.class)
 @TestPropertySource(properties = "p1 = v1")
+@NestedTestConfiguration(OVERRIDE) // since INHERIT is now the global default
 class TestPropertySourceNestedTests {
 
 	@Autowired
@@ -160,6 +161,12 @@ void propertiesInEnvironment() {
 				}
 
 				@Nested
+				// The following explicit INHERIT is necessary since this nested
+				// test class implements an interface whose enclosing class is
+				// annotated with @NestedTestConfiguration(OVERRIDE). In other
+				// words, the local declaration overrides the declaration
+				// "inherited" via the interface.
+				@NestedTestConfiguration(INHERIT)
 				class L5WithInheritedConfigAndTestInterfaceTests implements TestInterface {
 
 					@Autowired

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/nested/TransactionalNestedTests.java

@@ -53,6 +53,7 @@
 @SpringJUnitConfig
 @Transactional
 @Commit
+@NestedTestConfiguration(OVERRIDE) // since INHERIT is now the global default
 class TransactionalNestedTests {
 
 	@Test

spring-test/src/test/java/org/springframework/test/context/junit/jupiter/nested/WebAppConfigurationNestedTests.java

@@ -44,6 +44,7 @@
  * @see org.springframework.test.context.junit4.nested.NestedTestsWithSpringRulesTests
  */
 @SpringJUnitWebConfig(Config.class)
+@NestedTestConfiguration(OVERRIDE) // since INHERIT is now the global default
 class WebAppConfigurationNestedTests {
 
 	@Test