Selenium JavaScript SDK

Selenium with JavaScript is a robust automation framework for web testing, utilizing the Selenium WebDriver and JavaScript's flexibility to efficiently ensure the reliability and functionality of web applications across browsers.

For VisualTest's page on npm, go here.

Requirements

Node.js 18.17.0+
Selenium 3+

Set-up

Install:

npm install @smartbear/visualtest-selenium --save-dev
npx visualtest-setup

This will:

Create visualTest.config.js file.

Replace PROJECT_TOKEN with your project token in your newly created visualTest.config.js file.
```
module.exports = {projectToken: 'PROJECT_TOKEN'}
```

At each point within your functional test where you want to capture an image (fullpage, viewport, or element) for regression testing, call the capture method:

// Fullpage screenshot
await sbvtCapture(driver, 'homepage')

// Viewport screenshot
await sbvtCapture(driver, 'homepage-viewport', {
    viewport: true
})

// Element screenshot 
await driver.get('https://selenium.dev/')
const element = await driver.findElement({css: '.row'});
await sbvtCapture(driver, 'element-capture', {
    element
});

Execute Selenium tests in the usual manner.
Once your test is complete, VisualTest adds a tile to your Test Runs screen, where you can review and accept any found image differences.

Customizing VisualTest

VisualTest allows script customizations that improve the quality of your testing. This section provides ways to optimize your test scripts.

Over-ride Comparison Mode

VisualTest is set to the detailed comparison mode by default (see the Comparison Mode section for more information). You can change this setting to layout mode by going to Settings.

If your tests need a combination of detailed and layout modes, you can code a given screen capture to override what you have in Settings. Below is an example. Choose from the following options:

Variable	Options
`comparisonMode`	`'detailed'`
	`'layout'`

Variable	Options
`sensitivity` (layout mode only)	`'low'`
	`'medium'`
	`'high'`

await driver.get('https://smartbear.github.io/visual-testing-example-website/Example4/Original/index.html');
await sbvtCapture(driver, 'layout-mode', {
    comparisonMode: 'layout',
    sensitivity: 'low', // 'medium', or 'high'
    lazyload: 250
});

Assign Captures to a Test Group Name

To organize your captures, assign them the same test group name using one of the following methods:

//visualtest.config.js
module.exports = {
    projectToken: 'PROJECT_TOKEN',
    testGroupName: 'test group name'
}
// OR save on the environment variable 
// SBVT_TEST_GROUP_NAME = 'test group name'

Explore and manage your grouped test runs effortlessly by clicking the list view icon . Easily review and navigate through the organized test runs, all while retaining access to the detailed specifics of each individual test run.

Lazy-loading Sites

The below runs fullpage regression tests for lazy-loaded websites, setting time to elapse between scrolls. Note that the value (1000) is the number of milliseconds to wait between scrolls:

await sbvtCapture(driver, 'Lazy loaded', {
    lazyload: 1000 //1 second
})

For code examples that handle dynamic, moving content, see Screenshot Consistency.

Reporting in Console Output

For this, add the following code at the end of the test:

const {sbvtPrintReport} = require("@smartbear/visualtest-selenium");

// Implement your Selenium test code here

// After your test(s) have run
await sbvtPrintReport();

It produces results in this format:

Assert Comparison Results

You can aggregate all passed and failed VisualTest comparisons with the following assert:

const {sbvtGetTestRunResult} = require("@smartbear/visualtest-selenium");
const assert = require("assert");

// Implement your Selenium test code here  

// After your test(s) have run    
const sbvtReport = await sbvtGetTestRunResult();
assert(sbvtReport.failed === 0); //assert for no comparison differences