A small, rambunctious WD.js / WebdriverIO configuration wrapper.
JavaScript
Latest commit fe25a22 Mar 19, 2016 @ryan-roemer ryan-roemer Version 0.5.0
Permalink
Failed to load latest commit information.
adapters
examples/mocha
helpers
lib Version 0.4.0 Feb 16, 2016
.eslintrc-server
.eslintrc-server-test Misc cleanup: lint, guacamole shrinkwrap, dependencies Jan 22, 2016
.gitignore
.travis.yml
CONTRIBUTING.md Version 0.3.6 Feb 16, 2016
HISTORY.md Version 0.5.0 Mar 19, 2016
LICENSE.txt
README.md
config.js
guacamole-shrinkwrap.json
index.js
package.json Version 0.5.0 Mar 19, 2016

README.md

roWDy

A small, rambunctious configuration wrapper for WD.js or WebdriverIO

Main features:

  • Easy configuration for local, Sauce Labs, BrowserStack testing.
  • Invokes selenium server for local runs automagically.
  • Integration helpers for Mocha tests.
  • Auto-magic setting of Sauce Labs test status.
  • Use your own test framework and test runner.

Installation

First, install the library.

$ npm install --save-dev rowdy

Local Selenium Server

If you want to have Rowdy run and control a local Selenium server, then install the standalone client and run the install scripts:

$ npm install --save-dev selenium-standalone
$ npm run install-selenium

This shells out to selenium-standalone and is necessary at some point in your integration if using the standalone (local) server.

The above steps are necessary if the configuration value settings.local.server.start is true. You can skip the steps if you are separately running / managing a local Selenium server or using a remote Selenium farm (e.g., Sauce Labs or BrowserStack).

Client Libraries

Then, install the necessary client libraries.

WD.js

$ npm install --save-dev wd

WebdriverIO

$ npm install --save-dev webdriverio saucelabs

Note: If using SauceLabs + WebdriverIO, we lazy require the Sauce Labs module to upload results of "done" to your SL account.

Note: Rowdy requires webdriverio at version v3.0.0 or above.

Sauce Labs

If you intend to use Sauce Labs + guacamole-provide environments, then:

$ npm install --save-dev guacamole

Configuration

By default Rowdy will lazy initialize the library's included config.js configuration file. (The first access of most rowdy.* properties / methods will force this.)

However, on first import of Rowdy, you can override this behavior to do things like override parts of the default configuration:

// Start with default configuration.
var config = require("rowdy/config");
config.server.logger = true;
// ... any other mutations

// Pass configuration in.
var rowdy = require("rowdy")(config);

Or, you can simply copy config.js to your project, edit it as appropriate and load:

var config = require("./PATH/TO/config");
var rowdy = require("rowdy")(config);

Local Examples

Start the local Selenium server on a different port:

$ ROWDY_OPTIONS='{ "server": { "port":4321 } }' \
  npm run test

Have client hit an already running local Selenium server without starting its own:

# In one terminal
$  java -jar node_modules/selenium-standalone/.selenium/selenium-server/2.45.0-server.jar \
   -port 4321 \
   -Dphantomjs.binary.path=node_modules/phantomjs/lib/phantom/bin/phantomjs

# In another...
$ ROWDY_OPTIONS='{ "client": { "port":4321 }, "server": { "start":false } }' \
  npm run test

Sauce Labs + Guacamole

We use guacamole to have automatic access to all of the test environments Sauce Labs supports (e.g., firefox_38_Windows_2012_R2_Desktop, safari_7_OS_X_10_9_Desktop).

If you npm install guacamole, then by default Rowdy will use and enable those environments for use in configuration. Once installed, you can view all of the available environments with:

# View environments
$ node_modules/.bin/guacamole

# Generate a cached shrinkwrap file
$ node_modules/.bin/guacamole --generate-shrinkwrap

Rowdy uses a cached version of Sauce Labs configurations in the guacamole-shrinkwrap.json file so that guacamole doesn't query the Sauce Labs API at runtime.

Disabling Guacamole: If you don't want to use the guacamole environments with Sauce Labs, then you can skip the npm install and just make sure the following is active in your Rowdy configuration:

{
  options: {
    guacamole: {
      enabled: false
    }
  }
}

(By default guacamole.enabled is true if npm installed and false otherwise, so if you use the default Rowdy configuration, no code changes are needed.)

And then you should add your own bespoke Sauce Labs settings in configuration at:

{
  settings: {
    sauceLabs: {
      "mac-safari-7": { /* Sauce Labs capabilities */ }
    }
  }
}

Local Usage

One of the Rowdy peer dependencies is selenium-standalone. This package contains an install script that you may need (and do need on Windows):

$ node_modules/.bin/selenium-standalone install

Some other tips and tricks:

Mac + Safari

Recent Safari updates have broken automatic driver usage, so you need a series of tedious steps per http://elementalselenium.com/tips/69-safari:

Windows + IE

See https://code.google.com/p/selenium/wiki/InternetExplorerDriver#Required_Configuration for extra steps needed to work with local IE. Anecdotally, for Win7+IE11 in a VM, the only actually tweak needed was:

  • Create key HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Internet Explorer\MAIN\FeatureControl\FEATURE_BFCACHE and add DWORD of iexplore.exe defaulted to 0 value.

API

TODO: API is still settling out.

Mocha Adapter

We provide full working examples of the Mocha Adapter:

TODO: Add a full guide for configuring the adapter and (1) the options, (2) adapter.refreshClient() use, (3) adapter.client use.

Webdriver Client Guides

WD.js

The full API to WD.js is available at: https://github.com/admc/wd/blob/master/doc/api.md

WebdriverIO

WebdriverIO provides the following useful documentation:

Contributions

Please see the Contributions Guide for how to help out with the plugin.

We test all changes with Travis CI. Here's our current build status:

Build Status

We also do multi-browser testing thanks to donated VM time from Sauce Labs and BrowserStack. Here's our Sauce Labs build matrix:

Sauce Test Status