Skip to content
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.

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

Document wrapping behavior of TestExecutionListener callbacks #34422

Open
sbrannen opened this issue Feb 13, 2025 · 0 comments
Open

Document wrapping behavior of TestExecutionListener callbacks #34422

sbrannen opened this issue Feb 13, 2025 · 0 comments
Assignees
Labels
in: test Issues in the test module type: documentation A documentation task
Milestone

Comments

@sbrannen
Copy link
Member

Overview

The Javadoc for all "after" callback methods in TestContextManager (such as afterTestExecution()) states the following.

Note that listeners will be executed in the opposite order in which they were registered.

However, most developers would not logically think to read the Javadoc for TestContextManager when trying to reason about TestExecutionListener callbacks.

Therefore, as mentioned by @nizametdinovcrx in #34225 (comment), we should officially document the "wrapping behavior" of TestExecutionListener callbacks, especially with regard to the fact that "after" callbacks are invoked in reverse registration order.

Since I authored the documentation for JUnit Jupiter's Wrapping Behavior of Callbacks, I will likely borrow from that.

Related Issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: test Issues in the test module type: documentation A documentation task
Projects
None yet
Development

No branches or pull requests

1 participant