Interface TestInstantiationAwareExtension

All Superinterfaces:

Extension

All Known Subinterfaces:

InvocationInterceptor, ParameterResolver, TestInstanceFactory, TestInstancePostProcessor, TestInstancePreConstructCallback

All Known Implementing Classes:

TypeBasedParameterResolver

@API(status=MAINTAINED,
     since="5.13.3")
public interface TestInstantiationAwareExtension
extends Extension

Interface for Extensions that are aware and can influence the instantiation of test instances.

This interface is not indented to be implemented directly. Instead, extend one of its sub-interfaces.

Since:

5.12

See Also:

• InvocationInterceptor.interceptTestClassConstructor(InvocationInterceptor.Invocation, ReflectiveInvocationContext, ExtensionContext)
• ParameterResolver
• TestInstancePreConstructCallback
• TestInstancePostProcessor
• TestInstanceFactory

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	TestInstantiationAwareExtension.ExtensionContextScope	ExtensionContextScope is used to define the scope of the ExtensionContext passed to an extension during the instantiation of test instances.

Method Summary

Modifier and Type	Method	Description
default TestInstantiationAwareExtension.ExtensionContextScope	getTestInstantiationExtensionContextScope(ExtensionContext rootContext)	Whether this extension should receive a test-scoped ExtensionContext during the instantiation of test instances.

Method Details

getTestInstantiationExtensionContextScope

@API(status=MAINTAINED,
     since="5.13.3")
default TestInstantiationAwareExtension.ExtensionContextScope getTestInstantiationExtensionContextScope(ExtensionContext rootContext)

Whether this extension should receive a test-scoped ExtensionContext during the instantiation of test instances.

If an extension returns TEST_METHOD from this method, the following extension methods will be called with a test-scoped ExtensionContext instead of a class-scoped one, unless the PER_CLASS lifecycle is used:

• InvocationInterceptor.interceptTestClassConstructor(InvocationInterceptor.Invocation, ReflectiveInvocationContext, ExtensionContext)
• ParameterResolver when resolving constructor parameters
• TestInstancePreConstructCallback
• TestInstancePostProcessor
• TestInstanceFactory

In such cases, implementations of these extension callbacks can observe the following differences:

• getElement() may refer to the test method and getTestClass() may refer to a nested test class. Use TestInstanceFactoryContext.getTestClass() to get the class under construction.
• getTestMethod() is no longer empty, unless the PER_CLASS lifecycle is used.
• If the callback adds a new ExtensionContext.Store.CloseableResource or AutoCloseable to the Store (unless the junit.jupiter.extensions.store.close.autocloseable.enabled configuration parameter is set to false), then the resource is closed just after the instance is destroyed.
• The callbacks can now access data previously stored by TestTemplateInvocationContext, unless the PER_CLASS lifecycle is used.

Note: The behavior which is enabled by returning TEST_METHOD from this method will become the default in future versions of JUnit. To ensure forward compatibility, extension implementors are therefore advised to opt in, even if they don't require the new functionality.

Parameters:

rootContext - the root extension context to allow inspection of configuration parameters; never null

Since:

5.12

Implementation Note:

There are no guarantees about how often this method is called. Therefore, implementations should be idempotent and avoid side effects. They may, however, cache the result for performance in the Store of the supplied ExtensionContext, if necessary.