lambdatest / nodejs-selenium-sample

Run test automation on cloud with Node.js and LambdaTest. This is a sample repo to help you execute Node.js framework based test scripts in parallel with LambdaTest automation testing cloud

Run Selenium Tests With Node.js On LambdaTest

Blog   ⋅   Docs   ⋅   Learning Hub   ⋅   Newsletter   ⋅   Certifications   ⋅   YouTube

     

Learn how to use Node.js environment to configure and run your JavaScript automation testing scripts on the LambdaTest Selenium cloud platform.

Table of Contents

• Pre-requisites
• Run Your First Test
• Executing The Test
• Testing Locally Hosted or Privately Hosted Projects

Pre-requisites

Before getting started with Selenium automation testing on LambdaTest, you need to:

• Download and install NodeJS. You should be having NodeJS v6 to NodeJS v16. Click here to download.
• Make sure you are using the latest version of JavaScript.
• Install npm from the official website by clicking here.
• Download Selenium JavaScript bindings from the official website. Latest versions of Selenium Client and WebDriver are ideal for running your JavaScript automation testing script on LambdaTest’s Selenium Grid.

Installing Selenium Dependencies and tutorial repo

Clone the LambdaTest’s nodejs-selenium-sample repository and navigate to the code directory as shown below:

git clone https://github.com/LambdaTest/nodejs-selenium-sample
cd nodejs-selenium-sample

You need to install the following dependencies to your package.json file:

You will need to install the selenium webdriver to make the connection to the GRID:

npm install selenium-webdriver

Create a new file as index.js in your current project or the sample folder and add the below code snippet which will call the installed driver.

// index.js
const webdriver = require('selenium-webdriver');

Setting up Your Authentication

Make sure you have your LambdaTest credentials with you to run test automation scripts on LambdaTest Selenium Grid. You can obtain these credentials from the LambdaTest Automation Dashboard or through LambdaTest Profile.

Set LambdaTest Username and Access Key in environment variables.

• For Linux/macOS:

export LT_USERNAME="YOUR_USERNAME" export LT_ACCESS_KEY="YOUR ACCESS KEY"

• For Windows:

set LT_USERNAME="YOUR_USERNAME" set LT_ACCESS_KEY="YOUR ACCESS KEY"

Connecting to The Cloud Grid

Now you can add the GRID HOST which is used to connect your current test suites to be executed on the cloud grid.

// index.js
const GRID_HOST = 'hub.lambdatest.com/wd/hub';
const gridUrl = 'https://' + USERNAME + ':' + KEY + '@' + GRID_HOST;
const driver = new webdriver.Builder().usingServer(gridUrl).withCapabilities(capabilities).build();

The above grid connect will create the Webdriver for the test suite to execute the Selenium commands for your test.

Run Your First Test

Configuration of Your Test Capabilities

In the test script, you need to update your test capabilities. In this code, we are passing browser, browser version, and operating system information, along with LambdaTest Selenium grid capabilities via capabilities object. The capabilities object in the above code are defined as:

// index.js
const capabilities = {
        build: 'NodeJS build',  // Name of the build
        name: 'Test 1',         // Name of the test
        platform: 'windows 10', // Name of Operating System
        browserName: 'chrome',  // Name of the browser
        version: '67.0',        // Version of the browser
        resolution: '1280x800', // Resolution of the screen 
        network: true,          // Enable to capture browser network logs
        visual: true,           // Enable to capture screenshot on every command
        console: true,          // Enable to capture the console log
        video: true             // Enable to capture the video recording of the test
}

Note: You can generate capabilities for your test requirements with the help of our inbuilt Capabilities Generator tool.

Writing your Test Cases

Now you write your selenium test cases in your index.js file:

function searchTextOnGoogle() {
    // navigate to a url, search for a text and get title of page
    driver.get('https://www.google.com/ncr').then(function () {
        driver.findElement(webdriver.By.name('q')).sendKeys('LambdaTest\n').then(function () {
            driver.getTitle().then(function (title) {
                setTimeout(function () {
                    console.log(title);
                    driver.executeScript('lambda-status=passed');
                    driver.quit();
                }, 5000);
            });
        });
    }).catch(function (err) {
        console.log("test failed with reason " + err)
        driver.executeScript('lambda-status=failed');
        driver.quit();
    });
}
searchTextOnGoogle();

Executing the Test

Please execute the following command below to run your tests:

npm test OR node index.js

