@API(status=STABLE, since="1.0") public interface TestExecutionListener
Launcher
to be notified of
events that occur during test execution.
All methods in this class have empty default implementations. Concrete implementations may therefore override one or more of these methods to be notified of the selected events.
JUnit provides two example implementations:
Contrary to JUnit 4, test engines are supposed to report events not only for identifiers that represent executable leaves in the test plan but also for all intermediate containers. However, while both the JUnit Vintage and JUnit Jupiter engines comply with this contract, there is no way to guarantee this for third-party engines.
Launcher
,
TestPlan
,
TestIdentifier
Modifier and Type | Method and Description |
---|---|
default void |
dynamicTestRegistered(TestIdentifier testIdentifier)
Called when a new, dynamic
TestIdentifier has been registered. |
default void |
executionFinished(TestIdentifier testIdentifier,
TestExecutionResult testExecutionResult)
Called when the execution of a leaf or subtree of the
TestPlan
has finished, regardless of the outcome. |
default void |
executionSkipped(TestIdentifier testIdentifier,
String reason)
Called when the execution of a leaf or subtree of the
TestPlan
has been skipped. |
default void |
executionStarted(TestIdentifier testIdentifier)
Called when the execution of a leaf or subtree of the
TestPlan
is about to be started. |
default void |
reportingEntryPublished(TestIdentifier testIdentifier,
ReportEntry entry)
Called when additional test reporting data has been published for
the supplied
TestIdentifier . |
default void |
testPlanExecutionFinished(TestPlan testPlan)
Called when the execution of the
TestPlan has finished,
after all tests have been executed. |
default void |
testPlanExecutionStarted(TestPlan testPlan)
Called when the execution of the
TestPlan has started,
before any test has been executed. |
default void testPlanExecutionStarted(TestPlan testPlan)
TestPlan
has started,
before any test has been executed.testPlan
- describes the tree of tests about to be executeddefault void testPlanExecutionFinished(TestPlan testPlan)
TestPlan
has finished,
after all tests have been executed.testPlan
- describes the tree of tests that have been executeddefault void dynamicTestRegistered(TestIdentifier testIdentifier)
TestIdentifier
has been registered.
A dynamic test is a test that is not known a-priori and
therefore not contained in the original TestPlan
.
testIdentifier
- the identifier of the newly registered test
or containerdefault void executionSkipped(TestIdentifier testIdentifier, String reason)
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.
testIdentifier
- the identifier of the skipped test or containerreason
- a human-readable message describing why the execution
has been skippeddefault void executionStarted(TestIdentifier testIdentifier)
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.
testIdentifier
- the identifier of the started test or containerdefault void executionFinished(TestIdentifier testIdentifier, TestExecutionResult testExecutionResult)
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
.
testIdentifier
- the identifier of the finished test or containertestExecutionResult
- the (unaggregated) result of the execution for
the supplied TestIdentifier
TestExecutionResult
default void reportingEntryPublished(TestIdentifier testIdentifier, ReportEntry entry)
TestIdentifier
.
Can be called at any time during the execution of a test plan.
testIdentifier
- describes the test or container to which the entry pertainsentry
- the published ReportEntry