Module org.junit.platform.jfr

Package org.junit.platform.jfr

Class FlightRecordingListener

java.lang.Object

org.junit.platform.jfr.FlightRecordingListener

All Implemented Interfaces:

TestExecutionListener

@API(status=EXPERIMENTAL,
     since="1.7")
public class FlightRecordingListener
extends Object
implements TestExecutionListener

A TestExecutionListener that generates Java Flight Recorder events.

Since:

1.7

See Also:

JEP 328: Flight Recorder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FlightRecordingListener.UniqueId

Constructor Summary

Constructors

Constructor	Description
FlightRecordingListener()

Method Summary

Modifier and Type	Method	Description
void	executionFinished(TestIdentifier test, TestExecutionResult result)	Called when the execution of a leaf or subtree of the TestPlan has finished, regardless of the outcome.
void	executionSkipped(TestIdentifier test, String reason)	Called when the execution of a leaf or subtree of the TestPlan has been skipped.
void	executionStarted(TestIdentifier test)	Called when the execution of a leaf or subtree of the TestPlan is about to be started.
void	reportingEntryPublished(TestIdentifier test, ReportEntry reportEntry)	Called when additional test reporting data has been published for the supplied TestIdentifier.
void	testPlanExecutionFinished(TestPlan plan)	Called when the execution of the TestPlan has finished, after all tests have been executed.
void	testPlanExecutionStarted(TestPlan plan)	Called when the execution of the TestPlan has started, before any test has been executed.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.junit.platform.launcher.TestExecutionListener

dynamicTestRegistered

Constructor Detail

FlightRecordingListener

public FlightRecordingListener()

Method Detail

testPlanExecutionStarted

public void testPlanExecutionStarted(TestPlan plan)

Description copied from interface: TestExecutionListener

Called when the execution of the TestPlan has started, before any test has been executed.

Specified by:

testPlanExecutionStarted in interface TestExecutionListener

Parameters:

plan - describes the tree of tests about to be executed

testPlanExecutionFinished

public void testPlanExecutionFinished(TestPlan plan)

Description copied from interface: TestExecutionListener

Called when the execution of the TestPlan has finished, after all tests have been executed.

Specified by:

testPlanExecutionFinished in interface TestExecutionListener

Parameters:

plan - describes the tree of tests that have been executed

executionSkipped

public void executionSkipped(TestIdentifier test,
                             String reason)

Description copied from interface: TestExecutionListener

Called when the execution of a leaf or subtree of the TestPlan has been skipped.

The TestIdentifier may represent a test or a container. In the case of a container, no listener methods will be called for any of its descendants.

A skipped test or subtree of tests will never be reported as started or finished.

Specified by:

executionSkipped in interface TestExecutionListener

Parameters:

test - the identifier of the skipped test or container

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

executionStarted

public void executionStarted(TestIdentifier test)

Description copied from interface: TestExecutionListener

Called when the execution of a leaf or subtree of the TestPlan is about to be started.

The TestIdentifier may represent a test or a container.

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

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

Specified by:

executionStarted in interface TestExecutionListener

Parameters:

test - the identifier of the started test or container

executionFinished

public void executionFinished(TestIdentifier test,
                              TestExecutionResult result)

Description copied from interface: TestExecutionListener

Called when the execution of a leaf or subtree of the TestPlan has finished, regardless of the outcome.

The TestIdentifier may represent a test or a container.

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

This method will 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 TestIdentifier. The result does not include or aggregate the results of its children. For example, a container with a failing test will be reported as SUCCESSFUL even if one or more of its children are reported as FAILED.

Specified by:

executionFinished in interface TestExecutionListener

Parameters:

test - the identifier of the finished test or container

result - the (unaggregated) result of the execution for the supplied TestIdentifier

See Also:

TestExecutionResult

reportingEntryPublished

public void reportingEntryPublished(TestIdentifier test,
                                    ReportEntry reportEntry)

Description copied from interface: TestExecutionListener

Called when additional test reporting data has been published for the supplied TestIdentifier.

Can be called at any time during the execution of a test plan.

Specified by:

reportingEntryPublished in interface TestExecutionListener

Parameters:

test - describes the test or container to which the entry pertains

reportEntry - the published ReportEntry