• October 18, 2023

Node Js Selenium Webdriver

selenium-webdriver - npm

selenium-webdriver – npm

Selenium is a browser automation library. Most often used for testing
web-applications, Selenium may be used for any task that requires automating
interaction with the browser.
Selenium may be installed via npm with
npm install selenium-webdriver
You will need to download additional components to work with each of the major
browsers. The drivers for Chrome, Firefox, and Microsoft’s IE and Edge web
browsers are all standalone executables that should be placed on your system
PATH. Apple’s safaridriver is shipped with Safari 10 for OS X El Capitan and
macOS Sierra. You will need to enable Remote Automation in the Develop menu of
Safari 10 before testing.
Internet Explorer
The sample below and others are included in the example directory. You may
also find the tests for selenium-webdriver informative.
const {Builder, By, Key, until} = require(‘selenium-webdriver’);
(async function example() {
let driver = await new Builder(). forBrowser(‘firefox’)();
try {
await (”);
await ndElement((‘q’)). sendKeys(‘webdriver’, );
await (until. titleIs(‘webdriver – Google Search’), 1000);} finally {
await ();}})();
Using the Builder API
The Builder class is your one-stop shop for configuring new WebDriver
instances. Rather than clutter your code with branches for the various browsers,
the builder lets you set all options in one flow. When you call
Builder#build(), all options irrelevant to the selected browser are dropped:
const webdriver = require(‘selenium-webdriver’);
const chrome = require(‘selenium-webdriver/chrome’);
const firefox = require(‘selenium-webdriver/firefox’);
let driver = new er(). forBrowser(‘firefox’). setChromeOptions(/*… */). setFirefoxOptions(/*… */)
Why would you want to configure options irrelevant to the target browser? The
Builder’s API defines your default configuration. You can change the target
browser at runtime through the SELENIUM_BROWSER environment variable. For
example, the example/ script is configured to run against
Firefox. You can run the example against other browsers just by changing the
runtime environment
# cd node_modules/selenium-webdriver
node example/google_search
SELENIUM_BROWSER=chrome node example/google_search
SELENIUM_BROWSER=safari node example/google_search
The Standalone Selenium Server
The standalone Selenium Server acts as a proxy between your script and the
browser-specific drivers. The server may be used when running locally, but it’s
not recommend as it introduces an extra hop for each request and will slow
things down. The server is required, however, to use a browser on a remote host
(most browser drivers, like the IEDriverServer, do not accept remote
To use the Selenium Server, you will need to install the
JDK and
download the latest server from Selenium. Once downloaded, run the
server with
java -jar
You may configure your tests to run against a remote server through the Builder
let driver = new er(). usingServer(‘localhost:4444/wd/hub’)
Or change the Builder’s configuration at runtime with the SELENIUM_REMOTE_URL
environment variable:
SELENIUM_REMOTE_URL=”localhost:4444/wd/hub” node
You can experiment with these options using the example/
script provided with selenium-webdriver.
API documentation is available online from the Selenium project.
Additional resources include
the #selenium channel on freenode IRC
the list
SeleniumHQ documentation
Contributions are accepted either through GitHub pull requests or patches
via the Selenium issue tracker.
Node Support Policy
Each version of selenium-webdriver will support the latest semver-minor
version of the LTS and stable Node releases. All semver-major &
semver-minor versions between the LTS and stable release will have “best
effort” support. Following a Selenium release, any semver-minor Node releases
will also have “best effort” support. Releases older than the latest LTS,
semver-major releases, and all unstable release branches (e. g. “”)
are considered strictly unsupported.
For example, suppose the current LTS and stable releases are v6. 9. 5 and v7. 5. 0,
respectively. Then a Selenium release would have the following support levels:
<= 6. 8 unsupported 6. 9 supported 7. 0-4 best effort 7. 5 >= 7. 5
Support Level Definitions
supported: A selenium-webdriver release will be API compatible with the
platform API, without the use of runtime flags.
best effort: Bugs will be investigated as time permits. API compatibility is
only guaranteed where required by a supported release. This effectively
means the adoption of new JS features, such as ES2015 modules, will depend
on what is supported in Node’s LTS.
unsupported: Bug submissions will be closed as will-not-fix and API
compatibility is not guaranteed.
Projected Support Schedule
If Node releases a new LTS each October and a new major version every 6
months, the support window for selenium-webdriver will be roughly:
8. 9
9. 0
8. x
10. 0
10. x
11. 0
12. 0
12. x
13. 0
Please report any issues using the Selenium issue tracker. When using
the issue tracker
Do include a detailed description of the problem.
Do include a link to a gist with any
interesting stack traces/logs (you may also attach these directly to the bug
Do include a reduced test case. Reporting “unable to find
element on the page” is not a valid report – there’s nothing for us to
look into. Expect your bug report to be closed if you do not provide enough
information for us to investigate.
Do not use the issue tracker to submit basic help requests. All help
inquiries should be directed to the user forum or #selenium IRC
Do not post empty “I see this too” or “Any updates? ” comments. These
provide no additional information and clutter the log.
Do not report regressions on closed bugs as they are not actively
monitored for updates (especially bugs that are >6 months old). Please open a
new issue and reference the original bug in your report.
Licensed to the Software Freedom Conservancy (SFC) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The SFC licenses this file
to you under the Apache License, Version 2. 0 (the
“License”); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
Run Selenium tests with NodeJS | BrowserStack Docs

Run Selenium tests with NodeJS | BrowserStack Docs

Your guide to running Selenium Webdriver tests with NodeJS on BrowserStack.
BrowserStack gives you instant access to our Selenium Grid of 2000+ real devices and desktop browsers. Running your Selenium tests with NodeJS on BrowserStack is simple. This guide will help you:
Run your first test
Mark tests as passed or failed
Debug your app
Before you can start running your Selenium tests with Node JS, ensure the following libraries are installed:
# Use npm package manager to install selenium web driver
npm install -g selenium-webdriver
If you have added any new package and added dependency on your test script, don’t forget to run npm update
To get started, let’s run a simple Selenium Webdriver test. The NodeJS script below opens, input a search string, submits the form, and returns the page title. It also marks the test as passed or failed based on the page title
Step 1 – Select the OS and device/browser combination
Select the OS and Device/Browser combination you’d like to test on using the drop-down menus below. This will automatically update the NodeJS code sample below:
Look for the icon to select a real device.
The () statement is required, otherwise the test continues to execute, leading to a timeout.
Step 2 – Run the sample test code
Copy the code sample into your code editor, save it as file, and execute the test from your command line.
Command Line
You can use our capability builder and select from a wide range of custom capabilities that BrowserStack supports.
Step 3 – Verify the results
Once the test has run successfully, it is time to verify the results. The Selenium Webdriver test should have opened a URL, inputted a string, submitted the form, returned the page title and marked the test as passed or failed based on the returned title.
Your results will be displayed on the command-line interface and on the Automate dashboard, where you can see Text Logs, Screenshots of every Selenium command, and a Video Recording of your entire test. (Read more about viewing test results and debugging failed tests)
BrowserStack does not know whether your test’s assertions have passed or failed because only the test script knows whether the assertions have passed. Therefore, based on the assertions on your script, you have to explicitly inform BrowserStack whether your tests have passed or not and this document will help you in doing that exactly.
It is possible to mark tests as either a pass or a fail and also give a reason for the same, using the following snippet (Refer the above sample script for complete script implementing this snippet):
// For marking test as passed
driver. executeScript(‘browserstack_executor: {“action”: “setSessionStatus”, “arguments”: {“status”:”passed”, “reason”: “Yaay! my sample test passed”}}’);
// For marking test as failed
driver. executeScript(‘browserstack_executor: {“action”: “setSessionStatus”, “arguments”: {“status”:”failed”, “reason”: “Oops! my sample test failed”}}’);
The arguments passed in the JavaScript method for setting the status and the corresponding reason for the test are status and reason.
status accepts either passed or failed as the value
reason accepts a value in string datatype
Marking test as pass/fail is also possible using our REST API at any point in the test or also after the test has concluded. You can read more about marking test using REST API and use it, if it fits your use case.
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 capability to true:
var capabilities = {
”: ‘true’}
Sample Visual Logs from Automate Dashboard:
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.
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:
Migrate existing tests to BrowserStack
Run multiple tests in parallel to speed up the build execution
Test on private websites that are hosted on your internal networks
Select browsers and devices where you want to test
Set up your CI/CD: Jenkins, Bamboo, TeamCity, Azure, CircleCI, BitBucket, TravisCI, GitHub Actions
We’re sorry to hear that. Please share your feedback so we can do better
This page doesn’t have what I am looking for
The content / code samples on this page are inaccurate or outdated
This page is difficult to understand
Unable to find relevant documentation for my use case
Other (please tell us more below)
Help us understand your problem 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
Any additional feedback?
Thank you for your valuable feedback
How to setup Selenium on Node - Medium

How to setup Selenium on Node – Medium

Your guide to setting up and using Selenium with NodeSelenium is one of the most powerful testing suites with a bunch of tools commonly used for testing purposes. It basically opens up a web page automatically in the web browser and provides useful tools for checks page contents for errors, and/or inducing interaction with the page like clicking on buttons, entering input data and so lenium has a suite of tools that includes: Selenium IDE, Selenium WebDriver, Selenium Grid, and Selenium Standalone lenium WebDriver is a free, open-source, portable software-testing framework for testing web applications quickly. It provides a common application programming interface (API) for browser simply a library that you call from your code, which executes your commands on the browser of your of the good things about Selenium is, developers can write tests for Selenium WebDriver in any of the programming languages supported by the Selenium project, including Java, C#, Ruby, Python, and JavaScript (named Bindings) this article, we’ll explore how to install and setup Selenium/Selenium Webdriver for testing on the node environment. We will also look at how to integrate your local testing environment with third-party tools like BrowserStack, SauceLabs and test runner like first thing we need to do is to set up a new NPM project and install our testing library. We’ll be using a library called selenium-webdriver which is the official library for using Selenium on node environment. There are other alternatives like and Nightwatch. jsmkdir node_testing && cd node_testingnpm init -ynpm install selenium-webdriverThe next thing to do is to download the right web driver for the browser you will be testing on. You can find details of the list of available web drivers and where to download them from this page. In this article, we’ll be showing both Firefox and Chrome, as they are available on almost all Operating over to the GeckoDriver (for Firefox) or ChromeDriver driver page and download the latest driver for your operating system. Unzip it content into somewhere fairly easy to navigate to, like the root of your home user the next thing is to add the chrome driver or gecko driver’s location to your system PATH variable and it should be an absolute path from the root of your home directory, to the directory containing the instance, if you are on Linux and your username is toby, and the downloaded driver is placed in the root of your home directory, the path would be /home/toby and it was Mac Os it would be /Users/toby set your Path in Linux/Mac OS you need to add the export command to the terminal profile you are you are using Bash terminal you can open. bash_profile (or) file and if you are using ZSH. To open the files, you need to use your terminal or head over to the file and edit it you want to use your terminal, open your terminal and use any of the below commands:$ open. bashrcor $ nano. bashrcAfter opening it, paste the below at the end of the file:#Add WebDriver browser drivers to PATH#export PATH=$PATH:export PATH=$PATH:/home/tobyOnce that’s done, save and close the file, then restart your terminal to apply the changes. To confirm if your new path is in the PATH variable do echo $PATH and see what’s printed in the set your PATH in Windows, you will, first of all, get the path where the driver is download and use the System Environment windows to load your paths. You should watch the below video:To test if your driver is set PATH successfully, you can try running the name of the driver in your terminal:chromedriverYou should get something like below:Once you have successfully set up your PATH, the next thing is to see how to write and run selenium tests on Node using the Webdriver or Selenium the npm project, we created earlier, create a new file, give it any name and open it in any code editor of your let’s run a simple Selenium Webdriver test. The script below will open a chrome browser, input a term, submit the form, and return the page title. If the test is successful, then it should print out Test passedconst webdriver = require(‘selenium-webdriver’), By =, until =;const driver = new er(). forBrowser(‘chrome’) ();(”)(function(){ndElement((‘q’)). sendKeys(‘webdrivern’)(function(){ tTitle()(function(title) { (title) if(title === ‘webdriver – Google Search’) { (‘Test passed’);} else { (‘Test failed’);} ();});});});To run the script, in your terminal, ensure you are inside your project directory, then run the below command:node if there’s no error, you should see an instance of Chrome or Firefox browser opening up, navigating to and search the term webdriver. Then finally it should print out Test passed when all goes lenium Grid is a part of the Selenium Suite that helps in running multiple tests across different browsers, operating systems, and machines in parallel. Selenium Grid is a smart proxy server that allows Selenium tests to route commands to remote web browser are some third party integrations of Selenium grid:On BrowserStackYou can run your Selenium Test remotely using Selenium Grid on BrowserStack. BrowserStack gives you immediate access to the Selenium Grid of 2000+ real devices and desktop browsers. Running your Selenium tests with NodeJS on BrowserStack is quite nning Selenium tests on BrowserStack requires a username and an access key. To obtain your username and access keys, you’ll need to sign up for a Free you have acquired your access keys, let’s see how to run our tests on, you’ll need to decide on the OS and Device/Browser combination you’d like to test the same project directory, create a new file called and open it in your code editor:const webdriver = require(‘selenium-webdriver’), By =, until =;var capabilities = { ‘browserName’: ‘Chrome’, ‘browser_version’: ’81. 0′, ‘os’: ‘Windows’, ‘os_version’: ’10’, ‘resolution’: ‘1024×768’, ”: ‘USERNAME’, ”: ‘ACCESS_KEY’, ‘name’: ‘Bstack-[Node] Sample Test’}var driver = new er(). usingServer(”). withCapabilities(capabilities). build();(”)(function(){ ndElement((‘q’)). sendKeys(‘webdrivern’)(function(){ tTitle()(function(title) { (title); if(title === ‘webdriver – Google Search’) { (‘Test passed’);} else { (‘Test failed’);} ();});});});You’ll need to replace the USERNAME and ACCESS_KEY with your username and your access keyTo run the script, open up your terminal and run node should have opened a URL, input a search term *webdriver`, submitted the form, and returned the page title. The results will be displayed in your terminal like before and now on the BrowserStack Automate dashboard, where you can see Text Logs, Screenshots of every Selenium command, and a Video Recording of your entire Sauce LabsSauceLabs works similarly to BrowserStack and uses Selenium Grid to run selenium tests rewrite the tests above in BrowserStack:const webdriver = require(‘selenium-webdriver’), By =, until =, username = “USERNAME”, accessKey = “ACCESS_KEY”;let driver = new er(). withCapabilities({ ‘browserName’: ‘chrome’, ‘platform’: ‘Windows XP’, ‘version’: ’43. 0′, ‘username’: username, ‘accessKey’: accessKey}). usingServer(“” + username + “:” + accessKey + “”) ();(”);ndElement((‘q’)). sendKeys(‘webdriver’);(1000)(function() { ndElement((‘q’)). sendKeys();});ndElement((‘btnK’))();(2000)(function() { tTitle()(function(title) { (title); if(title === ‘webdriver – Google Search’) { (‘Test passed’);} else { (‘Test failed’);}});});();From your Sauce Labs user settings, you can get your user name and access key. Replace the USERNAME and ACCESS_KEY in the variable with your actual user name and access key run your tests, open your terminal in the project directory and run:node should tun your tests and result will be shown in your terminal. Just like Browserstack, if you go to your Sauce Labs dashboard page, you’ll see all your tests listed; from there you’ll be able to see videos, screenshots, and other such data of each is a testing framework that can be used to run multiple test case scenarios in Selenium. It simply a library that helps you run code, where you’ll be able to point out the part with the issue, also gives the coverage of code as a way of knowing what code impacts what comes with a bunch of testing features and power with it simple API interface and makes writing unit tests much start using mocha, all you need is to install it and write some test:npm install –save-dev mochaRun the above command on the terminal in your project directory to install create file:To run the tests, we can now do:node that’s done you should be able to see the results of the tests printed out one after the other in terminal. TestCraft is a powerful test automation platform for regression and continuous testing, as well as monitoring of web applications. All these are possible without a single line of code. TestCraft is built on Selenium and makes you write your automated tests with zero code. With TestCraft, you can visually create automated, Selenium-based tests using a drag and drop interface, and run them on multiple browsers and work environments, simultaneously. No coding skills needed to get also has support for End to End testing with any OS, Device, or Browser you want to test on. You can basically run your tests on multiple platforms with a single push of a TestCraft, you can write Frontend and UI Testing easily with no single start using TestCraft, you’ll first of all need to Sign up for a free TestCraft, you’ll be able to:Create a Custom Test Scenarios: Using the Drag and Drop tool, you can easily create test flows and scenarios depending on what part of the web app you want to Tests on Multiple Platforms: After writing and building your tests, right from TestCraft you can run your tests simultaneously on multiple platforms, environments, and oduce Comprehensive Reports: After running your tests, TestCraft is able to produce comprehensive reports of how your tests perform and what parts needed to be fixed. These reports usually include videos and screenshots pointing out the part with errors and needed Tests Using AI: TestCraft has a unique feature of using AI to automatically fix any broken tests due to changes in your web application to reduce back and forth on development and this article, we have been able to explore various ways to use selenium on Node Environment. Additionally, it is also possible to integrate Selenium and related tools like Sauce Labs and BrowserStack with continuous integration (CI) tools like have also seen how we can write and run tests on multiple platforms simultaneously without writing a single code using just you enjoyed this article, kindly clap and share it with others.

Frequently Asked Questions about node js selenium webdriver

Can Selenium be used with node js?

BrowserStack gives you instant access to our Selenium Grid of 2000+ real devices and desktop browsers. Running your Selenium tests with NodeJS on BrowserStack is simple.

What is Selenium WebDriver node?

Your guide to setting up and using Selenium with Node It basically opens up a web page automatically in the web browser and provides useful tools for checks page contents for errors, and/or inducing interaction with the page like clicking on buttons, entering input data and so on.Apr 21, 2020

What is Selenium WebDriver JS?

js). Selenium WebDriver with JavaScript is a favorable combination to perform automated UI testing of applications. JavaScript offers efficiency with its well built and structured patterns and functions, making the script more compact. It offers security and is well supported by a large community of developers.Apr 16, 2020

Leave a Reply

Your email address will not be published. Required fields are marked *