GH-9492: Add tests and extend fix to MockIntegrationContext

Switches `MockIntegrationContextCustomizerFactory` to use
`TestContextAnnotationUtils` in order to properly support
`@NestedTestConfiguration` semantics.

Adds an integration test with a base class and several
`@Nested` inner test classes to verify the various
permutations of `@SpringIntegrationTest` inherit/override
behavior when used w/ `@NestedTestConfiguration`.

Author: onobc

spring-integration-test/src/main/java/org/springframework/integration/test/context/MockIntegrationContextCustomizerFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2022 the original author or authors.
+ * Copyright 2017-2024 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.
@@ -18,17 +18,18 @@
 
 import java.util.List;
 
-import org.springframework.core.annotation.AnnotatedElementUtils;
 import org.springframework.test.context.ContextConfigurationAttributes;
 import org.springframework.test.context.ContextCustomizer;
 import org.springframework.test.context.ContextCustomizerFactory;
+import org.springframework.test.context.TestContextAnnotationUtils;
 
 /**
  * The {@link ContextCustomizerFactory} implementation to produce a
  * {@link MockIntegrationContextCustomizer} if a {@link SpringIntegrationTest} annotation
  * is present on the test class.
  *
  * @author Artem Bilan
+ * @author Chris Bono
  *
  * @since 5.0
  */
@@ -38,7 +39,7 @@ class MockIntegrationContextCustomizerFactory implements ContextCustomizerFactor
 	public ContextCustomizer createContextCustomizer(Class<?> testClass,
 			List<ContextConfigurationAttributes> configAttributes) {
 
-		return AnnotatedElementUtils.hasAnnotation(testClass, SpringIntegrationTest.class)
+		return TestContextAnnotationUtils.hasAnnotation(testClass, SpringIntegrationTest.class)
 				? new MockIntegrationContextCustomizer()
 				: null;
 	}

spring-integration-test/src/main/java/org/springframework/integration/test/context/SpringIntegrationTestExecutionListener.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2022 the original author or authors.
+ * Copyright 2017-2024 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.
@@ -18,7 +18,6 @@
 
 import java.util.Arrays;
 
-import org.springframework.beans.factory.NoSuchBeanDefinitionException;
 import org.springframework.context.ApplicationContext;
 import org.springframework.integration.endpoint.AbstractEndpoint;
 import org.springframework.test.context.TestContext;
