JUnit 6.0.1 · org.junit.platform.testkit.engine.Events

Modifier and Type	Field and Description
private final String	category
private final List<Event>	events

Access	Constructor and Description
pack-priv	Events(Stream<Event> events, String category)
pack-priv	Events(List<Event> events, String category)

Method Summary

Modifier and Type	Method and Description
public Events	Returns: the filtered `Events`; never `null` aborted() Get the aborted `Events` contained in this `Events` object.
public final void	assertEventsMatchExactly(Condition<? super Event>... the conditions to match against; never `null` conditions) Assert that all events contained in this `Events` object exactly match the provided conditions.
private static void	assertEventsMatchExactly(List<Event> events, Condition<? super Event>... conditions)
public final void	assertEventsMatchLoosely(Condition<? super Event>... the conditions to match against; never `null` conditions) Assert that all provided conditions are matched by an event contained in this `Events` object, regardless of order.
private static void	assertEventsMatchLoosely(List<Event> events, Condition<? super Event>... conditions)
public final void	assertEventsMatchLooselyInOrder(Condition<? super Event>... the conditions to match against; never `null` conditions) Assert that all provided conditions are matched by an event contained in this `Events` object.
private static void	assertEventsMatchLooselyInOrder(List<Event> events, Condition<? super Event>... conditions)
public Events	Returns: this `Events` object for method chaining; never `null` assertStatistics(Consumer<EventStatistics> a `Consumer` of `EventStatistics`; never `null` statisticsConsumer) Assert statistics for the events contained in this `Events` object.
public ListAssert<Event>	Returns: an instance of `ListAssert` for events; never `null` assertThatEvents() Shortcut for `org.assertj.core.api.Assertions.assertThat(events.list())`.
private static void	checkCondition(List<Event> events, SoftAssertions softly, Condition<? super Event> condition)
public long	count() Get the number of events contained in this `Events` object.
public Events	Returns: this `Events` object for method chaining; never `null` debug() Print all events to `System#out`.
public Events	Returns: this `Events` object for method chaining; never `null` debug(OutputStream the `OutputStream` to print to; never `null` out) Print all events to the supplied `OutputStream`.
public Events	Returns: this `Events` object for method chaining; never `null` debug(Writer the `Writer` to print to; never `null` writer) Print all events to the supplied `Writer`.
private Events	debug(PrintWriter printWriter)
public Events	Returns: the filtered `Events`; never `null` dynamicallyRegistered() Get the dynamic registration `Events` contained in this `Events` object.
private Stream<Event>	eventsByType(EventType type)
public Executions	Returns: an instance of `Executions` for the current set of events; never `null` executions() Get the `Executions` for the current set of events.
public Events	Returns: the filtered `Events`; never `null` failed() Get the failed `Events` contained in this `Events` object.
public Events	Returns: the filtered `Events`; never `null` fileEntryPublished() Get the file entry publication `Events` contained in this `Events` object.
public Stream<Event>	Returns: the filtered stream of events; never `null` filter(Predicate<? super Event> a `Predicate` to apply to each event to decide if it should be included in the filtered stream; never `null` predicate) Shortcut for `events.stream().filter(predicate)`.
private static @Nullable Event	findEvent(List<Event> events, SoftAssertions softly, Condition<? super Event> condition)
public Events	Returns: the filtered `Events`; never `null` finished() Get the finished `Events` contained in this `Events` object.
private Stream<Event>	finishedEventsByStatus(TestExecutionResult.Status status)
pack-priv String	getCategory()
private static boolean	isNotInIncreasingOrder(List<Integer> indices)
public List<Event>	Returns: the list of events; never `null` list() Get the events as a `List`.
public <R> Stream<R>	Returns: the mapped stream of events; never `null` map(Function<? super Event, ? extends R> a `Function` to apply to each event; never `null` mapper) Shortcut for `events.stream().map(mapper)`.
public Events	Returns: the filtered `Events`; never `null` reportingEntryPublished() Get the reporting entry publication `Events` contained in this `Events` object.
public Events	Returns: the filtered `Events`; never `null` skipped() Get the skipped `Events` contained in this `Events` object.
public Events	Returns: the filtered `Events`; never `null` started() Get the started `Events` contained in this `Events` object.
public Stream<Event>	Returns: the stream of events; never `null` stream() Get the events as a `Stream`.
public Events	Returns: the filtered `Events`; never `null` succeeded() Get the succeeded `Events` contained in this `Events` object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

category	back to summary
private final String category

events	back to summary
private final List<Event> events

Events	back to summary
pack-priv Events(Stream<Event> events, String category)

