Package org.junit.jupiter.engine.extension

Class TimeoutExtension

java.lang.Object

org.junit.jupiter.engine.extension.TimeoutExtension

All Implemented Interfaces:

BeforeAllCallback, BeforeEachCallback, Extension, InvocationInterceptor

class TimeoutExtension
extends Object
implements BeforeAllCallback, BeforeEachCallback, InvocationInterceptor

Since:

5.5

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface org.junit.jupiter.api.extension.InvocationInterceptor

InvocationInterceptor.Invocation<T>

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	DISABLED_MODE_VALUE
private static final String	DISABLED_ON_DEBUG_MODE_VALUE
private static final String	ENABLED_MODE_VALUE
private static final String	GLOBAL_TIMEOUT_CONFIG_KEY
private static final ExtensionContext.Namespace	NAMESPACE
private static final String	TESTABLE_METHOD_TIMEOUT_KEY

Constructor Summary

Constructors

Constructor	Description
TimeoutExtension()

Method Summary

Modifier and Type	Method	Description
void	beforeAll(ExtensionContext context)	Callback that is invoked once before all tests in the current container.
void	beforeEach(ExtensionContext context)	Callback that is invoked before an individual test and any user-defined setup methods for that test have been executed.
private <T> InvocationInterceptor.Invocation<T>	decorate(InvocationInterceptor.Invocation<T> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext, TimeoutDuration timeout)
private String	describe(ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext)
private TimeoutDuration	getDefaultTimeout(ExtensionContext extensionContext, TimeoutExtension.TimeoutProvider defaultTimeoutProvider)
private ScheduledExecutorService	getExecutor(ExtensionContext extensionContext)
private TimeoutConfiguration	getGlobalTimeoutConfiguration(ExtensionContext extensionContext)
private <T> T	intercept(InvocationInterceptor.Invocation<T> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext, TimeoutDuration explicitTimeout, TimeoutExtension.TimeoutProvider defaultTimeoutProvider)
void	interceptAfterAllMethod(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext)	Intercept the invocation of an @AfterAll method.
void	interceptAfterEachMethod(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext)	Intercept the invocation of an @AfterEach method.
void	interceptBeforeAllMethod(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext)	Intercept the invocation of a @BeforeAll method.
void	interceptBeforeEachMethod(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext)	Intercept the invocation of a @BeforeEach method.
private void	interceptLifecycleMethod(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext, TimeoutExtension.TimeoutProvider defaultTimeoutProvider)
private <T> T	interceptTestableMethod(InvocationInterceptor.Invocation<T> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext, TimeoutExtension.TimeoutProvider defaultTimeoutProvider)
<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.
void	interceptTestMethod(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext)	Intercept the invocation of a @Test method.
void	interceptTestTemplateMethod(InvocationInterceptor.Invocation<Void> invocation, ReflectiveInvocationContext<Method> invocationContext, ExtensionContext extensionContext)	Intercept the invocation of a @TestTemplate method.
private boolean	isTimeoutDisabled(String mode)	Determine if timeouts are disabled for the supplied mode.
private boolean	isTimeoutDisabled(ExtensionContext extensionContext)	Determine if timeouts are disabled for the supplied extension context.
private void	readAndStoreTimeoutSoChildrenInheritIt(ExtensionContext context)
private Optional<TimeoutDuration>	readTimeoutFromAnnotation(Optional<AnnotatedElement> element)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.junit.jupiter.api.extension.InvocationInterceptor

interceptDynamicTest, interceptDynamicTest, interceptTestClassConstructor

Field Details

NAMESPACE

private static final ExtensionContext.Namespace NAMESPACE

TESTABLE_METHOD_TIMEOUT_KEY

private static final String TESTABLE_METHOD_TIMEOUT_KEY

See Also:

• Constant Field Values

GLOBAL_TIMEOUT_CONFIG_KEY

private static final String GLOBAL_TIMEOUT_CONFIG_KEY

See Also:

• Constant Field Values

ENABLED_MODE_VALUE

private static final String ENABLED_MODE_VALUE

See Also:

• Constant Field Values

DISABLED_MODE_VALUE

private static final String DISABLED_MODE_VALUE

See Also:

• Constant Field Values

DISABLED_ON_DEBUG_MODE_VALUE

private static final String DISABLED_ON_DEBUG_MODE_VALUE

See Also:

• Constant Field Values

Constructor Details

TimeoutExtension

TimeoutExtension()

Method Details

beforeAll

public void beforeAll(ExtensionContext context)

Description copied from interface: BeforeAllCallback

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

Specified by:

beforeAll in interface BeforeAllCallback

Parameters:

context - the current extension context; never null

beforeEach

public void beforeEach(ExtensionContext context)

Description copied from interface: BeforeEachCallback

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

Specified by:

beforeEach in interface BeforeEachCallback

Parameters:

context - the current extension context; never null

readAndStoreTimeoutSoChildrenInheritIt

private void readAndStoreTimeoutSoChildrenInheritIt(ExtensionContext context)

interceptBeforeAllMethod

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

Description copied from interface: InvocationInterceptor

Intercept the invocation of a @BeforeAll method.

Specified by:

interceptBeforeAllMethod in interface InvocationInterceptor

Parameters:

invocation - the invocation that is being intercepted; never null

invocationContext - the context of the invocation that is being intercepted; never null

extensionContext - the current extension context; never null

Throws:

Throwable - in case of failures

interceptBeforeEachMethod

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

Description copied from interface: InvocationInterceptor

Intercept the invocation of a @BeforeEach method.

Specified by:

interceptBeforeEachMethod in interface InvocationInterceptor

Parameters:

invocation - the invocation that is being intercepted; never null

invocationContext - the context of the invocation that is being intercepted; never null

extensionContext - the current extension context; never null

Throws:

Throwable - in case of failures

interceptTestMethod

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

Description copied from interface: InvocationInterceptor

Intercept the invocation of a @Test method.

Specified by:

interceptTestMethod in interface InvocationInterceptor

Parameters:

invocation - the invocation that is being intercepted; never null

invocationContext - the context of the invocation that is being intercepted; never null

extensionContext - the current extension context; never null

Throws:

Throwable - in case of failures

interceptTestTemplateMethod

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

Description copied from interface: InvocationInterceptor

Intercept the invocation of a @TestTemplate method.

Specified by:

interceptTestTemplateMethod in interface InvocationInterceptor

Parameters:

invocation - the invocation that is being intercepted; never null

invocationContext - the context of the invocation that is being intercepted; never null

extensionContext - the current extension context; never null

Throws:

Throwable - in case of failures

interceptTestFactoryMethod

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

Description copied from interface: InvocationInterceptor

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

Specified by:

interceptTestFactoryMethod in interface InvocationInterceptor

Type Parameters:

T - the result type

Parameters:

invocation - the invocation that is being intercepted; never null

invocationContext - the context of the invocation that is being intercepted; never null

extensionContext - the current extension context; never null

Returns:

the result of the invocation; potentially null

Throws:

Throwable - in case of failures

interceptAfterEachMethod

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

Description copied from interface: InvocationInterceptor

Intercept the invocation of an @AfterEach method.

Specified by:

interceptAfterEachMethod in interface InvocationInterceptor

Parameters:

invocation - the invocation that is being intercepted; never null

invocationContext - the context of the invocation that is being intercepted; never null

extensionContext - the current extension context; never null

Throws:

Throwable - in case of failures

interceptAfterAllMethod

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

Description copied from interface: InvocationInterceptor

Intercept the invocation of an @AfterAll method.

Specified by:

interceptAfterAllMethod in interface InvocationInterceptor

Parameters:

invocation - the invocation that is being intercepted; never null

invocationContext - the context of the invocation that is being intercepted; never null

extensionContext - the current extension context; never null

Throws:

Throwable - in case of failures

interceptLifecycleMethod

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

Throws:

Throwable

readTimeoutFromAnnotation

private Optional<TimeoutDuration> readTimeoutFromAnnotation(Optional<AnnotatedElement> element)

interceptTestableMethod

private <T> T interceptTestableMethod(InvocationInterceptor.Invocation<T> invocation,
 ReflectiveInvocationContext<Method> invocationContext,
 ExtensionContext extensionContext,
 TimeoutExtension.TimeoutProvider defaultTimeoutProvider)
                               throws Throwable

Throws:

Throwable

intercept

private <T> T intercept(InvocationInterceptor.Invocation<T> invocation,
 ReflectiveInvocationContext<Method> invocationContext,
 ExtensionContext extensionContext,
 TimeoutDuration explicitTimeout,
 TimeoutExtension.TimeoutProvider defaultTimeoutProvider)
                 throws Throwable

Throws:

Throwable

getDefaultTimeout

private TimeoutDuration getDefaultTimeout(ExtensionContext extensionContext,
 TimeoutExtension.TimeoutProvider defaultTimeoutProvider)

getGlobalTimeoutConfiguration

private TimeoutConfiguration getGlobalTimeoutConfiguration(ExtensionContext extensionContext)

decorate

private <T> InvocationInterceptor.Invocation<T> decorate(InvocationInterceptor.Invocation<T> invocation,
 ReflectiveInvocationContext<Method> invocationContext,
 ExtensionContext extensionContext,
 TimeoutDuration timeout)

describe

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

getExecutor

private ScheduledExecutorService getExecutor(ExtensionContext extensionContext)

isTimeoutDisabled

private boolean isTimeoutDisabled(ExtensionContext extensionContext)

Determine if timeouts are disabled for the supplied extension context.

isTimeoutDisabled

private boolean isTimeoutDisabled(String mode)

Determine if timeouts are disabled for the supplied mode.