Sourced from mocha's releases.

v8.2.0

8.2.0 / 2020-10-16

The major feature added in v8.2.0 is addition of support for global fixtures.

While Mocha has always had the ability to run setup and teardown via a hook (e.g., a before() at the top level of a test file) when running tests in serial, Mocha v8.0.0 added support for parallel runs. Parallel runs are incompatible with this strategy; e.g., a top-level before() would only run for the file in which it was defined.

With global fixtures, Mocha can now perform user-defined setup and teardown regardless of mode, and these fixtures are guaranteed to run once and only once. This holds for parallel mode, serial mode, and even "watch" mode (the teardown will run once you hit Ctrl-C, just before Mocha finally exits). Tasks such as starting and stopping servers are well-suited to global fixtures, but not sharing resources--global fixtures do not share context with your test files (but they do share context with each other).

Here's a short example of usage:

// fixtures.js
// can be async or not
exports.mochaGlobalSetup = async function() {
this.server = await startSomeServer({port: process.env.TEST_PORT});
console.log(server running on port ${this.server.port});
};
exports.mochaGlobalTeardown = async function() {
// the context (this) is shared, but not with the test files
await this.server.stop();
console.log(server on port ${this.server.port} stopped);
};
// this file can contain root hook plugins as well!
// exports.mochaHooks = { ... }

Fixtures are loaded with --require, e.g., mocha --require fixtures.js.

For detailed information, please see the documentation and this handy-dandy flowchart to help understand the differences between hooks, root hook plugins, and global fixtures (and when you should use each).

🎉 Enhancements

• #4308: Support run-once global setup & teardown fixtures (@boneskull)
• #4442: Multi-part extensions (e.g., test.js) now usable with --extension option (@jordanstephens)
• #4472: Leading dots (e.g., .js, .test.js) now usable with --extension option (@boneskull)
• #4434: Output of json reporter now contains speed ("fast"/"medium"/"slow") property (@wwhurin)
• #4464: Errors thrown by serializer in parallel mode now have error codes (@evaline-ju)

For implementors of custom reporters:

• #4409: Parallel mode and custom reporter improvements (@boneskull):
  • Support custom worker-process-only reporters (Runner.prototype.workerReporter()); reporters should subclass ParallelBufferedReporter in mocha/lib/nodejs/reporters/parallel-buffered
  • Allow opt-in of object reference matching for "sufficiently advanced" custom reporters (Runner.prototype.linkPartialObjects()); use if strict object equality is needed when consuming Runner event data
  • Enable detection of parallel mode (Runner.prototype.isParallelMode())

🐛 Fixes

... (truncated)

Sourced from mocha's changelog.

8.2.0 / 2020-10-16

The major feature added in v8.2.0 is addition of support for global fixtures.

While Mocha has always had the ability to run setup and teardown via a hook (e.g., a before() at the top level of a test file) when running tests in serial, Mocha v8.0.0 added support for parallel runs. Parallel runs are incompatible with this strategy; e.g., a top-level before() would only run for the file in which it was defined.

With global fixtures, Mocha can now perform user-defined setup and teardown regardless of mode, and these fixtures are guaranteed to run once and only once. This holds for parallel mode, serial mode, and even "watch" mode (the teardown will run once you hit Ctrl-C, just before Mocha finally exits). Tasks such as starting and stopping servers are well-suited to global fixtures, but not sharing resources--global fixtures do not share context with your test files (but they do share context with each other).

Here's a short example of usage:

// fixtures.js
// can be async or not
exports.mochaGlobalSetup = async function() {
this.server = await startSomeServer({port: process.env.TEST_PORT});
console.log(server running on port ${this.server.port});
};
exports.mochaGlobalTeardown = async function() {
// the context (this) is shared, but not with the test files
await this.server.stop();
console.log(server on port ${this.server.port} stopped);
};
// this file can contain root hook plugins as well!
// exports.mochaHooks = { ... }

Fixtures are loaded with --require, e.g., mocha --require fixtures.js.

For detailed information, please see the documentation and this handy-dandy flowchart to help understand the differences between hooks, root hook plugins, and global fixtures (and when you should use each).

🎉 Enhancements

• #4308: Support run-once global setup & teardown fixtures (@boneskull)
• #4442: Multi-part extensions (e.g., test.js) now usable with --extension option (@jordanstephens)
• #4472: Leading dots (e.g., .js, .test.js) now usable with --extension option (@boneskull)
• #4434: Output of json reporter now contains speed ("fast"/"medium"/"slow") property (@wwhurin)
• #4464: Errors thrown by serializer in parallel mode now have error codes (@evaline-ju)

For implementors of custom reporters:

• #4409: Parallel mode and custom reporter improvements (@boneskull):
  • Support custom worker-process-only reporters (Runner.prototype.workerReporter()); reporters should subclass ParallelBufferedReporter in mocha/lib/nodejs/reporters/parallel-buffered
  • Allow opt-in of object reference matching for "sufficiently advanced" custom reporters (Runner.prototype.linkPartialObjects()); use if strict object equality is needed when consuming Runner event data
  • Enable detection of parallel mode (Runner.prototype.isParallelMode())

🐛 Fixes

... (truncated)

• afe8daa Release v8.2.0
• 20d3d4c update CHANGELOG for v8.2.0 [ci skip]
• 932c09a fix scripts/linkify-changelog to not blast fenced code blocks
• 3b333ec chore(deps): chokidar@3.4.3
• 058b2e7 attempt to force colors in karma config
• 60e3662 replace promise.allsettled with @ungap/promise-all-settled; closes #4474
• f132448 remove duplicated/problem reporter tests; closes #4469
• 31116db fix: remove job count from parallel mode debug log (#4416)
• 478ca6a add "fixture flowchart" to docs (#4440)
• 9c28990 support leading dots in --extension
• Additional commits viewable in compare view

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)