JUnit 6.0.1 · org.junit.jupiter.engine.extension.TimeoutExtension

Modifier and Type	Class and Description
private static interface	TimeoutExtension.TimeoutProvider

Modifier and Type	Field and Description
private static final String	GLOBAL_TIMEOUT_CONFIG_KEY
private static final ExtensionContext.Namespace	NAMESPACE
private static final String	TESTABLE_METHOD_TIMEOUT_KEY
private static final String	TESTABLE_METHOD_TIMEOUT_THREAD_MODE_KEY

Access	Constructor and Description
pack-priv	TimeoutExtension()

Modifier and Type	Method and Description
public void	beforeAll(ExtensionContext context) Implements org.junit.jupiter.api.extension.BeforeAllCallback.beforeAll. Callback that is invoked once before all tests in the current container.
public void	beforeEach(ExtensionContext context) Implements org.junit.jupiter.api.extension.BeforeEachCallback.beforeEach. Callback that is invoked before an individual test and any user-defined setup methods for that test have been executed.
private <T extends @Nullable Object> InvocationInterceptor.Invocation<T>	decorate(InvocationInterceptor.Invocation<T> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext, @Nullable TimeoutDuration timeout, TimeoutConfiguration timeoutConfiguration)
private String	describe(ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext)
private @Nullable Timeout.ThreadMode	getAnnotationThreadMode(ExtensionContext extensionContext)
private @Nullable TimeoutDuration	getDefaultTimeout(TimeoutExtension.TimeoutProvider defaultTimeoutProvider, TimeoutConfiguration timeoutConfiguration)
private TimeoutConfiguration	getGlobalTimeoutConfiguration(ExtensionContext extensionContext)
public TestInstantiationAwareExtension.ExtensionContextScope	getTestInstantiationExtensionContextScope(ExtensionContext rootContext) Overrides default org.junit.jupiter.api.extension.TestInstantiationAwareExtension.getTestInstantiationExtensionContextScope. Determine whether this extension should receive a test-method scoped `ExtensionContext` during the instantiation of test classes or processing of test instances.
private <T extends @Nullable Object> T	intercept(InvocationInterceptor.Invocation<T> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext, @Nullable TimeoutDuration explicitTimeout, TimeoutExtension.TimeoutProvider defaultTimeoutProvider)
public void	interceptAfterAllMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptAfterAllMethod. Intercept the invocation of an `@AfterAll` method.
public void	interceptAfterEachMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptAfterEachMethod. Intercept the invocation of an `@AfterEach` method.
public void	interceptBeforeAllMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptBeforeAllMethod. Intercept the invocation of a `@BeforeAll` method.
public void	interceptBeforeEachMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptBeforeEachMethod. Intercept the invocation of a `@BeforeEach` method.
private void	interceptLifecycleMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext, TimeoutExtension.TimeoutProvider defaultTimeoutProvider)
private <T extends @Nullable Object> T	interceptTestableMethod(InvocationInterceptor.Invocation<T> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext, TimeoutExtension.TimeoutProvider defaultTimeoutProvider)
public <T extends @Nullable Object> T	interceptTestFactoryMethod(InvocationInterceptor.Invocation<T> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptTestFactoryMethod. Intercept the invocation of a `@TestFactory` method, such as a `@RepeatedTest` or `@ParameterizedTest` method.
public void	interceptTestMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptTestMethod. Intercept the invocation of a `@Test` method.
public void	interceptTestTemplateMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptTestTemplateMethod. Intercept the invocation of a `@TestTemplate` method.
private void	readAndStoreTimeoutSoChildrenInheritIt(ExtensionContext context)
private Optional<TimeoutDuration>	readTimeoutFromAnnotation(Optional<AnnotatedElement> element)
private Optional<Timeout.ThreadMode>	readTimeoutThreadModeFromAnnotation(Optional<AnnotatedElement> element)
private Timeout.ThreadMode	resolveTimeoutThreadMode(ExtensionContext extensionContext, TimeoutConfiguration timeoutConfiguration)

GLOBAL_TIMEOUT_CONFIG_KEY	back to summary
private static final String GLOBAL_TIMEOUT_CONFIG_KEY

NAMESPACE	back to summary
private static final ExtensionContext.Namespace NAMESPACE

TESTABLE_METHOD_TIMEOUT_KEY	back to summary
private static final String TESTABLE_METHOD_TIMEOUT_KEY

TESTABLE_METHOD_TIMEOUT_THREAD_MODE_KEY	back to summary
private static final String TESTABLE_METHOD_TIMEOUT_THREAD_MODE_KEY

TimeoutExtension	back to summary
pack-priv TimeoutExtension()

Method Detail

beforeAll	back to summary
public void beforeAll(ExtensionContext context) Implements org.junit.jupiter.api.extension.BeforeAllCallback.beforeAll. Doc from org.junit.jupiter.api.extension.BeforeAllCallback.beforeAll. Callback that is invoked once before all tests in the current container. Annotations @Override

beforeAll

back to summary

public void beforeAll(ExtensionContext context)

Implements org.junit.jupiter.api.extension.BeforeAllCallback.beforeAll.

Doc from org.junit.jupiter.api.extension.BeforeAllCallback.beforeAll.

Callback that is invoked once before all tests in the current container.

Annotations

@Override

beforeEach	back to summary
public void beforeEach(ExtensionContext context) Implements org.junit.jupiter.api.extension.BeforeEachCallback.beforeEach. Doc from org.junit.jupiter.api.extension.BeforeEachCallback.beforeEach. Callback that is invoked before an individual test and any user-defined setup methods for that test have been executed. Annotations @Override

beforeEach

back to summary

public void beforeEach(ExtensionContext context)

Implements org.junit.jupiter.api.extension.BeforeEachCallback.beforeEach.

Doc from org.junit.jupiter.api.extension.BeforeEachCallback.beforeEach.

Callback that is invoked before an individual test and any user-defined setup methods for that test have been executed.

Annotations

@Override

decorate	back to summary
private <T extends @Nullable Object> InvocationInterceptor.Invocation<T> decorate(InvocationInterceptor.Invocation<T> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext, @Nullable TimeoutDuration timeout, TimeoutConfiguration timeoutConfiguration)

describe	back to summary
private String describe(ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext)

getAnnotationThreadMode	back to summary
private @Nullable Timeout.ThreadMode getAnnotationThreadMode(ExtensionContext extensionContext)

getDefaultTimeout	back to summary
private @Nullable TimeoutDuration getDefaultTimeout(TimeoutExtension.TimeoutProvider defaultTimeoutProvider, TimeoutConfiguration timeoutConfiguration)

getGlobalTimeoutConfiguration	back to summary
private TimeoutConfiguration getGlobalTimeoutConfiguration(ExtensionContext extensionContext)

getTestInstantiationExtensionContextScope back to summary

getTestInstantiationExtensionContextScope	back to summary
public TestInstantiationAwareExtension.ExtensionContextScope getTestInstantiationExtensionContextScope(ExtensionContext rootContext) Overrides default org.junit.jupiter.api.extension.TestInstantiationAwareExtension.getTestInstantiationExtensionContextScope. Doc from org.junit.jupiter.api.extension.TestInstantiationAwareExtension.getTestInstantiationExtensionContextScope. Determine whether this extension should receive a test-method scoped `ExtensionContext` during the instantiation of test classes or processing of test instances. If an extension returns `TEST_METHOD` from this method, methods defined in the following extension APIs will be called with a test-method scoped `ExtensionContext` instead of a test-class scoped context. Note, however, that a test-class scoped context will always be supplied if the `PER_CLASS` test instance lifecycle is used. `InvocationInterceptor`: only the `interceptTestClassConstructor(...)` method `ParameterResolver`: only when resolving constructor parameters `TestInstancePreConstructCallback` `TestInstancePostProcessor` `TestInstanceFactory` When a test-method scoped `ExtensionContext` is supplied, implementations of the above extension APIs will observe the following differences. `getElement()` may refer to the test method. `getTestClass()` may refer to a nested test class. For `TestInstancePostProcessor`, use `testInstance.getClass()` to get the test class associated with the supplied instance. For `TestInstanceFactory` and `TestInstancePreConstructCallback`, use `TestInstanceFactoryContext#getTestClass()` to get the class under construction. For `ParameterResolver`, when resolving a parameter for a constructor, ensure that the `Executable` is a `Constructor`, and then use `constructor.getDeclaringClass()` to get the test class associated with the constructor. `getTestMethod()` is no longer empty, unless the `PER_CLASS` test instance lifecycle is used. If the extension adds a `CloseableResource` or `AutoCloseable` to the `Store` (unless the `junit.jupiter.extensions.store.close.autocloseable.enabled` configuration parameter is set to `false`), then the resource will be closed just after the instance is destroyed. Extensions can now access data previously stored by a `TestTemplateInvocationContext`, unless the `PER_CLASS` test instance 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 authors are therefore advised to opt into this feature, even if they do not require the new functionality. Annotations @Override

public TestInstantiationAwareExtension.ExtensionContextScope getTestInstantiationExtensionContextScope(ExtensionContext rootContext)

Overrides default org.junit.jupiter.api.extension.TestInstantiationAwareExtension.getTestInstantiationExtensionContextScope.

Doc from org.junit.jupiter.api.extension.TestInstantiationAwareExtension.getTestInstantiationExtensionContextScope.

Determine whether this extension should receive a test-method scoped ExtensionContext during the instantiation of test classes or processing of test instances.

If an extension returns TEST_METHOD from this method, methods defined in the following extension APIs will be called with a test-method scoped ExtensionContext instead of a test-class scoped context. Note, however, that a test-class scoped context will always be supplied if the PER_CLASS test instance lifecycle is used.

InvocationInterceptor: only the interceptTestClassConstructor(...) method
ParameterResolver: only when resolving constructor parameters
TestInstancePreConstructCallback
TestInstancePostProcessor
TestInstanceFactory

When a test-method scoped ExtensionContext is supplied, implementations of the above extension APIs will observe the following differences.

getElement() may refer to the test method.
getTestClass() may refer to a nested test class.
- For TestInstancePostProcessor, use testInstance.getClass() to get the test class associated with the supplied instance.
- For TestInstanceFactory and TestInstancePreConstructCallback, use TestInstanceFactoryContext#getTestClass() to get the class under construction.
- For ParameterResolver, when resolving a parameter for a constructor, ensure that the Executable is a Constructor, and then use constructor.getDeclaringClass() to get the test class associated with the constructor.
getTestMethod() is no longer empty, unless the PER_CLASS test instance lifecycle is used.
If the extension adds a CloseableResource or AutoCloseable to the Store (unless the junit.jupiter.extensions.store.close.autocloseable.enabled configuration parameter is set to false), then the resource will be closed just after the instance is destroyed.
Extensions can now access data previously stored by a TestTemplateInvocationContext, unless the PER_CLASS test instance 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 authors are therefore advised to opt into this feature, even if they do not require the new functionality.

Annotations

@Override

intercept	back to summary
private <T extends @Nullable Object> T intercept(InvocationInterceptor.Invocation<T> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext, @Nullable TimeoutDuration explicitTimeout, TimeoutExtension.TimeoutProvider defaultTimeoutProvider) throws Throwable

interceptAfterAllMethod back to summary

interceptAfterAllMethod	back to summary
public void interceptAfterAllMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptAfterAllMethod. Doc from org.junit.jupiter.api.extension.InvocationInterceptor.interceptAfterAllMethod. Intercept the invocation of an `@AfterAll` method. Annotations @Override Exceptions Throwable: in case of failures

public void interceptAfterAllMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable

Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptAfterAllMethod.

Doc from org.junit.jupiter.api.extension.InvocationInterceptor.interceptAfterAllMethod.

Intercept the invocation of an @AfterAll method.

Annotations

@Override

Exceptions

Throwable:: in case of failures

interceptAfterEachMethod back to summary

interceptAfterEachMethod	back to summary
public void interceptAfterEachMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptAfterEachMethod. Doc from org.junit.jupiter.api.extension.InvocationInterceptor.interceptAfterEachMethod. Intercept the invocation of an `@AfterEach` method. Annotations @Override Exceptions Throwable: in case of failures

public void interceptAfterEachMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable

Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptAfterEachMethod.

Doc from org.junit.jupiter.api.extension.InvocationInterceptor.interceptAfterEachMethod.

Intercept the invocation of an @AfterEach method.

Annotations

@Override

Exceptions

Throwable:: in case of failures

interceptBeforeAllMethod back to summary

interceptBeforeAllMethod	back to summary
public void interceptBeforeAllMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptBeforeAllMethod. Doc from org.junit.jupiter.api.extension.InvocationInterceptor.interceptBeforeAllMethod. Intercept the invocation of a `@BeforeAll` method. Annotations @Override Exceptions Throwable: in case of failures

public void interceptBeforeAllMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable

Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptBeforeAllMethod.

Doc from org.junit.jupiter.api.extension.InvocationInterceptor.interceptBeforeAllMethod.

Intercept the invocation of a @BeforeAll method.

Annotations

@Override

Exceptions

Throwable:: in case of failures

interceptBeforeEachMethod back to summary

interceptBeforeEachMethod	back to summary
public void interceptBeforeEachMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptBeforeEachMethod. Doc from org.junit.jupiter.api.extension.InvocationInterceptor.interceptBeforeEachMethod. Intercept the invocation of a `@BeforeEach` method. Annotations @Override Exceptions Throwable: in case of failures

public void interceptBeforeEachMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable

Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptBeforeEachMethod.

Doc from org.junit.jupiter.api.extension.InvocationInterceptor.interceptBeforeEachMethod.

Intercept the invocation of a @BeforeEach method.

Annotations

@Override

Exceptions

Throwable:: in case of failures

interceptLifecycleMethod	back to summary
private void interceptLifecycleMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext, TimeoutExtension.TimeoutProvider defaultTimeoutProvider) throws Throwable

