Integrate SmartUI SDK with Cypress Tests

---

Welcome to the world of simplified visual testing with the SmartUI SDK.

Integrating seamlessly into your existing Cypress testing suite, SmartUI SDK revolutionizes the way you approach visual regression testing. Our robust solution empowers you to effortlessly capture, compare, and analyze screenshots across a multitude of browsers and resolutions, ensuring comprehensive coverage and accuracy in your visual testing endeavors.

Prerequisites

• Basic understanding of Command Line Interface and Cypress is required.
• Login to LambdaTest SmartUI with your credentials.

The following steps will guide you in running your first Visual Regression test on LambdaTest platform using SmartUI Cypress SDK integration.

Create a SmartUI Project

The first step is to create a project with the application in which we will combine all your builds run on the project. To create a SmartUI Project, follow these steps:

1. Go to Projects page
2. Click on the new project button
3. Select the platform as CLI for executing your SDK tests.
4. Add name of the project, approvers for the changes found, tags for any filter or easy navigation.
5. Click on the Submit.

Steps to run your first test

Once you have created a SmartUI Project, you can generate screenshots by running automation scripts. Follow the below steps to successfully generate screenshots

Step 1: Create/Update your test

You can clone the sample repository to run Cyoress tests with SmartUI and use the cypress/e2e/smartuiSDKLocal.cy.js file.

git clone https://github.com/LambdaTest/smartui-cypress-sdk-sample
cd smartui-cypress-sdk-sample

Step 2: Install the Dependencies

1. Install required NPM modules for LambdaTest Smart UI Cypress SDK in your Frontend project.

npm i @lambdatest/smartui-cli @lambdatest/cypress-driver cypress@v13

2. Import the LambdaTest Cypress driver in support/e2e.js.

import '@lambdatest/cypress-driver'

3. Update your config (cypress.config.js) or plugins/index.js with the following snippet

on('task', {
        log(message) {
            console.log(message);
            return null;
        },
 });

info

SmartUI SDK only supports Cypress versions >= 10.0.0

Step 3: Configure your Project Token

Setup your project token show in the SmartUI app after, creating your project.

MacOS/Linux

export PROJECT_TOKEN="123456#1234abcd-****-****-****-************"

Windows - CMD

set PROJECT_TOKEN="123456#1234abcd-****-****-****-************"

Windows-PS

$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************"

Step 4: Create and Configure SmartUI Config

You can now configure your project configurations on using various available options to run your tests with the SmartUI integration. To generate the configuration file, please execute the following command:

npx smartui config:create .smartui.json

Once, the configuration file will be created, you will be seeing the default configuration pre-filled in the configuration file:

/smartui-sdk-project/.smartui.json

{
  "web": {
    "browsers": [
      "chrome",
      "firefox",
      "safari",
      "edge"
    ],
    "viewports": [
      [
        1920
      ],
      [
        1366
      ],
      [
        1028
      ]
    ] // Full Page screenshots are captured by default for web viewports
  },
  "mobile": {
    "devices": [
      "iPhone 14",  //iPhone 14 viewport
      "Galaxy S24"  //Galaxy S24 viewport
    ],
    "fullPage": true, //Full Page is true by default for mobile viewports
    "orientation": "portrait" //Change to "landscape" for landscape snapshot
  },
  "waitForTimeout": 1000, //Optional (Should only be used in case lazy-loading/async components are present)
  "waitForPageRender": 50000, //Optional (Should only be used in case of websites which take more than 30s to load)
  "enableJavaScript": false, //Enable javascript for all the screenshots of the project
  "allowedHostnames": [] //Additional hostnames to capture assets from
}

Advanced options in SmartUI configuration

• For capturing fullpage or viewport screenshots, please refer to this documentation
• For the list of available mobile viewports, please refer to this documentation
• For more information about SmartUI config global options, please refer to this documentation.

Step 5: Adding SmartUI function to take screenshot

• You can incorporate SmartUI into your custom Cypress test script, as shown below:

/// <reference types="cypress" />

describe('Test Case name', () => {
  beforeEach(() => {

    cy.visit('Required URL')
  })

  it('SmartUI Snapshot', () => {
    cy.smartuiSnapshot('Screenshot Name');
  })
})

Step 6: Execute the Tests on SmartUI Cloud

Execute visual regression tests on SmartUI using the following commands

npx smartui --config .smartui.json exec -- npx cypress run --spec cypress/e2e/smartuiSDKLocal.cy.js --browser chrome --headed

note

