diff --git a/assets/images/smart-visual-testing/annotation-tool/1.png b/assets/images/smart-visual-testing/annotation-tool/1.png deleted file mode 100644 index 94fccb900..000000000 Binary files a/assets/images/smart-visual-testing/annotation-tool/1.png and /dev/null differ diff --git a/assets/images/smart-visual-testing/annotation-tool/2.png b/assets/images/smart-visual-testing/annotation-tool/2.png deleted file mode 100644 index a868bb36e..000000000 Binary files a/assets/images/smart-visual-testing/annotation-tool/2.png and /dev/null differ diff --git a/assets/images/smart-visual-testing/annotation-tool/3.png b/assets/images/smart-visual-testing/annotation-tool/3.png deleted file mode 100644 index e944ee3dd..000000000 Binary files a/assets/images/smart-visual-testing/annotation-tool/3.png and /dev/null differ diff --git a/assets/images/smart-visual-testing/annotation-tool/4.png b/assets/images/smart-visual-testing/annotation-tool/4.png deleted file mode 100644 index c7bc82a99..000000000 Binary files a/assets/images/smart-visual-testing/annotation-tool/4.png and /dev/null differ diff --git a/assets/images/smart-visual-testing/annotation-tool/5.png b/assets/images/smart-visual-testing/annotation-tool/5.png deleted file mode 100644 index dd1369ef2..000000000 Binary files a/assets/images/smart-visual-testing/annotation-tool/5.png and /dev/null differ diff --git a/assets/images/smart-visual-testing/annotation-tool/6.png b/assets/images/smart-visual-testing/annotation-tool/6.png deleted file mode 100644 index 21155a7b0..000000000 Binary files a/assets/images/smart-visual-testing/annotation-tool/6.png and /dev/null differ diff --git a/assets/images/smart-visual-testing/annotation-tool/annotationsicon.png b/assets/images/smart-visual-testing/annotation-tool/annotationsicon.png new file mode 100644 index 000000000..5e64c2e26 Binary files /dev/null and b/assets/images/smart-visual-testing/annotation-tool/annotationsicon.png differ diff --git a/assets/images/smart-visual-testing/annotation-tool/applyannotationmodal.png b/assets/images/smart-visual-testing/annotation-tool/applyannotationmodal.png new file mode 100644 index 000000000..14a543d1c Binary files /dev/null and b/assets/images/smart-visual-testing/annotation-tool/applyannotationmodal.png differ diff --git a/assets/images/smart-visual-testing/annotation-tool/changes_found.png b/assets/images/smart-visual-testing/annotation-tool/changes_found.png new file mode 100644 index 000000000..ca473dd28 Binary files /dev/null and b/assets/images/smart-visual-testing/annotation-tool/changes_found.png differ diff --git a/assets/images/smart-visual-testing/annotation-tool/floating_region.png b/assets/images/smart-visual-testing/annotation-tool/floating_region.png new file mode 100644 index 000000000..bce055829 Binary files /dev/null and b/assets/images/smart-visual-testing/annotation-tool/floating_region.png differ diff --git a/assets/images/smart-visual-testing/annotation-tool/ignore_region.png b/assets/images/smart-visual-testing/annotation-tool/ignore_region.png new file mode 100644 index 000000000..1be6bf15b Binary files /dev/null and b/assets/images/smart-visual-testing/annotation-tool/ignore_region.png differ diff --git a/assets/images/smart-visual-testing/annotation-tool/ignorecolor_region.png b/assets/images/smart-visual-testing/annotation-tool/ignorecolor_region.png new file mode 100644 index 000000000..aa1e829b8 Binary files /dev/null and b/assets/images/smart-visual-testing/annotation-tool/ignorecolor_region.png differ diff --git a/assets/images/smart-visual-testing/annotation-tool/resultoffloatingregion.png b/assets/images/smart-visual-testing/annotation-tool/resultoffloatingregion.png new file mode 100644 index 000000000..b5011efa7 Binary files /dev/null and b/assets/images/smart-visual-testing/annotation-tool/resultoffloatingregion.png differ diff --git a/assets/images/smart-visual-testing/annotation-tool/resultofignorecolors.png b/assets/images/smart-visual-testing/annotation-tool/resultofignorecolors.png new file mode 100644 index 000000000..415f46ce3 Binary files /dev/null and b/assets/images/smart-visual-testing/annotation-tool/resultofignorecolors.png differ diff --git a/assets/images/smart-visual-testing/annotation-tool/resultofignoreregion.png b/assets/images/smart-visual-testing/annotation-tool/resultofignoreregion.png new file mode 100644 index 000000000..9ebd97df4 Binary files /dev/null and b/assets/images/smart-visual-testing/annotation-tool/resultofignoreregion.png differ diff --git a/docs/analytics-ai-root-cause-analysis.md b/docs/analytics-ai-root-cause-analysis.md index 1a0a61ff4..429e5a938 100644 --- a/docs/analytics-ai-root-cause-analysis.md +++ b/docs/analytics-ai-root-cause-analysis.md @@ -300,7 +300,7 @@ The RCA Category Trends widget in Insights enables you to: 3. **Identify Recurring Issues**: Spot patterns in failure types to prioritize fixes 4. **Track Improvement**: Monitor the effectiveness of your remediation efforts -cmd +cmd ## Best Practices diff --git a/docs/espresso-visual-regression.md b/docs/espresso-visual-regression.md index 794ffadd6..abbb68c2a 100644 --- a/docs/espresso-visual-regression.md +++ b/docs/espresso-visual-regression.md @@ -83,25 +83,25 @@ Now, you need to export your environment variables LT_USERNAME and LT_ACCESS_KEY Run the below mentioned commands in your terminal to setup the CLI and the environment variables. - + - +
- {`export LT_USERNAME=${ YOUR_LAMBDATEST_USERNAME()} -export LT_ACCESS_KEY=${ YOUR_LAMBDATEST_ACCESS_KEY()}`} +{`export LT_USERNAME="${YOUR_LAMBDATEST_USERNAME}" +export LT_ACCESS_KEY="${YOUR_LAMBDATEST_ACCESS_KEY}"`}
- +
- {`set LT_USERNAME=${ YOUR_LAMBDATEST_USERNAME()} -set LT_ACCESS_KEY=${ YOUR_LAMBDATEST_ACCESS_KEY()}`} +{`set LT_USERNAME="${YOUR_LAMBDATEST_USERNAME}" +set LT_ACCESS_KEY="${YOUR_LAMBDATEST_ACCESS_KEY}"`}
@@ -142,23 +142,23 @@ To begin testing, upload your Android application (.apk file) to LambdaTest's se - **Authentication :** You'll need your LambdaTest Username and AccessKey. Combine them in the format `Username:AccessKey`. - **Uploading the App :** Use **cURL command** to send a request to our API. The request should include the path to your application file (**appFile**). - + - +
- {`curl -u "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" --location --request POST 'https://manual-api.lambdatest.com/app/uploadFramework' --form 'appFile=@""' --form 'type="espresso-android"'`} +{`curl -u "${YOUR_LAMBDATEST_USERNAME}:${YOUR_LAMBDATEST_ACCESS_KEY}" --location --request POST 'https://manual-api.lambdatest.com/app/uploadFramework' --form 'appFile=@""' --form 'type="espresso-android"'`}
- +
-{`curl -u "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" --location --request POST "https://manual-api.lambdatest.com/app/uploadFramework" --form "appFile=@""" --form "type=\"espresso-android\""`} +{`curl -u "${YOUR_LAMBDATEST_USERNAME}:${YOUR_LAMBDATEST_ACCESS_KEY}" --location --request POST "https://manual-api.lambdatest.com/app/uploadFramework" --form "appFile=@""" --form "type=\"espresso-android\""`}
@@ -176,23 +176,23 @@ Upload your Espresso test suite (.apk) file to LambdaTest servers using our REST The following sample cURL command shows how to upload a test suite: - + - +
- {`curl -u "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" --location --request POST 'https://manual-api.lambdatest.com/app/uploadFramework' --form 'appFile=@""' --form 'type="espresso-android"'`} +{`curl -u "${YOUR_LAMBDATEST_USERNAME}:${YOUR_LAMBDATEST_ACCESS_KEY}" --location --request POST 'https://manual-api.lambdatest.com/app/uploadFramework' --form 'appFile=@""' --form 'type="espresso-android"'`}
- +
-{`curl -u "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" --location --request POST "https://manual-api.lambdatest.com/app/uploadFramework" --form "appFile=@""" --form "type=\"espresso-android\""`} +{`curl -u "${YOUR_LAMBDATEST_USERNAME}:${YOUR_LAMBDATEST_ACCESS_KEY}" --location --request POST "https://manual-api.lambdatest.com/app/uploadFramework" --form "appFile=@""" --form "type=\"espresso-android\""`}
@@ -212,7 +212,7 @@ Take note of the base64 encoded authentication which needs to be added in the
-{`${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}`} +{`${YOUR_LAMBDATEST_USERNAME}:${YOUR_LAMBDATEST_ACCESS_KEY}`}
@@ -383,7 +383,10 @@ By leveraging machine learning algorithms, it accurately detects and crops the s ## Best Practices -### 1. Project and Build Naming + + + +### Project and Build Naming - Use descriptive, consistent names for projects and builds - Include app version or release info in build names @@ -398,35 +401,60 @@ By leveraging machine learning algorithms, it accurately detects and crops the s } ``` -### 2. Device Selection + + + +### Device Selection - Test on devices that match your user base - Include multiple device configurations for comprehensive coverage - Use device patterns for consistent testing (e.g., `Galaxy.*`, `Pixel.*`) -### 3. Smart Crop Configuration + + + +### Smart Crop Configuration - Enable `cropStatusBar` to focus on core UI elements - Enable `cropNavigationBar` for Android devices - Test cropped screenshots to ensure important content isn't removed -### 4. Test Organization + + + +### Test Organization - Use sharding for parallel test execution - Group related tests in same build - Use meaningful test names for better organization -### 5. App and Test Suite Management + + + +### App and Test Suite Management + +- Upload apps and test suites before execution +- Use app IDs (`lt://APP...`) for faster execution +- Keep app and test suite versions synchronized + + + + +### App and Test Suite Management - Upload apps and test suites before execution - Use app IDs (`lt://APP...`) for faster execution - Keep app and test suite versions synchronized + + + ## Troubleshooting -### Common Issues + + -#### Issue: Screenshots Not Captured +### Issue: Screenshots Not Captured **Symptoms**: Tests run but no screenshots appear in SmartUI dashboard @@ -440,7 +468,7 @@ By leveraging machine learning algorithms, it accurately detects and crops the s 1. Verify `visual: true` is set in API request: ```json { - "visual": true, + visual": true, "smartUI.project": "ProjectName" } ``` @@ -453,7 +481,10 @@ By leveraging machine learning algorithms, it accurately detects and crops the s 4. Check network connectivity to LambdaTest -#### Issue: "Project Not Found" Error + + + +### Issue: Project Not Found" Error **Symptoms**: Error indicating SmartUI project cannot be found @@ -468,7 +499,10 @@ By leveraging machine learning algorithms, it accurately detects and crops the s 3. Check credentials match the account with the project 4. Ensure project name is in API request -#### Issue: App Upload Fails + + + +### Issue: App Upload Fails **Symptoms**: App upload returns error or fails @@ -484,7 +518,10 @@ By leveraging machine learning algorithms, it accurately detects and crops the s 3. Retry upload with stable network connection 4. Verify authentication credentials -#### Issue: Test Execution Fails + + + +### Issue: Test Execution Fails **Symptoms**: Test suite execution fails or times out @@ -500,14 +537,17 @@ By leveraging machine learning algorithms, it accurately detects and crops the s 3. Increase `queueTimeout` and `IdleTimeout`: ```json { - "queueTimeout": 600, - "IdleTimeout": 60 + queueTimeout: 600, + IdleTimeout: 60 } ``` 4. Review device logs for test errors -#### Issue: Screenshots Show Incorrect Content + + + +### Issue: Screenshots Show Incorrect Content **Symptoms**: Screenshots captured but show wrong screen or state @@ -531,6 +571,9 @@ If you encounter issues not covered here: - Visit [LambdaTest Support](https://www.lambdatest.com/support) for additional resources - Contact support at support@lambdatest.com or use [24/7 Chat Support](https://www.lambdatest.com/support) + + + ## Additional Resources - [Comprehensive Troubleshooting Guide](/support/docs/smartui-troubleshooting-guide) @@ -541,7 +584,7 @@ If you encounter issues not covered here: - [Appium Hooks Documentation](/support/docs/smartui-appium-hooks) -