Module org.junit.platform.testkit

Package org.junit.platform.testkit.engine

Class EventConditions

java.lang.Object

org.junit.platform.testkit.engine.EventConditions

@API(status=MAINTAINED,
     since="1.7")
public final class EventConditions
extends Object

Collection of AssertJ conditions for Event.

Since:

1.4

See Also:

• TestExecutionResultConditions

Method Summary

Modifier and Type	Method	Description
static Condition<Event>	abortedWithReason(Condition<Throwable>... conditions)	Create a new Condition that matches if and only if an Event's type is EventType.FINISHED and its result has a status of ABORTED as well as a cause that matches all of the supplied conditions.
static Condition<Event>	container()	Create a new Condition that matches if and only if an Event's test descriptor is a container.
static Condition<Event>	container(Class<?> clazz)	Create a new Condition that matches if and only if an Event's test descriptor is a container and its unique id contains the fully qualified name of the supplied Class.
static Condition<Event>	container(String uniqueIdSubstring)	Create a new Condition that matches if and only if an Event's test descriptor is a container and its unique id contains the supplied String.
static Condition<Event>	container(Condition<Event> condition)	Create a new Condition that matches if and only if an Event matches the supplied Condition and its test descriptor is a container.
static Condition<Event>	displayName(String displayName)	Create a new Condition that matches if and only if the display name of an Event's test descriptor is equal to the supplied String.
static Condition<Event>	dynamicTestRegistered(String uniqueIdSubstring)	Create a new Condition that matches if and only if an Event's type is EventType.DYNAMIC_TEST_REGISTERED and its unique id contains the supplied String.
static Condition<Event>	dynamicTestRegistered(Condition<Event> condition)	Create a new Condition that matches if and only if an Event's type is EventType.DYNAMIC_TEST_REGISTERED and it matches the supplied Condition.
static Condition<Event>	engine()	Create a new Condition that matches if and only if an Event's test descriptor is an instance of EngineDescriptor.
static Condition<Event>	event(Condition<? super Event>... conditions)	Create a new Condition that matches if and only if an Event matches all of the supplied conditions.
static Condition<Event>	fileEntry(Predicate<FileEntry> predicate)	Create a new Condition that matches if and only if an Event's payload is an instance of FileEntry that contains a file that matches the supplied Predicate.
static Condition<Event>	finished(Condition<TestExecutionResult> resultCondition)	Create a new Condition that matches if and only if an Event's type is EventType.FINISHED and its payload is an instance of TestExecutionResult that matches the supplied Condition.
static Condition<Event>	finishedSuccessfully()	Create a new Condition that matches if and only if an Event's type is EventType.FINISHED and its result has a status of SUCCESSFUL.
static Condition<Event>	finishedWithFailure()	Create a new Condition that matches if and only if an Event's type is EventType.FINISHED and its result has a status of FAILED.
static Condition<Event>	finishedWithFailure(Condition<Throwable>... conditions)	Create a new Condition that matches if and only if an Event's type is EventType.FINISHED and its result has a status of FAILED as well as a cause that matches all of the supplied Conditions.
static Condition<Event>	legacyReportingName(String legacyReportingName)	Create a new Condition that matches if and only if the TestDescriptor.getLegacyReportingName() () legacy reporting name} of an Event's test descriptor is equal to the supplied String.
static Condition<Event>	nestedContainer(Class<?> clazz)	Create a new Condition that matches if and only if an Event's test descriptor is a container and its unique id contains the simple names of the supplied Class and all of its enclosing classes.
static Condition<Event>	nestedContainer(Class<?> clazz, Condition<Event> condition)	Create a new Condition that matches if and only if an Event matches the supplied Condition, its test descriptor is a container, and its unique id contains the simple names of the supplied Class and all of its enclosing classes.
static Condition<Event>	reason(String expectedReason)	Create a new Condition that matches if and only if an Event's payload is an instance of String that is equal to the supplied value.
static Condition<Event>	reason(Predicate<String> predicate)	Create a new Condition that matches if and only if an Event's payload is an instance of String that matches the supplied Predicate.
static Condition<Event>	reportEntry(Map<String,String> keyValuePairs)	Create a new Condition that matches if and only if an Event's payload is an instance of ReportEntry that contains the supplied key-value pairs.
static Condition<Event>	result(Condition<TestExecutionResult> condition)	Create a new Condition that matches if and only if an Event's payload is an instance of TestExecutionResult that matches the supplied Condition.
static Condition<Event>	skippedWithReason(String expectedReason)	Create a new Condition that matches if and only if an Event's type is EventType.SKIPPED and the reason is equal to the supplied String.
static Condition<Event>	skippedWithReason(Predicate<String> predicate)	Create a new Condition that matches if and only if an Event's type is EventType.SKIPPED and the reason matches the supplied Predicate.
static Condition<Event>	started()	Create a new Condition that matches if and only if an Event's type is EventType.STARTED.
static Condition<Event>	test()	Create a new Condition that matches if and only if an Event's test descriptor is a test.
static Condition<Event>	test(String uniqueIdSubstring)	Create a new Condition that matches if and only if an Event's test descriptor is a test and its unique id contains the supplied String.
static Condition<Event>	test(String uniqueIdSubstring, String displayName)	Create a new Condition that matches if and only if an Event's test descriptor is a test, its unique id contains the supplied String, and its display name equals the supplied String.
static Condition<Event>	test(Condition<Event> condition)	Create a new Condition that matches if and only if an Event matches the supplied Condition and its test descriptor is a test.
static Condition<Event>	type(EventType expectedType)	Create a new Condition that matches if and only if an Event's type is equal to the supplied EventType.
static Condition<Event>	uniqueId(String uniqueId)	Create a new Condition that matches if and only if the unique id of an Event's test descriptor is equal to the UniqueId parsed from the supplied String.
static Condition<Event>	uniqueId(Condition<? super UniqueId> condition)	Create a new Condition that matches if and only if the unique id of an Event's test descriptor matches the supplied Condition.
static Condition<Event>	uniqueId(UniqueId uniqueId)	Create a new Condition that matches if and only if the unique id of an Event's test descriptor is equal to the supplied UniqueId.
static Condition<Event>	uniqueIdSubstring(String uniqueIdSubstring)	Create a new Condition that matches if and only if the unique id of an Event's test descriptor contains the supplied String.
static Condition<Event>	uniqueIdSubstrings(String... uniqueIdSubstrings)	Create a new Condition that matches if and only if the unique id of an Event's test descriptor contains all of the supplied strings.
static Condition<Event>	uniqueIdSubstrings(List<String> uniqueIdSubstrings)	Create a new Condition that matches if and only if the unique id of an Event's test descriptor contains all of the supplied strings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

