1.0.14 • Public • Published


Shippable branch npm Linked In Twitter Follow

JavaScript browser automation framework using official selenium-webdriver and cucumber-js.

Table of Contents


npm install selenium-cucumber-js --save-dev


node ./node_modules/selenium-cucumber-js/index.js -s ./step-definitions


-h, --help                   output usage information
-V, --version                output the version number
-s, --steps <path>           path to step definitions. defaults to ./step-definitions
-p, --pageObjects <path>     path to page objects. defaults to ./page-objects
-o, --sharedObjects [paths]  path to shared objects (repeatable). defaults to ./shared-objects
-b, --browser <path>         name of browser to use. defaults to chrome
-r, --reports <path>         output path to save reports. defaults to ./reports
-d, --disableLaunchReport    disable the auto opening the browser with test report
-j, --junit <path>           output path to save junit-report.xml defaults to ./reports
-t, --tags <tagName>         name of tag to run
-f, --featureFile <path>     a specific feature file to run
-x, --timeOut <n>            steps definition timeout in milliseconds. defaults to 10 seconds
-n, --noScreenshot           disable auto capturing of screenshots when an error is encountered

By default tests are run using Google Chrome, to run tests using another browser supply the name of that browser along with the -b switch. Available options are:

Browser Example
Chrome -b chrome
Firefox -b firefox
Phantom JS -b phantomjs

Feature files

A feature file is a Business Readable, Domain Specific Language file that lets you describe software’s behavior without detailing how that behavior is implemented. Feature files are written using the Gherkin syntax and must live in a folder named features within the root of your project.

# ./features/google-search.feature
Feature: Searching for vote cards app
  As an internet user
  In order to find out more about the itunes vote cards app
  I want to be able to search for information about the itunes vote cards app
  Scenario: Google search for vote cards app
    When I search Google for "itunes vote cards app"
    Then I should see some results

The browser automatically closes after each scenario to ensure the next scenario uses a fresh browser environment.

Step definitions

Step definitions act as the glue between features files and the actual system under test.

To avoid confusion always return a JavaScript promise your step definition in order to let cucumber know when your task has completed.

