-
-
Notifications
You must be signed in to change notification settings - Fork 3k
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
fix: improve error handling in global fixtures #5208 #5275
Open
TG199
wants to merge
12
commits into
mochajs:main
Choose a base branch
from
TG199:mochaGlobalTeardown
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
b9874b5
fix: improve error handling in global fixtures #5208
TG199 bc63cb0
remove test file
TG199 f0d9524
Update lib/mocha.js
TG199 ae2c3a3
mark failed test
TG199 2319487
create false hook to represent global teardown failure
TG199 4649a6a
Add test
TG199 041536d
correct assertion
TG199 d6ff7cc
fix test file path, correct global teardown type
TG199 b00630c
Changes:
TG199 848f6a7
Add tests
TG199 2731673
Mark failed test:
TG199 38dfe9b
exit with code 1
TG199 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
'use strict' | ||
|
||
const { it } = require('../../../lib/mocha'); | ||
|
||
it('should pass', () => {}); | ||
|
||
exports.mochaGlobalTeardown = async function () { | ||
throw new Error('Teardown problem') | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
'use strict' | ||
|
||
const assert = require('assert'); | ||
const path = require('path'); | ||
const { spawnSync } = require('child_process'); | ||
const fs = require('fs').promises; | ||
|
||
describe('Global Teardown Error Handling', function() { | ||
this.timeout(5000); | ||
|
||
const setupFile = 'test/fixtures/global-teardown/setup.js'; | ||
const testFile = 'test/fixtures/global-teardown/test.js'; | ||
|
||
before(async function() { | ||
await fs.mkdir(path.dirname(setupFile), { recursive: true }); | ||
|
||
await fs.writeFile(setupFile, ` | ||
exports.mochaGlobalTeardown = async function () { | ||
throw new Error('Teardown failure'); | ||
}; | ||
`); | ||
|
||
await fs.writeFile(testFile, ` | ||
describe('Test Suite', function() { | ||
it('passing test', function() { | ||
// This test passes | ||
}); | ||
}); | ||
`); | ||
}); | ||
|
||
after(async function() { | ||
await fs.rm(path.dirname(setupFile), { recursive: true, force: true }); | ||
}); | ||
|
||
it('should fail with non-zero exit code when global teardown fails', function() { | ||
const result = spawnSync('node', [ | ||
'bin/mocha', | ||
'--require', setupFile, | ||
testFile | ||
], { | ||
encoding: 'utf8' | ||
}); | ||
|
||
assert.strictEqual(result.status, 1, 'Process should exit with code 1'); | ||
|
||
assert(result.stderr.includes('Teardown failure') || | ||
result.stdout.includes('Teardown failure'), | ||
'Should show teardown error message'); | ||
}); | ||
|
||
it('should combine test failures with teardown failures', async function() { | ||
|
||
await fs.writeFile(testFile, ` | ||
describe('Test Suite', function() { | ||
it('failing test', function() { | ||
throw new Error('Test failure'); | ||
}); | ||
}); | ||
`); | ||
|
||
const result = spawnSync('node', [ | ||
'bin/mocha', | ||
'--require', setupFile, | ||
testFile | ||
], { | ||
encoding: 'utf8' | ||
}); | ||
|
||
assert.strictEqual(result.status, 1, 'Process should exit with code 1'); | ||
|
||
const output = result.stdout + result.stderr; | ||
assert(output.includes('Test failure'), 'Should show test error'); | ||
assert(output.includes('Teardown failure'), 'Should show teardown error'); | ||
}); | ||
|
||
it('should pass with zero exit code when no errors occur', async function() { | ||
await fs.writeFile(setupFile, ` | ||
exports.mochaGlobalTeardown = async function () { | ||
// Success case | ||
}; | ||
`); | ||
|
||
await fs.writeFile(testFile, ` | ||
describe('Test Suite', function() { | ||
it('passing test', function() { | ||
// This test passes | ||
}); | ||
}); | ||
`); | ||
|
||
const result = spawnSync('node', [ | ||
'bin/mocha', | ||
'--require', setupFile, | ||
testFile | ||
], { | ||
encoding: 'utf8' | ||
}); | ||
|
||
assert.strictEqual(result.status, 0, 'Process should exit with code 0'); | ||
}); | ||
}); |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@TG199 this is still an open piece of feedback, can you add tests please?