event

@SafeVarargs
public static Condition<Event> event(Condition<? super Event>... conditions)

Create a new Condition that matches if and only if an Event matches all of the supplied conditions.

engine

public static Condition<Event> engine()

Create a new Condition that matches if and only if an Event's test descriptor is an instance of EngineDescriptor.

test

public static Condition<Event> test(String uniqueIdSubstring)

Create a new Condition that matches if and only if an Event's test descriptor is a test and its unique id contains the supplied String.

See Also:

• test()
• uniqueIdSubstring(String)

test

public static Condition<Event> test(String uniqueIdSubstring,
 String displayName)

Create a new Condition that matches if and only if an Event's test descriptor is a test, its unique id contains the supplied String, and its display name equals the supplied String.

See Also:

• test()
• test(Condition)
• uniqueIdSubstring(String)
• displayName(String)

test

@API(status=MAINTAINED,
     since="1.8")
public static Condition<Event> test(Condition<Event> condition)

Create a new Condition that matches if and only if an Event matches the supplied Condition and its test descriptor is a test.

For example, test(displayName("my display name")) can be used to match against a test with the given display name.

Since:

1.8

See Also:

• test(String)
• test(String, String)
• displayName(String)

test

public static Condition<Event> test()

Create a new Condition that matches if and only if an Event's test descriptor is a test.

container

public static Condition<Event> container(Class<?> clazz)

Create a new Condition that matches if and only if an Event's test descriptor is a container and its unique id contains the fully qualified name of the supplied Class.

container

public static Condition<Event> container(String uniqueIdSubstring)

Create a new Condition that matches if and only if an Event's test descriptor is a container and its unique id contains the supplied String.

container

public static Condition<Event> container(Condition<Event> condition)

Create a new Condition that matches if and only if an Event matches the supplied Condition and its test descriptor is a container.

container

public static Condition<Event> container()

Create a new Condition that matches if and only if an Event's test descriptor is a container.

nestedContainer

@API(status=MAINTAINED,
     since="1.8")
public static Condition<Event> nestedContainer(Class<?> clazz,
 Condition<Event> condition)

Create a new Condition that matches if and only if an Event matches the supplied Condition, its test descriptor is a container, and its unique id contains the simple names of the supplied Class and all of its enclosing classes.

For example, nestedContainer(MyNestedTests.class, displayName("my display name")) can be used to match against a nested container with the given display name.

Please note that this method does not differentiate between static nested classes and non-static member classes (e.g., inner classes).

Since:

1.8

See Also:

• nestedContainer(Class)

nestedContainer

public static Condition<Event> nestedContainer(Class<?> clazz)

Create a new Condition that matches if and only if an Event's test descriptor is a container and its unique id contains the simple names of the supplied Class and all of its enclosing classes.

Please note that this method does not differentiate between static nested classes and non-static member classes (e.g., inner classes).

See Also:

• nestedContainer(Class, Condition)

dynamicTestRegistered

public static Condition<Event> dynamicTestRegistered(String uniqueIdSubstring)

Create a new Condition that matches if and only if an Event's type is EventType.DYNAMIC_TEST_REGISTERED and its unique id contains the supplied String.

dynamicTestRegistered

public static Condition<Event> dynamicTestRegistered(Condition<Event> condition)

