SmartUI SDK Capabilities

SmartUI SDK provides several capabilities that allow you to configure your visual regression tests. These capabilities can be added to your test configuration to control various aspects of the testing process.

Important

These capabilities only work when running tests on the TestMu AI Automation Grid. For local test executions, please refer to the standard authentication methods using project token or project name in the Running your first project documentation.

Prerequisites

Before using SmartUI SDK capabilities, ensure you have the following minimum versions installed:

• SmartUI CLI version >= 4.1.0
• For Java SDK: SmartUI SDK version >= 1.0.7
• For JavaScript: Selenium WebDriver version >= 1.0.7

Available Capabilities

For JavaScript

Verified

let capabilities = {
  platform: "catalina",
  browserName: "chrome",
  version: "latest",
  "LT:Options": {
    username: USERNAME,
    accessKey: KEY,
    project: "ElementSS-MobileConfig",
    w3c: true,
    name: "Test Name", // name of the test
    build: "Automation Build Name", // name of the build
    "smartUI.project": "YOUR_PROJECT_NAME",
    "smartUI.build": "YOUR_BUILD_NAME",
    "smartUI.baseline": true,
  },
};

For Java

Verified

DesiredCapabilities capabilities = new DesiredCapabilities();
capabilities.setCapability("platform", "Windows 10");
capabilities.setCapability("browserName", "chrome");
capabilities.setCapability("version", "latest");

HashMap<String, Object> ltOptions = new HashMap<String, Object>();
ltOptions.put("username", "YOUR_USERNAME");
ltOptions.put("accessKey", "YOUR_ACCESS_KEY");
ltOptions.put("w3c", true);
ltOptions.put("name", "Test Name");
ltOptions.put("build", "Automation Build Name");
ltOptions.put("smartUI.project", "YOUR_PROJECT_NAME");
ltOptions.put("smartUI.build", "SmartUI_BUILD_NAME");
ltOptions.put("smartUI.baseline", true);

capabilities.setCapability("LT:Options", ltOptions);

Capability Descriptions

smartUI.project

This capability specifies the project Name where your screenshots will be stored and compared. You can add an existing project name or create a new project name.

smartUI.build

This capability allows you to group your screenshots into specific builds. This is particularly useful when you want to organize your screenshots and compare them against specific baselines. The build name should be unique and descriptive to help identify the purpose of that particular test run.

smartUI.baseline

This boolean capability determines whether the current build should be set as the baseline for future comparisons. When set to true, the build will be automatically approved and set as the baseline build. This capability works in conjunction with the Git branching strategy, meaning it will also update the baseline branch accordingly.

smartUI.tags

An array of strings that adds tags to the SmartUI project, for example ["regression", "checkout-flow"]. Tags are only ever added, never removed, and each run may send up to 50 tags of up to 50 characters. See Set Project Tags from Code for the full rules.

Note

If you need capabilities' support for SDKs other than Selenium Java and JavaScript, please contact support@testmuai.com. Our team will be happy to assist you with integrating SmartUI capabilities into your preferred testing framework.