Skip to content

Commit

Permalink
Document AOT support in the TestContext framework
Browse files Browse the repository at this point in the history
Closes gh-29482
  • Loading branch information
sbrannen committed Nov 15, 2022
1 parent 074ec97 commit 9457ed3
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 0 deletions.
2 changes: 2 additions & 0 deletions framework-docs/src/docs/asciidoc/core/core-aot.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

This chapter covers Spring's Ahead of Time (AOT) optimizations.

For AOT support specific to integration tests, see <<testing.adoc#testcontext-aot, Ahead of Time Support for Tests>>.

[[aot-introduction]]
== Introduction to Ahead of Time Optimizations

Expand Down
59 changes: 59 additions & 0 deletions framework-docs/src/docs/asciidoc/testing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6982,6 +6982,65 @@ classes by using `@ContextConfiguration`, `@TestExecutionListeners`, and so on a
manually instrumenting your test class with a `TestContextManager`. See the source code
of `AbstractTestNGSpringContextTests` for an example of how to instrument your test class.

[[testcontext-aot]]
==== Ahead of Time Support for Tests

This chapter covers Spring's Ahead of Time (AOT) support for integration tests using the
Spring TestContext Framework.

The testing support extends Spring's <<core.adoc#aot,core AOT support>> with the
following features.

* Build-time detection of all integration tests in the current project that use the
TestContext framework to load an `ApplicationContext`.
- Provides explicit support for test classes based on JUnit Jupiter and JUnit 4 as well
as implicit support for TestNG and other testing frameworks that use Spring's core
testing annotations -- as long as the tests are run using a JUnit Platform
`TestEngine` that is registered for the current project.
* Build-time AOT processing: each unique test `ApplicationContext` in the current project
will be <<core.adoc#aot-refresh,refreshed for AOT processing>>.
* Runtime AOT support: when executing in AOT runtime mode, a Spring integration test will
use an AOT-optimized `ApplicationContext` that participates transparently with the
<<testcontext-ctx-management-caching, context cache>>.

[WARNING]
====
The `@ContextHierarchy` annotation is currently not supported in AOT mode.
====

To provide test-specific runtime hints for use within a GraalVM native image, you have
the following options.

* Implement a custom
{api-spring-framework}/test/context/aot/TestRuntimeHintsRegistrar.html[`TestRuntimeHintsRegistrar`]
and register it globally via `META-INF/spring/aot.factories`.
* Implement a custom {api-spring-framework}/aot/hint/RuntimeHintsRegistrar.html[`RuntimeHintsRegistrar`]
and register it globally via `META-INF/spring/aot.factories` or locally on a test class
via {api-spring-framework}/context/annotation/ImportRuntimeHints.html[`@ImportRuntimeHints`].
* Annotate a test class with {api-spring-framework}/aot/hint/annotation/Reflective.html[`@Reflective`] or
{api-spring-framework}/aot/hint/annotation/RegisterReflectionForBinding.html[`@RegisterReflectionForBinding`].
* See <<core.adoc#aot-hints,Runtime Hints>> for details on Spring's core runtime hints
and annotation support.

[TIP]
====
The `TestRuntimeHintsRegistrar` API serves as a companion to the core
`RuntimeHintsRegistrar` API. If you need to register global hints for testing support
that are not specific to particular test classes, favor implementing
`RuntimeHintsRegistrar` over the test-specific API.
====

If you implement a custom `ContextLoader`, it must implement
{api-spring-framework}/test/context/aot/AotContextLoader.html[`AotContextLoader`] in
order to provide AOT build-time processing and AOT runtime execution support. Note,
however, that all context loader implementations provided by the Spring Framework and
Spring Boot already implement `AotContextLoader`.

If you implement a custom `TestExecutionListener`, it must implement
{api-spring-framework}/test/context/aot/AotTestExecutionListener.html[`AotTestExecutionListener`]
in order to participate in AOT processing. See the `SqlScriptsTestExecutionListener` in
the `spring-test` module for an example.



include::testing/testing-webtestclient.adoc[leveloffset=+2]
Expand Down

0 comments on commit 9457ed3

Please sign in to comment.