interceptTestableMethod	back to summary
private <T extends @Nullable Object> T interceptTestableMethod(InvocationInterceptor.Invocation<T> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext, TimeoutExtension.TimeoutProvider defaultTimeoutProvider) throws Throwable

interceptTestFactoryMethod back to summary

interceptTestFactoryMethod	back to summary
public <T extends @Nullable Object> T interceptTestFactoryMethod(InvocationInterceptor.Invocation<T> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptTestFactoryMethod. Doc from org.junit.jupiter.api.extension.InvocationInterceptor.interceptTestFactoryMethod. Intercept the invocation of a `@TestFactory` method, such as a `@RepeatedTest` or `@ParameterizedTest` method. Annotations @Override Exceptions Throwable: in case of failures

public <T extends @Nullable Object> T interceptTestFactoryMethod(InvocationInterceptor.Invocation<T> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable

Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptTestFactoryMethod.

Doc from org.junit.jupiter.api.extension.InvocationInterceptor.interceptTestFactoryMethod.

Intercept the invocation of a @TestFactory method, such as a @RepeatedTest or @ParameterizedTest method.

Annotations

@Override

Exceptions

Throwable:: in case of failures

interceptTestMethod back to summary

interceptTestMethod	back to summary
public void interceptTestMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptTestMethod. Doc from org.junit.jupiter.api.extension.InvocationInterceptor.interceptTestMethod. Intercept the invocation of a `@Test` method. Annotations @Override Exceptions Throwable: in case of failures

public void interceptTestMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable

Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptTestMethod.

Doc from org.junit.jupiter.api.extension.InvocationInterceptor.interceptTestMethod.

Intercept the invocation of a @Test method.

Annotations

@Override

Exceptions

Throwable:: in case of failures

interceptTestTemplateMethod back to summary

interceptTestTemplateMethod	back to summary
public void interceptTestTemplateMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptTestTemplateMethod. Doc from org.junit.jupiter.api.extension.InvocationInterceptor.interceptTestTemplateMethod. Intercept the invocation of a `@TestTemplate` method. Annotations @Override Exceptions Throwable: in case of failures

public void interceptTestTemplateMethod(InvocationInterceptor.Invocation<@Nullable Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext) throws Throwable

Overrides default org.junit.jupiter.api.extension.InvocationInterceptor.interceptTestTemplateMethod.

Doc from org.junit.jupiter.api.extension.InvocationInterceptor.interceptTestTemplateMethod.

Intercept the invocation of a @TestTemplate method.

Annotations

@Override

Exceptions

Throwable:: in case of failures

readAndStoreTimeoutSoChildrenInheritIt	back to summary
private void readAndStoreTimeoutSoChildrenInheritIt(ExtensionContext context)

readTimeoutFromAnnotation	back to summary
private Optional<TimeoutDuration> readTimeoutFromAnnotation(Optional<AnnotatedElement> element) Annotations @SuppressWarnings:OptionalUsedAsFieldOrParameterType

readTimeoutThreadModeFromAnnotation	back to summary
private Optional<Timeout.ThreadMode> readTimeoutThreadModeFromAnnotation(Optional<AnnotatedElement> element) Annotations @SuppressWarnings:OptionalUsedAsFieldOrParameterType

resolveTimeoutThreadMode	back to summary
private Timeout.ThreadMode resolveTimeoutThreadMode(ExtensionContext extensionContext, TimeoutConfiguration timeoutConfiguration)

pack-priv Class TimeoutExtension

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Interface TimeoutExtension.TimeoutProvider

Method Summary