Add prepare/unprepare async hooks to your Mocha test environment.
You may have multiple test cases to run with mocha, and often times, you would come across situations where you need to do a global setup/teardown processes. Mocha supports root level hooks, but at that point, all of your test files are loaded, meaning, all of your code outside describe() or other mocha's global functions are all executed.
Imagine, the following scenario:
// My test case 1var foo = ; // called even before the root level handler `before`;
foo provides a method
getStatus(). But, what if later on, this
foo module chainged its behavior and required an async initialization before
the getStatus() method returns a correct value, and you have already
written hundreds of test cases this way?
// somewhere, we need to do...var foo = ;foo
Where can we put the above code? You can put it in your root level
handler, however, modifying all of your existing test cases to put the
initialization routine inside the root level hook is obviously painful.
This module allows you to set
onUnprepare handlers (takes
callback) that are called right before test cases are loaded and right after
all the tests are complete.
$ npm install mocha-prepare --save-dev
How to use
Use require (-r,--require) option
Use require (-r,--require) mocha option to set up prepare / unprepare handlers. Your ./test/mocha.opts should look like this:
--ui bdd--reporter spec--timeout 2000--recursive--require test/prepare
In this example, Mocha will load
./test/prepare.js first. You can implement your
prepare/unprepare handlers in this file.
Set prepare/unprepare handlers
Your prepare.js file should look like this.
var prepare = ;;
The second (unprepare) hander is optional.
require('mocha-prepare') returns a function that takes
module(onPrepare [, onUnprepare])
Each handlers takes an argument
done which will be
used in your handlers to tell the module that onPrepare/onUnprepare
has been complete and ready to move on.
The onPrepare handler's callback (done) may optionally take one argument
(err) to indicate the preparation was failed, in which case, the process
will exit immediately with exit code 1. If the value passed to
an instance of Error, it will print the error stack.
var prepare = ;;
The onUnprepare handler's callback does not take any argument.
- 'mocha' is specified as its
peerDepenencies. Make sure to have mocha in your devDependencies.