Class TestContextAotGenerator

java.lang.Object

org.springframework.test.context.aot.TestContextAotGenerator

public class TestContextAotGenerator
extends Object

TestContextAotGenerator generates AOT artifacts for integration tests that depend on support from the Spring TestContext Framework.

Since:

6.0

Author:

Sam Brannen

See Also:

• ApplicationContextAotGenerator

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FAIL_ON_ERROR_PROPERTY_NAME	JVM system property used to set the failOnError flag: "spring.test.aot.processing.failOnError".

Constructor Summary

Constructors

Constructor	Description
TestContextAotGenerator(GeneratedFiles generatedFiles)	Create a new TestContextAotGenerator that uses the supplied GeneratedFiles.
TestContextAotGenerator(GeneratedFiles generatedFiles, RuntimeHints runtimeHints)	Create a new TestContextAotGenerator that uses the supplied GeneratedFiles and RuntimeHints.
TestContextAotGenerator(GeneratedFiles generatedFiles, RuntimeHints runtimeHints, boolean failOnError)	Create a new TestContextAotGenerator that uses the supplied GeneratedFiles, RuntimeHints, and failOnError flag.

Method Summary

Modifier and Type	Method	Description
final RuntimeHints	getRuntimeHints()	Get the RuntimeHints gathered during AOT processing.
void	processAheadOfTime(Stream<Class<?>> testClasses)	Process each of the supplied Spring integration test classes and generate AOT artifacts.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FAIL_ON_ERROR_PROPERTY_NAME

public static final String FAIL_ON_ERROR_PROPERTY_NAME

JVM system property used to set the failOnError flag: "spring.test.aot.processing.failOnError".

The failOnError flag controls whether errors encountered during AOT processing in the Spring TestContext Framework should result in an exception that fails the overall process.

Defaults to true.

Supported values include true or false, ignoring case. For example, the default may be changed to false by supplying the following JVM system property via the command line.

-Dspring.test.aot.processing.failOnError=false

May alternatively be configured via the SpringProperties mechanism.

Since:

6.1

See Also:

• Constant Field Values

Constructor Details

TestContextAotGenerator

public TestContextAotGenerator(GeneratedFiles generatedFiles)

Create a new TestContextAotGenerator that uses the supplied GeneratedFiles.

Parameters:

generatedFiles - the GeneratedFiles to use

See Also:

• TestContextAotGenerator(GeneratedFiles, RuntimeHints)

TestContextAotGenerator

public TestContextAotGenerator(GeneratedFiles generatedFiles,
 RuntimeHints runtimeHints)

Create a new TestContextAotGenerator that uses the supplied GeneratedFiles and RuntimeHints.

This constructor looks up the value of the failOnError flag via the "spring.test.aot.processing.failOnError" property, defaulting to true if the property is not set.

Parameters:

generatedFiles - the GeneratedFiles to use

runtimeHints - the RuntimeHints to use

See Also:

• TestContextAotGenerator(GeneratedFiles, RuntimeHints, boolean)

TestContextAotGenerator

public TestContextAotGenerator(GeneratedFiles generatedFiles,
 RuntimeHints runtimeHints,
 boolean failOnError)

Create a new TestContextAotGenerator that uses the supplied GeneratedFiles, RuntimeHints, and failOnError flag.

Parameters:

generatedFiles - the GeneratedFiles to use

runtimeHints - the RuntimeHints to use

failOnError - true if errors encountered during AOT processing should result in an exception that fails the overall process

Since:

6.1

Method Details

getRuntimeHints

public final RuntimeHints getRuntimeHints()

Get the RuntimeHints gathered during AOT processing.

processAheadOfTime

public void processAheadOfTime(Stream<Class<?>> testClasses)
                        throws TestContextAotException

Process each of the supplied Spring integration test classes and generate AOT artifacts.

Throws:

TestContextAotException - if an error occurs during AOT processing