org.springframework.test.context.junit.jupiter

Annotation Type EnabledIf



  • @Target(value={TYPE,METHOD})
     @Retention(value=RUNTIME)
     @Documented
     @ExtendWith(value=EnabledIfCondition.class)
    public @interface 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 {}
     
    Since:
    5.0
    Author:
    Sam Brannen
    See Also:
    SpringExtension, DisabledIf, Disabled
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element and Description
      java.lang.String expression
      The expression that will be evaluated to determine if the annotated test class or test method is enabled.
      boolean loadContext
      Whether the ApplicationContext associated with the current test should be eagerly loaded in order to evaluate the expression().
      java.lang.String reason
      The reason this test is enabled.
      java.lang.String value
      Alias for expression(); only intended to be used if reason() and loadContext() are not specified.
      • expression

        @AliasFor(value="value")
        public abstract java.lang.String expression
        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 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.

        See Also:
        reason(), loadContext(), value()
        Default:
        ""
      • reason

        public abstract java.lang.String reason
        The reason this test is enabled.
        See Also:
        expression()
        Default:
        ""
      • loadContext

        public abstract boolean loadContext
        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.

        See Also:
        expression()
        Default:
        false