grunt-mocha-selenium

Run functional Mocha tests with wd with Selenium, Phantomjs and Appium.

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 "mochaSelenium" task

Selenium tests are run by a standalone selenium driver that will be downloaded the first time the task is run. Chrome support is provided by the Chrome Driver plugin for Selenium and is provided on demand.

The task fires up a selenium instance for the browser of your choice (Firefox, Chrome or Phantomjs) and initializes an instance of wd, passing it to the mocha test runner's context.

Take a look in the test directory for examples of what mocha tests with wd look like.

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:

options.usePromises

Type: Boolean Default value: false

If enabled, this will use the promise-enabled wd browser API instead of the normal synchronous API.

options.host and options.port

If these are specified then a server will not be started but these settings will be used to connect to an existing server.

"options.username" and "options.accesskey" can be specified if you want to use Sauce Labs' on demand service.

options.wdCustomizer

If you'd like to add custom wd methods, you can specify a wdCustomizer path to a module that patches the wd module before the wd remote is created.

Example:

grunt.initConfig({
  mochaSelenium: {
    options: {
      reporter: 'spec',
      timeout: 30e3,
      useChaining: true
    },
    phantomjs: {
      src: ['test/*.js'],
      options: {
        browserName: 'phantomjs',
        wdCustomizer: 'test/wd_customizer'
      }
    }
  }
})

test/wd_customizer.js:

function wdCustomizer(wd) {
  wd.addPromiseChainMethod(
    'waitForSomethingCustom',
    function(pageId) {
      return this.waitForElementByCssSelector('#somethingCustom');
    }
  );
 
  return wd;
}
 
module.exports = wdCustomizer;

Usage Examples

See this project's Gruntfile.js for examples.

In this example, we'll run functional 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.7.0 - bumping selenium and chromedriver versions
• v0.4.0 - add Appium support
• v0.3.0 - add phantomjs support
• v0.2.0 - add chromedriver support
• v0.0.1 - initial release

Licensed under the MIT license.