Package org.junit.platform.launcher.core

Class CompositeEngineExecutionListener

java.lang.Object

org.junit.platform.launcher.core.CompositeEngineExecutionListener

All Implemented Interfaces:

EngineExecutionListener

class CompositeEngineExecutionListener
extends java.lang.Object
implements EngineExecutionListener

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<EngineExecutionListener>	engineExecutionListeners
private static org.junit.platform.commons.logging.Logger	logger

Fields inherited from interface org.junit.platform.engine.EngineExecutionListener

NOOP

Constructor Summary

Constructors

Constructor	Description
CompositeEngineExecutionListener(java.util.List<EngineExecutionListener> engineExecutionListeners)

Method Summary

Modifier and Type	Method	Description
void	dynamicTestRegistered(TestDescriptor testDescriptor)	Must be called when a new, dynamic TestDescriptor has been registered.
void	executionFinished(TestDescriptor testDescriptor, TestExecutionResult testExecutionResult)	Must be called when the execution of a leaf or subtree of the test tree has finished, regardless of the outcome.
void	executionSkipped(TestDescriptor testDescriptor, java.lang.String reason)	Must be called when the execution of a leaf or subtree of the test tree has been skipped.
void	executionStarted(TestDescriptor testDescriptor)	Must be called when the execution of a leaf or subtree of the test tree is about to be started.
void	fileEntryPublished(TestDescriptor testDescriptor, FileEntry file)	Can be called for any TestDescriptor in order to publish a file or directory by attaching it to a test or container — for example: Screenshots Logs Output files written by the code under test Test output directory
private static <T extends EngineExecutionListener> void	notifyEach(java.util.List<T> listeners, IterationOrder iterationOrder, java.util.function.Consumer<T> consumer, java.util.function.Supplier<java.lang.String> description)
void	reportingEntryPublished(TestDescriptor testDescriptor, ReportEntry entry)	Can be called for any TestDescriptor in order to publish additional information to the reporting infrastructure — for example: Output that would otherwise go to System.out Information about test context or test data

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.junit.platform.commons.logging.Logger logger

engineExecutionListeners

private final java.util.List<EngineExecutionListener> engineExecutionListeners

Constructor Detail

CompositeEngineExecutionListener

CompositeEngineExecutionListener(java.util.List<EngineExecutionListener> engineExecutionListeners)

Method Detail

dynamicTestRegistered

public void dynamicTestRegistered(TestDescriptor testDescriptor)

Description copied from interface: EngineExecutionListener

Must be called when a new, dynamic TestDescriptor has been registered.

A dynamic test is a test that is not known a-priori and therefore was not present in the test tree when discovering tests.

Specified by:

dynamicTestRegistered in interface EngineExecutionListener

Parameters:

testDescriptor - the descriptor of the newly registered test or container

executionSkipped

public void executionSkipped(TestDescriptor testDescriptor,
                             java.lang.String reason)

Description copied from interface: EngineExecutionListener

Must be called when the execution of a leaf or subtree of the test tree has been skipped.

The TestDescriptor may represent a test or a container. In the case of a container, an engine must not fire any additional events for its descendants.

A skipped test or subtree of tests must not be reported as started or finished.

Specified by:

executionSkipped in interface EngineExecutionListener

Parameters:

testDescriptor - the descriptor of the skipped test or container

reason - a human-readable message describing why the execution has been skipped

executionStarted

public void executionStarted(TestDescriptor testDescriptor)

Description copied from interface: EngineExecutionListener

Must be called when the execution of a leaf or subtree of the test tree is about to be started.

The TestDescriptor may represent a test or a container. In the case of a container, an engine must fire additional events for its children.

This method may only be called if the test or container has not been skipped.

This method must be called for a container TestDescriptor before starting or skipping any of its children.

Specified by:

executionStarted in interface EngineExecutionListener

Parameters:

testDescriptor - the descriptor of the started test or container

executionFinished

public void executionFinished(TestDescriptor testDescriptor,
                              TestExecutionResult testExecutionResult)

Description copied from interface: EngineExecutionListener

Must be called when the execution of a leaf or subtree of the test tree has finished, regardless of the outcome.

The TestDescriptor may represent a test or a container.

This method may only be called if the test or container has not been skipped.

This method must be called for a container TestIdentifier after all of its children have been skipped or have finished.

The TestExecutionResult describes the result of the execution for the supplied testDescriptor. The result does not include or aggregate the results of its children. For example, a container with a failing test must be reported as SUCCESSFUL even if one or more of its children are reported as FAILED.

Specified by:

executionFinished in interface EngineExecutionListener

Parameters:

testDescriptor - the descriptor of the finished test or container

testExecutionResult - the (unaggregated) result of the execution for the supplied TestDescriptor

See Also:

TestExecutionResult

reportingEntryPublished

public void reportingEntryPublished(TestDescriptor testDescriptor,
                                    ReportEntry entry)

Description copied from interface: EngineExecutionListener

Can be called for any TestDescriptor in order to publish additional information to the reporting infrastructure — for example:

• Output that would otherwise go to System.out
• Information about test context or test data

The current lifecycle state of the supplied TestDescriptor is not relevant: reporting events can occur at any time.

Specified by:

reportingEntryPublished in interface EngineExecutionListener

Parameters:

testDescriptor - the descriptor of the test or container to which the reporting entry belongs

entry - the ReportEntry to be published

fileEntryPublished

public void fileEntryPublished(TestDescriptor testDescriptor,
                               FileEntry file)

Description copied from interface: EngineExecutionListener

Can be called for any TestDescriptor in order to publish a file or directory by attaching it to a test or container — for example:

• Screenshots
• Logs
• Output files written by the code under test
• Test output directory

The current lifecycle state of the supplied TestDescriptor is not relevant: file events can occur at any time.

Specified by:

fileEntryPublished in interface EngineExecutionListener

Parameters:

testDescriptor - the descriptor of the test or container to which the file entry belongs

file - the FileEntry to be published

notifyEach

private static <T extends EngineExecutionListener> void notifyEach(java.util.List<T> listeners,
                                                                   IterationOrder iterationOrder,
                                                                   java.util.function.Consumer<T> consumer,
                                                                   java.util.function.Supplier<java.lang.String> description)