Skip to main content

Selenium with Cucumber JS

A guide to running Selenium Webdriver tests with Cucumber NodeJS on BrowserStack.

Note: Code samples in this guide can be found in the cucumber-js-browserstack sample repo on GitHub.


BrowserStack gives you instant access to our Selenium Grid of 3000+ real devices and desktop browsers. Running your Selenium tests with Cucumber NodeJS on BrowserStack is simple. This guide will help you:

  1. Run your first test
  2. Integrating your tests with BrowserStack
  3. Mark tests as passed or failed
  4. Debug your app


  • You need to have BrowserStack Username and Access key, which you can find in your account settings. If you have not created an account yet, you can sign up for a Free Trial or purchase a plan.
  • Before you can start running your Selenium tests with Cucumber.js, Install Cucumber.js using npm:
      npm install cucumber

Run your first test

Protip: Selenium 4 is now supported on BrowserStack. To use the Selenium 4 client bindings, modify your existing test scripts as follows:
  • Edit or add capabilities in the W3C format using our W3C capability generator.
  • Add the seleniumVersion capability in your test script and set the value to 4.0.0.

To run your first Cucumber JS test on BrowserStack, follow the steps below:

  1. Clone the cucumber-js-browserstack sample repo on GitHub using the following command:

    git clone
    cd cucumber-js-browserstack
  2. Install the dependencies using npm install
  3. Setup your credentials in the cucumber-js-browserstack/conf/single.conf.js file as shown below:

    exports.config = {
     user: 'YOUR_USERNAME',
     key: 'YOUR_ACCESS_KEY',
     server: '',
     capabilities: [{
       browserName: 'chrome',
       name: "single_test",
       build: "cucumber-js-browserstack"
  4. Run your first test using the following command:
     npm run single
  5. You can visit BrowserStack Automate Dashboard and see your test there once it has successfully completed.
Protip: You can use our capability builder and select from a wide range of custom capabilities that BrowserStack supports.

Details of your first test

The sample test that you just ran can be found in cucumber-js-browserstack/features/single.feature. The test case below searches for the string “BrowserStack” on Google, and checks if the title of the resulting page is “BrowserStack - Google Search”:

Feature: Google's Search Functionality

  Scenario: Can find search results
    When I type query as "BrowserStack"
    Then I submit
    Then I should see title "BrowserStack - Google Search"

Once we have defined the feature file, which contains the test case, we now need to create the step definition. The step definition for the Cucumber NodeJS test case shown above is:

// Google Steps
module.exports = function() {

  this.When(/^I type query as "([^"]*)"$/, function (searchQuery, next) {
    this.driver.findElement({ name: 'q' })
      .sendKeys(searchQuery + '\n').then(next);

  this.Then(/^I submit$/, function (next) {
    var self = this;
    this.driver.findElement({ name: 'btnG' })
      .then(function() {
        self.driver.wait(function () {
          return self.driver.isElementPresent("top_nav"));
        }, 5000);

  this.Then(/^I should see title "([^"]*)"$/, function (titleMatch, next) {
      .then(function(title) {
        assert.equal(title, titleMatch, next, 'Expected title to be ' + titleMatch);

Integrating your tests with BrowserStack

In the sample repository, you can find env.js and hook.js file within cucumber-js-browserstack/features/support/ directory which is responsible for configuring your test to run on BrowserStack. The useful sections of the file are shown below which enable the tests to run on BrowserStack:

var config_file = '../../conf/' + (process.env.CONFIG_FILE || 'single') + '.conf.js';
var config = require(config_file).config;

var username = process.env.BROWSERSTACK_USERNAME || config.user;
var accessKey = process.env.BROWSERSTACK_ACCESS_KEY || config.key;

var createBrowserStackSession = function(config, caps){
  return new webdriver.Builder().

var myHooks = function () {
  var bs_local = null;

  this.Before(function (scenario, callback) {
    var world = this;
    var task_id = parseInt(process.env.TASK_ID || 0);
    var caps = config.capabilities[task_id];
    caps['browserstack.user'] = username;
    caps['browserstack.key'] = accessKey;

      // Code to start browserstack local before start of test and stop browserstack local after end of test
      bs_local = new browserstack.Local();
      bs_local.start({'key': accessKey }, function(error) {
        if (error) return console.log(;

        world.driver = createBrowserStackSession(config, caps);
    else {
      world.driver = createBrowserStackSession(config, caps);

  this.After(function(scenario, callback){
      else callback();

module.exports = myHooks;
var configure = function () {
    this.setDefaultTimeout(60 * 1000);

module.exports = configure;

Mark tests as passed or failed

BrowserStack provides a comprehensive REST API to access and update information about your tests. Shown below is a sample code snippet which allows you to mark your tests as pass or fail based on the assertions in your Cucumber JS test cases.

var request = require("request");
request({uri: "<session-id>.json", method:"PUT", form:{"status":"<passed/failed>","reason":"<Your reason goes here>"}})

Debug your app

BrowserStack provides a range of debugging tools to help you quickly identify and fix bugs you discover through your automated tests. Learn more about how to debug tests on BrowserStack using the Automate Dashboard.

Text logs

Text Logs are a comprehensive record of your test. They are used to identify all the steps executed in the test and troubleshoot errors for the failed step. Text Logs are accessible from the Automate dashboard or via our REST API.

Visual logs

Visual Logs automatically capture the screenshots generated at every Selenium command run through your Cucumber JS tests. Visual logs help with debugging the exact step and the page where failure occurred. They also help identify any layout or design related issues with your web pages on different browsers.

Visual Logs are disabled by default. In order to enable Visual Logs you will need to set browserstack.debug capability to true.

desiredCapabilities: {
  'browserstack.debug': true

Sample Visual Logs from Automate Dashboard: BrowserStack Automate Visual Logs

Video recording

Every test run on the BrowserStack Selenium grid is recorded exactly as it is executed on our remote machine. This feature is particularly helpful whenever a browser test fails. You can access videos from Automate Dashboard for each session. You can also download the videos from the Dashboard or retrieve a link to download the video using our REST API.

Note: Video recording increases test execution time slightly. You can disable this feature by setting the capability to false.

In addition to these logs BrowserStack also provides Raw logs, Network logs, Console logs, Selenium logs, Appium logs and Interactive session. You can find the complete details to enable all the debugging options.

Next steps

Once you have successfully run your first test on BrowserStack, you might want to do one of the following:

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked

Thank you for your valuable feedback

Is this page helping you?


We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked

Thank you for your valuable feedback!

Talk to an Expert
Talk to an Expert