Annotation Type ReportEntry

@Repeatable(ReportEntry.ReportEntries.class) @Target({METHOD,ANNOTATION_TYPE}) @Retention(RUNTIME) @ExtendWith(ReportEntryExtension.class) public @interface ReportEntry
Publish the specified key-value pair to be consumed by an org.junit.platform.engine.EngineExecutionListener in order to supply additional information to the reporting infrastructure. This is functionally identical to calling ExtensionContext::publishReportEntry from within the test method.

ReportEntry is repeatable and can be used on methods.

This extension does not interact with parallel test execution.

For more details and examples, see the documentation on report entries.

Since:
0.5.6

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    ReportEntry.PublishCondition
    The available values you can choose from to define for which test outcomes the extension should publish the report entry.
    static @interface 
    ReportEntry.ReportEntries
    Containing annotation of repeatable ReportEntry.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    Specifies the value of the pair that's to be published as a report entry.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    key
    Specifies the key of the pair that's to be published as a report entry.
    ReportEntry.PublishCondition
    when
    Specifies when the extension should publish the report entry.

  • Element Details

    • key

      String key
      Specifies the key of the pair that's to be published as a report entry. Defaults to "value" and can't be blank.
      See Also:
      • ExtensionContext::publishReportEntry
      Default:
      "value"

    • value

      String value
      Specifies the value of the pair that's to be published as a report entry. Can't be blank.
      See Also:
      • ExtensionContext::publishReportEntry

    • when

      ReportEntry.PublishCondition when
      Specifies when the extension should publish the report entry. Defaults to ALWAYS.
      See Also:
      Default:
      ALWAYS