Integrate Your Test Suite

Integrate BrowserStack Automate into your test suite using the BrowserStack Nightwatch plugin.

The BrowserStack Nightwatch plugin ensures a plug-and-play integration. It manages your BrowserStack local connections and configures other connections under the hood without any code changes.

Prerequisites

BrowserStack Username and Access key. You can find this in your account profile. If you do not have an account yet, you can sign up for a Free Trial.
Node.js v12 or higher installed on your machine.
Nightwatch 2.6.0 or higher installed on your machine.

Integration steps

Set BrowserStack credentials

Saving your BrowserStack credentials as environment variables makes it easier to run your test suite from your local or CI environment.

Copy

Install Nightwatch plugin

Use either of the following ways to install the BrowserStack Nightwatch plugin to your project:

      
            NPM
          
            Packagejson
          
          Copy
        
npm i @nightwatch/browserstack --save-dev
"devDependencies": {
  "@nightwatch/browserstack": "^0.2.1",
}

Update your Nightwatch config file

Update your configuration file with the following parameters to run tests on BrowserStack.
At the end of this step, you will have a sample configuration file with BrowserStack capabilities to use in your project.

Add BrowserStack plugin

Add @nightwatch/browserstack to the plugins list in your configuration file.

Set platforms to test on

Set the browsers/devices you want to test within the test_settings object. Our config follows W3C formatted capabilities.

Platform	Browser
Linux	Firefox
Linux	Chrome
Linux	Edge

Enable BrowserStack Local

Test localhost/internal servers in your network

True

False

Test localhost/staging websites that are not publicly accessible

BrowserStack’s Local Testing feature connects with test suites pointing to your localhost URL

Learn more

BrowserStack Local supports all advanced use cases and restricted networks. Contact our support team for assistance in configuring BrowserStack Local for your enterprise.

BrowserStack Reporting

You can leverage BrowserStack’s extensive reporting features using the capabilities:

sessionName is the name of your test sessions and is automatically picked from your test class/spec name. It doesn’t need to be set manually when using the BrowserStack Nightwatch plugin.

Use additional debugging features

By default, BrowserStack provides prettified session logs, screenshots of every failed selenium command, and a video of the entire test. Additionally, you can enable the following features:

Use Automate Turboscale

Update configuration file with selected capabilities

Copy the following code snippet and add it to the configuration file of your test suite.

```javascript
const additonalEnvironments = require("./environments");

if(!additonalEnvironments.test_settings)
  additonalEnvironments.test_settings = {};

const bstackOptions = {
  'bstack:options' : {
    YOUR_BUILD_NAME_TYPE: "YOUR_BUILD_NAME",
    YOUR_PROJECT_NAME_TYPE: "YOUR_PROJECT_NAME",
    YOUR_DEBUG_CAPS_TYPE: "YOUR_DEBUG_CAPS",
    YOUR_NETWORK_CAPS_TYPE: "YOUR_NETWORK_CAPS",
    YOUR_CONSOLE_CAPS_TYPE: "YOUR_CONSOLE_CAPS",
    turboScale: YOUR_TURBOSCALE_CAPS,
    turboScaleOptions:
        gridName: YOUR_GRID_NAME,
    "source": "nightwatch:sample-sdk:v1.0",
    "seleniumVersion" : "4.0.0",
    userName: '${BROWSERSTACK_USERNAME}' || 'YOUR_USERNAME',
    accessKey: '${BROWSERSTACK_ACCESS_KEY}' || 'YOUR_ACCESS_KEY',
  },
}

const browserStack = {
  webdriver: {
    start_process: false,
    timeout_options: {
      timeout: 120000,
      retry_attempts: 3
    },
    keep_alive: true
  },

  selenium: {
    host: 'hub.browserstack.com',
    port: 443
  },

  desiredCapabilities: {
    browserName: 'chrome',
    ...bstackOptions
  }
}

const nightwatchConfigs = {
  src_folders: [],
  live_output: true,
  plugins: ['@nightwatch/browserstack'],
  '@nightwatch/browserstack': {
    browserstackLocal: 'YOUR_LOCAL_CAPS', opts: { forceLocal: false } // set true to manage browserstack local tunnel. Defaults to false.
  },

  test_settings: {
    default: {
      launch_url: 'https://nightwatchjs.org'
    },

    browserstack:  {
      ...browserStack
    },

    'browserstack.YOUR_FIRST_BROWSER': {
      extends: 'browserstack',
      desiredCapabilities: {
        browserName: 'YOUR_FIRST_BROWSER',
        browserVersion: 'YOUR_FIRST_BROWSER_VERSION',
        'bstack:options' : {
          os: 'YOUR_FIRST_OS',
          local: 'false'
        }
      }
    },
  }
}

for(let key in additonalEnvironments.test_settings) {
  nightwatchConfigs.test_settings[key] = {
    ...browserStack,
    ...additonalEnvironments.test_settings[key]
  };
}

module.exports = nightwatchConfigs;

Copy

Run your test suite

Your test suite is now ready to run on BrowserStack. Use the commands defined in your package.json file to run the tests.

Did this page help 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

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback

Is this page helping you?

Yes

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

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback!