Skip to content

Commit

Permalink
Log condition evaluation report during AOT processing
Browse files Browse the repository at this point in the history
Closes gh-32109
  • Loading branch information
wilkinsona committed Oct 7, 2022
1 parent 8e35f2a commit 3eb3d79
Show file tree
Hide file tree
Showing 4 changed files with 117 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/*
* 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.autoconfigure.logging;

import org.springframework.beans.factory.aot.BeanFactoryInitializationAotContribution;
import org.springframework.beans.factory.aot.BeanFactoryInitializationAotProcessor;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.boot.autoconfigure.condition.ConditionEvaluationReport;
import org.springframework.boot.logging.LogLevel;

/**
* {@link BeanFactoryInitializationAotProcessor} that logs the
* {@link ConditionEvaluationReport} during ahead-of-time processing.
*
* @author Andy Wilkinson
*/
class ConditionEvaluationReportLoggingProcessor implements BeanFactoryInitializationAotProcessor {

@Override
public BeanFactoryInitializationAotContribution processAheadOfTime(ConfigurableListableBeanFactory beanFactory) {
logConditionEvaluationReport(beanFactory);
return null;
}

private void logConditionEvaluationReport(ConfigurableListableBeanFactory beanFactory) {
new ConditionEvaluationReportLogger(LogLevel.DEBUG, () -> ConditionEvaluationReport.get(beanFactory))
.logReport(false);
}

}
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
org.springframework.aot.hint.RuntimeHintsRegistrar=\
org.springframework.boot.autoconfigure.template.TemplateRuntimeHints

org.springframework.beans.factory.aot.BeanFactoryInitializationAotProcessor=\
org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingProcessor
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
/*
* 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.autoconfigure.logging;

import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.Logger;
import ch.qos.logback.classic.LoggerContext;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.slf4j.LoggerFactory;

import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import org.springframework.boot.autoconfigure.condition.ConditionEvaluationReport;
import org.springframework.boot.autoconfigure.condition.ConditionOutcome;
import org.springframework.boot.test.system.CapturedOutput;
import org.springframework.boot.test.system.OutputCaptureExtension;
import org.springframework.context.annotation.Condition;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;

/**
* Tests for {@link ConditionEvaluationReportLoggingProcessor}.
*
* @author Andy Wilkinson
*/
@ExtendWith(OutputCaptureExtension.class)
class ConditionEvaluationReportLoggingProcessorTests {

@Test
void logsDebugOnProcessAheadOfTime(CapturedOutput output) {
DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
ConditionEvaluationReport.get(beanFactory).recordConditionEvaluation("test", mock(Condition.class),
ConditionOutcome.match());
ConditionEvaluationReportLoggingProcessor processor = new ConditionEvaluationReportLoggingProcessor();
processor.processAheadOfTime(beanFactory);
assertThat(output).doesNotContain("CONDITIONS EVALUATION REPORT");
withDebugLogging(() -> processor.processAheadOfTime(beanFactory));
assertThat(output).contains("CONDITIONS EVALUATION REPORT");
}

private void withDebugLogging(Runnable runnable) {
Logger logger = ((LoggerContext) LoggerFactory.getILoggerFactory())
.getLogger(ConditionEvaluationReportLogger.class);
Level currentLevel = logger.getLevel();
logger.setLevel(Level.DEBUG);
try {
runnable.run();
}
finally {
logger.setLevel(currentLevel);
}
}

}
1 change: 1 addition & 0 deletions src/checkstyle/checkstyle-suppressions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
<suppressions>
<suppress files="ConditionEvaluationReportLoggerTests\.java" checks="IllegalImport" />
<suppress files="ConditionEvaluationReportLoggingListenerTests\.java" checks="IllegalImport" />
<suppress files="ConditionEvaluationReportLoggingProcessorTests\.java" checks="IllegalImport" />
<suppress files="LoggingApplicationListenerTests\.java" checks="IllegalImport" />
<suppress files="LogbackInitializer\.java" checks="IllegalImport" />
<suppress files="LogbackLoggingSystem\.java" checks="IllegalImport" />
Expand Down

0 comments on commit 3eb3d79

Please sign in to comment.