Skip to content

Introduce 'spring.test.print-condition-evaluation-report' property to control whether the condition evaluation report should be printed when the ApplicationContext fails to start #45268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
+56 −4
Closed

Introduce 'spring.test.print-condition-evaluation-report' property to control whether the condition evaluation report should be printed when the ApplicationContext fails to start #45268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions ...ngframework/boot/test/autoconfigure/OnFailureConditionReportContextCustomizerFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2024 the original author or authors.
* Copyright 2012-2025 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.
Expand Down Expand Up @@ -84,7 +84,17 @@ private ApplicationFailureListener(Supplier<ConditionEvaluationReport> reportSup

@Override
public void onApplicationEvent(ApplicationFailedEvent event) {
System.err.println(new ConditionEvaluationReportMessage(this.reportSupplier.get()));
if (shouldPrintReport(event.getApplicationContext())) {
System.err.println(new ConditionEvaluationReportMessage(this.reportSupplier.get()));
}
}

private static boolean shouldPrintReport(ConfigurableApplicationContext context) {
if (context == null) {
return true;
}
return context.getEnvironment()
.getProperty("spring.test.print-condition-evaluation-report", Boolean.class, true);
}

}
Expand Down
6 changes: 6 additions & 0 deletions ...ng-boot-test-autoconfigure/src/main/resources/META-INF/spring-configuration-metadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@
"type": "java.lang.Boolean",
"description": "Whether observability should be auto-configured in tests.",
"defaultValue": "false"
},
{
"name": "spring.test.print-condition-evaluation-report",
"type": "java.lang.Boolean",
"description": "Whether the condition evaluation report should be printed when the ApplicationContext fails to start.",
"defaultValue": "true"
}
]
}
40 changes: 38 additions & 2 deletions ...mework/boot/test/autoconfigure/OnFailureConditionReportContextCustomizerFactoryTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2024 the original author or authors.
* Copyright 2012-2025 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.
Expand All @@ -16,6 +16,7 @@

package org.springframework.boot.test.autoconfigure;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;

Expand All @@ -24,9 +25,13 @@
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.system.CapturedOutput;
import org.springframework.boot.test.system.OutputCaptureExtension;
import org.springframework.boot.testsupport.classpath.resources.WithResource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.test.context.TestContextManager;
import org.springframework.test.context.cache.ContextCache;
import org.springframework.test.context.cache.DefaultCacheAwareContextLoaderDelegate;
import org.springframework.test.util.ReflectionTestUtils;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
Expand All @@ -39,11 +44,42 @@
@ExtendWith(OutputCaptureExtension.class)
class OnFailureConditionReportContextCustomizerFactoryTests {

@BeforeEach
void clearCache() {
ContextCache contextCache = (ContextCache) ReflectionTestUtils
.getField(DefaultCacheAwareContextLoaderDelegate.class, "defaultContextCache");
if (contextCache != null) {
contextCache.reset();
}
}

@Test
void loadFailureShouldPrintReport(CapturedOutput output) {
load();
assertThat(output.getErr()).contains("JacksonAutoConfiguration matched");
assertThat(output).contains("Error creating bean with name 'faultyBean'");
}

@Test
@WithResource(name = "application.xml", content = "invalid xml")
void loadFailureShouldNotPrintReportWhenApplicationPropertiesIsBroken(CapturedOutput output) {
load();
assertThat(output).doesNotContain("JacksonAutoConfiguration matched")
.doesNotContain("Error creating bean with name 'faultyBean'")
.contains("java.util.InvalidPropertiesFormatException");
}

@Test
@WithResource(name = "application.properties", content = "spring.test.print-condition-evaluation-report=false")
void loadFailureShouldNotPrintReportWhenDisabled(CapturedOutput output) {
load();
assertThat(output).doesNotContain("JacksonAutoConfiguration matched")
.contains("Error creating bean with name 'faultyBean'");
}

private void load() {
assertThatIllegalStateException()
.isThrownBy(() -> new TestContextManager(FailingTests.class).getTestContext().getApplicationContext());
assertThat(output).contains("JacksonAutoConfiguration matched");
}

@SpringBootTest
Expand Down