Events	back to summary
pack-priv Events(List<Event> events, String category)

Method Detail

aborted back to summary

aborted	back to summary
public Events aborted() Get the aborted `Events` contained in this `Events` object. Returns:Events the filtered `Events`; never `null`

public Events aborted()

Get the aborted Events contained in this Events object.

Returns:Events: the filtered Events; never null

assertEventsMatchExactly back to summary

assertEventsMatchExactly	back to summary
public final void assertEventsMatchExactly(Condition<? super Event>... conditions) Assert that all events contained in this `Events` object exactly match the provided conditions. Conditions can be imported statically from `EventConditions` and `TestExecutionResultConditions`. Example executionResults.testEvents().assertEventsMatchExactly( event(test("exampleTestMethod"), started()), event(test("exampleTestMethod"), finishedSuccessfully()) ); Parameters conditions:Condition<? super Event>[] the conditions to match against; never `null` Annotations @SafeVarargs See Also `assertEventsMatchLoosely(Condition...)`, `assertEventsMatchLooselyInOrder(Condition...)`, `EventConditions`, `TestExecutionResultConditions`

public final void assertEventsMatchExactly(Condition<? super Event>... conditions)

Assert that all events contained in this Events object exactly match the provided conditions.

Conditions can be imported statically from EventConditions and TestExecutionResultConditions.

Example

executionResults.testEvents().assertEventsMatchExactly(
    event(test("exampleTestMethod"), started()),
    event(test("exampleTestMethod"), finishedSuccessfully())
);

Parameters

conditions:Condition<? super Event>[]: the conditions to match against; never null

Annotations

@SafeVarargs

assertEventsMatchExactly	back to summary
private static void assertEventsMatchExactly(List<Event> events, Condition<? super Event>... conditions) Annotations @SafeVarargs

assertEventsMatchLoosely back to summary

assertEventsMatchLoosely	back to summary
public final void assertEventsMatchLoosely(Condition<? super Event>... conditions) Assert that all provided conditions are matched by an event contained in this `Events` object, regardless of order. Note that this method performs a partial match. Thus, some events may not match any of the provided conditions. Conditions can be imported statically from `EventConditions` and `TestExecutionResultConditions`. Example executionResults.testEvents().assertEventsMatchLoosely( event(test("exampleTestMethod"), started()), event(test("exampleTestMethod"), finishedSuccessfully()) ); Parameters conditions:Condition<? super Event>[] the conditions to match against; never `null` Annotations @SafeVarargs @SuppressWarnings:varargs Since 1.7 See Also `assertEventsMatchExactly(Condition...)`, `assertEventsMatchLooselyInOrder(Condition...)`, `EventConditions`, `TestExecutionResultConditions`

public final void assertEventsMatchLoosely(Condition<? super Event>... conditions)

Assert that all provided conditions are matched by an event contained in this Events object, regardless of order.

Note that this method performs a partial match. Thus, some events may not match any of the provided conditions.

Conditions can be imported statically from EventConditions and TestExecutionResultConditions.

Example

executionResults.testEvents().assertEventsMatchLoosely(
    event(test("exampleTestMethod"), started()),
    event(test("exampleTestMethod"), finishedSuccessfully())
);

Parameters

conditions:Condition<? super Event>[]: the conditions to match against; never null

Annotations

@SafeVarargs
@SuppressWarnings:varargs

Since

1.7

assertEventsMatchLoosely	back to summary
private static void assertEventsMatchLoosely(List<Event> events, Condition<? super Event>... conditions) Annotations @SafeVarargs

assertEventsMatchLooselyInOrder back to summary

assertEventsMatchLooselyInOrder	back to summary
public final void assertEventsMatchLooselyInOrder(Condition<? super Event>... conditions) Assert that all provided conditions are matched by an event contained in this `Events` object. Note that this method performs a partial match. Thus, some events may not match any of the provided conditions; however, the conditions provided must be in the correct order. Conditions can be imported statically from `EventConditions` and `TestExecutionResultConditions`. Example executionResults.testEvents().assertEventsMatchLooselyInOrder( event(test("exampleTestMethod"), started()), event(test("exampleTestMethod"), finishedSuccessfully()) ); Parameters conditions:Condition<? super Event>[] the conditions to match against; never `null` Annotations @SafeVarargs @SuppressWarnings:varargs Since 1.7 See Also `assertEventsMatchExactly(Condition...)`, `assertEventsMatchLoosely(Condition...)`, `EventConditions`, `TestExecutionResultConditions`