Create a new Condition that matches if and only if an Event's type is EventType.DYNAMIC_TEST_REGISTERED and it matches the supplied Condition.

uniqueId

@API(status=MAINTAINED,
     since="1.13.3")
public static Condition<Event> uniqueId(String uniqueId)

Create a new Condition that matches if and only if the unique id of an Event's test descriptor is equal to the UniqueId parsed from the supplied String.

Since:

1.13

uniqueId

@API(status=MAINTAINED,
     since="1.13.3")
public static Condition<Event> uniqueId(UniqueId uniqueId)

Create a new Condition that matches if and only if the unique id of an Event's test descriptor is equal to the supplied UniqueId.

Since:

1.13

uniqueIdSubstring

public static Condition<Event> uniqueIdSubstring(String uniqueIdSubstring)

Create a new Condition that matches if and only if the unique id of an Event's test descriptor contains the supplied String.

uniqueId

@API(status=MAINTAINED,
     since="1.13.3")
public static Condition<Event> uniqueId(Condition<? super UniqueId> condition)

Create a new Condition that matches if and only if the unique id of an Event's test descriptor matches the supplied Condition.

Since:

1.13

uniqueIdSubstrings

public static Condition<Event> uniqueIdSubstrings(String... uniqueIdSubstrings)

Create a new Condition that matches if and only if the unique id of an Event's test descriptor contains all of the supplied strings.

Since:

1.6

uniqueIdSubstrings

public static Condition<Event> uniqueIdSubstrings(List<String> uniqueIdSubstrings)

Create a new Condition that matches if and only if the unique id of an Event's test descriptor contains all of the supplied strings.

Since:

1.6

displayName

public static Condition<Event> displayName(String displayName)

Create a new Condition that matches if and only if the display name of an Event's test descriptor is equal to the supplied String.

legacyReportingName

@API(status=MAINTAINED,
     since="1.13.3")
public static Condition<Event> legacyReportingName(String legacyReportingName)

Create a new Condition that matches if and only if the TestDescriptor.getLegacyReportingName() () legacy reporting name} of an Event's test descriptor is equal to the supplied String.

Since:

1.13

skippedWithReason

public static Condition<Event> skippedWithReason(String expectedReason)

Create a new Condition that matches if and only if an Event's type is EventType.SKIPPED and the reason is equal to the supplied String.

See Also:

• reason(String)

skippedWithReason

public static Condition<Event> skippedWithReason(Predicate<String> predicate)

Create a new Condition that matches if and only if an Event's type is EventType.SKIPPED and the reason matches the supplied Predicate.

See Also:

• reason(Predicate)

started

public static Condition<Event> started()

Create a new Condition that matches if and only if an Event's type is EventType.STARTED.

abortedWithReason

@SafeVarargs
public static Condition<Event> abortedWithReason(Condition<Throwable>... conditions)

Create a new Condition that matches if and only if an Event's type is EventType.FINISHED and its result has a status of ABORTED as well as a cause that matches all of the supplied conditions.

finishedWithFailure

@SafeVarargs
public static Condition<Event> finishedWithFailure(Condition<Throwable>... conditions)

Create a new Condition that matches if and only if an Event's type is EventType.FINISHED and its result has a status of FAILED as well as a cause that matches all of the supplied Conditions.

finishedWithFailure

public static Condition<Event> finishedWithFailure()

Create a new Condition that matches if and only if an Event's type is EventType.FINISHED and its result has a status of FAILED.

finishedSuccessfully

public static Condition<Event> finishedSuccessfully()

Create a new Condition that matches if and only if an Event's type is EventType.FINISHED and its result has a status of SUCCESSFUL.

finished

public static Condition<Event> finished(Condition<TestExecutionResult> resultCondition)

Create a new Condition that matches if and only if an Event's type is EventType.FINISHED and its payload is an instance of TestExecutionResult that matches the supplied Condition.

type

public static Condition<Event> type(EventType expectedType)

Create a new Condition that matches if and only if an Event's type is equal to the supplied EventType.

result

public static Condition<Event> result(Condition<TestExecutionResult> condition)

Create a new Condition that matches if and only if an Event's payload is an instance of TestExecutionResult that matches the supplied Condition.

reason

public static Condition<Event> reason(String expectedReason)

Create a new Condition that matches if and only if an Event's payload is an instance of String that is equal to the supplied value.

reason

public static Condition<Event> reason(Predicate<String> predicate)

Create a new Condition that matches if and only if an Event's payload is an instance of String that matches the supplied Predicate.

reportEntry

@API(status=STABLE,
     since="1.10")
public static Condition<Event> reportEntry(Map<String,String> keyValuePairs)

Create a new Condition that matches if and only if an Event's payload is an instance of ReportEntry that contains the supplied key-value pairs.

fileEntry

@API(status=MAINTAINED,
     since="1.13.3")
public static Condition<Event> fileEntry(Predicate<FileEntry> predicate)

Create a new Condition that matches if and only if an Event's payload is an instance of FileEntry that contains a file that matches the supplied Predicate.

Since:

1.12