Inherit enclosing class's configuration in nested tests

Fixes gh-12470
spring-projects · Oct 28, 2020 · 6b437ec · 6b437ec
1 parent b0a1c2a
commit 6b437ec
Show file tree

Hide file tree

Showing 11 changed files with 171 additions and 48 deletions.
diff --git a/...gframework/boot/test/autoconfigure/OverrideAutoConfigurationContextCustomizerFactory.java b/...gframework/boot/test/autoconfigure/OverrideAutoConfigurationContextCustomizerFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-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.
@@ -21,12 +21,12 @@
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.test.util.TestPropertyValues;
 import org.springframework.context.ConfigurableApplicationContext;
-import org.springframework.core.annotation.MergedAnnotations;
-import org.springframework.core.annotation.MergedAnnotations.SearchStrategy;
 import org.springframework.test.context.ContextConfigurationAttributes;
 import org.springframework.test.context.ContextCustomizer;
 import org.springframework.test.context.ContextCustomizerFactory;
 import org.springframework.test.context.MergedContextConfiguration;
+import org.springframework.test.context.TestContextAnnotationUtils;
+import org.springframework.test.context.TestContextAnnotationUtils.AnnotationDescriptor;
 
 /**
  * {@link ContextCustomizerFactory} to support
@@ -39,8 +39,9 @@ class OverrideAutoConfigurationContextCustomizerFactory implements ContextCustom
 	@Override
 	public ContextCustomizer createContextCustomizer(Class<?> testClass,
 			List<ContextConfigurationAttributes> configurationAttributes) {
-		boolean enabled = MergedAnnotations.from(testClass, SearchStrategy.TYPE_HIERARCHY)
-				.get(OverrideAutoConfiguration.class).getValue("enabled", Boolean.class).orElse(true);
+		AnnotationDescriptor<OverrideAutoConfiguration> descriptor = TestContextAnnotationUtils
+				.findAnnotationDescriptor(testClass, OverrideAutoConfiguration.class);
+		boolean enabled = (descriptor != null) ? descriptor.getAnnotation().enabled() : true;
 		return !enabled ? new DisableAutoConfigurationContextCustomizer() : null;
 	}
 

diff --git a/...mework/boot/test/autoconfigure/actuate/metrics/MetricsExportContextCustomizerFactory.java b/...mework/boot/test/autoconfigure/actuate/metrics/MetricsExportContextCustomizerFactory.java
@@ -20,12 +20,11 @@
 
 import org.springframework.boot.test.util.TestPropertyValues;
 import org.springframework.context.ConfigurableApplicationContext;
-import org.springframework.core.annotation.MergedAnnotations;
-import org.springframework.core.annotation.MergedAnnotations.SearchStrategy;
 import org.springframework.test.context.ContextConfigurationAttributes;
 import org.springframework.test.context.ContextCustomizer;
 import org.springframework.test.context.ContextCustomizerFactory;
 import org.springframework.test.context.MergedContextConfiguration;
+import org.springframework.test.context.TestContextAnnotationUtils;
 
 /**
  * {@link ContextCustomizerFactory} that globally disables metrics export unless
@@ -38,8 +37,8 @@ class MetricsExportContextCustomizerFactory implements ContextCustomizerFactory
 	@Override
 	public ContextCustomizer createContextCustomizer(Class<?> testClass,
 			List<ContextConfigurationAttributes> configAttributes) {
-		boolean disableMetricsExport = !MergedAnnotations.from(testClass, SearchStrategy.TYPE_HIERARCHY)
-				.get(AutoConfigureMetrics.class).isPresent();
+		boolean disableMetricsExport = TestContextAnnotationUtils.findAnnotationDescriptor(testClass,
+				AutoConfigureMetrics.class) == null;
 		return disableMetricsExport ? new DisableMetricExportContextCustomizer() : null;
 	}
 

diff --git a/.../src/main/java/org/springframework/boot/test/context/ImportsContextCustomizerFactory.java b/.../src/main/java/org/springframework/boot/test/context/ImportsContextCustomizerFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-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.
@@ -22,10 +22,11 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Import;
 import org.springframework.core.annotation.MergedAnnotations;
-import org.springframework.core.annotation.MergedAnnotations.SearchStrategy;
 import org.springframework.test.context.ContextConfigurationAttributes;
 import org.springframework.test.context.ContextCustomizer;
 import org.springframework.test.context.ContextCustomizerFactory;
+import org.springframework.test.context.TestContextAnnotationUtils;
+import org.springframework.test.context.TestContextAnnotationUtils.AnnotationDescriptor;
 import org.springframework.util.Assert;
 import org.springframework.util.ReflectionUtils;
 
@@ -41,9 +42,11 @@ class ImportsContextCustomizerFactory implements ContextCustomizerFactory {
 	@Override
 	public ContextCustomizer createContextCustomizer(Class<?> testClass,
 			List<ContextConfigurationAttributes> configAttributes) {
-		if (MergedAnnotations.from(testClass, SearchStrategy.TYPE_HIERARCHY).isPresent(Import.class)) {
-			assertHasNoBeanMethods(testClass);
-			return new ImportsContextCustomizer(testClass);
+		AnnotationDescriptor<Import> descriptor = TestContextAnnotationUtils.findAnnotationDescriptor(testClass,
+				Import.class);
+		if (descriptor != null) {
+			assertHasNoBeanMethods(descriptor.getRootDeclaringClass());
+			return new ImportsContextCustomizer(descriptor.getRootDeclaringClass());
 		}
 		return null;
 	}

diff --git a/...rc/main/java/org/springframework/boot/test/context/SpringBootTestContextBootstrapper.java b/...rc/main/java/org/springframework/boot/test/context/SpringBootTestContextBootstrapper.java
@@ -46,6 +46,8 @@
 import org.springframework.test.context.ContextLoader;
 import org.springframework.test.context.MergedContextConfiguration;
 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.support.DefaultTestContextBootstrapper;
@@ -318,8 +320,12 @@ protected String[] getProperties(Class<?> testClass) {
 	}
 
 	protected SpringBootTest getAnnotation(Class<?> testClass) {
-		return MergedAnnotations.from(testClass, SearchStrategy.INHERITED_ANNOTATIONS).get(SpringBootTest.class)
-				.synthesize(MergedAnnotation::isPresent).orElse(null);
+		AnnotationDescriptor<SpringBootTest> descriptor = TestContextAnnotationUtils.findAnnotationDescriptor(testClass,
+				SpringBootTest.class);
+		if (descriptor != null) {
+			return descriptor.getAnnotation();
+		}
+		return null;
 	}
 
 	protected void verifyConfiguration(Class<?> testClass) {

diff --git a/...est/src/main/java/org/springframework/boot/test/context/SpringBootTestWebEnvironment.java b/...est/src/main/java/org/springframework/boot/test/context/SpringBootTestWebEnvironment.java
@@ -18,9 +18,10 @@
 
 import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
 import org.springframework.context.ConfigurableApplicationContext;
-import org.springframework.core.annotation.MergedAnnotations;
 import org.springframework.test.context.ContextCustomizer;
 import org.springframework.test.context.MergedContextConfiguration;
+import org.springframework.test.context.TestContextAnnotationUtils;
+import org.springframework.test.context.TestContextAnnotationUtils.AnnotationDescriptor;
 
 /**
  * {@link ContextCustomizer} to track the web environment that is used in a
@@ -35,8 +36,9 @@ class SpringBootTestWebEnvironment implements ContextCustomizer {
 	private final WebEnvironment webEnvironment;
 
 	SpringBootTestWebEnvironment(Class<?> testClass) {
-		this.webEnvironment = MergedAnnotations.from(testClass, MergedAnnotations.SearchStrategy.TYPE_HIERARCHY)
-				.get(SpringBootTest.class).getValue("webEnvironment", WebEnvironment.class).orElse(null);
+		AnnotationDescriptor<SpringBootTest> descriptor = TestContextAnnotationUtils.findAnnotationDescriptor(testClass,
+				SpringBootTest.class);
+		this.webEnvironment = (descriptor != null) ? descriptor.getAnnotation().webEnvironment() : null;
 	}
 
 	@Override

diff --git a/...main/java/org/springframework/boot/test/mock/mockito/MockitoContextCustomizerFactory.java b/...main/java/org/springframework/boot/test/mock/mockito/MockitoContextCustomizerFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-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.
@@ -21,6 +21,7 @@
 import org.springframework.test.context.ContextConfigurationAttributes;
 import org.springframework.test.context.ContextCustomizer;
 import org.springframework.test.context.ContextCustomizerFactory;
+import org.springframework.test.context.TestContextAnnotationUtils;
 
 /**
  * A {@link ContextCustomizerFactory} to add Mockito support.
@@ -35,8 +36,15 @@ public ContextCustomizer createContextCustomizer(Class<?> testClass,
 		// We gather the explicit mock definitions here since they form part of the
 		// MergedContextConfiguration key. Different mocks need to have a different key.
 		DefinitionsParser parser = new DefinitionsParser();
-		parser.parse(testClass);
+		parseDefinitions(testClass, parser);
 		return new MockitoContextCustomizer(parser.getDefinitions());
 	}
 
+	private void parseDefinitions(Class<?> testClass, DefinitionsParser parser) {
+		parser.parse(testClass);
+		if (TestContextAnnotationUtils.searchEnclosingClass(testClass)) {
+			parseDefinitions(testClass.getEnclosingClass(), parser);
+		}
+	}
+
 }
diff --git a/...main/java/org/springframework/boot/test/web/client/TestRestTemplateContextCustomizer.java b/...main/java/org/springframework/boot/test/web/client/TestRestTemplateContextCustomizer.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-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.
@@ -29,7 +29,6 @@
 import org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor;
 import org.springframework.beans.factory.support.RootBeanDefinition;
 import org.springframework.boot.test.context.SpringBootTest;
-import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
 import org.springframework.boot.test.web.client.TestRestTemplate.HttpClientOption;
 import org.springframework.boot.web.client.RestTemplateBuilder;
 import org.springframework.boot.web.servlet.server.AbstractServletWebServerFactory;
@@ -38,11 +37,10 @@
 import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.context.annotation.ConfigurationClassPostProcessor;
 import org.springframework.core.Ordered;
-import org.springframework.core.annotation.MergedAnnotation;
-import org.springframework.core.annotation.MergedAnnotations;
-import org.springframework.core.annotation.MergedAnnotations.SearchStrategy;
 import org.springframework.test.context.ContextCustomizer;
 import org.springframework.test.context.MergedContextConfiguration;
+import org.springframework.test.context.TestContextAnnotationUtils;
+import org.springframework.test.context.TestContextAnnotationUtils.AnnotationDescriptor;
 
 /**
  * {@link ContextCustomizer} for {@link TestRestTemplate}.
@@ -55,10 +53,9 @@ class TestRestTemplateContextCustomizer implements ContextCustomizer {
 	@Override
 	public void customizeContext(ConfigurableApplicationContext context,
 			MergedContextConfiguration mergedContextConfiguration) {
-		MergedAnnotation<?> annotation = MergedAnnotations
-				.from(mergedContextConfiguration.getTestClass(), SearchStrategy.INHERITED_ANNOTATIONS)
-				.get(SpringBootTest.class);
-		if (annotation.getEnum("webEnvironment", WebEnvironment.class).isEmbedded()) {
+		AnnotationDescriptor<SpringBootTest> springBootTest = TestContextAnnotationUtils
+				.findAnnotationDescriptor(mergedContextConfiguration.getTestClass(), SpringBootTest.class);
+		if (springBootTest.getAnnotation().webEnvironment().isEmbedded()) {
 			registerTestRestTemplate(context);
 		}
 	}

diff --git a/...va/org/springframework/boot/test/web/client/TestRestTemplateContextCustomizerFactory.java b/...va/org/springframework/boot/test/web/client/TestRestTemplateContextCustomizerFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-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.
@@ -19,11 +19,11 @@
 import java.util.List;
 
 import org.springframework.boot.test.context.SpringBootTest;
-import org.springframework.core.annotation.MergedAnnotations;
-import org.springframework.core.annotation.MergedAnnotations.SearchStrategy;
 import org.springframework.test.context.ContextConfigurationAttributes;
 import org.springframework.test.context.ContextCustomizer;
 import org.springframework.test.context.ContextCustomizerFactory;
+import org.springframework.test.context.TestContextAnnotationUtils;
+import org.springframework.test.context.TestContextAnnotationUtils.AnnotationDescriptor;
 
 /**
  * {@link ContextCustomizerFactory} for {@link TestRestTemplate}.
@@ -36,8 +36,9 @@ class TestRestTemplateContextCustomizerFactory implements ContextCustomizerFacto
 	@Override
 	public ContextCustomizer createContextCustomizer(Class<?> testClass,
 			List<ContextConfigurationAttributes> configAttributes) {
-		MergedAnnotations annotations = MergedAnnotations.from(testClass, SearchStrategy.INHERITED_ANNOTATIONS);
-		if (annotations.isPresent(SpringBootTest.class)) {
+		AnnotationDescriptor<SpringBootTest> springBootTest = TestContextAnnotationUtils
+				.findAnnotationDescriptor(testClass, SpringBootTest.class);
+		if (springBootTest != null) {
 			return new TestRestTemplateContextCustomizer();
 		}
 		return null;

diff --git a/...ava/org/springframework/boot/test/web/reactive/server/WebTestClientContextCustomizer.java b/...ava/org/springframework/boot/test/web/reactive/server/WebTestClientContextCustomizer.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-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.
@@ -31,19 +31,17 @@
 import org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor;
 import org.springframework.beans.factory.support.RootBeanDefinition;
 import org.springframework.boot.test.context.SpringBootTest;
-import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
 import org.springframework.boot.web.codec.CodecCustomizer;
 import org.springframework.boot.web.reactive.server.AbstractReactiveWebServerFactory;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.ApplicationContextAware;
 import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.context.annotation.ConfigurationClassPostProcessor;
 import org.springframework.core.Ordered;
-import org.springframework.core.annotation.MergedAnnotation;
-import org.springframework.core.annotation.MergedAnnotations;
-import org.springframework.core.annotation.MergedAnnotations.SearchStrategy;
 import org.springframework.test.context.ContextCustomizer;
 import org.springframework.test.context.MergedContextConfiguration;
+import org.springframework.test.context.TestContextAnnotationUtils;
+import org.springframework.test.context.TestContextAnnotationUtils.AnnotationDescriptor;
 import org.springframework.test.web.reactive.server.WebTestClient;
 import org.springframework.util.CollectionUtils;
 import org.springframework.web.reactive.function.client.ExchangeStrategies;
@@ -57,9 +55,9 @@ class WebTestClientContextCustomizer implements ContextCustomizer {
 
 	@Override
 	public void customizeContext(ConfigurableApplicationContext context, MergedContextConfiguration mergedConfig) {
-		MergedAnnotation<?> annotation = MergedAnnotations
-				.from(mergedConfig.getTestClass(), SearchStrategy.INHERITED_ANNOTATIONS).get(SpringBootTest.class);
-		if (annotation.getEnum("webEnvironment", WebEnvironment.class).isEmbedded()) {
+		AnnotationDescriptor<SpringBootTest> springBootTest = TestContextAnnotationUtils
+				.findAnnotationDescriptor(mergedConfig.getTestClass(), SpringBootTest.class);
+		if (springBootTest.getAnnotation().webEnvironment().isEmbedded()) {
 			registerWebTestClient(context);
 		}
 	}

diff --git a/.../springframework/boot/test/web/reactive/server/WebTestClientContextCustomizerFactory.java b/.../springframework/boot/test/web/reactive/server/WebTestClientContextCustomizerFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-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.
@@ -19,11 +19,11 @@
 import java.util.List;
 
 import org.springframework.boot.test.context.SpringBootTest;
-import org.springframework.core.annotation.MergedAnnotations;
-import org.springframework.core.annotation.MergedAnnotations.SearchStrategy;
 import org.springframework.test.context.ContextConfigurationAttributes;
 import org.springframework.test.context.ContextCustomizer;
 import org.springframework.test.context.ContextCustomizerFactory;
+import org.springframework.test.context.TestContextAnnotationUtils;
+import org.springframework.test.context.TestContextAnnotationUtils.AnnotationDescriptor;
 import org.springframework.util.ClassUtils;
 
 /**
@@ -38,8 +38,9 @@ class WebTestClientContextCustomizerFactory implements ContextCustomizerFactory
 	@Override
 	public ContextCustomizer createContextCustomizer(Class<?> testClass,
 			List<ContextConfigurationAttributes> configAttributes) {
-		MergedAnnotations annotations = MergedAnnotations.from(testClass, SearchStrategy.INHERITED_ANNOTATIONS);
-		if (isWebClientPresent() && annotations.isPresent(SpringBootTest.class)) {
+		AnnotationDescriptor<SpringBootTest> springBootTest = TestContextAnnotationUtils
+				.findAnnotationDescriptor(testClass, SpringBootTest.class);
+		if (springBootTest != null) {
 			return new WebTestClientContextCustomizer();
 		}
 		return null;