public final void assertEventsMatchLooselyInOrder(Condition<? super Event>... conditions)

Assert that all provided conditions are matched by an event contained in this Events object.

Note that this method performs a partial match. Thus, some events may not match any of the provided conditions; however, the conditions provided must be in the correct order.

Conditions can be imported statically from EventConditions and TestExecutionResultConditions.

Example

executionResults.testEvents().assertEventsMatchLooselyInOrder(
    event(test("exampleTestMethod"), started()),
    event(test("exampleTestMethod"), finishedSuccessfully())
);

Parameters

conditions:Condition<? super Event>[]: the conditions to match against; never null

Annotations

@SafeVarargs
@SuppressWarnings:varargs

Since

1.7

assertEventsMatchLooselyInOrder	back to summary
private static void assertEventsMatchLooselyInOrder(List<Event> events, Condition<? super Event>... conditions) Annotations @SafeVarargs @SuppressWarnings:varargs

assertStatistics back to summary

assertStatistics	back to summary
public Events assertStatistics(Consumer<EventStatistics> statisticsConsumer) Assert statistics for the events contained in this `Events` object. Example `events.assertStatistics(stats -> stats.started(1).succeeded(1).failed(0));` Parameters statisticsConsumer:Consumer<EventStatistics> a `Consumer` of `EventStatistics`; never `null` Returns:Events this `Events` object for method chaining; never `null`

public Events assertStatistics(Consumer<EventStatistics> statisticsConsumer)

Assert statistics for the events contained in this Events object.

Example

events.assertStatistics(stats -> stats.started(1).succeeded(1).failed(0));

Parameters

statisticsConsumer:Consumer<EventStatistics>: a Consumer of EventStatistics; never null

Returns:Events

this Events object for method chaining; never null

assertThatEvents back to summary

assertThatEvents	back to summary
public ListAssert<Event> assertThatEvents() Shortcut for `org.assertj.core.api.Assertions.assertThat(events.list())`. Returns:ListAssert<Event> an instance of `ListAssert` for events; never `null` See Also `org.assertj.core.api.Assertions#assertThat(List)`, `org.assertj.core.api.ListAssert`

public ListAssert<Event> assertThatEvents()

Shortcut for org.assertj.core.api.Assertions.assertThat(events.list()).

Returns:ListAssert<Event>: an instance of ListAssert for events; never null
See Also: org.assertj.core.api.Assertions#assertThat(List), org.assertj.core.api.ListAssert

checkCondition	back to summary
private static void checkCondition(List<Event> events, SoftAssertions softly, Condition<? super Event> condition)

count	back to summary
public long count() Get the number of events contained in this `Events` object.

debug back to summary

debug	back to summary
public Events debug() Print all events to `System#out`. Returns:Events this `Events` object for method chaining; never `null`

public Events debug()

Print all events to System#out.

Returns:Events: this Events object for method chaining; never null

debug back to summary

debug	back to summary
public Events debug(OutputStream out) Print all events to the supplied `OutputStream`. Parameters out:OutputStream the `OutputStream` to print to; never `null` Returns:Events this `Events` object for method chaining; never `null` Annotations @SuppressWarnings:DefaultCharset

public Events debug(OutputStream out)

Print all events to the supplied OutputStream.

Parameters

out:OutputStream: the OutputStream to print to; never null

Returns:Events

this Events object for method chaining; never null

Annotations

@SuppressWarnings:DefaultCharset

debug back to summary

debug	back to summary
public Events debug(Writer writer) Print all events to the supplied `Writer`. Parameters writer:Writer the `Writer` to print to; never `null` Returns:Events this `Events` object for method chaining; never `null`

public Events debug(Writer writer)

Print all events to the supplied Writer.

Parameters

writer:Writer: the Writer to print to; never null

Returns:Events

this Events object for method chaining; never null

debug	back to summary
private Events debug(PrintWriter printWriter)

dynamicallyRegistered back to summary

dynamicallyRegistered	back to summary
public Events dynamicallyRegistered() Get the dynamic registration `Events` contained in this `Events` object. Returns:Events the filtered `Events`; never `null`

public Events dynamicallyRegistered()

Get the dynamic registration Events contained in this Events object.

Returns:Events: the filtered Events; never null

eventsByType	back to summary
private Stream<Event> eventsByType(EventType type)

executions back to summary

executions	back to summary
public Executions executions() Get the `Executions` for the current set of events. Returns:Executions an instance of `Executions` for the current set of events; never `null`

public Executions executions()

Get the Executions for the current set of events.

Returns:Executions: an instance of Executions for the current set of events; never null

failed back to summary

