fix: improve error handling in global fixtures #5208 #5275
Conversation
|
All tests pass locally using npm run test-node:unit on both the main branch and my working branch. However, they fail in CI. This suggests an environment-specific issue. I'm investigating further and would appreciate any guidance on differences between the CI and local setups. |
Ah, this looks like #5278. Sorry for the confusing errors here - you can ignore them. |
| @@ -881,7 +881,7 @@ Mocha.prototype.failZero = function (failZero) { | |||
| * @return {Mocha} this | |||
| * @chainable | |||
| */ | |||
| Mocha.prototype.passOnFailingTestSuite = function(passOnFailingTestSuite) { | |||
| Mocha.prototype.passOnFailingTestSuite = function (passOnFailingTestSuite) { | |||
There was a problem hiding this comment.
This reminds me, I've been meaning to write a blog post about removing unrelated formatting changes from PRs... quick summary: unrelated changes clutter the Git history and make it harder to review PRs.
| Mocha.prototype.passOnFailingTestSuite = function (passOnFailingTestSuite) { | |
| Mocha.prototype.passOnFailingTestSuite = function(passOnFailingTestSuite) { |
At some point we'll start enforcing formatting in this repo anyway.
| try { | ||
| await fixtureFn.call(context); | ||
| } catch (err) { | ||
| console.error(err.stack); |
There was a problem hiding this comment.
[Functionality] This is a good start, but I think we'll want to do more than just log the error to the console. I think we'll want to mark the test as failed too. It's easy to miss console logs that don't change the exit code.
There was a problem hiding this comment.
[Testing] This change is missing test coverage. It's great that existing tests pass, but there should be a test added that shows Mocha acting appropriately when an a global fixture does reject.
JoshuaKGoldberg
added
the
status: waiting for author
|
Thanks for the review 🙏🏽. I'll make the necessary changes asap. |
PR Checklist
status: accepting prsOverview
Description
This PR addresses an issue with the handling of errors in global teardown functions. Previously, if a global teardown function threw an error, the error was not logged clearly, and the process exit code might not reflect the failure.
Changes Made
Updated the _runGlobalFixtures method in lib/mocha.js to:
Log errors with a clear and descriptive message.
Set the process exit code to 1 when a global teardown function fails.
Improved debugging output to aid in identifying which function caused the error.
New Behavior
When a global teardown function fails:
A descriptive error message is logged.
The process exits with a non-zero code, signaling the failure.