README

Starts and stops selenium in webdriver or hub mode, works with 3rd party CI platforms

We wrote this after extensive problems getting selenium webdriver tests to run in all local and 3rd party environments. If you are using circleci and want to run headless tests then the selenium_phantom_hub task will do the trick.

Note that we have found problems with selenium and bundled chromedriver but at the current time we do not have an option to start chromedriver in the same way as phantomjs. Our advice is use firefox and phantom for CI testing and saucelabs / local for the rest.

Getting Started

This plugin requires Grunt ~0.4.2

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-selenium-webdriver --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-selenium-webdriver');

The "selenium_webdriver" tasks

Three tasks are added (selenium_start, selenium_stop and selenium_phantom_hub). The tasks do not require or set any options

Overview

    grunt.loadNpmTasks('grunt-selenium-webdriver');
    grunt.registerTask('e2e', [
        'selenium_phantom_hub',
        'mocha_e2e',
        'selenium_stop'    
    ]);

options

You can set various selenium commandline options. Some environments already have an instance running on 4444, in which case set the port in your grunt config:

    selenium_start: {
        local: {
            options: { port: 4445 }
        }
    },

You can see we do this in our tests, have a look at our GruntFile setup for the plugin. The options are:

host
port
timeout
maxSession
phantomPort
firefoxProfile
displaySeleniumLog

Usage Examples

This task is designed to be used in conjunction with your test runner of preference. The server is destroyed when grunt exists so grunt start_selenium will only make a server available to other grunt tasks. If you need a task that persists the selenium server then try grunt-selenium-standalone.

If you look in the plugin you can see an example of a mocha test that uses using the raw selenium-webdriver node module. This project also works with protractor.

selenium_start

Starts a selenium local server on http://127.0.0.1:4444/wd/hub with all browsers in PATH available, including phantom. However, if you get errors with test run using default phantomjs try the task below.

selenium_phantom_hub

starts a selenium grid hub and attaches phantomjs to it for headless testing, only one client is available in this configuration

selenium_stop

stops whichever server was started, if you need to change from headless to normal mode then you will need to stop first

Problems?

The reason for this project is there are inconsistencies between the location of files on different environments. If you hit a problem

cd node_modules/grunt-selenium-webdriver
npm install
grunt test --trace

This should give you some info about your system and relative paths etc. There are also some additional commented out console statement in the tasks file you can enable. If you can't fix the problem from here please send us this info on your support ticket along with any platform details (eg AWS, Travis etc).

Contributing

Please fix any bugs you find and add any new cases not covered, pull requests gratefully received.

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

0.2.432 support for node 0.12 
0.2.422 phantomPort option added 
0.2.421 added some mocha tests + improved branching logic separated for phantom and selenium components 
0.2.420 release using selenium-server-standalone-2.42.2.jar
0.2.391 initial release using selenium-server-standalone-2.39.0.jar
0.2.392 will have theses documentation updates
0.2.450 release using selenium-server-standalone-2.45.0.jar
0.2.451 adds --ignore-ssl-errors to phantomjs startup
0.2.461 release using selenium-server-standalone-2.47.1.jar
0.2.482 release using selenium-server-standalone-2.48.2.jar
0.2.501 release using selenium-server-standalone-2.50.1.jar
0.2.530 release using selenium-server-standalone-2.53.0.jar
0.2.531 added firefoxProfile and displaySeleniumLog options

kfts / grunt-selenium-webdriver

Maintainers

Details