grunt-mocha-selenium
Run functional Mocha tests with webdriver against a local selenium instance.
Getting Started This plugin requires Grunt.
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:
npm install grunt-mocha-selenium --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-mocha-selenium');
The "mocha_selenium" task
Overview In your project's Gruntfile, add a section named
mochaSelenium
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
mochaSelenium: {
options: {
// Mocha options
reporter: 'spec',
timeout: 30e3,
// Toggles wd's promises API, default:false
usePromises: false
},
firefox: {
src: ['test/*.js']
// firefox is the default browser, so no browserName option required
},
chrome: {
src: ['test/*.js'],
options: {
// Chrome browser must be installed from Chromedriver support
browserName: 'chrome'
}
},
phantomjs: {
src: ['test/*.js'],
options: {
// phantomjs must be in the $PATH when invoked
browserName: 'phantomjs'
}
}
}
})
Options
The usual Mocha options are passed through this task to a new Mocha instance.
The following options can be supplied to the task:
Boolean
Default value: false
options.usePromises Type: If enabled, this will use the promise-enabled wd browser API instead of the normal synchronous API.
Usage Examples
See this project's Gruntfile.js
for examples.
In this example, we'll run functinoal mocha tests for all files in the
test
directory using the wd promises API and the nyan-cat reporter.
grunt.initConfig({
mochaSelenium: {
options: {
reporter: 'nyan',
usePromises: true,
useChrome: true
},
all: ['test/*.js' ]
},
})
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
Release History
- v0.2.0 - add chromedriver support
- v0.0.1 - initial release