Use ApplicationContextFailureProcessor to log report on failure

Closes gh-31793

spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/ConditionReportApplicationContextFailureProcessor.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2012-2022 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.boot.test.autoconfigure;
+
+import org.springframework.boot.autoconfigure.condition.ConditionEvaluationReport;
+import org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportMessage;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.test.context.ApplicationContextFailureProcessor;
+
+/**
+ * An {@link ApplicationContextFailureProcessor} that prints the
+ * {@link ConditionEvaluationReport} when the context cannot be prepared.
+ *
+ * @author Phillip Webb
+ * @author Scott Frederick
+ * @since 3.0.0
+ */
+public class ConditionReportApplicationContextFailureProcessor implements ApplicationContextFailureProcessor {
+
+	@Override
+	public void processLoadFailure(ApplicationContext context, Throwable exception) {
+		if (context instanceof ConfigurableApplicationContext configurableContext) {
+			ConditionEvaluationReport report = ConditionEvaluationReport.get(configurableContext.getBeanFactory());
+			System.err.println(new ConditionEvaluationReportMessage(report));
+		}
+	}
+
+}

spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/SpringBootDependencyInjectionTestExecutionListener.java

@@ -16,25 +16,24 @@
 
 package org.springframework.boot.test.autoconfigure;
 
-import java.util.ArrayList;
-import java.util.List;
-
 import org.springframework.boot.autoconfigure.condition.ConditionEvaluationReport;
 import org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportMessage;
-import org.springframework.boot.test.context.DefaultTestExecutionListenersPostProcessor;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.test.context.ApplicationContextFailureProcessor;
 import org.springframework.test.context.TestContext;
-import org.springframework.test.context.TestExecutionListener;
 import org.springframework.test.context.support.DependencyInjectionTestExecutionListener;
 
 /**
- * Alternative {@link DependencyInjectionTestExecutionListener} prints the
- * {@link ConditionEvaluationReport} when the context cannot be prepared.
+ * Since 3.0.0 this class has been replaced by
+ * {@link ConditionReportApplicationContextFailureProcessor} and is not used internally.
  *
  * @author Phillip Webb
  * @since 1.4.1
+ * @deprecated since 3.0.0 for removal in 3.2.0 in favor of
+ * {@link ApplicationContextFailureProcessor}
  */
+@Deprecated(since = "3.0.0", forRemoval = true)
 public class SpringBootDependencyInjectionTestExecutionListener extends DependencyInjectionTestExecutionListener {
 
 	@Override
@@ -61,19 +60,4 @@ private void outputConditionEvaluationReport(TestContext testContext) {
 		}
 	}
 
-	static class PostProcessor implements DefaultTestExecutionListenersPostProcessor {
-
-		@Override
-		public List<TestExecutionListener> postProcessDefaultTestExecutionListeners(
-				List<TestExecutionListener> listeners) {
-			List<TestExecutionListener> updated = new ArrayList<>();
-			for (TestExecutionListener listener : listeners) {
-				updated.add((listener instanceof DependencyInjectionTestExecutionListener)
-						? new SpringBootDependencyInjectionTestExecutionListener() : listener);
-			}
-			return updated;
-		}
-
-	}
-
 }

spring-boot-project/spring-boot-test-autoconfigure/src/main/resources/META-INF/spring.factories

@@ -1,7 +1,3 @@
-# DefaultTestExecutionListenersPostProcessors
-org.springframework.boot.test.context.DefaultTestExecutionListenersPostProcessor=\
-org.springframework.boot.test.autoconfigure.SpringBootDependencyInjectionTestExecutionListener$PostProcessor
-
 # Spring Test ContextCustomizerFactories
 org.springframework.test.context.ContextCustomizerFactory=\
 org.springframework.boot.test.autoconfigure.OverrideAutoConfigurationContextCustomizerFactory,\
@@ -17,3 +13,6 @@ org.springframework.boot.test.autoconfigure.web.client.MockRestServiceServerRese
 org.springframework.boot.test.autoconfigure.web.servlet.MockMvcPrintOnlyOnFailureTestExecutionListener,\
 org.springframework.boot.test.autoconfigure.web.servlet.WebDriverTestExecutionListener,\
 org.springframework.boot.test.autoconfigure.webservices.client.MockWebServiceServerTestExecutionListener
