Annotation Type DisabledIf
@Target({TYPE,METHOD}) @Retention(RUNTIME) @Documented @ExtendWith(DisabledIfCondition.class) public @interface DisabledIf
@DisabledIf
is used to signal that the annotated test class or test method is disabled and should not be executed if the suppliedexpression()
evaluates totrue
.When applied at the class level, all test methods within that class are automatically disabled as well.
For basic examples, see the Javadoc for
expression()
.This annotation may be used as a meta-annotation to create custom composed annotations. For example, a custom
@DisabledOnMac
annotation can be created as follows.@Target({ElementType.TYPE, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @DisabledIf( expression = "#{systemProperties['os.name'].toLowerCase().contains('mac')}", reason = "Disabled on Mac OS" ) public @interface DisabledOnMac {}
- Since:
- 5.0
- Author:
- Sam Brannen, Tadaya Tsuyukubo
- See Also:
SpringExtension
,EnabledIf
,Disabled
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description String
expression
The expression that will be evaluated to determine if the annotated test class or test method is disabled.boolean
loadContext
Whether theApplicationContext
associated with the current test should be eagerly loaded in order to evaluate theexpression()
.String
reason
The reason this test is disabled.String
value
Element Detail
value
@AliasFor("expression") String value
- See Also:
expression()
- Default:
- ""
expression
@AliasFor("value") String expression
The expression that will be evaluated to determine if the annotated test class or test method is disabled.If the expression evaluates to
Boolean.TRUE
or aString
equal to"true"
(ignoring case), the test will be disabled.Expressions can be any of the following.
- Spring Expression Language (SpEL) expression — for example:
@DisabledIf("#{systemProperties['os.name'].toLowerCase().contains('mac')}")
- Placeholder for a property available in the Spring
Environment
— for example:@DisabledIf("${smoke.tests.disabled}")
- Text literal — for example:
@DisabledIf("true")
Note, however, that a text literal which is not the result of dynamic resolution of a property placeholder is of zero practical value since
@DisabledIf("true")
is equivalent to@Disabled
and@DisabledIf("false")
is logically meaningless.- See Also:
reason()
,loadContext()
,value()
- Default:
- ""
- Spring Expression Language (SpEL) expression — for example:
reason
String reason
The reason this test is disabled.- See Also:
expression()
- Default:
- ""
loadContext
boolean loadContext
Whether theApplicationContext
associated with the current test should be eagerly loaded in order to evaluate theexpression()
.Defaults to
false
so that test application contexts are not eagerly loaded unnecessarily. If an expression is based solely on system properties or environment variables or does not interact with beans in the test's application context, there is no need to load the context prematurely since doing so would be a waste of time if the test ends up being disabled.- See Also:
expression()
- Default:
- false