Annotation Interface DisabledIfEnvironmentVariable
@DisabledIfEnvironmentVariableis used to signal that the annotated test class or test method is disabled if the value of the specified environment variable matches the specified regular expression.
When declared at the class level, the result will apply to all test methods within that class as well.
If a test method is disabled via this annotation, that does not prevent
the test class from being instantiated. Rather, it prevents the execution of
the test method and method-level lifecycle callbacks such as
@AfterEach 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 SummaryModifier and TypeOptional ElementDescriptionReason to provide if the test of container ends up being disabled.
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
disabledReasonString disabledReasonReason to provide if the test of container ends up being disabled.