Class ExecutionRecorder

java.lang.Object

org.junit.platform.testkit.engine.ExecutionRecorder

All Implemented Interfaces:

EngineExecutionListener

@API(status=MAINTAINED,
     since="1.7")
public class ExecutionRecorder
extends Object
implements EngineExecutionListener

ExecutionRecorder is an EngineExecutionListener that records data from every event that occurs during the engine execution lifecycle and provides functionality for retrieving execution state via EngineExecutionResults.

Since:

1.4

See Also:

• EngineExecutionResults
• Event
• Execution

Field Summary

Fields inherited from interface EngineExecutionListener

NOOP

Constructor Summary

Constructors

Constructor	Description
ExecutionRecorder()

Method Summary

Modifier and Type	Method	Description
void	dynamicTestRegistered(TestDescriptor testDescriptor)	Record an Event for a dynamically registered container or test.
void	executionFinished(TestDescriptor testDescriptor, TestExecutionResult testExecutionResult)	Record an Event for a container or test that completed with the provided TestExecutionResult.
void	executionSkipped(TestDescriptor testDescriptor, String reason)	Record an Event for a container or test that was skipped.
void	executionStarted(TestDescriptor testDescriptor)	Record an Event for a container or test that started.
void	fileEntryPublished(TestDescriptor testDescriptor, FileEntry file)	Record an Event for a published FileEntry.
EngineExecutionResults	getExecutionResults()	Get the state of the engine's execution in the form of EngineExecutionResults.
void	reportingEntryPublished(TestDescriptor testDescriptor, ReportEntry entry)	Record an Event for a published ReportEntry.

Methods inherited from class Object

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

Constructor Details

ExecutionRecorder

public ExecutionRecorder()

Method Details

dynamicTestRegistered

public void dynamicTestRegistered(TestDescriptor testDescriptor)

Record an Event for a dynamically registered container or test.

Specified by:

dynamicTestRegistered in interface EngineExecutionListener

Parameters:

testDescriptor - the descriptor of the newly registered test or container

executionSkipped

public void executionSkipped(TestDescriptor testDescriptor,
 String reason)

Record an Event for a container or test that was skipped.

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)

Record an Event for a container or test that started.

Specified by:

executionStarted in interface EngineExecutionListener

Parameters:

testDescriptor - the descriptor of the started test or container

executionFinished

public void executionFinished(TestDescriptor testDescriptor,
 TestExecutionResult testExecutionResult)

Record an Event for a container or test that completed with the provided TestExecutionResult.

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)

Record an Event for a published ReportEntry.

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

@API(status=MAINTAINED,
     since="1.13.3")
public void fileEntryPublished(TestDescriptor testDescriptor,
 FileEntry file)

Record an Event for a published FileEntry.

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

Since:

1.12

getExecutionResults

public EngineExecutionResults getExecutionResults()

Get the state of the engine's execution in the form of EngineExecutionResults.

Returns:

the EngineExecutionResults containing all current state information