Annotation Interface DisabledIfEnvironmentVariable
@DisabledIfEnvironmentVariable is used to signal that the annotated test
class or test method is disabled if the value of the specified
environment variable matches the specified
When declared at the class level, the result will apply to all test methods within that class as well.
This annotation is not
Consequently, if you wish to apply the same semantics to a subclass, this
annotation must be redeclared on the subclass.
If a test method is disabled via this annotation, that prevents execution
of the test method and method-level lifecycle callbacks such as
@AfterEach methods, and corresponding
extension APIs. However, that does not prevent the test class from being
instantiated, and it does not prevent the execution of class-level lifecycle
callbacks such as
@AfterAll methods, and
corresponding extension APIs.
If the specified environment variable is undefined, the presence of this annotation will have no effect on whether or not the class or method is disabled.
This annotation may be used as a meta-annotation in order to create a custom composed annotation that inherits the semantics of this annotation.
As of JUnit Jupiter 5.6, this annotation is a repeatable annotation. Consequently, this annotation may be declared multiple
times on an
test interface, test class, or test method). Specifically, this annotation will
be found if it is directly present, indirectly present, or meta-present on a
Required Element Summary
Optional Element Summary
namedString namedThe name of the environment variable to retrieve.
- the environment variable name; never blank
- See Also:
matchesString matchesA regular expression that will be used to match against the retrieved value of the
disabledReasonCustom reason to provide if the test or container is disabled.
If a custom reason is supplied, it will be combined with the default reason for this annotation. If a custom reason is not supplied, the default reason will be used.