Upgrade mocha to version 8.2.0

[depfu]

Here is everything you need to know about this upgrade. Please take a good look at what changed and the test results before merging this pull request.

What changed?

✳️ mocha (^7.0.0 → ^8.2.0) · Repo · Changelog

Release Notes

8.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 <span class="pl-s1"><span class="pl-kos">${</span><span class="pl-smi">this</span><span class="pl-kos">.</span><span class="pl-c1">server</span><span class="pl-kos">.</span><span class="pl-c1">port</span><span class="pl-kos">}</span></span>);

};
exports.mochaGlobalTeardown = async function() {

// the context (this) is shared, but not with the test files

await this.server.stop();

console.log(server on port <span class="pl-s1"><span class="pl-kos">${</span><span class="pl-smi">this</span><span class="pl-kos">.</span><span class="pl-c1">server</span><span class="pl-kos">.</span><span class="pl-c1">port</span><span class="pl-kos">}</span></span> 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

• #4476: Workaround for profoundly bizarre issue affecting npm v6.x causing some of Mocha's deps to be installed when mocha is present in a package's devDependencies and npm install --production is run the package's working copy (@boneskull)
• #4465: Worker processes guaranteed (as opposed to "very likely") to exit before Mocha does; fixes a problem when using nyc with Mocha in parallel mode (@boneskull)
• #4419: Restore lookupFiles() in mocha/lib/utils, which was broken/missing in Mocha v8.1.0; it now prints a deprecation warning (use const {lookupFiles} = require('mocha/lib/cli') instead) (@boneskull)

Thanks to @AviVahl, @donghoon-song, @ValeriaVG, @znarf, @sujin-park, and @majecty for other helpful contributions!

Does any of this look wrong? Please let us know.

Commits

See the full diff on Github. The new version differs by 29 commits:

• Release v8.2.0
• update CHANGELOG for v8.2.0 [ci skip]
• fix scripts/linkify-changelog to not blast fenced code blocks
• chore(deps): chokidar@3.4.3
• attempt to force colors in karma config
• replace promise.allsettled with @ungap/promise-all-settled; closes #4474
• remove duplicated/problem reporter tests; closes #4469
• fix: remove job count from parallel mode debug log (#4416)
• add "fixture flowchart" to docs (#4440)
• support leading dots in --extension
• chore(deps): upgrade to latest stable
• Support multipart extensions like ".test.js" (#4442)
• refactor: utils.type() (#4457); closes #4306
• Change serializer errors to use error codes (#4464)
• make guarantees about orphaned processes
• avoid deprecated add-path in GHA workflow
• parallel mode: enable custom worker reporters and object references (#4409); closes #4403
• run all node.js tests on GHA (#4459)
• cleanup a little bit of eslint config
• Update eslint version (#4443)
• implement Open Collective categories for extended filtering
• ci(win): setup GH actions for windows CI (#4402)
• Add speed in -R json option (#4226) (#4434)
• remove unused interface tests (#4247)
• Add npm and node version badges to README
• implementation of global setup/teardown; closes #4308 (#4360)
• redirect webpack test output to a temp dir
• remove wallaby-logo.png trim option
• fix typo in 8.1.2 changelog (#4432)

---

Depfu will automatically keep this PR conflict-free, as long as you don't add any commits to this branch yourself. You can also trigger a rebase manually by commenting with @depfu rebase.

All Depfu comment commands

@​depfu rebase

Rebases against your default branch and redoes this update

@​depfu recreate

Recreates this PR, overwriting any edits that you've made to it

@​depfu merge

Merges this PR once your tests are passing and conflicts are resolved

@​depfu close

Closes this PR and deletes the branch

@​depfu reopen

Restores the branch and reopens this PR (if it's closed)

@​depfu pause

Ignores all future updates for this dependency and closes this PR

@​depfu pause [minor|major]

Ignores all future minor/major updates for this dependency and closes this PR

@​depfu resume

Future versions of this dependency will create PRs again (leaves this PR as is)

[coveralls]

Coverage remained the same at 84.314% when pulling 2ea4d77 on depfu/update/npm/mocha-8.2.0 into a1b6f62 on master.

[coveralls]

Coverage remained the same at 84.314% when pulling 2ea4d77 on depfu/update/npm/mocha-8.2.0 into a1b6f62 on master.

[papandreou]

@depfu pause

[depfu]

Pausing mocha updates for all future versions. Go to your Depfu dashboard or use the @depfu resume command to resume updates.