Skip to content

Document concurrency considerations for TestExecutionListener implementations #3053

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 10, 2022
Merged

Document concurrency considerations for TestExecutionListener implementations #3053

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions junit-platform-launcher/src/main/java/org/junit/platform/launcher/TestExecutionListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@
* {@link #testPlanExecutionStarted(TestPlan)} and
* {@link #testPlanExecutionFinished(TestPlan)}.
*
* <p>Note on concurrency: {@link #testPlanExecutionStarted(TestPlan)} and
* {@link #testPlanExecutionFinished(TestPlan)} are always called from the same
* thread. It is safe to assume that there is at most one {@code TestPlan}
* instance at a time. All other methods could be called from different threads
* concurrently in case one or multiple test engines execute tests in parallel.
*
* @since 1.0
* @see Launcher
* @see TestPlan
Expand All @@ -58,6 +64,8 @@ public interface TestExecutionListener {
* Called when the execution of the {@link TestPlan} has started,
* <em>before</em> any test has been executed.
*
* <p>Called from the same thread as {@link #testPlanExecutionFinished(TestPlan)}.
*
* @param testPlan describes the tree of tests about to be executed
*/
default void testPlanExecutionStarted(TestPlan testPlan) {
Expand All @@ -67,6 +75,8 @@ default void testPlanExecutionStarted(TestPlan testPlan) {
* Called when the execution of the {@link TestPlan} has finished,
* <em>after</em> all tests have been executed.
*
* <p>Called from the same thread as {@link #testPlanExecutionStarted(TestPlan)}.
*
* @param testPlan describes the tree of tests that have been executed
*/
default void testPlanExecutionFinished(TestPlan testPlan) {
Expand Down