Grunt task for running client-side Mocha specs in PhantomJS
npm install grunt-mocha> Automatically run client-side mocha specs via grunt/mocha/PhantomJS
For a grunt task for server-side mocha tests, see grunt-mocha-test or grunt-simple-mocha
This plugin requires Grunt ~0.4.0. Use a 0.1.x tag of this plugin to use with Grunt ~0.3.0.
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
``shell`
npm install grunt-mocha --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
`js`
grunt.loadNpmTasks('grunt-mocha');
command._$3
#### files/src
Type:
String|ArrayThis defines which HTML spec files to run using PhantomJS. These are the same files you would open to run tests in a browser.
There are a number of options available. Please review the minimatch options here.
Example:
js
mocha: {
test: {
src: ['tests/*/.html'],
},
},
`#### dest
Type:
Default: Write reporter output to a file. Useful if you need a file to feed your CI bot.
Example:
js
mocha: {
test: {
options: {
reporter: 'XUnit'
},
src: ['tests/*/.html'],
dest: './test/output/xunit.out',
},
},
`#### options.run
Type:
Default: grunt-mocha injects a script into the PhantomJS instance that loads your HTML spec files. The file sets up a reporter and listeners so the output can be output in the command line. This option will call
after the script is injected, ensuring that the proper listeners are setup.You may want to set this to false if your files are loaded asynchronously via AMD and call
mocha.run in your own callback.In HTML spec:
`html
`Gruntfile:
js
mocha: {
test: {
src: ['tests/*/.html'],
options: {
run: true,
},
},
},
`#### options.urls
Type:
Default: Instead of files, hit these URLs. Usually used in conjunction with the connect task to spin up a server for testing.
js
connect: {
server: {
options: {
port: 8888,
base: '.',
},
},
},
mocha: {
test: {
options: {
urls: [ 'http://localhost:8888/example/test/test2.html' ],
},
},
},
`Then run:
grunt connect mocha
#### options.timeout
Type:
Default: PhantomJS timeout in milliseconds. If nothing happens within 5 seconds, exit.
Example:
js
mocha: {
test: {
src: ['tests/*/.html'],
options: {
timeout: 10000,
},
},
},
`#### options.bail
Type:
Default: Call
and exit the grunt task on the first failed test. This only calls grunt.warn after the entire spec file is finished.Example:
`js
mocha: {
test: {
src: ['tests/*/.html'],
options: {
bail: true,
},
},
},
`#### options.growlOnFail
Type:
Default: Display a Growl notification when tests fail.
Example:
js
mocha: {
test: {
src: ['tests/*/.html'],
options: {
growlOnFail: false,
},
},
},
`#### options.growlOnSuccess
Type:
Default: Display a Growl notification when all tests successfully pass.
Example:
js
mocha: {
test: {
src: ['tests/*/.html'],
options: {
growlOnSuccess: false,
},
},
},
`#### options.log
Type:
Default: Print any
calls from PhantomJS to the command line. Only used for very quick and dirty debugging. It is highly recommended that you open the failing spec file in a browser so you can use much richer debugging tools.Example:
`js
mocha: {
test: {
src: ['tests/*/.html'],
options: {
log: true,
},
},
},
`#### options.logErrors
Type:
Default: Fail and output script errors.
Example:
js
mocha: {
test: {
src: ['tests/*/.html'],
options: {
logErrors: true,
},
},
},
`#### options.mocha
Type:
A mocha options simple object. Very few options are currently supported. Actually, I think
is the only one.Example:
`js
mocha: {
test: {
src: ['tests/*/.html'],
options: {
mocha: {
grep: 'router*'
}
}
},
},
`#### options.reporter
Type:
Default: The reporter to use. Note: XUnit and those types of reporters should probably use the
option.Example:
`js
mocha: {
test: {
files: ['tests/*/.html'],
options: {
reporter: 'Nyan',
}
},
},
`Custom reporter example:
Example:
js
mocha: {
test: {
files: ['tests/*/.html'],
options {
reporter: './path/to/custom/reporter', // included via require
},
},
},
`$3
Type: Set properties in the PhantomJS webpage instance used for tests, see http://phantomjs.org/api/webpage/
Example:
js
mocha: {
test: {
options: {
page: {
settings: {
webSecurityEnabled: false, // disable cors checks in phantomjs
},
},
},
},
},
`Hacks
The PhantomJS -> Grunt superdimensional conduit uses
. If you have disabled or aliased alert in your app, this won't work. I have conveniently set a global PHANTOMJS on window so you can conditionally override alert in your app.Examples
$3
#### Option 1 (recommended)
- Write mocha task description in grunt config using and specify
run: true option (see this task's Gruntfile.js for details);
- Check for PhantomJS userAgent in a test html file and run tests only in a real browser (see test2.html for details).In this case you shouldn't include bridge.js (it will be included automatically) and tests will be run from bridge.js.
#### Option 2
Alternatively, include
bridge.js from tasks/phantomjs after you include mocha.js and run mocha.setup in your HTML file. The helper will override mocha.setup` if it detects PhantomJS. See test.html.Mocha must be included via script tag in the header. There is no need to load Mocha via AMD. You may load other testing libs via AMD if that gives you a fuzzy feeling.
Example setup with AMD (advanced): https://gist.github.com/2655876
[npm-image]: https://img.shields.io/npm/v/grunt-mocha.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/grunt-mocha
[travis-image]: https://img.shields.io/travis/disqus/grunt-mocha/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/disqus/grunt-mocha