grunt-webdriver 
grunt-webdriver is a grunt plugin to run selenium tests with Mocha and WebdriverIO
Getting Started
This plugin requires Grunt ~0.4.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:
npm install grunt-webdriver --save-dev
One the plugin has been installed, it may be enabled inside your Gruntfile
with this line of JavaScript:
grunt.loadNpmTasks('grunt-webdriver');
The "webdriver" task
Overview
In your project's Gruntfile, add a section named webdriver
to the data
object passed into grunt.initConfig()
.
Run this task with the grunt webdriver
command.
grunt.initConfig({
webdriver: {
options: {
desiredCapabilities: {
browserName: 'chrome'
}
},
login: {
tests: ['test/spec/login/*.js'],
options: {
desiredCapabilities: {
browserName: 'firefox'
}
}
},
form: {
tests: ['test/spec/form/*.js']
}
},
})
To use a cloud service like Sauce Labs make sure you define host
and port
properties like in the example below as well as authenticate yourself with your username and key.
grunt.initConfig({
webdriver: {
options: {
host: 'ondemand.saucelabs.com',
port: 80,
user: SAUCE_USERNAME,
key: SAUCE_ACCESS_KEY,
desiredCapabilities: {
browserName: 'chrome',
version: '27',
platform: 'XP'
}
},
login: {
tests: ['test/spec/login/*.js']
},
form: {
tests: ['test/spec/form/*.js']
}
},
})
If you specify a tunnel-identifier
within your desiredCapabilities
object, the task
will automatically try to establish a tunnel connection via Sauce Connect. With the tunnel-flags
property you can pass command line options to the created Sauce Tunnel.
grunt.initConfig({
webdriver: {
options: {
user: SAUCE_USERNAME,
key: SAUCE_ACCESS_KEY,
desiredCapabilities: {
browserName: 'chrome',
version: '27',
platform: 'XP',
'tunnel-identifier': 'my-test-tunnel',
'tunnel-flags': [ '-vv', '-l sauce_connect_tech_support.log' ]
}
},
login: {
tests: ['test/spec/login/*.js']
},
form: {
tests: ['test/spec/form/*.js']
}
},
})
Options
All options get passed into the WebdriverIO remote
function. So this is the place where
you can define your driver instance. You'll find more informations about all WebdriverIO
options here. You can overwrite these
options in any target. Also you have to define all Mocha options here. The following
are supported:
bail
Type: Boolean
Default: false
If true you are only interested in the first execption
ui
Type: String
Default: bdd
Options: bdd | tdd | qunit | exports
Specify the interface to use.
reporter
Type: String
Default: spec
Options: Base | Dot | Doc | TAP | JSON | HTML | List | Min | Spec | Nyan | XUnit | Markdown | Progress | Landing | JSONCov | HTMLCov | JSONStream
Allows you to specify the reporter that will be used.
slow
Type: Number
Default: 75
Specify the "slow" test threshold, defaulting to 75ms. Mocha uses this to highlight test-cases that are taking too long.
timeout
Type: Number
Default: 1000000
Specifies the test-case timeout.
grep
Type: String
When specified will trigger mocha to only run tests matching the given pattern which is internally compiled to a RegExp
.
updateSauceJob
Type: Boolean
Default: false
If true it will automatically update the current job and does publish it.
output
Type: String
Default: null
If set grunt-webdriver will pipe reporter output into given file path
quiet
Type: Boolean
Default: false
If true it prevents the original process.stdout.write from executing - no output at all
nospawn
Type: Boolean
Default: false
If true it will not spawn a new selenium server process (useful if you use Sauce Labs without Sauce Tunnel)
seleniumOptions
Type: Object
Default: {}
Options for starting the Selenium server. For more information check out the selenium-standalone project.
seleniumInstallOptions
Type: Object
Default: {}
Options for installing Selenium dependencies. For more information check out the selenium-standalone project.
Usage Examples
Required Options
In this example, the minimum required options are used to execute a simple
test script.
grunt.initConfig({
webdriver: {
githubTest: {
tests: './test/github-test.js'
}
},
})
The corresponding Hello World test script is using WebdriverIO API to search the
grunt-webdriver repository on GitHub. The global browser
variable lets you access
your client instance. See more functions and test examples in the WebdriverIO repository.
'use strict';
var assert = require('assert');
describe('grunt-webdriver test', function () {
it('checks if title contains the search query', function(done) {
browser
.url('http://github.com')
.setValue('#js-command-bar-field','grunt-webdriver')
.submitForm('.command-bar-form')
.getTitle(function(err,title) {
assert(title.indexOf('grunt-webdriver') !== -1);
})
.call(done);
});
});
Using CoffeeScript
If you like to write your tests in CoffeeScript just add the following on the top of your Gruntfile
and you are set.
require('coffee-script/register');
module.exports = function(grunt) {
grunt.initConfig({
});
}
Contributing
Please fork, add specs, and send pull requests! In lieu of a formal styleguide, take care to
maintain the existing coding style.
Release History
- 2013-03-13 v0.1.1 first working version, without special features
- 2013-03-14 v0.1.2 bugfixing, enhanced task option, improved test case
- 2013-03-15 v0.1.3 added support for phantomjs, implemented reporter option
- 2013-03-16 v0.1.4 save result of busterjs reporters to a file, use travis for CI testing
- 2013-03-16 v0.1.5 added support for setUp function
- 2013-03-16 v0.1.6 fixed WebdriverJS version
- 2014-02-01 v0.2.0 rewrote plugin, replaced BusterJS with Mocha
- 2014-03-13 v0.3.0 support Sauce Connect
- 2014-03-16 v0.3.1 start selenium server and Sauce Connect tunnel only once
- 2014-03-22 v0.3.2 make task work with absolute minimum required options - closes #11
- 2014-03-13 v0.3.3 updated version of WebdriverJS
- 2014-03-13 v0.4.0 pipe reporter output into file, expose flag to prevent spawing of selenium process
- 2014-05-23 v0.4.1 updated dependencies
- 2014-08-17 v0.4.2 updated webdriverjs dependencies
- 2014-08-17 v0.4.3 fixed broke v0.4.3 version
- 2014-09-18 v0.4.4 selenium server outputs log on stderr, implemented workaround
- 2014-11-27 v0.4.5 Updated WebdriverIO package version, smaller bugfixes regarding file output
- 2014-11-27 v0.4.6 Additional bugfixes
- 2014-11-27 v0.4.7 check isLastTask properly
- 2014-11-27 v0.4.8 bugfix
- 2015-04-22 v0.5.0 updated selenium-standalone dependency
- 2015-04-26 v0.5.1 better handling of different environments - closes webdriverio/webdriverio#506
- 2015-06-04 v0.5.2 update selenium-standalone dependency