Selenium with WD

Documentation for running Selenium Tests with BrowserStack.

WD repo on Github

Introduction

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

  1. Run your first test
  2. Mark tests as pass / fail
  3. Debug your app

Prerequisites

For the code to run successfully on your machine, please ensure that the following libraries have been installed:

# Install using npm
npm install wd

Run your first test

To understand how to integrate with BrowserStack, we will look at two things:

  1. A sample test case written in WD with NodeJS
  2. Integration of this sample test case with BrowserStack

Sample test case

The sample WD test case below searches for the string “BrowserStack” on Google, and checks if the title of the resulting page is “BrowserStack - Google Search”

module.exports = {
  name: 'Google\'s Search Functionality',
  run : function (browser) {
    return browser
      .get("https://www.google.com/ncr")
      .elementByName('q')
      .sendKeys('BrowserStack\n')
      .sleep(5000)
      .title()
        .should.become('BrowserStack - Google Search');
  }
};

Now that we have created the test case, we are ready to integrate it into BrowserStack.

Integration with BrowserStack

Note: Running your Selenium tests on BrowserStack requires a BrowserStack Username and Access Key.

To obtain your username and access keys, sign up for a Free Trial or purchase a plan.

Integration of WD with BrowserStack is made possible by the use of the following module:

var chai = require("chai"),
    chaiAsPromised = require("chai-as-promised"),
    wd = require('wd'),
    colors = require('colors'),
    child_process = require('child_process'),
    browserstack = require('browserstack-local');

chai.use(chaiAsPromised);
chai.should();
chaiAsPromised.transferPromiseness = wd.transferPromiseness;

wd.addPromiseChainMethod(
  'onQuit', function(done) {
    if(done) done();
    return this;
  }
);

function runOnBrowserStack(caps, test, done){
  console.log("Running Test: " + test.name.green + '\n');
  var browser = wd.promiseChainRemote(config.seleniumHost, config.seleniumPort, username, accessKey);

  // optional extra logging
  browser.on('status', function(info) {
    console.log(info.cyan);
  });
  browser.on('command', function(eventType, command, response) {
    console.log(' > ' + eventType.green, command, (response || '').grey);
  });
  browser.on('http', function(meth, path, data) {
    console.log(' > ' + meth.yellow, path, (data || '').grey);
  });

  test.run(browser.init(caps)).fin(function() { return browser.quit(); }).onQuit(done).done();
}

var config_file = process.argv[2] || 'conf.js'
var config = require(config_file).config;
var test = require(config.test);

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

for(var i in config.capabilities){
  var caps = config.capabilities[i];
  if(caps["browserstack.local"]){
    // Code to start browserstack local before start of test and stop browserstack local after end of test
    console.log("Connecting local");
    var bs_local = new browserstack.Local();
    bs_local.start({'key': accessKey }, function(error) {
      if (error) return console.log(error.red);
      console.log('Connected. Now testing...');

      runOnBrowserStack(caps, test, function(){ bs_local.stop(); });
    });
  }
  else {
    runOnBrowserStack(caps, test);
  }
}

The module reads from config file where you need to put the BrowserStack Hub URL and credentials.

exports.config = {
  user: 'YOUR_USERNAME',
  key: 'YOUR_ACCESS_KEY',

  seleniumHost: 'hub-cloud.browserstack.com',
  seleniumPort: 80,

  capabilities: [{
    browserName: 'chrome',
    name: 'Bstack-[WD] Sample Test'
  }]
}

Run your test on BrowserStack using following command:

# Run using npm

npm run single

Mark tests as pass / fail

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 WD test cases.

var request = require("request");
request({uri: "https://YOUR_USERNAME:YOUR_ACCESS_KEY@api.browserstack.com/automate/sessions/<session-id>.json", method:"PUT", form:{"status":"completed","reason":""}})

A full reference of our REST API can be found 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.

  • 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 NodeJS script. 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:

capabilities: [{
  'browserstack.debug': true
}]
  • 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 browserstack.video capability to false.

capabilities: [{
  'browserstack.video' : false
}]

In addition to these logs BrowserStack also provides Raw logs, Network logs, Console logs, Selenium logs, Appium logs and Interactive session. Complete details to enable all the debugging options can be found here.

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