Module org.junit.jupiter.api
Package org.junit.jupiter.api.condition

Annotation Interface EnabledOnOs

@Target({TYPE,METHOD}) @Retention(RUNTIME) @Documented @ExtendWith(org.junit.jupiter.api.condition.EnabledOnOsCondition.class) @API(status=STABLE, since="5.1") public @interface EnabledOnOs
@EnabledOnOs is used to signal that the annotated test class or test method is only enabled on one or more specified operating systems.

When applied at the class level, all test methods within that class will be enabled on the same specified operating systems.

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 @BeforeEach methods, @AfterEach methods, and corresponding extension APIs.

This annotation may be used as a meta-annotation in order to create a custom composed annotation that inherits the semantics of this annotation.

Warning

As of JUnit Jupiter 5.1, this annotation can only be declared once on an AnnotatedElement (i.e., test interface, test class, or test method). If this annotation is directly present, indirectly present, or meta-present multiple times on a given element, only the first such annotation discovered by JUnit will be used; any additional declarations will be silently ignored. Note, however, that this annotation may be used in conjunction with other @Enabled* or @Disabled* annotations in this package.

Since:
5.1
See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    OS[]
    value
    Operating systems on which the annotated class or method should be enabled.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    disabledReason
    Custom reason to provide if the test or container is disabled.

  • Element Details

    • value

      OS[] value
      Operating systems on which the annotated class or method should be enabled.
      See Also:

    • disabledReason

      @API(status=STABLE, since="5.7") String disabledReason
      Custom 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.

      Since:
      5.7
      Default:
      ""