1. Node version >=14 required

node --version

2. You can switch the node version by below command

nvm install 12.0.0
node --version

Step 1. 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"

Step 2. Clone the smartui-node-sample Repo.

git clone https://github.com/LambdaTest/smartui-node-sample

Step 3. Install Dependencies.

npm i

We have many different examples revolving around different usecases.

1. General Capability Change.

   • index.js - This Test is an example of all the advanced funtionalities possible with Smart UI

     npm start
     

   • general.js - This Test is an example of all the general test.

     npm start general
     

   • errorSetting.js - This Test is an example of how error settings can be modified.

     npm start error
     

   • transparency.js - This Test is to show how to alter the opacity of the comparison screenshot.

     npm start transparency
     

   • BoundingBoxes.js - This Test shows an example of comparing only a certain area in the screenshot.

     npm start boundingBoxes
     

   • ignoredBoxes.js - This test is for excluding certain areas in the screenshot for comparison.

     npm start ignoredBoxes
     

   • ignoreAreasColoredWith.js - This test is for removing the colored content from the comparison.

     npm start ignoreAreasColoredWith
     

If you want to execute visual regression tests on multiple resolutions, need to add capability resolution in capabilities option.

  let capabilities = {
      ...
      resolution = "1920x1080";
      ...
  }

Few common resolutions are

• 1024x768
• 1280x800
• 1600x1200
• 1920x1080
• 2560x1440

$ node custom-resolutions.js 1024x768