Module org.junit.jupiter.api
Package org.junit.jupiter.api.extension
Interface InvocationInterceptor
- All Superinterfaces:
Extension
InvocationInterceptor
defines the API for Extensions
that wish to intercept calls to test code.
Invocation Contract
Each method in this class must call InvocationInterceptor.Invocation.proceed()
or InvocationInterceptor.Invocation.skip()
exactly once on the supplied invocation. Otherwise, the
enclosing test or container will be reported as failed.
The default implementation calls proceed()
on the supplied invocation.
Constructor Requirements
Consult the documentation in Extension
for details on
constructor requirements.
- Since:
- 5.5
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
An invocation that returns a result and may throw aThrowable
. -
Method Summary
Modifier and TypeMethodDescriptiondefault void
interceptAfterAllMethod
(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) Intercept the invocation of an@AfterAll
method.default void
interceptAfterEachMethod
(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) Intercept the invocation of an@AfterEach
method.default void
interceptBeforeAllMethod
(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) Intercept the invocation of a@BeforeAll
method.default void
interceptBeforeEachMethod
(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) Intercept the invocation of a@BeforeEach
method.default void
interceptDynamicTest
(InvocationInterceptor.Invocation<Void> invocation, DynamicTestInvocationContext invocationContext, ExtensionContext extensionContext) Intercept the invocation of aDynamicTest
.default void
interceptDynamicTest
(InvocationInterceptor.Invocation<Void> invocation, ExtensionContext extensionContext) Deprecated.default <T> T
interceptTestClassConstructor
(InvocationInterceptor.Invocation<T> invocation, ReflectiveInvocationContext<Constructor<T>> invocationContext, ExtensionContext extensionContext) Intercept the invocation of a test class constructor.default <T> T
interceptTestFactoryMethod
(InvocationInterceptor.Invocation<T> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) Intercept the invocation of a@TestFactory
method, such as a@RepeatedTest
or@ParameterizedTest
method.default void
interceptTestMethod
(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) Intercept the invocation of a@Test
method.default void
interceptTestTemplateMethod
(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) Intercept the invocation of a@TestTemplate
method.
-
Method Details
-
interceptTestClassConstructor
default <T> T interceptTestClassConstructor(InvocationInterceptor.Invocation<T> invocation, ReflectiveInvocationContext<Constructor<T>> invocationContext, ExtensionContext extensionContext) throws Throwable Intercept the invocation of a test class constructor.Note that the test class may not have been initialized (static initialization) when this method is invoked.
- Type Parameters:
T
- the result type- Parameters:
invocation
- the invocation that is being intercepted; nevernull
invocationContext
- the context of the invocation that is being intercepted; nevernull
extensionContext
- the current extension context; nevernull
- Returns:
- the result of the invocation; never
null
- Throws:
Throwable
- in case of failure
-
interceptBeforeAllMethod
default void interceptBeforeAllMethod(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable Intercept the invocation of a@BeforeAll
method.- Parameters:
invocation
- the invocation that is being intercepted; nevernull
invocationContext
- the context of the invocation that is being intercepted; nevernull
extensionContext
- the current extension context; nevernull
- Throws:
Throwable
- in case of failures
-
interceptBeforeEachMethod
default void interceptBeforeEachMethod(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable Intercept the invocation of a@BeforeEach
method.- Parameters:
invocation
- the invocation that is being intercepted; nevernull
invocationContext
- the context of the invocation that is being intercepted; nevernull
extensionContext
- the current extension context; nevernull
- Throws:
Throwable
- in case of failures
-
interceptTestMethod
default void interceptTestMethod(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable Intercept the invocation of a@Test
method.- Parameters:
invocation
- the invocation that is being intercepted; nevernull
invocationContext
- the context of the invocation that is being intercepted; nevernull
extensionContext
- the current extension context; nevernull
- Throws:
Throwable
- in case of failures
-
interceptTestFactoryMethod
default <T> T interceptTestFactoryMethod(InvocationInterceptor.Invocation<T> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable Intercept the invocation of a@TestFactory
method, such as a@RepeatedTest
or@ParameterizedTest
method.- Type Parameters:
T
- the result type- Parameters:
invocation
- the invocation that is being intercepted; nevernull
invocationContext
- the context of the invocation that is being intercepted; nevernull
extensionContext
- the current extension context; nevernull
- Returns:
- the result of the invocation; potentially
null
- Throws:
Throwable
- in case of failures
-
interceptTestTemplateMethod
default void interceptTestTemplateMethod(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable Intercept the invocation of a@TestTemplate
method.- Parameters:
invocation
- the invocation that is being intercepted; nevernull
invocationContext
- the context of the invocation that is being intercepted; nevernull
extensionContext
- the current extension context; nevernull
- Throws:
Throwable
- in case of failures
-
interceptDynamicTest
@Deprecated @API(status=DEPRECATED, since="5.8") default void interceptDynamicTest(InvocationInterceptor.Invocation<Void> invocation, ExtensionContext extensionContext) throws Throwable Deprecated.Intercept the invocation of aDynamicTest
.- Parameters:
invocation
- the invocation that is being intercepted; nevernull
extensionContext
- the current extension context; nevernull
- Throws:
Throwable
- in case of failures
-
interceptDynamicTest
@API(status=EXPERIMENTAL, since="5.8") default void interceptDynamicTest(InvocationInterceptor.Invocation<Void> invocation, DynamicTestInvocationContext invocationContext, ExtensionContext extensionContext) throws Throwable Intercept the invocation of aDynamicTest
.- Parameters:
invocation
- the invocation that is being intercepted; nevernull
invocationContext
- the context of the invocation that is being intercepted; nevernull
extensionContext
- the current extension context; nevernull
- Throws:
Throwable
- in case of failures
-
interceptAfterEachMethod
default void interceptAfterEachMethod(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable Intercept the invocation of an@AfterEach
method.- Parameters:
invocation
- the invocation that is being intercepted; nevernull
invocationContext
- the context of the invocation that is being intercepted; nevernull
extensionContext
- the current extension context; nevernull
- Throws:
Throwable
- in case of failures
-
interceptAfterAllMethod
default void interceptAfterAllMethod(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable Intercept the invocation of an@AfterAll
method.- Parameters:
invocation
- the invocation that is being intercepted; nevernull
invocationContext
- the context of the invocation that is being intercepted; nevernull
extensionContext
- the current extension context; nevernull
- Throws:
Throwable
- in case of failures
-
interceptDynamicTest(Invocation, DynamicTestInvocationContext, ExtensionContext)
instead