failed	back to summary
public Events failed() Get the failed `Events` contained in this `Events` object. Returns:Events the filtered `Events`; never `null`

public Events failed()

Get the failed Events contained in this Events object.

Returns:Events: the filtered Events; never null

fileEntryPublished back to summary

fileEntryPublished	back to summary
public Events fileEntryPublished() Get the file entry publication `Events` contained in this `Events` object. Returns:Events the filtered `Events`; never `null` Annotations @API status:MAINTAINED since:1.13.3 Since 1.12

public Events fileEntryPublished()

Get the file entry publication Events contained in this Events object.

Returns:Events

the filtered Events; never null

Annotations

@API
status:MAINTAINED
since:1.13.3

Since

1.12

filter back to summary

filter	back to summary
public Stream<Event> filter(Predicate<? super Event> predicate) Shortcut for `events.stream().filter(predicate)`. Parameters predicate:Predicate<? super Event> a `Predicate` to apply to each event to decide if it should be included in the filtered stream; never `null` Returns:Stream<Event> the filtered stream of events; never `null` See Also `stream()`, `Stream#filter(Predicate)`

public Stream<Event> filter(Predicate<? super Event> predicate)

Shortcut for events.stream().filter(predicate).

Parameters

predicate:Predicate<? super Event>: a Predicate to apply to each event to decide if it should be included in the filtered stream; never null

Returns:Stream<Event>

the filtered stream of events; never null

See Also

stream(), Stream#filter(Predicate)

findEvent	back to summary
private static @Nullable Event findEvent(List<Event> events, SoftAssertions softly, Condition<? super Event> condition)

finished back to summary

finished	back to summary
public Events finished() Get the finished `Events` contained in this `Events` object. Returns:Events the filtered `Events`; never `null`

public Events finished()

Get the finished Events contained in this Events object.

Returns:Events: the filtered Events; never null

finishedEventsByStatus	back to summary
private Stream<Event> finishedEventsByStatus(TestExecutionResult.Status status)

getCategory	back to summary
pack-priv String getCategory()

isNotInIncreasingOrder	back to summary
private static boolean isNotInIncreasingOrder(List<Integer> indices)

list back to summary

list	back to summary
public List<Event> list() Get the events as a `List`. Returns:List<Event> the list of events; never `null` See Also `stream()`

public List<Event> list()

Get the events as a List.

Returns:List<Event>: the list of events; never null
See Also: stream()

map back to summary

map	back to summary
public <R> Stream<R> map(Function<? super Event, ? extends R> mapper) Shortcut for `events.stream().map(mapper)`. Parameters mapper:Function<? super Event, ? extends R> a `Function` to apply to each event; never `null` Returns:Stream<R> the mapped stream of events; never `null` See Also `stream()`, `Stream#map(Function)`

public <R> Stream<R> map(Function<? super Event, ? extends R> mapper)

Shortcut for events.stream().map(mapper).

Parameters

mapper:Function<? super Event, ? extends R>: a Function to apply to each event; never null

Returns:Stream<R>

the mapped stream of events; never null

See Also

stream(), Stream#map(Function)

reportingEntryPublished back to summary

reportingEntryPublished	back to summary
public Events reportingEntryPublished() Get the reporting entry publication `Events` contained in this `Events` object. Returns:Events the filtered `Events`; never `null`

public Events reportingEntryPublished()

Get the reporting entry publication Events contained in this Events object.

Returns:Events: the filtered Events; never null

skipped back to summary

skipped	back to summary
public Events skipped() Get the skipped `Events` contained in this `Events` object. Returns:Events the filtered `Events`; never `null`

public Events skipped()

Get the skipped Events contained in this Events object.

Returns:Events: the filtered Events; never null

started back to summary

started	back to summary
public Events started() Get the started `Events` contained in this `Events` object. Returns:Events the filtered `Events`; never `null`

public Events started()

Get the started Events contained in this Events object.

Returns:Events: the filtered Events; never null

stream back to summary

stream	back to summary
public Stream<Event> stream() Get the events as a `Stream`. Returns:Stream<Event> the stream of events; never `null` See Also `list()`

public Stream<Event> stream()

Get the events as a Stream.

Returns:Stream<Event>: the stream of events; never null
See Also: list()

succeeded back to summary

succeeded	back to summary
public Events succeeded() Get the succeeded `Events` contained in this `Events` object. Returns:Events the filtered `Events`; never `null`

public Events succeeded()

Get the succeeded Events contained in this Events object.

Returns:Events: the filtered Events; never null

public final Class Events

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Example

Example

Example

Example