Package org.junit.runner.notification
Class RunNotifier
java.lang.Object
org.junit.runner.notification.RunNotifier
If you write custom runners, you may need to notify JUnit of your progress running tests.
Do this by invoking the
RunNotifier
passed to your implementation of
Runner.run(RunNotifier)
. Future evolution of this class is likely to
move fireTestRunStarted(Description)
and fireTestRunFinished(Result)
to a separate class since they should only be called once per run.- Since:
- 4.0
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addFirstListener
(RunListener listener) Internal use only.void
addListener
(RunListener listener) Internal use onlyvoid
fireTestAssumptionFailed
(Failure failure) Invoke to tell listeners that an atomic test flagged that it assumed something false.void
fireTestFailure
(Failure failure) Invoke to tell listeners that an atomic test failed.private void
fireTestFailures
(List<RunListener> listeners, List<Failure> failures) void
fireTestFinished
(Description description) Invoke to tell listeners that an atomic test finished.void
fireTestIgnored
(Description description) Invoke to tell listeners that an atomic test was ignored.void
fireTestRunFinished
(Result result) Do not invoke.void
fireTestRunStarted
(Description description) Do not invoke.void
fireTestStarted
(Description description) Invoke to tell listeners that an atomic test is about to start.void
fireTestSuiteFinished
(Description description) Invoke to tell listeners that a test suite is about to finish.void
fireTestSuiteStarted
(Description description) Invoke to tell listeners that a test suite is about to start.void
Ask that the tests run stop before starting the next test.void
removeListener
(RunListener listener) Internal use only(package private) RunListener
wrapIfNotThreadSafe
(RunListener listener) Wraps the given listener withSynchronizedRunListener
if it is not annotated withRunListener.ThreadSafe
.
-
Field Details
-
listeners
-
pleaseStop
private volatile boolean pleaseStop
-
-
Constructor Details
-
RunNotifier
public RunNotifier()
-
-
Method Details
-
addListener
Internal use only -
removeListener
Internal use only -
wrapIfNotThreadSafe
Wraps the given listener withSynchronizedRunListener
if it is not annotated withRunListener.ThreadSafe
. -
fireTestRunStarted
Do not invoke. -
fireTestRunFinished
Do not invoke. -
fireTestSuiteStarted
Invoke to tell listeners that a test suite is about to start. Runners are strongly encouraged--but not required--to call this method. If this method is called for a givenDescription
thenfireTestSuiteFinished(Description)
MUST be called for the sameDescription
.- Parameters:
description
- the description of the suite test (generally a class name)- Since:
- 4.13
-
fireTestSuiteFinished
Invoke to tell listeners that a test suite is about to finish. Always invoke this method if you invokefireTestSuiteStarted(Description)
as listeners are likely to expect them to come in pairs.- Parameters:
description
- the description of the suite test (generally a class name)- Since:
- 4.13
-
fireTestStarted
Invoke to tell listeners that an atomic test is about to start.- Parameters:
description
- the description of the atomic test (generally a class and method name)- Throws:
StoppedByUserException
- thrown if a user has requested that the test run stop
-
fireTestFailure
Invoke to tell listeners that an atomic test failed.- Parameters:
failure
- the description of the test that failed and the exception thrown
-
fireTestFailures
-
fireTestAssumptionFailed
Invoke to tell listeners that an atomic test flagged that it assumed something false.- Parameters:
failure
- the description of the test that failed and theAssumptionViolatedException
thrown
-
fireTestIgnored
Invoke to tell listeners that an atomic test was ignored.- Parameters:
description
- the description of the ignored test
-
fireTestFinished
Invoke to tell listeners that an atomic test finished. Always invoke this method if you invokefireTestStarted(Description)
as listeners are likely to expect them to come in pairs.- Parameters:
description
- the description of the test that finished
-
pleaseStop
public void pleaseStop()Ask that the tests run stop before starting the next test. Phrased politely because the test currently running will not be interrupted. It seems a little odd to put this functionality here, but theRunNotifier
is the only object guaranteed to be shared amongst the many runners involved. -
addFirstListener
Internal use only. The Result's listener must be first.
-