// ./step-definitions/google-search-steps.js
module.exports = function () {
    this.Then(/^I should see some results$/, function () {
        // driver wait returns a promise so return that
        return driver.wait(until.elementsLocated(by.css('div.g')), 10000).then(function(){
            // return the promise of an element to the following then.
            return driver.findElements(by.css('div.g'));
        .then(function (elements) {
            // verify this element has children

The following variables are available within the Given(), When() and Then() functions:

Variable Description
driver an instance of selenium web driver (the browser)
selenium the raw selenium-webdriver module, providing access to static properties/methods
page collection of page objects loaded from disk and keyed by filename
shared collection of shared objects loaded from disk and keyed by filename
helpers a collection of helper methods things selenium does not provide but really should!
by the selenium By class used to locate elements on the page
until the selenium until class used to wait for elements/events
expect instance of chai expect to expect('something').to.equal('something')
assert instance of chai assert to assert.isOk('everything', 'everything is ok')
trace handy trace method to log console output with increased visibility

Page objects

Page objects are accessible via a global page object and are automatically loaded from ./page-objects (or the path specified using the -p switch). Page objects are exposed via a camel-cased version of their filename, for example ./page-objects/google-search.js becomes page.googleSearch.

Page objects also have access to the same runtime variables available to step definitions.

An example page object:

// ./page-objects/google-search.js
module.exports = {
    url: 'http://www.google.co.uk',
    elements: {
        searchInput: by.name('q'),
        searchResultLink: by.css('div.g > h3 > a')
     * enters a search term into Google's search box and presses enter
     * @param {string} searchQuery 
     * @returns {Promise} a promise to enter the search values
    preformSearch: function (searchQuery) {
        var selector = page.googleSearch.elements.searchInput;
        // return a promise so the calling function knows the task has completed
        return driver.findElement(selector).sendKeys(searchQuery, selenium.Key.ENTER);

And its usage within a step definition:

// ./step-definitions/google-search-steps.js
this.When(/^I search Google for "([^"]*)"$/, function (searchQuery) {
    return helpers.loadPage('http://www.google.com').then(function() {
        // use a method on the page object which also returns a promise
        return page.googleSearch.preformSearch(searchQuery);

Shared objects

Shared objects allow you to share anything from test data to helper methods throughout your project via a global shared object. Shared objects are automatically loaded from ./shared-objects (or the path specified using the -o switch) and made available via a camel-cased version of their filename, for example ./shared-objects/test-data.js becomes shared.testData.

Shared objects also have access to the same runtime variables available to step definitions.

An example shared object:

// ./shared-objects/test-data.js
module.exports = {
    username: "import-test-user",
    password: "import-test-pa**word"

And its usage within a step definition:

module.exports = function () {
    this.Given(/^I am logged in"$/, function () {

Before/After hooks

You can register before and after handlers for features and scenarios:

Event Example
BeforeFeature this.BeforeFeatures(function(feature, callback) {})
AfterFeature this.AfterFeature(function(feature, callback) {});
BeforeScenario this.BeforeScenario(function(scenario, callback) {});
AfterScenario this.AfterScenario(function(scenario, callback) {});
module.exports = function () {
    // add a before feature hook
    this.BeforeFeature(function(feature, done) {
        console.log('BeforeFeature: ' + feature.getName());
    // add an after feature hook
    this.AfterFeature(function(feature, done) {
        console.log('AfterFeature: ' + feature.getName());
    // add before scenario hook
    this.BeforeScenario(function(scenario, done) {
        console.log('BeforeScenario: ' + scenario.getName());
    // add after scenario hook
    this.AfterScenario(function(scenario, done) {
        console.log('AfterScenario: ' + scenario.getName());


HTML and JSON reports are automatically generated and stored in the default ./reports folder. This location can be changed by providing a new path using the -r command line switch:

Cucumber HTML report

How to debug

Most selenium methods return a JavaScript Promise that is resolved when the method completes. The easiest way to step in with a debugger is to add a .then method to a selenium function and place a debugger statement within it, for example:

module.exports = function () {
    this.When(/^I search Google for "([^"]*)"$/, function (searchQuery, done) {
        driver.findElement(by.name('q')).then(function(input) {
            debugger; // <<- your IDE should step in at this point, with the browser open
            return input;
            done(); // <<- let cucumber know you're done

Directory structure

You can use the framework without any command line arguments if your application uses the following folder structure:

├── features
│   └── google-search.feature
├── step-definitions
│   └── google-search-steps.js
├── page-objects
│   └── google-search.js
└── shared-objects
│   ├── test-data.js
│   └── stuff.json
└── reports
    ├── cucumber-report.json
    └── cucumber-report.html


This project includes an example to help you get started. You can run the example using the following command:

node ./node_modules/selenium-cucumber-js/index.js


Please raise bugs via the selenium-cucumber-js issue tracker and, if possible, please provide enough information to allow the bug to be reproduced.


Everyone is very welcome to contribute to this project. You can contribute just by submitting bugs or suggesting improvements by opening an issue on GitHub.


IntelliJ Cucumber Plugin

IntelliJ based IDE's have a plugin that allows the tester to control click on a Given, When, Then statement within a Cucumber feature file and have the user taken to the associated step definition. This plugin relies on your project having the following folder structure:

└── features
   │   google-search.feature
   └── step_definitions
   │   └── google-search-steps.js
   └── page_objects
   │   └── google-search.js
   └── shared_objects
   │   ├── test-data.js
   │   └── stuff.json
   └── reports
       ├── cucumber-report.json
       └── cucumber-report.html

This can be achieved by restructuring your project to match the layout above (notice the underscores), and running your tests with the following switches:

node ./node_modules/selenium-cucumber-js/index.js -s ./features/step_definitions -p ./features/page_objects -o ./features/shared_objects -r ./features/reports


Licensed under ISC License © John Doherty

Package Sidebar


npm i jiiis-selenium-cucumber-js

Weekly Downloads






Unpacked Size

181 kB

Total Files


Last publish


  • jiiis