spring-framework / org.springframework.test.context.junit.jupiter / EnabledIf

EnabledIf

@Target([AnnotationTarget.CLASS, AnnotationTarget.FILE, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER]) @ExtendWith(EnabledIfCondition) class EnabledIf

@EnabledIf is used to signal that the annotated test class or test method is enabled and should be executed if the supplied #expression evaluates to true.

When applied at the class level, all test methods within that class are automatically enabled by default 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 @EnabledOnMac annotation can be created as follows.

 @Target({ ElementType.TYPE, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) @EnabledIf( expression = "#{systemProperties['os.name'].toLowerCase().contains('mac')}", reason = "Enabled on Mac OS" ) public @interface EnabledOnMac {}

Author
Sam Brannen

Since
5.0

See Also
SpringExtensionDisabledIforg.junit.jupiter.api.Disabled

Constructors

<init>

EnabledIf(value: String, expression: String, reason: String, loadContext: Boolean)

@EnabledIf is used to signal that the annotated test class or test method is enabled and should be executed if the supplied #expression evaluates to true.

When applied at the class level, all test methods within that class are automatically enabled by default 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 @EnabledOnMac annotation can be created as follows.

 @Target({ ElementType.TYPE, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) @EnabledIf( expression = "#{systemProperties['os.name'].toLowerCase().contains('mac')}", reason = "Enabled on Mac OS" ) public @interface EnabledOnMac {}

Properties

expression	`val expression: String` The expression that will be evaluated to determine if the annotated test class or test method is enabled. If the expression evaluates to `Boolean#TRUE` or a String equal to `"true"` (ignoring case), the test will be enabled. Expressions can be any of the following. Spring Expression Language (SpEL) expression — for example: `@EnabledIf("#{systemProperties['os.name'].toLowerCase().contains('mac')}")` Placeholder for a property available in the Spring org.springframework.core.env.Environment — for example: `@EnabledIf("${smoke.tests.enabled}")` Text literal — for example: `@EnabledIf("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 `@EnabledIf("false")` is equivalent to `@Disabled` and `@EnabledIf("true")` is logically meaningless.
loadContext	`val loadContext: Boolean` Whether the `ApplicationContext` associated with the current test should be eagerly loaded in order to evaluate the `#expression`. 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.
reason	`val reason: String` The reason this test is enabled.
value	`val value: String` Alias for `#expression`; only intended to be used if `#reason` and `#loadContext` are not specified.