@@ -45,11 +44,7 @@ public void prepareTestInstance(TestContext testContext) {
 		String[] patterns = springIntegrationTest != null ? springIntegrationTest.noAutoStartup() : new String[0];
 
 		ApplicationContext applicationContext = testContext.getApplicationContext();
-		MockIntegrationContext mockIntegrationContext = handledGetMockIntegrationContext(applicationContext);
-		if (mockIntegrationContext == null) {
-			return;
-		}
-
+		MockIntegrationContext mockIntegrationContext = applicationContext.getBean(MockIntegrationContext.class);
 		mockIntegrationContext.getAutoStartupCandidates()
 				.stream()
 				.filter(endpoint -> !match(endpoint.getBeanName(), patterns))
@@ -60,11 +55,7 @@ public void prepareTestInstance(TestContext testContext) {
 	@Override
 	public void afterTestClass(TestContext testContext) {
 		ApplicationContext applicationContext = testContext.getApplicationContext();
-		MockIntegrationContext mockIntegrationContext = handledGetMockIntegrationContext(applicationContext);
-		if (mockIntegrationContext == null) {
-			return;
-		}
-
+		MockIntegrationContext mockIntegrationContext = applicationContext.getBean(MockIntegrationContext.class);
 		mockIntegrationContext.getAutoStartupCandidates()
 				.forEach(AbstractEndpoint::stop);
 	}
@@ -75,15 +66,4 @@ private boolean match(String name, String[] patterns) {
 						.anyMatch(pattern -> PatternMatchUtils.simpleMatch(pattern, name));
 	}
 
-	/**
-	 * to allow nested class execution
-	 */
-	private MockIntegrationContext handledGetMockIntegrationContext(ApplicationContext applicationContext) {
-		try {
-			return applicationContext.getBean(MockIntegrationContext.class);
-		} catch (NoSuchBeanDefinitionException e) {
-			return null;
-		}
-	}
-
 }

spring-integration-test/src/test/java/org/springframework/integration/test/context/AbstractIntegrationTest.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2024-2024 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
+ *
+ *      https://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.integration.test.context;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.integration.config.EnableIntegration;
+import org.springframework.integration.endpoint.AbstractEndpoint;
+import org.springframework.integration.endpoint.ReactiveMessageSourceProducer;
+import org.springframework.messaging.support.GenericMessage;
+import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
+
+/**
+ * Base integration test that specifies a default {@link SpringIntegrationTest}
+ * to be inherited by concrete subclasses.
+ *
+ * @author Chris Bono
+ * @since 6.4.0
+ */
+@SpringJUnitConfig
+@SpringIntegrationTest(noAutoStartup = "*")
+class AbstractIntegrationTest {
+
+	@Configuration(proxyBeanMethods = false)
+	@EnableIntegration
+	static class MockEndpointConfig {
+
+		@Bean
+		AbstractEndpoint mockEndpoint() {
+			ReactiveMessageSourceProducer endpoint = new ReactiveMessageSourceProducer(() -> new GenericMessage<>("testFromMockEndpoint"));
+			endpoint.setOutputChannelName("nullChannel");
+			return endpoint;
+		}
+
+	}
+}

spring-integration-test/src/test/java/org/springframework/integration/test/context/NestedSpringIntegrationTestAnnotationTests.java

@@ -0,0 +1,86 @@
+/*
+ * Copyright 2024-2024 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
+ *
+ *      https://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.integration.test.context;
+
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.integration.endpoint.AbstractEndpoint;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.NestedTestConfiguration;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Concrete specialization of {@link AbstractIntegrationTest} used to
+ * test inherit and override behavior of {@link SpringIntegrationTest}
+ * when used with {@link Nested} and {@link NestedTestConfiguration}.
+ *
+ * @author Chris Bono
+ * @since 6.4.0
+ */
+class NestedSpringIntegrationTestAnnotationTests extends AbstractIntegrationTest {
+
+	@Test
+	void annotationDefinedOnParentIsInheritedByDefault(@Autowired AbstractEndpoint mockEndpoint) {
+		// parent disables startup for all endpoints
+		assertThat(mockEndpoint.isRunning()).isFalse();
+	}
+
+	@Nested
+	class NestedTestWithoutEnclosingConfiguration {
+
+		@Test
+		void annotationDefinedOnParentOfEnclosingIsInheritedByDefault(@Autowired AbstractEndpoint mockEndpoint) {
+			assertThat(mockEndpoint.isRunning()).isFalse();
+		}
+	}
+
+	@Nested
+	@NestedTestConfiguration(NestedTestConfiguration.EnclosingConfiguration.INHERIT)
+	class NestedTestWithInheritEnclosingConfiguration {
+
+		@Test
+		void annotationDefinedOnParentOfEnclosingIsInherited(@Autowired AbstractEndpoint mockEndpoint) {
+			assertThat(mockEndpoint.isRunning()).isFalse();
+		}
+	}
+
+	@Nested
+	@NestedTestConfiguration(NestedTestConfiguration.EnclosingConfiguration.INHERIT)
+	@SpringIntegrationTest(noAutoStartup = "noSuchEndpointWithThisPatternExists")
+	class NestedTestWithInheritEnclosingConfigurationButOverrideAnnotation {
+
+		@Test
+		void annotationDefinedOnParentOfEnclosingIsOverridden(@Autowired AbstractEndpoint mockEndpoint) {
+			assertThat(mockEndpoint.isRunning()).isTrue();
+		}
+	}
+
+	@Nested
+	@NestedTestConfiguration(NestedTestConfiguration.EnclosingConfiguration.OVERRIDE)
+	@ContextConfiguration(classes = MockEndpointConfig.class)
+	class NestedTestWithOverrideEnclosingConfiguration {
+
+		@Test
+		void annotationDefinedOnParentOfEnclosingIsInherited(@Autowired AbstractEndpoint mockEndpoint) {
+			assertThat(mockEndpoint.isRunning()).isTrue();
+		}
+	}
+
+}