Your test results would be displayed on the test console (or command-line interface if you are using terminal/cmd) and on LambdaTest automation dashboard. LambdaTest Automation Dashboard will help you view all your text logs, screenshots and video recording for your entire automation tests.

Testing Locally Hosted or Privately Hosted Projects

You can test your locally hosted or privately hosted projects with LambdaTest Selenium grid cloud using LambdaTest Tunnel app. All you would have to do is set up an SSH tunnel using LambdaTest Tunnel app and pass toggle tunnel = True via desired capabilities. LambdaTest Tunnel establishes a secure SSH protocol based tunnel that allows you in testing your locally hosted or privately hosted pages, even before they are made live.

Refer our LambdaTest Tunnel documentation for more information.

Here’s how you can establish LambdaTest Tunnel.

Download the binary file of:

• LambdaTest Tunnel for Windows
• LambdaTest Tunnel for Mac
• LambdaTest Tunnel for Linux

Open command prompt and navigate to the binary folder.

Run the following command:

LT -user {user’s login email} -key {user’s access key}

So if your user name is [email protected] and key is 123456, the command would be:

LT -user [email protected] -key 123456

Once you are able to connect LambdaTest Tunnel successfully, you would just have to pass on tunnel capabilities in the code shown below :

Tunnel Capability

const capabilities = {
        tunnel: true,
}

Additional Links

• Advanced Configuration for Capabilities
• How to test locally hosted apps
• How to integrate LambdaTest with CI/CD

Tutorials 📙

Check out our latest tutorials on JavaScript automation testing 👇

• How To Perform Modern Web Testing With TestCafe Using JavaScript And Selenium
• How To Implement Drag And Drop In JavaScript Using Selenium?
• Automation Testing with Selenium JavaScript [Tutorial]
• Best 9 JavaScript Testing Frameworks
• Jest vs Mocha vs Jasmine: Comparing The Top 3 JavaScript Testing Frameworks
• How To Use JavaScript Wait Function In Selenium WebDriver
• Jest Tutorial For Selenium JavaScript Testing With Examples
• Cucumber.js Tutorial with Examples For Selenium JavaScript
• Mocha JavaScript Tutorial With Examples For Selenium Testing
• How To Get Data Of Attributes In JavaScript With Selenium
• How To Take Screenshots In Selenium WebDriver Using JavaScript
• How To Use Strings In JavaScript With Selenium WebDriver
• How To Use JavaScript Wait Function In Selenium WebDriver

Documentation & Resources 📚

Visit the following links to learn more about LambdaTest's features, setup and tutorials around test automation, mobile app testing, responsive testing, and manual testing.

• LambdaTest Documentation
• LambdaTest Blog
• LambdaTest Learning Hub

LambdaTest Community 👥

The LambdaTest Community allows people to interact with tech enthusiasts. Connect, ask questions, and learn from tech-savvy people. Discuss best practises in web development, testing, and DevOps with professionals from across the globe 🌎

What's New At LambdaTest ❓

To stay updated with the latest features and product add-ons, visit Changelog

About LambdaTest

LambdaTest is a leading test execution and orchestration platform that is fast, reliable, scalable, and secure. It allows users to run both manual and automated testing of web and mobile apps across 3000+ different browsers, operating systems, and real device combinations. Using LambdaTest, businesses can ensure quicker developer feedback and hence achieve faster go to market. Over 500 enterprises and 1 Million + users across 130+ countries rely on LambdaTest for their testing needs.

Features

• Run Selenium, Cypress, Puppeteer, Playwright, and Appium automation tests across 3000+ real desktop and mobile environments.
• Real-time cross browser testing on 3000+ environments.
• Test on Real device cloud
• Blazing fast test automation with HyperExecute
• Accelerate testing, shorten job times and get faster feedback on code changes with Test At Scale.
• Smart Visual Regression Testing on cloud
• 120+ third-party integrations with your favorite tool for CI/CD, Project Management, Codeless Automation, and more.
• Automated Screenshot testing across multiple browsers in a single click.
• Local testing of web and mobile apps.
• Online Accessibility Testing across 3000+ desktop and mobile browsers, browser versions, and operating systems.
• Geolocation testing of web and mobile apps across 53+ countries.
• LT Browser - for responsive testing across 50+ pre-installed mobile, tablets, desktop, and laptop viewports

We are here to help you 🎧

• Got a query? we are available 24x7 to help. Contact Us
• For more info, visit - LambdaTest