Annotation Interface TestTemplate

@TestTemplate is used to signal that the annotated method is a test template method.

In contrast to @Test methods, a test template is not itself a test case but rather a template for test cases. As such, it is designed to be invoked multiple times depending on the number of invocation contexts returned by the registered providers. Must be used together with at least one provider. Otherwise, execution will fail.

Each invocation of a test template method behaves like the execution of a regular @Test method with full support for the same lifecycle callbacks and extensions.

@TestTemplate methods must not be private or static and must return void.

@TestTemplate methods may optionally declare parameters to be resolved by ParameterResolvers.

@TestTemplate may also be used as a meta-annotation in order to create a custom composed annotation that inherits the semantics of @TestTemplate.

Test Execution Order

By default, test methods will be ordered using an algorithm that is deterministic but intentionally nonobvious. This ensures that subsequent runs of a test suite execute test methods in the same order, thereby allowing for repeatable builds. In this context, a test method is any instance method that is directly annotated or meta-annotated with @Test, @RepeatedTest, @ParameterizedTest, @TestFactory, or @TestTemplate.

Although true unit tests typically should not rely on the order in which they are executed, there are times when it is necessary to enforce a specific test method execution order — for example, when writing integration tests or functional tests where the sequence of the tests is important, especially in conjunction with @TestInstance(Lifecycle.PER_CLASS).

To control the order in which test methods are executed, annotate your test class or test interface with @TestMethodOrder and specify the desired MethodOrderer implementation.

See Also:
Test, TestTemplateInvocationContext, TestTemplateInvocationContextProvider