Introduce TestContextAnnotationUtils to avoid package cycles

This commit introduces TestContextAnnotationUtils as a replacement for
MetaAnnotationUtils, with dedicated support for honoring the new
@NestedTestConfiguration annotation and related annotation search
semantics.

MetaAnnotationUtils has been reverted to its previous scope and is now
deprecated.

See gh-19930

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

@@ -26,8 +26,7 @@
 
 import org.springframework.beans.BeanUtils;
 import org.springframework.lang.Nullable;
-import org.springframework.test.util.MetaAnnotationUtils;
-import org.springframework.test.util.MetaAnnotationUtils.AnnotationDescriptor;
+import org.springframework.test.context.TestContextAnnotationUtils.AnnotationDescriptor;
 import org.springframework.util.ClassUtils;
 
 /**
@@ -155,7 +154,7 @@ static TestContextBootstrapper resolveTestContextBootstrapper(BootstrapContext b
 	private static Class<?> resolveExplicitTestContextBootstrapper(Class<?> testClass) {
 		Set<BootstrapWith> annotations = new LinkedHashSet<>();
 		AnnotationDescriptor<BootstrapWith> descriptor =
-				MetaAnnotationUtils.findAnnotationDescriptor(testClass, BootstrapWith.class);
+				TestContextAnnotationUtils.findAnnotationDescriptor(testClass, BootstrapWith.class);
 		while (descriptor != null) {
 			annotations.addAll(descriptor.findAllLocalMergedAnnotations());
 			descriptor = descriptor.next();
@@ -180,7 +179,7 @@ private static Class<?> resolveExplicitTestContextBootstrapper(Class<?> testClas
 	}
 
 	private static Class<?> resolveDefaultTestContextBootstrapper(Class<?> testClass) throws Exception {
-		boolean webApp = (MetaAnnotationUtils.findMergedAnnotation(testClass, webAppConfigurationClass) != null);
+		boolean webApp = (TestContextAnnotationUtils.findMergedAnnotation(testClass, webAppConfigurationClass) != null);
 		String bootstrapperClassName = (webApp ? DEFAULT_WEB_TEST_CONTEXT_BOOTSTRAPPER_CLASS_NAME :
 				DEFAULT_TEST_CONTEXT_BOOTSTRAPPER_CLASS_NAME);
 		return ClassUtils.forName(bootstrapperClassName, BootstrapUtils.class.getClassLoader());

spring-test/src/main/java/org/springframework/test/context/jdbc/MergedSqlConfig.java

@@ -24,9 +24,9 @@
 import org.springframework.core.style.ToStringCreator;
 import org.springframework.jdbc.datasource.init.ScriptUtils;
 import org.springframework.lang.Nullable;
+import org.springframework.test.context.TestContextAnnotationUtils;
 import org.springframework.test.context.jdbc.SqlConfig.ErrorMode;
 import org.springframework.test.context.jdbc.SqlConfig.TransactionMode;
-import org.springframework.test.util.MetaAnnotationUtils;
 import org.springframework.util.Assert;
 
 /**
@@ -100,7 +100,7 @@ private AnnotationAttributes mergeAttributes(SqlConfig localSqlConfig, Class<?>
 		enforceCommentPrefixAliases(localAttributes);
 
 		// Get global attributes, if any.
-		SqlConfig globalSqlConfig = MetaAnnotationUtils.findMergedAnnotation(testClass, SqlConfig.class);
+		SqlConfig globalSqlConfig = TestContextAnnotationUtils.findMergedAnnotation(testClass, SqlConfig.class);
 
 		// Use local attributes only?
 		if (globalSqlConfig == null) {

spring-test/src/main/java/org/springframework/test/context/jdbc/SqlScriptsTestExecutionListener.java

@@ -34,14 +34,14 @@
 import org.springframework.lang.NonNull;
 import org.springframework.lang.Nullable;
 import org.springframework.test.context.TestContext;
+import org.springframework.test.context.TestContextAnnotationUtils;
 import org.springframework.test.context.jdbc.Sql.ExecutionPhase;
 import org.springframework.test.context.jdbc.SqlConfig.ErrorMode;
 import org.springframework.test.context.jdbc.SqlConfig.TransactionMode;
 import org.springframework.test.context.jdbc.SqlMergeMode.MergeMode;
 import org.springframework.test.context.support.AbstractTestExecutionListener;
 import org.springframework.test.context.transaction.TestContextTransactionUtils;
 import org.springframework.test.context.util.TestContextResourceUtils;
-import org.springframework.test.util.MetaAnnotationUtils;
 import org.springframework.transaction.PlatformTransactionManager;
 import org.springframework.transaction.TransactionDefinition;
 import org.springframework.transaction.interceptor.DefaultTransactionAttribute;
@@ -166,7 +166,7 @@ private boolean mergeSqlAnnotations(TestContext testContext) {
 	 */
 	@Nullable
 	private SqlMergeMode getSqlMergeModeFor(Class<?> clazz) {
-		return MetaAnnotationUtils.findMergedAnnotation(clazz, SqlMergeMode.class);
+		return TestContextAnnotationUtils.findMergedAnnotation(clazz, SqlMergeMode.class);
 	}
 
 	/**
@@ -181,7 +181,7 @@ private SqlMergeMode getSqlMergeModeFor(Method method) {
 	 * Get the {@code @Sql} annotations declared on the supplied class.
 	 */
 	private Set<Sql> getSqlAnnotationsFor(Class<?> clazz) {
-		return MetaAnnotationUtils.getMergedRepeatableAnnotations(clazz, Sql.class);
+		return TestContextAnnotationUtils.getMergedRepeatableAnnotations(clazz, Sql.class);
 	}
 
 	/**

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

@@ -29,7 +29,7 @@
 import org.springframework.test.annotation.DirtiesContext.HierarchyMode;
 import org.springframework.test.annotation.DirtiesContext.MethodMode;
 import org.springframework.test.context.TestContext;
-import org.springframework.test.util.MetaAnnotationUtils;
+import org.springframework.test.context.TestContextAnnotationUtils;
 import org.springframework.util.Assert;
 
 /**
@@ -97,7 +97,7 @@ protected void beforeOrAfterTestMethod(TestContext testContext, MethodMode requi
 		Assert.notNull(testMethod, "The test method of the supplied TestContext must not be null");
 
 		DirtiesContext methodAnn = AnnotatedElementUtils.findMergedAnnotation(testMethod, DirtiesContext.class);
-		DirtiesContext classAnn = MetaAnnotationUtils.findMergedAnnotation(testClass, DirtiesContext.class);
+		DirtiesContext classAnn = TestContextAnnotationUtils.findMergedAnnotation(testClass, DirtiesContext.class);
 		boolean methodAnnotated = (methodAnn != null);
 		boolean classAnnotated = (classAnn != null);
 		MethodMode methodMode = (methodAnnotated ? methodAnn.methodMode() : null);
@@ -134,7 +134,7 @@ protected void beforeOrAfterTestClass(TestContext testContext, ClassMode require
 		Class<?> testClass = testContext.getTestClass();
 		Assert.notNull(testClass, "The test class of the supplied TestContext must not be null");
 
-		DirtiesContext dirtiesContext = MetaAnnotationUtils.findMergedAnnotation(testClass, DirtiesContext.class);
+		DirtiesContext dirtiesContext = TestContextAnnotationUtils.findMergedAnnotation(testClass, DirtiesContext.class);
 		boolean classAnnotated = (dirtiesContext != null);
 		ClassMode classMode = (classAnnotated ? dirtiesContext.classMode() : null);
 

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

@@ -44,12 +44,12 @@
 import org.springframework.test.context.MergedContextConfiguration;
 import org.springframework.test.context.SmartContextLoader;
 import org.springframework.test.context.TestContext;
+import org.springframework.test.context.TestContextAnnotationUtils;
+import org.springframework.test.context.TestContextAnnotationUtils.AnnotationDescriptor;
 import org.springframework.test.context.TestContextBootstrapper;
 import org.springframework.test.context.TestExecutionListener;
 import org.springframework.test.context.TestExecutionListeners;
 import org.springframework.test.context.TestExecutionListeners.MergeMode;
-import org.springframework.test.util.MetaAnnotationUtils;
-import org.springframework.test.util.MetaAnnotationUtils.AnnotationDescriptor;
 import org.springframework.util.Assert;
 import org.springframework.util.ClassUtils;
 import org.springframework.util.StringUtils;
@@ -116,7 +116,7 @@ public final List<TestExecutionListener> getTestExecutionListeners() {
 		boolean usingDefaults = false;
 
 		AnnotationDescriptor<TestExecutionListeners> descriptor =
-				MetaAnnotationUtils.findAnnotationDescriptor(clazz, annotationType);
+				TestContextAnnotationUtils.findAnnotationDescriptor(clazz, annotationType);
 
 		// Use defaults?
 		if (descriptor == null) {
@@ -257,12 +257,12 @@ public final MergedContextConfiguration buildMergedContextConfiguration() {
 		Class<?> testClass = getBootstrapContext().getTestClass();
 		CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate = getCacheAwareContextLoaderDelegate();
 
-		if (MetaAnnotationUtils.findAnnotationDescriptorForTypes(
+		if (TestContextAnnotationUtils.findAnnotationDescriptorForTypes(
 				testClass, ContextConfiguration.class, ContextHierarchy.class) == null) {
 			return buildDefaultMergedContextConfiguration(testClass, cacheAwareContextLoaderDelegate);
 		}
 
-		if (MetaAnnotationUtils.findAnnotationDescriptor(testClass, ContextHierarchy.class) != null) {
+		if (TestContextAnnotationUtils.findAnnotationDescriptor(testClass, ContextHierarchy.class) != null) {
 			Map<String, List<ContextConfigurationAttributes>> hierarchyMap =
 					ContextLoaderUtils.buildContextHierarchyMap(testClass);
 			MergedContextConfiguration parentConfig = null;

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

@@ -28,12 +28,12 @@
 import org.springframework.beans.BeanUtils;
 import org.springframework.test.context.ActiveProfiles;
 import org.springframework.test.context.ActiveProfilesResolver;
-import org.springframework.test.util.MetaAnnotationUtils.AnnotationDescriptor;
+import org.springframework.test.context.TestContextAnnotationUtils.AnnotationDescriptor;
 import org.springframework.util.Assert;
 import org.springframework.util.ObjectUtils;
 import org.springframework.util.StringUtils;
 
-import static org.springframework.test.util.MetaAnnotationUtils.findAnnotationDescriptor;
+import static org.springframework.test.context.TestContextAnnotationUtils.findAnnotationDescriptor;
 
 /**
  * Utility methods for working with {@link ActiveProfiles @ActiveProfiles} and

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

@@ -27,20 +27,19 @@
 import org.apache.commons.logging.LogFactory;
 
 import org.springframework.core.annotation.AnnotationUtils;
-import org.springframework.lang.Nullable;
 import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.context.ContextConfigurationAttributes;
 import org.springframework.test.context.ContextHierarchy;
 import org.springframework.test.context.SmartContextLoader;
-import org.springframework.test.util.MetaAnnotationUtils.AnnotationDescriptor;
-import org.springframework.test.util.MetaAnnotationUtils.UntypedAnnotationDescriptor;
+import org.springframework.test.context.TestContextAnnotationUtils.AnnotationDescriptor;
+import org.springframework.test.context.TestContextAnnotationUtils.UntypedAnnotationDescriptor;
 import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
 
 import static org.springframework.core.annotation.AnnotationUtils.getAnnotation;
 import static org.springframework.core.annotation.AnnotationUtils.isAnnotationDeclaredLocally;
-import static org.springframework.test.util.MetaAnnotationUtils.findAnnotationDescriptor;
-import static org.springframework.test.util.MetaAnnotationUtils.findAnnotationDescriptorForTypes;
+import static org.springframework.test.context.TestContextAnnotationUtils.findAnnotationDescriptor;
+import static org.springframework.test.context.TestContextAnnotationUtils.findAnnotationDescriptorForTypes;
 
 /**
  * Utility methods for resolving {@link ContextConfigurationAttributes} from the
@@ -245,18 +244,12 @@ static List<ContextConfigurationAttributes> resolveContextConfigurationAttribute
 					annotationType.getName(), testClass.getName()));
 
 		List<ContextConfigurationAttributes> attributesList = new ArrayList<>();
-		resolveContextConfigurationAttributes(attributesList, descriptor);
-		return attributesList;
-	}
-
-	private static void resolveContextConfigurationAttributes(List<ContextConfigurationAttributes> attributesList,
-			@Nullable AnnotationDescriptor<ContextConfiguration> descriptor) {
-
-		if (descriptor != null) {
+		while (descriptor != null) {
 			convertContextConfigToConfigAttributesAndAddToList(descriptor.synthesizeAnnotation(),
 					descriptor.getRootDeclaringClass(), attributesList);
-			resolveContextConfigurationAttributes(attributesList, descriptor.next());
+			descriptor = descriptor.next();
 		}
+		return attributesList;
 	}
 
 	/**

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2018 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.
@@ -24,11 +24,11 @@
 
 import org.springframework.test.context.ActiveProfiles;
 import org.springframework.test.context.ActiveProfilesResolver;
-import org.springframework.test.util.MetaAnnotationUtils.AnnotationDescriptor;
+import org.springframework.test.context.TestContextAnnotationUtils.AnnotationDescriptor;
 import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
 
-import static org.springframework.test.util.MetaAnnotationUtils.findAnnotationDescriptor;
+import static org.springframework.test.context.TestContextAnnotationUtils.findAnnotationDescriptor;
 
 /**
  * Default implementation of the {@link ActiveProfilesResolver} strategy that

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

@@ -25,7 +25,7 @@
 import org.springframework.lang.Nullable;
 import org.springframework.test.context.TestConstructor;
 import org.springframework.test.context.TestConstructor.AutowireMode;
-import org.springframework.test.util.MetaAnnotationUtils;
+import org.springframework.test.context.TestContextAnnotationUtils;
 
 /**
  * Utility methods for working with {@link TestConstructor @TestConstructor}.
@@ -134,7 +134,7 @@ public static boolean isAutowirableConstructor(Constructor<?> constructor, Class
 		AutowireMode autowireMode = null;
 
 		// Is the test class annotated with @TestConstructor?
-		TestConstructor testConstructor = MetaAnnotationUtils.findMergedAnnotation(testClass, TestConstructor.class);
+		TestConstructor testConstructor = TestContextAnnotationUtils.findMergedAnnotation(testClass, TestConstructor.class);
 		if (testConstructor != null) {
 			autowireMode = testConstructor.autowireMode();
 		}

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

@@ -44,9 +44,9 @@
 import org.springframework.core.io.Resource;
 import org.springframework.core.io.ResourceLoader;
 import org.springframework.core.io.support.ResourcePropertySource;
+import org.springframework.test.context.TestContextAnnotationUtils;
 import org.springframework.test.context.TestPropertySource;
 import org.springframework.test.context.util.TestContextResourceUtils;
-import org.springframework.test.util.MetaAnnotationUtils;
 import org.springframework.util.Assert;
 import org.springframework.util.ObjectUtils;
 import org.springframework.util.StringUtils;
@@ -308,7 +308,7 @@ private static <T extends Annotation> void findRepeatableAnnotations(
 		}
 
 		// Declared on an enclosing class of an inner class?
-		if (MetaAnnotationUtils.searchEnclosingClass(clazz)) {
+		if (TestContextAnnotationUtils.searchEnclosingClass(clazz)) {
 			findRepeatableAnnotations(clazz.getEnclosingClass(), annotationType, listOfLists, aggregateIndex);
 		}
 	}

spring-test/src/main/java/org/springframework/test/context/transaction/TransactionalTestExecutionListener.java

@@ -35,8 +35,8 @@
 import org.springframework.test.annotation.Commit;
 import org.springframework.test.annotation.Rollback;
 import org.springframework.test.context.TestContext;
+import org.springframework.test.context.TestContextAnnotationUtils;
 import org.springframework.test.context.support.AbstractTestExecutionListener;
-import org.springframework.test.util.MetaAnnotationUtils;
 import org.springframework.transaction.PlatformTransactionManager;
 import org.springframework.transaction.TransactionDefinition;
 import org.springframework.transaction.TransactionStatus;
@@ -167,7 +167,7 @@ protected TransactionAttribute findTransactionAttribute(Class<?> clazz) {
 
 		@Nullable
 		private TransactionAttribute findTransactionAttributeInEnclosingClassHierarchy(Class<?> clazz) {
-			if (MetaAnnotationUtils.searchEnclosingClass(clazz)) {
+			if (TestContextAnnotationUtils.searchEnclosingClass(clazz)) {
 				return findTransactionAttribute(clazz.getEnclosingClass());
 			}
 			return null;
@@ -401,7 +401,7 @@ protected PlatformTransactionManager getTransactionManager(TestContext testConte
 	 */
 	protected final boolean isDefaultRollback(TestContext testContext) throws Exception {
 		Class<?> testClass = testContext.getTestClass();
-		Rollback rollback = MetaAnnotationUtils.findMergedAnnotation(testClass, Rollback.class);
+		Rollback rollback = TestContextAnnotationUtils.findMergedAnnotation(testClass, Rollback.class);
 		boolean rollbackPresent = (rollback != null);
 
 		if (rollbackPresent) {

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

@@ -19,9 +19,9 @@
 import org.springframework.lang.Nullable;
 import org.springframework.test.context.ContextLoader;
 import org.springframework.test.context.MergedContextConfiguration;
+import org.springframework.test.context.TestContextAnnotationUtils;
 import org.springframework.test.context.TestContextBootstrapper;
 import org.springframework.test.context.support.DefaultTestContextBootstrapper;
-import org.springframework.test.util.MetaAnnotationUtils;
 
 /**
  * Web-specific implementation of the {@link TestContextBootstrapper} SPI.
@@ -73,7 +73,7 @@ protected MergedContextConfiguration processMergedContextConfiguration(MergedCon
 
 	@Nullable
 	private static WebAppConfiguration getWebAppConfiguration(Class<?> testClass) {
-		return MetaAnnotationUtils.findMergedAnnotation(testClass, WebAppConfiguration.class);
+		return TestContextAnnotationUtils.findMergedAnnotation(testClass, WebAppConfiguration.class);
 	}
 
 }