@testim/testim-cli
Version:
Command line interface for running Testing on you CI
102 lines (79 loc) • 3.18 kB
Markdown
name: grunt-webdriver
category: plugins
tags: guide
title: WebdriverIO - grunt-webdriver
---
grunt-webdriver [](https://travis-ci.org/webdriverio/grunt-webdriver) [](https://gitter.im/webdriverio/grunt-webdriver?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
===============
> grunt-webdriver is a grunt plugin to run selenium tests with the [WebdriverIO](http://webdriver.io) testrunner
## Getting Started
This plugin requires Grunt `~0.4.0`
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out
the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains
how to create a [Gruntfile](http://gruntjs.com/sample-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 --save-dev grunt-webdriver
```
This grunt plugin only runs with WebdriverIO >=v3.x. Make sure you have the latest
WebdriverIO version installed as dependency:
```shell
npm install --save-dev webdriverio
```
Once the plugin has been installed, it may be enabled inside your Gruntfile
with this line of JavaScript:
```js
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()`. Your test should contain a `configFile`
property with a path to your wdio config. You can pass in additional options
as cli arguments.
_Run this task with the `grunt webdriver` command._
```js
grunt.initConfig({
webdriver: {
test: {
configFile: './test/wdio.conf.js'
}
},
// ...
})
```
The plugin is an easy helper to run WebdriverIO tests using the wdio test runner.
You can find more information about the test runner on our [docs page](http://webdriver.io/guide/testrunner/gettingstarted.html).
#### Example using [Sauce Labs](https://saucelabs.com)
To use a cloud service like [Sauce Labs](https://saucelabs.com) make sure you define `host` and `port` properties like in the example below as well as authenticate yourself with your username and key.
```js
grunt.initConfig({
webdriver: {
options: {
user: SAUCE_USERNAME,
key: SAUCE_ACCESS_KEY
},
test: {
configFile: './test/wdio.conf.js'
}
},
// ...
})
```
### Options
All options get passed into to the wdio process. You should define your main configurations
within your wdio config file. The plugin allows you to easy overwrite them. You can find all available
cli arguments here: [http://webdriver.io/guide/testrunner/gettingstarted.html](http://webdriver.io/guide/testrunner/gettingstarted.html)
#### 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.
```js
require('coffee-script/register');
module.exports = function(grunt) {
// Project configuration.
grunt.initConfig({
// ...
});
}
```