doc: clarify after and afterEach hooks execution #51523
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `after` hook now explicitly mentions that it is executed once after all the tests in a test suite have completed, regardless of whether the tests passed or failed. This ensures that cleanup tasks or actions specified in the after hook are guaranteed to run. Refs: nodejs#50901
The `afterEach` hook is now documented to be executed after each individual test in a test suite, irrespective of whether the test passed or failed. Developers can rely on this hook for performing cleanup or resetting state after each test. Refs: nodejs#50901
Refined the language in the documentation for the `after` and `afterEach` hooks to enhance clarity. Replaced instances of "note that" with more direct and concise language for better readability. Refs: nodejs#50901
|
Review requested:
|
nodejs-github-bot
added
doc
doc/api/test.md
Outdated
Comment on lines
1423
to
1427
| **Note:** The `after` hook is executed once after all the tests | ||
| in a test suite have completed, regardless of whether the tests | ||
| passed or failed. This hook is useful for performing cleanup tasks | ||
| or actions that should occur after the entire test suite has been run. | ||
| The `after` hook is guaranteed to run, even if tests within the suite fail. |
There was a problem hiding this comment.
Suggested change
| **Note:** The `after` hook is executed once after all the tests | |
| in a test suite have completed, regardless of whether the tests | |
| passed or failed. This hook is useful for performing cleanup tasks | |
| or actions that should occur after the entire test suite has been run. | |
| The `after` hook is guaranteed to run, even if tests within the suite fail. | |
| **Note:** The `after` hook is guaranteed to run, even if tests within the suite fail. |
doc/api/test.md
Outdated
Comment on lines
1482
to
1486
| **Note:** The `afterEach` hook is executed after each individual test | ||
| in a test suite, regardless of whether the test passed or failed. | ||
| This hook is commonly used for cleaning up resources or resetting state | ||
| between tests. The `afterEach` hook is guaranteed to run after every test, | ||
| even if any of the tests fail. |
There was a problem hiding this comment.
Suggested change
| **Note:** The `afterEach` hook is executed after each individual test | |
| in a test suite, regardless of whether the test passed or failed. | |
| This hook is commonly used for cleaning up resources or resetting state | |
| between tests. The `afterEach` hook is guaranteed to run after every test, | |
| even if any of the tests fail. | |
| **Note:** The `afterEach` hook is guaranteed to run after every test, | |
| even if any of the tests fail. |
Refined the documentation for the `after` and `afterEach` hooks to enhance clarity. Removed redundant information and retained the essential details. The revised note now explicitly states that the `after` and `afterEach` hooks are guaranteed to run, even if tests within the suite fail. Refs: nodejs#50901
|
Hey @marco-ippolito thank you for your prompt review! 🚀 I apologize for a slight delay on my end. |
Adjusted line lengths in the documentation to adhere to the maximum allowed limit of 80 characters. This change resolves the linting error. Refs: nodejs#50901
|
Included the commit for adhering to the maximum allowed limit of 80 characters, as per linting configuration (after the change). |
marco-ippolito
changed the title
lpinca
approved these changes
Jan 20, 2024
MoLow
approved these changes
Jan 20, 2024
marco-ippolito
added
commit-queue-squash
lpinca
added
the
commit-queue
nodejs-github-bot
removed
the
commit-queue
|
Landed in 9aa211e |
rdw-msft
pushed a commit
to rdw-msft/node
that referenced
this pull request
Feb 9, 2024
The `after` hook now explicitly mentions that it is executed once after all the tests in a test suite have completed, regardless of whether the tests passed or failed. This ensures that cleanup tasks or actions specified in the after hook are guaranteed to run. Refs: nodejs#50901 PR-URL: nodejs#51523 Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
targos
pushed a commit
that referenced
this pull request
Feb 15, 2024
The `after` hook now explicitly mentions that it is executed once after all the tests in a test suite have completed, regardless of whether the tests passed or failed. This ensures that cleanup tasks or actions specified in the after hook are guaranteed to run. Refs: #50901 PR-URL: #51523 Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
marco-ippolito
pushed a commit
to marco-ippolito/node
that referenced
this pull request
Feb 19, 2024
The `after` hook now explicitly mentions that it is executed once after all the tests in a test suite have completed, regardless of whether the tests passed or failed. This ensures that cleanup tasks or actions specified in the after hook are guaranteed to run. Refs: nodejs#50901 PR-URL: nodejs#51523 Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Merged
|
Thanks all! |
richardlau
pushed a commit
that referenced
this pull request
Mar 25, 2024
The `after` hook now explicitly mentions that it is executed once after all the tests in a test suite have completed, regardless of whether the tests passed or failed. This ensures that cleanup tasks or actions specified in the after hook are guaranteed to run. Refs: #50901 PR-URL: #51523 Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
richardlau
pushed a commit
that referenced
this pull request
Mar 25, 2024
The `after` hook now explicitly mentions that it is executed once after all the tests in a test suite have completed, regardless of whether the tests passed or failed. This ensures that cleanup tasks or actions specified in the after hook are guaranteed to run. Refs: #50901 PR-URL: #51523 Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This pull request addresses Issue #50901 , which highlights a documentation clarification regarding the execution of the
afterandafterEachhooks in the test runner.Changes Made
afterHook Documentation:afterhook is executed once after all tests in a suite, irrespective of test success or failure.afterEachHook Documentation:afterEachhook is executed after each individual test, regardless of test outcomes.Additional Notes
The changes adhere to the Node.js documentation style guide.
Linting warnings related to the phrase "note that" have been addressed for improved documentation clarity.
Related Issues
Fixes: Issue #50901