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
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.
28 changes: 27 additions & 1 deletion docs/smartui-guided-walkthrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,30 @@ slug: smartui-guided-walkthrough/
}]
})
}}
></script>
></script>
This page gives you a guided walkthrough of all the things on the HyperExecute Dashboard and how you can get the most out of the platform once you have successfully [run your first sample project](/support/docs/smartui-running-your-first-project/).

## Projects Page
All the tests on SmartUI gets executed as a Project. All the Projects can be found on our Projects page. Each Project has a Approver, Tags, Platform, and a Sort By section followed by the details of the number of builds and who initiated the Project.

<img loading="lazy" src={require('../assets/images/smart-visual-testing/guided-walkthrough/1.png').default} alt="Image" className="doc_img"/>

## Projects Dashboard Details
The SmartUI dashboard presents a comparison between the baseline and the captured screenshots for visual regression testing. It provides essential insights to detect any UI anomalies.

### Key Sections
- **Baseline View :** Displays the previously captured UI state for comparison. It serves as the reference point for regression testing.
- **Captured View :** Shows the latest UI version to compare against the baseline. Differences are highlighted for easy identification.

### Diff Controls
Located at the center of the top menu, the Diff Controls allow testers to customize how visual differences are displayed, offering multiple options to refine the comparison process. The available modes are:

- **Captured Diffs :** Highlights the differences detected in the current captured screenshots when compared to the baseline. Ideal for spotting changes introduced in the latest version.
- **Baseline Diffs :** Displays the differences by focusing on the baseline's unique elements. Helps identify elements missing or changed in the new capture. Annotations : Allows users to add notes or highlight specific regions of interest on the screenshots. Useful for documenting findings or collaborating with team members.
- **Strict Mode :** Highlights exact pixel mismatches between the baseline and captured screenshots. Best suited for detailed visual inspections where high precision is required.
- **Smart Ignore :** Automatically ignores minor, non-critical differences (e.g., anti-aliasing, rendering variations). Useful for reducing noise in tests, allowing the focus to remain on significant UI changes.

### Variants
The top menu includes browser variants, which allow cross-browser testing. Variants visible in the screenshot include: Chrome, Firefox, Edge, Playwright WebKit (Pw-Webkit). Each variant shows the same test across different browsers and resolutions, helping identify browser-specific visual issues.

<img loading="lazy" src={require('../assets/images/smart-visual-testing/guided-walkthrough/2.png').default} alt="Image" className="doc_img"/>
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
id: smartui-running-your-first-test
title: Running Your First Test on SmartUI
id: smartui-running-your-first-project
title: Running Your First Project on SmartUI
hide_title: false
sidebar_label: Running Your First Test
description: Learn how to run your first test on smartui step by step guide for the first time users to help them understand how the platform works
description: Learn how to run your first project on smartui step by step guide for the first time users to help them understand how the platform works
keywords:
- smart visual testing in lambdatest
- visual ui testing,image to image comparison
Expand All @@ -15,9 +15,9 @@ keywords:
- test on samsung a7 online
- test on mac 10.11 el capitan online
- apple mac el capitan virtual machine
url: https://www.lambdatest.com/support/docs/smartui-running-your-first-test/
url: https://www.lambdatest.com/support/docs/smartui-running-your-first-project/
site_name: LambdaTest
slug: smartui-running-your-first-test/
slug: smartui-running-your-first-project/
---

import Tabs from '@theme/Tabs';
Expand All @@ -43,12 +43,11 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co
"@type": "ListItem",
"position": 3,
"name": "Smart Visual Testing",
"item": "https://www.lambdatest.com/support/docs/smartui-running-your-first-test/"
"item": "https://www.lambdatest.com/support/docs/smartui-running-your-first-project/"
}]
})
}}
></script>

This guide will walk you through the process of running your first visual regression test using SmartUI, a powerful feature of LambdaTest that ensures your web applications look flawless across all browsers and devices.
## Prerequisites

Expand All @@ -72,7 +71,7 @@ Now select your desired framework and click on the **Configure** button. For the
You can use your own project to configure and test it. For demo purposes, we are using the sample repository.

:::tip Sample repo
Download or Clone the code sample code repository from the LambdaTest GitHub repository to run the tests on the SmartUI.
Download or Clone the code sample code repository from the LambdaTest GitHub repository to run the project on the SmartUI.

<a href="https://github.com/LambdaTest/smartui-java-testng-sample" target="_blank" className="github__anchor"><img loading="lazy" src={require('../assets/images/icons/github.png').default} alt="Image" className="doc_img"/> View on GitHub</a>
:::
Expand Down Expand Up @@ -130,7 +129,6 @@ set PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`}
{`$Env:LT_USERNAME="${YOUR_LAMBDATEST_USERNAME()}"
$Env:LT_ACCESS_KEY="${YOUR_LAMBDATEST_ACCESS_KEY()}"
$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`}

</CodeBlock>
</div>
</TabItem>
Expand All @@ -140,7 +138,7 @@ $Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`}
<img loading="lazy" src={require('../assets/images/smart-visual-testing/running-first-test/1.png').default} alt="cmd" width="768" height="373" className="doc_img"/>

## 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:
You can now configure your project configurations on using various available options to run your project with the SmartUI integration. To generate the configuration file, please execute the following command:

```bash
npx smartui config:create .smartui.json
Expand Down
2 changes: 1 addition & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -2681,7 +2681,7 @@ module.exports = {
type: "doc",
id: "smart-visual-regression-testing",
},
items: ["smartui-running-your-first-test", "smartui-guided-walkthrough", "smartui-cli-git-branching-strategy", "smartui-cli-env-variables"],
items: ["smartui-running-your-first-project", "smartui-guided-walkthrough", "smartui-cli-git-branching-strategy", "smartui-cli-env-variables"],
},
{
type: "category",
Expand Down
Loading