You may use the npx smartui --help command in case you are facing issues during the execution of SmartUI commands in the CLI.

View SmartUI Results

You have successfully integrated SmartUI SDK with your Cypress tests. Visit your SmartUI project to view builds and compare snapshots between different test runs.

You can see the Smart UI dashboard to view the results. This will help you identify the Mismatches from the existing Baseline build and do the required visual testing.

Arguments supported in the cy.smartUISnapshot function

The following are the different options which are currently supported:

Key	Description
t (test controller)	This object allows you to control the test execution and interact with the web page under test.
"Screenshot Name" (string)	Specify a name for the screenshot in your tests to match the same screenshot with the name from your baseline.
options (object)	Specify one or a combination of selectors in the ignoreDOM or selectDOM objects. These selectors can be based on HTML DOM IDs, CSS classes, CSS selectors, or XPaths used by your webpage. They define elements that should be excluded from or included in the visual comparison.

Handling Dynamic Data in SmartUI SDK New

When conducting visual tests, you may encounter scenarios where certain elements within your application change between test runs. These changes might introduce inconsistencies in your test results.You can ignore / select specific element(s) to be removed from the comparison by parsing the options in the cy.smartuiSnapshot function in the following way

Ignore ID

This is a sample for your configuration for Cypress to ignore by ID

let options = {
            ignoreDOM: {
                id: ["ID-1", "ID-2"],
            }
        }
cy.smartuiSnapshot(‘Screenshot Name’, options);

Ignore Class

This is a sample for your configuration for Cypress to ignore by Class

let options = {
            ignoreDOM: {
                class: ["Class-1", "Class-2"],
            }
        }
cy.smartuiSnapshot(‘Screenshot Name’, options);

Ignore XPath

This is a sample for your configuration for Cypress to ignore by XPath

let options = {
            ignoreDOM: {
                xpath: ["Xpath-1", "Xpath-2"],
            }
        }
cy.smartuiSnapshot(‘Screenshot Name’, options);

Ignore CSS Selector

This is a sample for your configuration for Cypress to ignore by CSS Selector

let options = {
            ignoreDOM: {
                cssSelector: ["CSS-Selector-1", "CSS-Selector-2"],
            }
        }
cy.smartuiSnapshot(‘Screenshot Name’, options);

Select ID

This is a sample for your configuration for Cypress to select by ID.

let options = {
            selectDOM: {
                id: ["ID-1", "ID-2"],
            }
        }
cy.smartuiSnapshot(‘Screenshot Name’, options);

Select Class

This is a sample for your configuration for Cypress to select by Class

let options = {
            selectDOM: {
                class: ["Class-1", "Class-2"],
            }
        }
cy.smartuiSnapshot(‘Screenshot Name’, options);

Select XPath

This is a sample for your configuration for Cypress to select by XPath

let options = {
            selectDOM: {
                xpath: ["Xpath-1", "Xpath-2"],
            }
        }
cy.smartuiSnapshot(‘Screenshot Name’, options);

Select CSS Selector

This is a sample for your webhook configuration for Cypress to select by CSS Selector

let options = {
            selectDOM: {
                cssSelector: ["CSS-Selector-1", "CSS-Selector-2"],
            }
        }
cy.smartuiSnapshot(‘Screenshot Name’, options);

For capturing the screenshot of a specific element

You can capture screenshots of targeted elements by leveraging various locator mechanisms such as XPath, CSS ID, class, and selectors. This precision-driven approach ensures accurate and specific visual regression testing for your web application's components.

Capture Element by ID

This is a sample for your configuration for Cypress to capture an element by ID.

let options = {
      element: {
          id: 'Required ID',
      }
  };
cy.smartuiSnapshot(‘Screenshot Name’, options);

Capture Element by Class

This is a sample for your configuration for Cypress to capture an element by Class

let options = {
      element: {
          class: 'Required Class',
      }
  };
cy.smartuiSnapshot(‘Screenshot Name’, options);

Capture Element by XPath

This is a sample for your configuration for Cypress to capture an element by XPath

let options = {
      element: {
          xpath: 'Required Xpath',
      }
  };
cy.smartuiSnapshot(‘Screenshot Name’, options);

Capture Element by Selector

This is a sample for your webhook configuration for Cypress to capture an element by CSS Selector

let options = {
      element: {
          cssSelector: 'Required CSS Selector',
      }
  };
cy.smartuiSnapshot(‘Screenshot Name’, options);

For additional information about SmartUI APIs please explore the documentation here