Selenium with NodeJS

Your guide to running tests using NodeJS on BrowserStack’s Selenium Grid of 3000+ real devices and desktop browsers.

Run tests on 3000+ real devices and desktop browsers

Run a sample Build

Here’s how you can run a sample NodeJS test build in three steps on BrowserStack:

The sample test script in this section is compatible with W3C-based client bindings. Check out our JSON wire protocol-based scripts in the selenium-3 branch of the repository.

Set up the dependencies

Before you can start running your Selenium tests with NodeJS , you need to have the NodeJS language bindings installed.

Run the following command on your terminal/command-line to install the required dependencies.

Copy snippet

Configure test script

Configure the browser or device combinations

Select desktop browsers or real devices from a list of 3000+ available combinations. You can see the selected device combination in the below code snippet as capabilities:

Copy the code

Copy the following code snippet and save it in your machine. In the next step, we will run this script which will execute your first build on BrowserStack.

The following sample test case opens the bstackdemo.com website, adds a product to the cart, and verifies whether the product is added to the cart.

```javascript
const webdriver = require('selenium-webdriver');
async function runTestWithCaps (capabilities) {
  let driver = new webdriver.Builder()
    .usingServer('http://YOUR_USERNAME:YOUR_ACCESS_KEY@hub-cloud.browserstack.com/wd/hub')
    .withCapabilities({
      ...capabilities,
      ...capabilities['browser'] && { browserName: capabilities['browser']}  // Because NodeJS language binding requires browserName to be defined
    })
    .build();

    try {
    await driver.get("https://bstackdemo.com/");
    await driver.wait(webdriver.until.titleMatches(/StackDemo/i), 10000);
    // locating product on webpage and getting name of the product
    let productText = await driver
      .findElement(webdriver.By.xpath('//*[@id="1"]/p'))
      .getText();
    // clicking the 'Add to cart' button
    await driver.findElement(webdriver.By.xpath('//*[@id="1"]/div[4]')).click();
    // waiting until the Cart pane has been displayed on the webpage
    driver.findElement(webdriver.By.className("float-cart__content"));
    // locating product in cart and getting name of the product in cart
    let productCartText = await driver
      .findElement(
        webdriver.By.xpath(
          '//*[@id="__next"]/div/div/div[2]/div[2]/div[2]/div/div[3]/p[1]'
        )
      )
      .getText();
    // checking whether product has been added to cart by comparing product name
    if(productCartText !== productText)
      throw new Error("");
    await driver.executeScript(
      'browserstack_executor: {"action": "setSessionStatus", "arguments": {"status":"passed","reason": "Product has been successfully added to the cart!"}}'
    );
  } catch (e) {
    await driver.executeScript(
      'browserstack_executor: {"action": "setSessionStatus", "arguments": {"status":"failed","reason": "Some elements failed to load!"}}'
    );
  }
  await driver.quit();
}

const capabilities1 = {
    'bstack:options' : {
        "YOUR_FIRST_OS_TYPE": "YOUR_FIRST_OS",
        "YOUR_FIRST_OS_VERSION_TYPE": "YOUR_FIRST_OS_VERSION",
        "YOUR_FIRST_BROWSER_VERSION_TYPE": "YOUR_FIRST_BROWSER_VERSION",
        "buildName" : "browserstack-build-1",
        "sessionName" : "Parallel test 1",
    },
    "YOUR_FIRST_BROWSER_TYPE": "YOUR_FIRST_BROWSER"
    }
 const capabilities2 = {
    'bstack:options' : {
        "YOUR_SECOND_OS_TYPE": "YOUR_SECOND_OS",
        "YOUR_SECOND_OS_VERSION_TYPE": "YOUR_SECOND_OS_VERSION",
        "YOUR_SECOND_BROWSER_VERSION_TYPE": "YOUR_SECOND_BROWSER_VERSION",
        "buildName" : "browserstack-build-1",
        "sessionName" : "Parallel test 2",
    },
    "YOUR_SECOND_BROWSER_TYPE": "YOUR_SECOND_BROWSER"
    }
const capabilities3 = {
    'bstack:options' : {
        "YOUR_THIRD_OS_TYPE": "YOUR_THIRD_OS",
        "YOUR_THIRD_OS_VERSION_TYPE": "YOUR_THIRD_OS_VERSION",
        "YOUR_THIRD_BROWSER_VERSION_TYPE": "YOUR_THIRD_BROWSER_VERSION",
        "buildName" : "browserstack-build-1",
        "sessionName" : "Parallel test 3",
    },
    "YOUR_THIRD_BROWSER_TYPE": "YOUR_THIRD_BROWSER"
    }

runTestWithCaps(capabilities1);
runTestWithCaps(capabilities2);
runTestWithCaps(capabilities3);
```

Copy snippet

Execute build on BrowserStack

You are now ready to run your build on BrowserStack. From the root directory of this project, run the following command.

Copy snippet

Facing issues? View commonly occurring errors

Check the regular culprits

Check if the file is saved correctly and you’ve installed the required packages & libraries installed to run the test. In most cases, searching on Google is helpful.

Authentication errors

If you are facing any authentication errors, you might have not passed or passed incorrect credentials. You can find your Username and Access Key on the Account Settings page. Try running the test again and it should solve your issue!

Behind a proxy?

You might face some connection issues if you are behind a proxy as your network may be blocking traffic to browserstack.com. Just whitelist traffic to *.browserstack.com and you’re all set. If you have a complex network setup, just reach out to our Support team and they’ll work with you to get this working.

After you have successfully run your first test on BrowserStack, try integrating your test suite with BrowserStack

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!