@Target(value={TYPE,METHOD}) @Retention(value=RUNTIME) @Documented @Inherited @API(status=EXPERIMENTAL, since="5.5") public @interface Timeout
@Timeout
is used to define a timeout for a method or all testable
methods within one class and its @Nested
classes.
This annotation may also be used on lifecycle methods annotated with
@BeforeAll
, @BeforeEach
,
@AfterEach
, or @AfterAll
.
Applying this annotation to a test class has the same effect as applying
it to all testable methods, i.e. all methods annotated or meta-annotated with
@Test
, @TestFactory
, or
@TestTemplate
, but not to its lifecycle methods.
If this annotation is not present, no timeout will be used unless a default timeout is defined via one of the following configuration parameters:
junit.jupiter.execution.timeout.default
junit.jupiter.execution.timeout.testable.method.default
junit.jupiter.execution.timeout.test.method.default
@Test
methodsjunit.jupiter.execution.timeout.testtemplate.method.default
@TestTemplate
methodsjunit.jupiter.execution.timeout.testfactory.method.default
@TestFactory
methodsjunit.jupiter.execution.timeout.lifecycle.method.default
junit.jupiter.execution.timeout.beforeall.method.default
@BeforeAll
methodsjunit.jupiter.execution.timeout.beforeeach.method.default
@BeforeEach
methodsjunit.jupiter.execution.timeout.aftereach.method.default
@AfterEach
methodsjunit.jupiter.execution.timeout.afterall.method.default
@AfterAll
methodsMore specific configuration parameters override less specific ones. For
example, junit.jupiter.execution.timeout.test.method.default
overrides junit.jupiter.execution.timeout.testable.method.default
which overrides junit.jupiter.execution.timeout.default
.
Values must be in the following, case-insensitive format:
<number> [ns|μs|ms|s|m|h|d]
. The space between the number and the
unit may be omitted. Specifying no unit is equivalent to using seconds.
Value | Equivalent annotation |
---|---|
42 | @Timeout(42) |
42 ns | @Timeout(value = 42, unit = NANOSECONDS) |
42 μs | @Timeout(value = 42, unit = MICROSECONDS) |
42 ms | @Timeout(value = 42, unit = MILLISECONDS) |
42 s | @Timeout(value = 42, unit = SECONDS) |
42 m | @Timeout(value = 42, unit = MINUTES) |
42 h | @Timeout(value = 42, unit = HOURS) |
42 d | @Timeout(value = 42, unit = DAYS) |
Copyright © 2020. All rights reserved.