org.junitpioneer.jupiter

Annotation Type ReportEntry

@Repeatable(value=ReportEntry.ReportEntries.class)
 @Target(value=METHOD)
 @Retention(value=RUNTIME)
 @ExtendWith(value=org.junitpioneer.jupiter.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.

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

Since:

0.5.6

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.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 and Description
java.lang.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 Detail

value

public abstract java.lang.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

key

public abstract java.lang.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"

when

public abstract ReportEntry.PublishCondition when

Specifies when the extension should publish the report entry. Defaults to ALWAYS.

See Also:

ReportEntry.PublishCondition

Default:

org.junitpioneer.jupiter.ReportEntry.PublishCondition.ALWAYS