Skip to content

Commit 39fca34

Browse files
committed
KaneAI.SmartUI doc fixes
1 parent a2a0d98 commit 39fca34

10 files changed

+51
-15
lines changed
156 Bytes
Loading
88.3 KB
Loading
88.4 KB
Loading
-80.2 KB
Binary file not shown.
88.3 KB
Loading
88.7 KB
Loading
88.1 KB
Loading
88.1 KB
Loading
88.1 KB
Loading

docs/kaneai-smartui-visual-testing.md

Lines changed: 51 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -49,20 +49,20 @@ This guide provides a detailed walkthrough on how to leverage KaneAI to create,
4949

5050
## Creating Your First Visual Test
5151

52-
### Step 1: Initiate a Web Test
53-
To begin, navigate to the [KaneAI dashboard](https://kaneai.lambdatest.com/dashboard) and click **Create a Web Test**. You can configure network settings before clicking **Start Testing** to launch the test authoring environment.
52+
### Initiate a Web Test
53+
To begin, navigate to the [KaneAI dashboard](https://kaneai.lambdatest.com/dashboard) and click **Author Browser Test**. You can configure network settings before clicking **Start Testing** to launch the test authoring environment.
5454

5555

56-
<img loading="lazy" src={require('../assets/images/kane-ai/smartui/initiate-web-test.png').default} alt="Initiate a Web Test in KaneAI" className="doc_img"/>
56+
<img loading="lazy" src={require('../assets/images/kane-ai/smartui/initiate-web-test.jpeg').default} alt="Initiate a Web Test in KaneAI" className="doc_img"/>
5757

58-
### Step 2: Add a Visual Comparison Step
58+
### Add a Visual Comparison Step
5959
Author your test by writing steps in plain language, such as `go to lambdatest`.
6060

6161
To add a visual test step, type `/` in the "Write a step" editor and select **Visual Comparison** from the command menu.
6262

6363
<img loading="lazy" src={require('../assets/images/kane-ai/smartui/add-visual-comparison-step.jpeg').default} alt="Add Visual Comparison Step" className="doc_img"/>
6464

65-
### Step 3: Configure Your Screenshot
65+
### Configure Your Screenshot
6666
A configuration modal will appear for your screenshot.
6767
* **Screenshot Name (Required):** You must provide a descriptive name for the screenshot.
6868
* **Mis-Match Threshold (Optional):** Set an acceptable percentage of difference below which changes are auto-approved. The default is 0%.
@@ -74,17 +74,17 @@ Click **Create** to add the step to your test flow.
7474

7575
## Analyzing Baselines and Regressions
7676

77-
### Step 4: Establish the Baseline
77+
### Establish the Baseline
7878
The first time the test is executed, it captures an initial screenshot that becomes the **Baseline** for all future comparisons. You can view this image by clicking **Show Baseline**.
7979

8080
<img loading="lazy" src={require('../assets/images/kane-ai/smartui/establish-baseline.jpeg').default} alt="Baseline screenshot created" className="doc_img"/>
8181

82-
### Step 5: Rerun and Analyze the Comparison
83-
When you rerun the test, a new screenshot is captured and compared against the baseline. Click **Show Comparison** to open the SmartUI view. This interface highlights any visual differences found between the two images.
82+
### Rerun and Analyze the Comparison
83+
When the test case is replayed or re-run during authoring, a new screenshot is captured and compared against the baseline. Click **Show Comparison** to open the SmartUI view. This interface highlights any visual differences found between the two images.
8484

8585
<img loading="lazy" src={require('../assets/images/kane-ai/smartui/analyze-comparison.png').default} alt="Analyze the visual comparison between baseline and new screenshot" className="doc_img"/>
8686

87-
### Step 6: Approve or Reject Changes
87+
### Approve or Reject Changes
8888
Within the comparison view, you can review the changes and decide on a verdict.
8989
* **Reject Screenshot:** If the changes are unintended defects, you may reject the comparison.
9090
* **Approve Screenshot:** If the changes are intentional, you may accept the comparison. This will update the baseline with the new image.
@@ -95,21 +95,57 @@ You can also adjust project settings like **Compare Type** and **Mis-Match Thres
9595

9696
## Saving and Automating Your Visual Test
9797

98-
### Step 7: Save Your Test Case
98+
### Save Your Test Case
9999
Once your test flow is complete, click **Finish test**. You will be prompted to save the session, where you can define the **Project**, **Folder**, **Test Name**, and **Description**.
100100

101101
<img loading="lazy" src={require('../assets/images/kane-ai/smartui/save-test-case.png').default} alt="Save the test case session" className="doc_img"/>
102102

103-
### Step 8: Schedule the Test for Automation
104-
You can access your saved tests via the **Test Manager**. To automate execution, navigate to **Test Runs** and schedule the finalized test[cite: 225]. When creating the run, provide a name and select **KaneAI Generated** as the `Type`. You can then set a recurring schedule for execution. Scheduled runs will automatically capture screenshots and store them in the SmartUI project for continuous comparison.
103+
### Configure Test Case
104+
After test run creation, make sure to **"Add a Configuration"**:
105+
* **Configuration Name**
106+
* **Desktop Configuration** - Choose and configure among options:
107+
* Operating Systems (3)
108+
* OS Versions (6)
109+
* Browsers (4)
110+
* Browser Versions (from 2023 to Latest)
111+
* Resolutions (11)
112+
113+
And after creating the configuration make sure to apply this configuration to the test run.
114+
<img loading="lazy" src={require('../assets/images/kane-ai/smartui/test-run-config.jpeg').default} alt="Save the test case session" className="doc_img"/>
115+
116+
### Run or Schedule the Test for Automation
117+
You can now simply run your tests by selecting **Run on HyperExecute** and either "Run Instance Now" (for quick run) or "Schedule Test Run" (for scheduled visual regression)
118+
119+
<img loading="lazy" src={require('../assets/images/kane-ai/smartui/run-test.jpeg').default} alt="Schedule the Test Run for automation" className="doc_img"/>
120+
121+
You may also access your saved tests via the **<a href="https://www.lambdatest.com/support/docs/kaneai-hyperexecute-test-run-execution/" rel="nofollow">Test Manager</a>**. To automate execution, navigate to **<a href="https://www.lambdatest.com/support/docs/kaneai-scheduled-test-runs/" rel="nofollow">Test Runs</a>** and schedule the finalized test. When creating the run, provide a name and select **KaneAI Generated** as the `Type`. You can then set a recurring schedule for execution. Scheduled runs will automatically capture screenshots and store them in the SmartUI project for continuous comparison.
105122

106123
<img loading="lazy" src={require('../assets/images/kane-ai/smartui/schedule-test-run.png').default} alt="Schedule the Test Run for automation" className="doc_img"/>
107124

108-
## Step 9: View Your Visual Test Results on SmartUI
109125

110-
After the HyperExecute job is finished, all screenshots captured using the `takeScreenshot` command will be available in your SmartUI project for review.
126+
### Using Advanced Configurations for Visual Regression
127+
While running **Run Instances Now** user can access **Visual Regression** settings via **Advanced Configurations**
128+
129+
130+
<img loading="lazy" src={require('../assets/images/kane-ai/smartui/advanced_config.jpeg').default} alt="Schedule the Test Run for automation" className="doc_img"/>
131+
132+
Here users can enable **Visual Regression** settings to use the advanced configurations:
133+
* Custom Browsers (upto 4)
134+
* Custom Viewports (upto 5)
135+
* Custom Devices (upto 2) with Orientation (Portrait and Landscape)
136+
<img loading="lazy" src={require('../assets/images/kane-ai/smartui/visual_config.jpeg').default} alt="Schedule the Test Run for automation" className="doc_img"/>
137+
138+
For a more flexible usage they may use the **JSON** tab where you may set your own parameters and configuration.
139+
140+
<img loading="lazy" src={require('../assets/images/kane-ai/smartui/visual_configs_json.jpeg').default} alt="Schedule the Test Run for automation" className="doc_img"/>
141+
142+
143+
## View Your Visual Test Results on SmartUI
144+
145+
After the HyperExecute job is finished, all screenshots captured using the `/Visual Comparison` command via KaneAI will be available in your SmartUI project for review.
146+
147+
<img loading="lazy" src={require('../assets/images/kane-ai/smartui/smartui_dashboard.jpeg').default} alt="Schedule the Test Run for automation" className="doc_img"/>
111148

112-
<img loading="lazy" src={require('../assets/images/smart-visual-testing/smartui-sdk-results-primer.webp').default} alt="SmartUI Results" width="768" height="373" className="doc_img"/>
113149

114150
1. Navigate to the [SmartUI Dashboard](https://smartui.lambdatest.com/).
115151
2. Select your project and the most recent build.

0 commit comments

Comments
 (0)