+
+org.springframework.test.context.ApplicationContextFailureProcessor=\
+org.springframework.boot.test.autoconfigure.ConditionReportApplicationContextFailureProcessor

spring-boot-project/spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/ConditionReportApplicationContextFailureProcessorTests.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2012-2022 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.boot.test.autoconfigure;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.WebApplicationType;
+import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
+import org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration;
+import org.springframework.boot.test.system.CapturedOutput;
+import org.springframework.boot.test.system.OutputCaptureExtension;
+import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.context.annotation.Configuration;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link ConditionReportApplicationContextFailureProcessor}.
+ *
+ * @author Phillip Webb
+ * @author Scott Frederick
+ */
+@ExtendWith(OutputCaptureExtension.class)
+class ConditionReportApplicationContextFailureProcessorTests {
+
+	@Test
+	void loadFailureShouldPrintReport(CapturedOutput output) throws Exception {
+		SpringApplication application = new SpringApplication(TestConfig.class);
+		application.setWebApplicationType(WebApplicationType.NONE);
+		ConfigurableApplicationContext applicationContext = application.run();
+		ConditionReportApplicationContextFailureProcessor processor = new ConditionReportApplicationContextFailureProcessor();
+		processor.processLoadFailure(applicationContext, new IllegalStateException());
+		assertThat(output).contains("CONDITIONS EVALUATION REPORT").contains("Positive matches")
+				.contains("Negative matches");
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	@ImportAutoConfiguration(JacksonAutoConfiguration.class)
+	static class TestConfig {
+
+	}
+
+}

spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/context/DefaultTestExecutionListenersPostProcessor.java

@@ -18,19 +18,19 @@
 
 import java.util.List;
 
+import org.springframework.test.context.ApplicationContextFailureProcessor;
 import org.springframework.test.context.TestExecutionListener;
 
 /**
- * Callback interface trigger from {@link SpringBootTestContextBootstrapper} that can be
- * used to post-process the list of default {@link TestExecutionListener
- * TestExecutionListeners} to be used by a test. Can be used to add or remove existing
- * listeners.
+ * Since 3.0.0 this class is not used internally.
  *
  * @author Phillip Webb
  * @since 1.4.1
- * @see SpringBootTest
+ * @deprecated since 3.0.0 removal in 3.2.0 in favor of
+ * {@link ApplicationContextFailureProcessor}
  */
 @FunctionalInterface
+@Deprecated(since = "3.0.0", forRemoval = true)
 public interface DefaultTestExecutionListenersPostProcessor {
 
 	/**

spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/context/SpringBootTestContextBootstrapper.java

@@ -38,7 +38,6 @@
 import org.springframework.core.annotation.MergedAnnotations;
 import org.springframework.core.annotation.MergedAnnotations.SearchStrategy;
 import org.springframework.core.env.Environment;
-import org.springframework.core.io.support.SpringFactoriesLoader;
 import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.context.ContextConfigurationAttributes;
 import org.springframework.test.context.ContextCustomizer;
@@ -48,7 +47,6 @@
 import org.springframework.test.context.TestContext;
 import org.springframework.test.context.TestContextAnnotationUtils;
 import org.springframework.test.context.TestContextBootstrapper;
-import org.springframework.test.context.TestExecutionListener;
 import org.springframework.test.context.aot.AotTestAttributes;
 import org.springframework.test.context.support.DefaultTestContextBootstrapper;
 import org.springframework.test.context.support.TestPropertySourceUtils;
@@ -122,17 +120,6 @@ else if (webEnvironment != null && webEnvironment.isEmbedded()) {
 		return context;
 	}
 
-	@Override
-	protected List<TestExecutionListener> getDefaultTestExecutionListeners() {
-		List<TestExecutionListener> listeners = new ArrayList<>(super.getDefaultTestExecutionListeners());
-		List<DefaultTestExecutionListenersPostProcessor> postProcessors = SpringFactoriesLoader
-				.loadFactories(DefaultTestExecutionListenersPostProcessor.class, getClass().getClassLoader());
-		for (DefaultTestExecutionListenersPostProcessor postProcessor : postProcessors) {
-			listeners = postProcessor.postProcessDefaultTestExecutionListeners(listeners);
-		}
-		return listeners;
-	}
-
 	@Override
 	protected ContextLoader resolveContextLoader(Class<?> testClass,
 			List<ContextConfigurationAttributes> configAttributesList) {