Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,5 @@

npm-debug.log*
yarn-debug.log*
yarn-error.log*
yarn-error.log*
pnpm-lock.yaml
Binary file modified assets/images/smart-visual-testing/delete.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/smart-visual-testing/github-app-installed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/smart-visual-testing/github-app-landing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/smart-visual-testing/guided-walkthrough/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/smart-visual-testing/guided-walkthrough/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/smart-visual-testing/smart-ignore/Dropdown-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/smart-visual-testing/smartui-project-token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 8 additions & 8 deletions docs/html-dom-smartui-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The following are the different options which are currently supported:
<Tabs className="docs__val" groupId="framework">
<TabItem value="IgnoreID" label="Ignore ID" default>

```js title="This is a sample for your webhook configuration for Javascript to ignore by ID"
```js title="This is a sample for your webhook configuration for JavaScript to ignore by ID"
let config = {
screenshotName: "Ignore-ID",
fullPage: false, //You can make this property as true in case of Chrome browser
Expand All @@ -82,7 +82,7 @@ await driver.executeScript("smartui.takeScreenshot", config);
</TabItem>
<TabItem value="IgoreClass" label="Ignore Class">

```js title="This is a sample for your webhook configuration for Javascript to ignore by Class"
```js title="This is a sample for your webhook configuration for JavaScript to ignore by Class"
let config = {
screenshotName: "Ignore-Class",
fullPage: false, //You can make this property as true in case of Chrome browser
Expand All @@ -96,7 +96,7 @@ await driver.executeScript("smartui.takeScreenshot", config);
</TabItem>
<TabItem value="IgnoreXPath" label="Ignore XPath">

```js title="This is a sample for your webhook configuration for Javascript to ignore by XPath"
```js title="This is a sample for your webhook configuration for JavaScript to ignore by XPath"
let config = {
screenshotName: "Ignore-XPath",
fullPage: false, //You can make this property as true in case of Chrome browser
Expand All @@ -111,7 +111,7 @@ await driver.executeScript("smartui.takeScreenshot", config);

<TabItem value="IgnoreSelector" label="Ignore CSS Selector">

```js title="This is a sample for your webhook configuration for Javascript to ignore by CSS Selector"
```js title="This is a sample for your webhook configuration for JavaScript to ignore by CSS Selector"
let config = {
screenshotName: "Ignore-cssSelector",
fullPage: false, //You can make this property as true in case of Chrome browser
Expand All @@ -128,7 +128,7 @@ await driver.executeScript("smartui.takeScreenshot", config);
<Tabs className="docs__val" groupId="framework">
<TabItem value="SelectID" label="Select ID" default>

```js title="This is a sample for your webhook configuration for Javascript to select by ID."
```js title="This is a sample for your webhook configuration for JavaScript to select by ID."
let config = {
screenshotName: "Select-ID",
fullPage: false, //You can make this property as true in case of Chrome browser
Expand All @@ -142,7 +142,7 @@ await driver.executeScript("smartui.takeScreenshot", config);
</TabItem>
<TabItem value="SelectClass" label="Select Class">

```js title="This is a sample for your webhook configuration for Javascript to select by Class"
```js title="This is a sample for your webhook configuration for JavaScript to select by Class"
let config = {
screenshotName: "Select-Class",
fullPage: false, //You can make this property as true in case of Chrome browser
Expand All @@ -156,7 +156,7 @@ await driver.executeScript("smartui.takeScreenshot", config);
</TabItem>
<TabItem value="SelectXPath" label="Select XPath">

```js title="This is a sample for your webhook configuration for Javascript to select by XPath"
```js title="This is a sample for your webhook configuration for JavaScript to select by XPath"
let config = {
screenshotName: "Select-XPath",
fullPage: false, //You can make this property as true in case of Chrome browser
Expand All @@ -171,7 +171,7 @@ await driver.executeScript("smartui.takeScreenshot", config);

<TabItem value="SelectSelector" label="Select CSS Selector">

```js title="This is a sample for your webhook configuration for Javascript to select by CSS Selector"
```js title="This is a sample for your webhook configuration for JavaScript to select by CSS Selector"
let config = {
screenshotName: "Select-cssSelector",
fullPage: false, //You can make this property as true in case of Chrome browser
Expand Down
2 changes: 1 addition & 1 deletion docs/hyperexecute-smart-ui-test-using-playwright.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ You can use your own project to configure and test it. For demo purposes, we are
:::tip Sample repo
Download or Clone the code sample for the Playwright JavaScript from the LambdaTest GitHub repository to run the tests on the HyperExecute.

<a href="https://github.com/LambdaTest/HyperExecute-Playwright-Vanilla-Javascript/tree/smart-ui" className="github__anchor"><img loading="lazy" src={require('../assets/images/icons/github.png').default} alt="Image" className="doc_img"/> View on GitHub</a>
<a href="https://github.com/LambdaTest/HyperExecute-Playwright-Vanilla-JavaScript/tree/smart-ui" className="github__anchor"><img loading="lazy" src={require('../assets/images/icons/github.png').default} alt="Image" className="doc_img"/> View on GitHub</a>
:::

If you are using your own project, make sure you update the **CDP endpoint** in your tests file.
Expand Down
16 changes: 8 additions & 8 deletions docs/hyperexecute-smart-ui-testing-using-selenium.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ Here you can see the difference.
<Tabs className="docs__val" groupId="framework">
<TabItem value="IgnoreID" label="Ignore ID" default>

```js title="This is a sample for your webhook configuration for Javascript to ignore by ID"
```js title="This is a sample for your webhook configuration for JavaScript to ignore by ID"
let config = {
screenshotName: "Ignore-ID",
fullPage: false, //You can make this property as true in case of Chrome browser
Expand All @@ -262,7 +262,7 @@ await driver.executeScript("smartui.takeScreenshot", config);
</TabItem>
<TabItem value="IgoreClass" label="Ignore Class">

```js title="This is a sample for your webhook configuration for Javascript to ignore by Class"
```js title="This is a sample for your webhook configuration for JavaScript to ignore by Class"
let config = {
screenshotName: "Ignore-Class",
fullPage: false, //You can make this property as true in case of Chrome browser
Expand All @@ -276,7 +276,7 @@ await driver.executeScript("smartui.takeScreenshot", config);
</TabItem>
<TabItem value="IgnoreXPath" label="Ignore XPath">

```js title="This is a sample for your webhook configuration for Javascript to ignore by XPath"
```js title="This is a sample for your webhook configuration for JavaScript to ignore by XPath"
let config = {
screenshotName: "Ignore-XPath",
fullPage: false, //You can make this property as true in case of Chrome browser
Expand All @@ -291,7 +291,7 @@ await driver.executeScript("smartui.takeScreenshot", config);

<TabItem value="IgnoreSelector" label="Ignore CSS Selector">

```js title="This is a sample for your webhook configuration for Javascript to ignore by CSS Selector"
```js title="This is a sample for your webhook configuration for JavaScript to ignore by CSS Selector"
let config = {
screenshotName: "Ignore-cssSelector",
fullPage: false, //You can make this property as true in case of Chrome browser
Expand All @@ -308,7 +308,7 @@ await driver.executeScript("smartui.takeScreenshot", config);
<Tabs className="docs__val" groupId="framework">
<TabItem value="SelectID" label="Select ID" default>

```js title="This is a sample for your webhook configuration for Javascript to select by ID."
```js title="This is a sample for your webhook configuration for JavaScript to select by ID."
let config = {
screenshotName: "Select-ID",
fullPage: false, //You can make this property as true in case of Chrome browser
Expand All @@ -322,7 +322,7 @@ await driver.executeScript("smartui.takeScreenshot", config);
</TabItem>
<TabItem value="SelectClass" label="Select Class">

```js title="This is a sample for your webhook configuration for Javascript to select by Class"
```js title="This is a sample for your webhook configuration for JavaScript to select by Class"
let config = {
screenshotName: "Select-Class",
fullPage: false, //You can make this property as true in case of Chrome browser
Expand All @@ -336,7 +336,7 @@ await driver.executeScript("smartui.takeScreenshot", config);
</TabItem>
<TabItem value="SelectXPath" label="Select XPath">

```js title="This is a sample for your webhook configuration for Javascript to select by XPath"
```js title="This is a sample for your webhook configuration for JavaScript to select by XPath"
let config = {
screenshotName: "Select-XPath",
fullPage: false, //You can make this property as true in case of Chrome browser
Expand All @@ -351,7 +351,7 @@ await driver.executeScript("smartui.takeScreenshot", config);

<TabItem value="SelectSelector" label="Select CSS Selector">

```js title="This is a sample for your webhook configuration for Javascript to select by CSS Selector"
```js title="This is a sample for your webhook configuration for JavaScript to select by CSS Selector"
let config = {
screenshotName: "Select-cssSelector",
fullPage: false, //You can make this property as true in case of Chrome browser
Expand Down
4 changes: 2 additions & 2 deletions docs/lambdatest-capability-map.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Below are the capabilities of BrowserStack and LambdaTest to help teams map Brow

<Tabs className="docs__val">

<TabItem value="ios" label="BrowserStack Capablities" default>
<TabItem value="ios" label="BrowserStack Capabilities" default>

```js
MutableCapabilities capabilities = new MutableCapabilities();
Expand Down Expand Up @@ -151,7 +151,7 @@ Below are the capabilities of Sauce Labs and LambdaTest to help teams map Sauce

<Tabs className="docs__val">

<TabItem value="ios" label="Sauce Labs Capablities" default>
<TabItem value="ios" label="Sauce Labs Capabilities" default>

```js
SafariOptions browserOptions = new SafariOptions();
Expand Down
4 changes: 2 additions & 2 deletions docs/legacy-test-platform-to-lambdatest.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Add your capabilities using the [LambdaTest Capabilities Generator](https://www.

<Tabs className="docs__val">

<TabItem value="android" label="Selenium 4 LambdaTest Capablities" default>
<TabItem value="android" label="Selenium 4 LambdaTest Capabilities" default>

```js
SafariOptions browserOptions = new SafariOptions();
Expand All @@ -185,7 +185,7 @@ browserOptions.setCapability("LT:Options", ltOptions);
```
</TabItem>

<TabItem value="ios" label="Selenium 3 LambdaTest Capablities" default>
<TabItem value="ios" label="Selenium 3 LambdaTest Capabilities" default>

```js
DesiredCapabilities capabilities = new DesiredCapabilities();
Expand Down
2 changes: 1 addition & 1 deletion docs/smart-ui-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co
></script>
SmartUI Testing is a technique used by designers and front-end testers to ensure the visual consistency of web applications by employing a sort of testing called **"Visual Regression"**.

In Visual Regression testing, we compare screenshots and identify visual variations in the pixels. It is integrated with Lambdatest's HyperExecute, allowing you to execute **Smart UI** Tests on the platform.
In Visual Regression testing, we compare screenshots and identify visual variations in the pixels. It is integrated with LambdaTest's HyperExecute, allowing you to execute **SmartUI** Tests on the platform.

## Features of SmartUI Testing
HyperExecute's SmartUITesting offers the following features:
Expand Down
8 changes: 4 additions & 4 deletions docs/smartui-appium-hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ let capabilities = {
//highlight-end
};

// Connecting to the Lambdatest appium Cloud Grid with SmartUI
// Connecting to the LambdaTest appium Cloud Grid with SmartUI
let gridUrl =
"https://" +
"<Your Username>" +
Expand Down Expand Up @@ -345,7 +345,7 @@ ignoreBoxes.put("xpath", new String[]{
});

configIgnore.put("ignoreBoxes", ignoreBoxes);
((JavascriptExecutor) driver).executeScript("smartui.takeScreenshot", configIgnore);
((JavaScriptExecutor) driver).executeScript("smartui.takeScreenshot", configIgnore);

```
</TabItem>
Expand Down Expand Up @@ -433,7 +433,7 @@ driver.Execute("smartui.takeScreenshot=<Your Screenshot Name>");
<TabItem value='java-1' label='Java' default>

```java
((JavascriptExecutor)driver).executeScript("smartui.takeScreenshot=<Your Screenshot Name>");
((JavaScriptExecutor)driver).executeScript("smartui.takeScreenshot=<Your Screenshot Name>");
```

</TabItem>
Expand Down Expand Up @@ -497,7 +497,7 @@ Map<String, Object> config = new HashMap<>();
config.put("screenshotName", "<Your Screenshot Name>");
config.put("fullPage", true);
config.put("pageCount", 15); // Enter the number of pages for the Full Page screenshot (Minimum 1, Maximum 20)
((JavascriptExecutor)driver).executeScript("smartui.takeScreenshot", config);
((JavaScriptExecutor)driver).executeScript("smartui.takeScreenshot", config);
```

</TabItem>
Expand Down
26 changes: 11 additions & 15 deletions docs/smartui-baseline-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,21 @@
id: smartui-baseline-management
title: Baseline Management in SmartUI
sidebar_label: Baseline Management
description: Learn how to effectively manage baselines in SmartUI for visual regression testing, including dynamic baseline specification and baseline marking.
description: Learn how to manage baselines effectively in LambdaTest SmartUI. Understand baseline creation, updating, and versioning for reliable visual regression testing.
keywords:
- SmartUI Baseline
- Visual Regression Baseline
- Baseline Management
- Dynamic Baseline
- Baseline Marking
- SmartUI Git
- Visual Regression Testing
- Git Integration
- LambdaTest SmartUI
- Visual Testing
- Automatic Baseline
url: https://www.lambdatest.com/support/docs/smartui-baseline-management/
site_name: LambdaTest
slug: smartui-baseline-management/

---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import NewTag from '../src/component/newTag';
import CodeBlock from '@theme/CodeBlock';
import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";

---

<script type="application/ld+json"
dangerouslySetInnerHTML={{ __html: JSON.stringify({
Expand All @@ -47,11 +42,12 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co
}}
></script>

:::info
This guide explains how to effectively manage baselines in SmartUI for your visual regression testing workflow.
:::
# Baseline Management

In SmartUI, a **Baseline** is the reference image used for comparison against future test runs. Effective baseline management is crucial for accurate visual regression testing. This guide explains how baselines are created, updated, and maintained.

## Understanding Baselines
## What is a Baseline?
A baseline represents the "expected" state of your application's UI. When you run a SmartUI test, the new screenshots are compared against this baseline to detect unauthorized visual changes.

A baseline in SmartUI represents the reference point for visual regression testing. It's the set of screenshots against which all future builds are compared.

Expand Down
2 changes: 1 addition & 1 deletion docs/smartui-cli-figma-web.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ npx smartui upload-figma-web designs.json

### Working example with actual web comparisons

1. Please clone the following sample Github repo (`https://github.com/LambdaTest/smartui-figma-web-cli-sample`).
1. Please clone the following sample GitHub repo (`https://github.com/LambdaTest/smartui-figma-web-cli-sample`).

```bash
git clone https://github.com/LambdaTest/smartui-figma-web-cli-sample
Expand Down
2 changes: 1 addition & 1 deletion docs/smartui-cli-figma.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: smartui-cli-figma
title: Getting started with Lambdatest's SmartUI Figma CLI
title: Getting started with LambdaTest's SmartUI Figma CLI
sidebar_label: Figma CLI
description: In this documentation, learn how to perform Visual Testing of your Figma files using command line interface using SmartUI CLI.
keywords:
Expand Down
6 changes: 3 additions & 3 deletions docs/smartui-cli-git-branching.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co
This is the guide to understand our Git Branching with SmartUI projects which can detect the commit history and execute the appropriate actions for your visual regression testing.
:::

### Prerequisites for running Git with Smart UI
### Prerequisites for running Git with SmartUI

- You have an account with [Lambdatest](https://accounts.lambdatest.com).
- You have an account with [LambdaTest](https://accounts.lambdatest.com).
- You must have an active [subscription](https://www.lambdatest.com/pricing) plan with valid screenshots limit.
- You must have created an Project on the SmartUI web app.

Expand Down Expand Up @@ -286,7 +286,7 @@ For the first build generated for the **Baseline branch build** in the SmartUI P

### Detect changes for Git commit added to **Baseline Branch**

In this workflow, if I make changes in the set Baseline branch in the Smart UI project that is master and make an commit to the Git then,
In this workflow, if I make changes in the set Baseline branch in the SmartUI project that is master and make an commit to the Git then,

Execute `SmartUI CLI` commands to execute the test cases. Tests will compare the results with the latest **APPROVED** build run for **Baseline Branch** build in the SmartUI project.

Expand Down
6 changes: 3 additions & 3 deletions docs/smartui-git-branching.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co
This is the guide to understand our Git Branching with SmartUI projects which can detect the commit history and execute the appropriate actions for your visual regression testing.
:::

### Prerequisites for running Git with Smart UI
### Prerequisites for running Git with SmartUI

- You have an account with [Lambdatest](https://accounts.lambdatest.com).
- You have an account with [LambdaTest](https://accounts.lambdatest.com).
- You must have an active [subscription](https://www.lambdatest.com/pricing) plan with valid screenshots limit.
- You must have created an Project on the SmartUI web app.

Expand Down Expand Up @@ -233,7 +233,7 @@ For the first build generated for the **Baseline branch build** in the SmartUI P

### Detect changes for Git commit added to **Baseline Branch**

In this workflow, if I make changes in the set Baseline branch in the Smart UI project that is master and make an commit to the Git then,
In this workflow, if I make changes in the set Baseline branch in the SmartUI project that is master and make an commit to the Git then,

Execute `SmartUI Storybook CLI` commands to execute the `.stories` tests will compare the results with the latest **APPROVED** build run for **Baseline Branch** build in the SmartUI project.

Expand Down
Loading
Loading