Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fail on error by default during test AOT processing

Browse Source 
Prior to this commit, if an error was encountered during build-time AOT
processing, the error was logged at WARN/DEBUG level, and processing
continued.

With this commit, test AOT processing now fails on error by default. In
addition, the `failOnError` mode can be disabled by setting the
`spring.test.aot.processing.failOnError` Spring/System property to
`false`.

Closes gh-30977
This commit is contained in:
Sam Brannen
2023-08-03 10:59:42 +03:00
parent 1bfcaecc9b
commit 3e5aa8d734
5 changed files with 127 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
spring-test/src/main/java/org/springframework/test/context/aot/TestContextAotGenerator.java
View File

@@ -43,6 +43,7 @@ import org.springframework.context.ApplicationContextInitializer;
import org.springframework.context.annotation.ImportRuntimeHints;
import org.springframework.context.aot.ApplicationContextAotGenerator;
import org.springframework.context.support.GenericApplicationContext;
import org.springframework.core.SpringProperties;
import org.springframework.core.annotation.MergedAnnotation;
import org.springframework.core.annotation.MergedAnnotations;
import org.springframework.core.annotation.MergedAnnotations.SearchStrategy;
@@ -56,6 +57,7 @@ import org.springframework.test.context.TestContextBootstrapper;
import org.springframework.util.Assert;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.util.StringUtils;
import static org.springframework.aot.hint.MemberCategory.INVOKE_DECLARED_CONSTRUCTORS;
import static org.springframework.aot.hint.MemberCategory.INVOKE_PUBLIC_METHODS;
@@ -70,8 +72,26 @@ import static org.springframework.aot.hint.MemberCategory.INVOKE_PUBLIC_METHODS;
*/
public class TestContextAotGenerator {
/**
* JVM system property used to set the {@code failOnError} flag: {@value}.
* <p>The {@code failOnError} flag controls whether errors encountered during
* AOT processing in the <em>Spring TestContext Framework</em> should result
* in an exception that fails the overall process.
* <p>Defaults to {@code true}.
* <p>Supported values include {@code true} or {@code false}, ignoring case.
* For example, the default may be changed to {@code false} by supplying
* the following JVM system property via the command line.
* <pre style="code">-Dspring.test.aot.processing.failOnError=false</pre>
* <p>May alternatively be configured via the
* {@link org.springframework.core.SpringProperties SpringProperties}
* mechanism.
* @since 6.1
*/
public static final String FAIL_ON_ERROR_PROPERTY_NAME = "spring.test.aot.processing.failOnError";
private static final Log logger = LogFactory.getLog(TestContextAotGenerator.class);
private final ApplicationContextAotGenerator aotGenerator = new ApplicationContextAotGenerator();
private final AotServices<TestRuntimeHintsRegistrar> testRuntimeHintsRegistrars;
@@ -85,13 +105,14 @@ public class TestContextAotGenerator {
private final RuntimeHints runtimeHints;
private final boolean failOnError;
final boolean failOnError;
/**
* Create a new {@link TestContextAotGenerator} that uses the supplied
* {@link GeneratedFiles}.
* @param generatedFiles the {@code GeneratedFiles} to use
* @see #TestContextAotGenerator(GeneratedFiles, RuntimeHints)
*/
public TestContextAotGenerator(GeneratedFiles generatedFiles) {
this(generatedFiles, new RuntimeHints());
@@ -100,11 +121,15 @@ public class TestContextAotGenerator {
/**
* Create a new {@link TestContextAotGenerator} that uses the supplied
* {@link GeneratedFiles} and {@link RuntimeHints}.
* <p>This constructor looks up the value of the {@code failOnError} flag via
* the {@value #FAIL_ON_ERROR_PROPERTY_NAME} property, defaulting to
* {@code true} if the property is not set.
* @param generatedFiles the {@code GeneratedFiles} to use
* @param runtimeHints the {@code RuntimeHints} to use
* @see #TestContextAotGenerator(GeneratedFiles, RuntimeHints, boolean)
*/
public TestContextAotGenerator(GeneratedFiles generatedFiles, RuntimeHints runtimeHints) {
this(generatedFiles, runtimeHints, false);
this(generatedFiles, runtimeHints, getFailOnErrorFlag());
}
/**
@@ -114,9 +139,9 @@ public class TestContextAotGenerator {
* @param runtimeHints the {@code RuntimeHints} to use
* @param failOnError {@code true} if errors encountered during AOT processing
* should result in an exception that fails the overall process
* @since 6.0.12
* @since 6.1
*/
TestContextAotGenerator(GeneratedFiles generatedFiles, RuntimeHints runtimeHints, boolean failOnError) {
public TestContextAotGenerator(GeneratedFiles generatedFiles, RuntimeHints runtimeHints, boolean failOnError) {
this.testRuntimeHintsRegistrars = AotServices.factories().load(TestRuntimeHintsRegistrar.class);
this.generatedFiles = generatedFiles;
this.runtimeHints = runtimeHints;
@@ -368,4 +393,12 @@ public class TestContextAotGenerator {
this.runtimeHints.reflection().registerType(type, INVOKE_DECLARED_CONSTRUCTORS);
}
private static boolean getFailOnErrorFlag() {
String failOnError = SpringProperties.getProperty(FAIL_ON_ERROR_PROPERTY_NAME);
if (StringUtils.hasText(failOnError)) {
return Boolean.parseBoolean(failOnError.trim());
}
return true;
}
}