Mocha convenience helpers
Place this file somewhere in your test directory:
// test/helpers/mocha.js
require('mocha-helpers')(module);Then use it via:
// test/unit/my-file/my-function-test.js
const { describe, it } = require('../../helpers/mocha');
const { myFunction } = require('my-file');
describe(function() {
it(myFunction, function() {
// stuff
});
it.allowFail('skip on error', function() {
assert.ok(false);
});
});Prints:
Unit | My-File
✓ myFunction
Make hooks follow --retries logic. https://github.com/mochajs/mocha/issues/2127.
// test/helpers/mocha.js
require('mocha-helpers')(module, {
retryHooks: true
});Then use it via:
// test/my-test.js
const { describe, beforeEach } = require('./helpers/mocha');
describe(function() {
let retries = 0;
beforeEach(function() {
if (retries++ < 1) {
throw new Error();
}
});
it('works', function() {
// stuff
});
});mocha test/my-test.js --retries 1
Prints:
My-Test
✓ works
Add a way to await Mocha's synchronous events.
const { events, registerAsyncEvents, unregisterAsyncEvents } = require('mocha-helpers');
let runner;
async function retry(test, err) {
// do something async on retries...
}
try {
await new Promise((resolve, reject) => {
try {
events.on(constants.EVENT_TEST_RETRY, retry);
runner = mocha.run(resolve);
registerAsyncEvents(runner);
} catch (err) {
reject(err);
}
});
} finally {
events.off(constants.EVENT_TEST_RETRY, retry);
if (runner) {
await unregisterAsyncEvents(runner);
}
}require('mocha-helpers')(module, {
dirname: __dirname,
titleSeparator: ' | ',
titleize: true,
prefix: '',
retryHooks: false
});