Automatically run client-side mocha specs via grunt/mocha/PhantomJS
For a grunt task for server-side mocha tests, see https://github.com/yaymukund/grunt-simple-mocha
(package/README format heavily borrowed from grunt-jasmine-task and builtin QUnit task)
Grunt plugin for running Mocha browser specs in a headless browser (PhantomJS)
mocha:// runs all html files (except test2.html) in the test dir// In this example, there's only one, but you can add as many as// you want. You can split them up into different groups here// ex: admin: [ 'test/admin.html' ]all: 'test/**/!(test2).html'// Runs 'test/test2.html' with specified mocha options.// This variant auto-includes 'mocha-helper.js' so you do not have// to include it in your HTML spec file. Instead, you must add an// environment check before you run `mocha.run` in your HTML.test2:// Test filessrc: 'test/test2.html'// mocha optionsoptions:ignoreLeaks: falsegrep: 'food'// Indicates whether 'mocha.run()' should be executed in// 'mocha-helper.js'//// NOTE: If you use AMD, you should not use this and just add a call to// `mocha.run` after you load the specsrun: true
- Write mocha task description in grunt config using full format and specify
run: trueoption (see
- Check for PhantomJS
userAgentin a test html file and run tests only in a real browser (see
In this case you shouldn't include
mocha-helper.js (it will be included automatically) and tests will be run from
tasks/mocha after you include
mocha.js and run
mocha.setup in your HTML file. The helper will override
mocha.setup if it detects PhantomJS. See
Example setup with AMD (advanced): https://gist.github.com/2655876
Grunt and this plugin
First, make sure you have grunt installed globally,
npm install grunt -g
Install this grunt plugin next to your project's grunt.js gruntfile with:
npm install grunt-mocha
Then add this line to your project's
grunt.js gruntfile at the bottom:
Also add this to the
grunt.initConfig object in the same file:
specs/index.html with the location of your mocha spec running html file.
Now you can run the mocha task with
grunt mocha, but it won't work. That's because you need...
This task is for running Mocha tests in a headless browser, PhantomJS. See the FAQ on how to install PhantomJS.
Growl support is optional. I'm not sure what the Windows situation is with growl.
The PhantomJS -> Grunt superdimensional conduit uses
alert. If you have disabled or aliased alert in your app, this won't work. I have conveniently set a global
window so you can conditionally override alert in your app.
Copyright (c) 2012 Kelly Miyashiro Licensed under the MIT license.