diff --git a/assets/images/smart-visual-testing/multiselect/allselect.png b/assets/images/smart-visual-testing/multiselect/allselect.png new file mode 100644 index 00000000..e80e280b Binary files /dev/null and b/assets/images/smart-visual-testing/multiselect/allselect.png differ diff --git a/assets/images/smart-visual-testing/multiselect/approvebulkops.png b/assets/images/smart-visual-testing/multiselect/approvebulkops.png new file mode 100644 index 00000000..6d4a0695 Binary files /dev/null and b/assets/images/smart-visual-testing/multiselect/approvebulkops.png differ diff --git a/assets/images/smart-visual-testing/multiselect/dashboard.png b/assets/images/smart-visual-testing/multiselect/dashboard.png new file mode 100644 index 00000000..0713e03f Binary files /dev/null and b/assets/images/smart-visual-testing/multiselect/dashboard.png differ diff --git a/assets/images/smart-visual-testing/multiselect/movebulkops.png b/assets/images/smart-visual-testing/multiselect/movebulkops.png new file mode 100644 index 00000000..cb056e65 Binary files /dev/null and b/assets/images/smart-visual-testing/multiselect/movebulkops.png differ diff --git a/assets/images/smart-visual-testing/multiselect/noneselected.png b/assets/images/smart-visual-testing/multiselect/noneselected.png new file mode 100644 index 00000000..41734d74 Binary files /dev/null and b/assets/images/smart-visual-testing/multiselect/noneselected.png differ diff --git a/assets/images/smart-visual-testing/multiselect/noselectionbulkops.png b/assets/images/smart-visual-testing/multiselect/noselectionbulkops.png new file mode 100644 index 00000000..78dbec6b Binary files /dev/null and b/assets/images/smart-visual-testing/multiselect/noselectionbulkops.png differ diff --git a/assets/images/smart-visual-testing/multiselect/rejectbulkops.png b/assets/images/smart-visual-testing/multiselect/rejectbulkops.png new file mode 100644 index 00000000..68a5942f Binary files /dev/null and b/assets/images/smart-visual-testing/multiselect/rejectbulkops.png differ diff --git a/assets/images/smart-visual-testing/multiselect/selectedstate.png b/assets/images/smart-visual-testing/multiselect/selectedstate.png new file mode 100644 index 00000000..83110c79 Binary files /dev/null and b/assets/images/smart-visual-testing/multiselect/selectedstate.png differ diff --git a/assets/images/smart-visual-testing/multiselect/tabselection.png b/assets/images/smart-visual-testing/multiselect/tabselection.png new file mode 100644 index 00000000..d90ec901 Binary files /dev/null and b/assets/images/smart-visual-testing/multiselect/tabselection.png differ diff --git a/docs/smartui-appium-hooks.md b/docs/smartui-appium-hooks.md index e73ba8fe..6a45440c 100644 --- a/docs/smartui-appium-hooks.md +++ b/docs/smartui-appium-hooks.md @@ -512,7 +512,7 @@ Please note that this webhook is only applicable to native app screenshots -### Screenshot Naming +**Screenshot Naming** - Use descriptive, consistent names for screenshots - Include screen/component name in screenshot names @@ -528,7 +528,7 @@ await driver.execute("smartui.takeScreenshot=CheckoutScreen-PaymentForm"); -### Wait for Screen Load +**Wait for Screen Load** - Always wait for screens to fully load before taking screenshots - Use Appium's wait methods for dynamic content @@ -544,7 +544,7 @@ await driver.execute("smartui.takeScreenshot=Screen Loaded"); -### Handle Dynamic Content +**Handle Dynamic Content** - Use `ignoreBoxes` for elements that change between runs (ads, timestamps, user avatars) - Use `selectBoxes` when you only need to compare specific regions @@ -553,7 +553,7 @@ await driver.execute("smartui.takeScreenshot=Screen Loaded"); -### Smart Crop Configuration +**Smart Crop Configuration** - Enable `cropStatusBar` to focus on core UI elements - Enable `cropNavigationBar` for Android devices @@ -562,7 +562,7 @@ await driver.execute("smartui.takeScreenshot=Screen Loaded"); -### Test Organization +**Test Organization** - Group related screenshots in the same build - Use meaningful build names @@ -571,7 +571,7 @@ await driver.execute("smartui.takeScreenshot=Screen Loaded"); -### Test Organization +**Test Organization** - Group related screenshots in the same build - Use meaningful build names @@ -585,7 +585,7 @@ await driver.execute("smartui.takeScreenshot=Screen Loaded"); -### Issue: Screenshots Not Captured +**Issue: Screenshots Not Captured** **Symptoms**: Tests run but no screenshots appear in SmartUI dashboard @@ -620,7 +620,7 @@ await driver.execute("smartui.takeScreenshot=Screen Loaded"); -### Issue: "Project Not Found" Error +**Issue: "Project Not Found" Error** **Symptoms**: Error indicating SmartUI project cannot be found @@ -638,7 +638,7 @@ await driver.execute("smartui.takeScreenshot=Screen Loaded"); -### Issue: Screenshots Show Blank or Incorrect Content +**Issue: Screenshots Show Blank or Incorrect Content** **Symptoms**: Screenshots captured but show blank screens or incorrect content @@ -666,7 +666,7 @@ await driver.execute("smartui.takeScreenshot=Screen Loaded"); -### Issue: Full Page Screenshot Issues +**Issue: Full Page Screenshot Issues** **Symptoms**: Full page screenshots incomplete or incorrect @@ -692,7 +692,7 @@ await driver.execute("smartui.takeScreenshot=Screen Loaded"); -### Issue: ignoreBoxes/selectBoxes Not Working +**Issue: ignoreBoxes/selectBoxes Not Working** **Symptoms**: Dynamic content still causing false positives @@ -713,7 +713,7 @@ await driver.execute("smartui.takeScreenshot=Screen Loaded"); 4. Test XPath locators in isolation before using in config -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-appium-java-sdk.md b/docs/smartui-appium-java-sdk.md index 49c42664..8c36ab6a 100644 --- a/docs/smartui-appium-java-sdk.md +++ b/docs/smartui-appium-java-sdk.md @@ -312,7 +312,7 @@ After test execution, visit your SmartUI project dashboard to: -### Screenshot Naming +**Screenshot Naming** - Use descriptive, consistent names for screenshots - Include screen/component name in screenshot names @@ -328,7 +328,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "CheckoutScreen-PaymentForm"); -### Wait for Screen Load +**Wait for Screen Load** - Always wait for screens to fully load before taking screenshots - Use Appium's wait methods for dynamic content @@ -344,7 +344,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Screen Loaded"); -### Handle Dynamic Content +**Handle Dynamic Content** - Use `ignoreBoxes` for elements that change between runs (ads, timestamps, user avatars) - Use `selectBoxes` when you only need to compare specific regions @@ -353,7 +353,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Screen Loaded"); -### Device Configuration +**Device Configuration** - Use consistent `deviceName` and `platform` combinations across builds - Document device configurations for reference @@ -362,18 +362,18 @@ SmartUISnapshot.smartuiSnapshot(driver, "Screen Loaded"); -### Test Organization +**Test Organization** - Group related screenshots in the same build - Use meaningful build names - Run tests on consistent device configurations -## Troubleshooting +**Troubleshooting** -### Issue: Screenshots Not Captured +**Issue: Screenshots Not Captured** **Symptoms**: Tests run but no screenshots appear in SmartUI dashboard @@ -407,7 +407,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Screen Loaded"); -### Issue: Project Not Found" Error +**Issue: Project Not Found" Error** **Symptoms**: Error indicating SmartUI project cannot be found @@ -426,7 +426,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Screen Loaded"); -### Issue: Screenshots Show Blank or Incorrect Content +**Issue: Screenshots Show Blank or Incorrect Content** **Symptoms**: Screenshots captured but show blank screens or incorrect content @@ -455,7 +455,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Screen Loaded"); -### Issue: ignoreBoxes/selectBoxes Not Working +**Issue: ignoreBoxes/selectBoxes Not Working** **Symptoms**: Dynamic content still causing false positives @@ -478,7 +478,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Screen Loaded"); -### Issue: Maven Dependencies Not Resolving +**Issue: Maven Dependencies Not Resolving** **Symptoms**: Maven cannot find `lambdatest-java-sdk` or dependencies fail @@ -499,7 +499,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Screen Loaded"); -### Issue: Screenshot Names Not Matching Baseline +**Issue: Screenshot Names Not Matching Baseline** **Symptoms**: Screenshots appear as New" instead of comparing with baseline @@ -514,7 +514,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Screen Loaded"); 3. Avoid special characters in screenshot names 4. Check for case sensitivity issues -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-baseline-management.md b/docs/smartui-baseline-management.md index 4e189133..d0d87381 100644 --- a/docs/smartui-baseline-management.md +++ b/docs/smartui-baseline-management.md @@ -135,7 +135,7 @@ npx smartui --markBaseline capture urls.json -### Baseline Selection +**Baseline Selection** - Choose stable builds as baselines - Document baseline selection criteria @@ -145,7 +145,7 @@ npx smartui --markBaseline capture urls.json -### Branch Management +**Branch Management** - Clear branch naming conventions - Document branch purposes @@ -155,7 +155,7 @@ npx smartui --markBaseline capture urls.json -### Build Management +**Build Management** - Meaningful build names - Document build purposes @@ -165,7 +165,7 @@ npx smartui --markBaseline capture urls.json -### Approval Process +**Approval Process** - Clear approval criteria - Document approval decisions @@ -179,7 +179,7 @@ npx smartui --markBaseline capture urls.json -### Common Issues +**Common Issues** 1. **Baseline Issues**: - Verify baseline exists @@ -200,7 +200,7 @@ npx smartui --markBaseline capture urls.json -### Baseline Not Found +**Baseline Not Found** **Error**: Baseline branch or build does not exist @@ -218,7 +218,7 @@ npx smartui --baselineBranch "main" exec -- -### Permission Denied +**Permission Denied** **Error**: Insufficient permissions to set baseline @@ -231,7 +231,7 @@ npx smartui --baselineBranch "main" exec -- -### Baseline Mismatch +**Baseline Mismatch** **Error**: Screenshot names don't match between baseline and current build diff --git a/docs/smartui-branch-merging.md b/docs/smartui-branch-merging.md index 283e62ea..8adef863 100644 --- a/docs/smartui-branch-merging.md +++ b/docs/smartui-branch-merging.md @@ -136,7 +136,7 @@ npx smartui merge branch --source release/v1.0.0 --target main -### Merge Planning +**Merge Planning** - Plan merges in advance - Document merge strategies @@ -145,7 +145,7 @@ npx smartui merge branch --source release/v1.0.0 --target main -### Branch Management +**Branch Management** - Keep branches up to date - Clean up merged branches @@ -154,7 +154,7 @@ npx smartui merge branch --source release/v1.0.0 --target main -### Approval Process +**Approval Process** - Establish clear approval criteria - Document approval decisions diff --git a/docs/smartui-build-merging.md b/docs/smartui-build-merging.md index 59710839..acfe08b7 100644 --- a/docs/smartui-build-merging.md +++ b/docs/smartui-build-merging.md @@ -123,7 +123,7 @@ npx smartui merge build --source hotfix-build-202 --target prod-build-456 -### Build Management +**Build Management** - Use meaningful build names - Document build purposes @@ -132,13 +132,13 @@ npx smartui merge build --source hotfix-build-202 --target prod-build-456 -### Merge Planning +**Merge Planning** - Plan merges in advance - Document merge strategies - Establish approval processes -### Getting Help +**Getting Help** If you encounter any issues with build merging in SmartUI, please contact our support team at support@lambdatest.com. diff --git a/docs/smartui-cli-complete-reference.md b/docs/smartui-cli-complete-reference.md index f7d6cf6c..299d7292 100644 --- a/docs/smartui-cli-complete-reference.md +++ b/docs/smartui-cli-complete-reference.md @@ -141,7 +141,7 @@ npm install -g @lambdatest/smartui-storybook@latest -### Execute Tests +**Execute Tests** Execute test commands with SmartUI server running. @@ -187,7 +187,7 @@ smartui exec --userName "user" --accessKey "key" -- npm test -### Capture Static URLs +**Capture Static URLs** Capture screenshots of static URLs from a configuration file. @@ -235,7 +235,7 @@ smartui capture urls.json --buildName "Daily-Run" --fetch-results daily-results. -### Upload Screenshots +**Upload Screenshots** Upload screenshots from a directory for comparison. @@ -285,7 +285,7 @@ smartui upload ./screenshots -R -E --buildName "Test-Run" -### Upload PDFs +**Upload PDFs** Upload PDF files for visual comparison. @@ -325,7 +325,7 @@ smartui upload-pdf ./pdfs --fetch-results pdf-results.json -### Start Server +**Start Server** Start the SmartUI snapshot server. @@ -373,7 +373,7 @@ smartui exec:start --buildName "Server-Build" -### Stop Server +**Stop Server** Stop the SmartUI snapshot server. @@ -386,7 +386,7 @@ smartui exec:stop -### Check Server Status +**Check Server Status** Check if the SmartUI server is running. @@ -406,7 +406,7 @@ smartui exec:pingTest -### Merge Branches/Builds +**Merge Branches/Builds** Merge source branch or build into target. @@ -443,7 +443,7 @@ smartui merge build --source "Build-123" --target "Baseline-Build" -### Figma Integration Commands +**Figma Integration Commands** @@ -541,7 +541,7 @@ These options can be used with most commands: -### Main Command +**Main Command** **Syntax:** ```bash @@ -582,7 +582,7 @@ smartui storybook http://localhost:6006 --env stage -### Config Command +**Config Command** **Syntax:** ```bash @@ -729,7 +729,7 @@ $env:LT_SDK_DEBUG="true" -### Basic Static URL Capture +**Basic Static URL Capture** ```bash # 1. Install CLI npm install -g @lambdatest/smartui-cli @@ -750,7 +750,7 @@ npx smartui capture urls.json --fetch-results results.json -### SDK Test Execution +**SDK Test Execution** ```bash # 1. Set project token export PROJECT_TOKEN="123456#token" @@ -770,7 +770,7 @@ npx smartui exec:stop -### Upload Existing Screenshots +**Upload Existing Screenshots** ```bash # 1. Set project token export PROJECT_TOKEN="123456#token" @@ -787,7 +787,7 @@ npx smartui upload ./screenshots \ ``` -### Storybook Testing +**Storybook Testing** ```bash # 1. Install Storybook CLI npm install -g @lambdatest/smartui-storybook @@ -808,7 +808,7 @@ smartui storybook ./storybook-static --config .smartui.json -### PDF Testing +**PDF Testing** ```bash # 1. Set project token export PROJECT_TOKEN="123456#token" @@ -822,7 +822,7 @@ npx smartui upload-pdf ./pdfs --markBaseline --buildName "PDF-Baseline" -### CI/CD Integration +**CI/CD Integration** **GitHub Actions Example:** ```yaml @@ -851,7 +851,7 @@ test: -### Build Naming +**Build Naming** - Use meaningful, consistent names - Include version or commit info @@ -870,7 +870,7 @@ test: -### Configuration Management +**Configuration Management** - Keep config files in version control - Use environment variables for sensitive data @@ -880,7 +880,7 @@ test: -### Parallel Execution +**Parallel Execution** - Start with lower thread counts - Monitor system resources @@ -889,7 +889,7 @@ test: -### Server Management +**Server Management** - Always use `exec:stop` to terminate server - Check server status with `exec:ping` @@ -899,7 +899,7 @@ test: -### Error Handling +**Error Handling** - Always use `--fetch-results` for CI/CD - Check exit codes in scripts @@ -915,7 +915,7 @@ test: -### Server Not Running +**Server Not Running** ```bash # Check status npx smartui exec:ping @@ -929,7 +929,7 @@ echo $SMARTUI_SERVER_ADDRESS -### Port Conflicts +**Port Conflicts** ```bash # Use custom port npx smartui exec:start -P 5000 @@ -938,7 +938,7 @@ npx smartui exec -P 5000 -- npm test -### Authentication Issues +**Authentication Issues** ```bash # Verify credentials echo $PROJECT_TOKEN @@ -950,7 +950,7 @@ npx smartui capture urls.json --userName "user" --accessKey "key" ``` -### Configuration Errors +**Configuration Errors** ```bash # Validate JSON cat .smartui.json | python -m json.tool diff --git a/docs/smartui-cli-exec.md b/docs/smartui-cli-exec.md index 0abe3e64..c4129a7c 100644 --- a/docs/smartui-cli-exec.md +++ b/docs/smartui-cli-exec.md @@ -199,7 +199,7 @@ When running tests from IDEs like IntelliJ: -### Server Termination +**Server Termination** Always use `exec:stop` to properly terminate the server. @@ -207,7 +207,7 @@ Always use `exec:stop` to properly terminate the server. -### Timeouts +**Timeouts** Set appropriate timeouts for your tests. @@ -215,7 +215,7 @@ Set appropriate timeouts for your tests. -### Snapshot Naming +**Snapshot Naming** Use meaningful names for your snapshots. @@ -223,7 +223,7 @@ Use meaningful names for your snapshots. -### Environment Variables +**Environment Variables** Configure environment variables before starting your IDE. @@ -231,7 +231,7 @@ Configure environment variables before starting your IDE. -### Configuration Files +**Configuration Files** Consider using configuration files for complex setups. @@ -243,7 +243,7 @@ Consider using configuration files for complex setups. -### Server Status +**Server Status** Verify the server is running using `exec:ping`. @@ -251,7 +251,7 @@ Verify the server is running using `exec:ping`. -### Server Address +**Server Address** Check if the server address is correctly configured. @@ -259,7 +259,7 @@ Check if the server address is correctly configured. -### Port Conflicts +**Port Conflicts** Ensure no other process is using the default port. @@ -267,7 +267,7 @@ Ensure no other process is using the default port. -### Server Logs +**Server Logs** Review the server logs for error messages. diff --git a/docs/smartui-cli-figma-app.md b/docs/smartui-cli-figma-app.md index b79c9b1c..4c0dec2f 100644 --- a/docs/smartui-cli-figma-app.md +++ b/docs/smartui-cli-figma-app.md @@ -147,7 +147,7 @@ You can see the SmartUI dashboard to view the results. This will help you identi -### Build Names +**Build Names** ```bash npx smartui upload-figma-app designs.json --buildName "v1.0.0" @@ -156,7 +156,7 @@ You can see the SmartUI dashboard to view the results. This will help you identi -### Screenshot Names +**Screenshot Names** - Good: `homepage-screen`, `login-form`, `dashboard-tab` - Avoid: `test1`, `screenshot`, `design-1` @@ -165,9 +165,9 @@ You can see the SmartUI dashboard to view the results. This will help you identi -### Device Names +**Device Names** -### Screenshot Naming for SDK Comparisons +**Screenshot Naming for SDK Comparisons** **Critical**: When comparing Figma designs with app screenshots captured via SDKs, add `.png` extension to your SDK screenshot names. @@ -208,9 +208,9 @@ This ensures that Figma screenshots (e.g., `homepage.png`) match app screenshots -### Device Names +**Device Names** -### Screenshot Naming for SDK Comparisons +**Screenshot Naming for SDK Comparisons** **Critical**: When comparing Figma designs with app screenshots captured via SDKs, add `.png` extension to your SDK screenshot names. diff --git a/docs/smartui-cli-figma-web.md b/docs/smartui-cli-figma-web.md index 441d6a31..32dc0737 100644 --- a/docs/smartui-cli-figma-web.md +++ b/docs/smartui-cli-figma-web.md @@ -341,7 +341,7 @@ npx smartui --config web-config.json exec --buildName=web-build -- node figma-we -### Build Names +**Build Names** ```bash npx smartui upload-figma-web designs.json --buildName "v1.0.0" @@ -350,7 +350,7 @@ npx smartui --config web-config.json exec --buildName=web-build -- node figma-we -### Screenshot Names +**Screenshot Names** - Good: `homepage-hero`, `login-form`, `dashboard-sidebar` - Avoid: `test1`, `screenshot`, `design-1` @@ -359,9 +359,9 @@ npx smartui --config web-config.json exec --buildName=web-build -- node figma-we -### Branch Names +**Branch Names** -### Screenshot Naming for SDK Comparisons +**Screenshot Naming for SDK Comparisons** **Critical**: When comparing Figma designs with live implementations captured via SDKs, add `.png` extension to your SDK screenshot names. diff --git a/docs/smartui-cli-figma.md b/docs/smartui-cli-figma.md index 115f04de..2b4bd63d 100644 --- a/docs/smartui-cli-figma.md +++ b/docs/smartui-cli-figma.md @@ -266,7 +266,7 @@ You can add more screenshots in a build by specifying the particular build name -### Build Names +**Build Names** ```bash npx smartui upload-figma designs.json --buildName "v1.0.0" @@ -275,7 +275,7 @@ You can add more screenshots in a build by specifying the particular build name -### Screenshot Names +**Screenshot Names** - Good: `homepage-hero`, `login-form`, `dashboard-sidebar` - Avoid: `test1`, `screenshot`, `design-1` @@ -286,9 +286,9 @@ You can add more screenshots in a build by specifying the particular build name -### Branch Names +**Branch Names** -### Screenshot Naming for SDK Comparisons +**Screenshot Naming for SDK Comparisons** **Important**: When comparing Figma designs with live implementations captured via SDKs, add `.png` extension to your SDK screenshot names. @@ -359,9 +359,9 @@ You can see the SmartUI dashboard to view the results. This will help you identi -### Branch Names +**Branch Names** -### Screenshot Naming for SDK Comparisons +**Screenshot Naming for SDK Comparisons** **Important**: When comparing Figma designs with live implementations captured via SDKs, add `.png` extension to your SDK screenshot names. diff --git a/docs/smartui-cypress-sdk.md b/docs/smartui-cypress-sdk.md index a4e5e1c4..c06de4b2 100644 --- a/docs/smartui-cypress-sdk.md +++ b/docs/smartui-cypress-sdk.md @@ -418,7 +418,7 @@ cy.smartuiSnapshot(‘Screenshot Name’, options); -### Screenshot Naming +**Screenshot Naming** - Use descriptive, consistent names for screenshots - Include page/component name in screenshot names @@ -435,7 +435,7 @@ cy.smartuiSnapshot('ProductPage-MainContent'); -### Wait for Page Load +**Wait for Page Load** - Always wait for pages to fully load before taking screenshots - Use Cypress's built-in wait methods for dynamic content @@ -453,7 +453,7 @@ cy.smartuiSnapshot('Page Loaded'); -### Handle Dynamic Content +**Handle Dynamic Content** - Use `ignoreDOM` for elements that change between runs - Use `selectDOM` when you only need to compare specific areas @@ -463,7 +463,7 @@ cy.smartuiSnapshot('Page Loaded'); -### Configuration Management +**Configuration Management** - Keep `.smartui.json` in version control - Use environment variables for sensitive data @@ -473,7 +473,7 @@ cy.smartuiSnapshot('Page Loaded'); -### Test Organization +**Test Organization** - Group related screenshots in the same build - Use meaningful build names @@ -487,7 +487,7 @@ cy.smartuiSnapshot('Page Loaded'); -### Issue: Screenshots Not Appearing in Dashboard +**Issue: Screenshots Not Appearing in Dashboard** **Symptoms**: Tests run successfully but no screenshots appear in SmartUI dashboard @@ -517,7 +517,7 @@ cy.smartuiSnapshot('Page Loaded'); -### Issue: Project Not Found" Error +**Issue: Project Not Found" Error** **Symptoms**: Error message indicating project cannot be found @@ -535,7 +535,7 @@ cy.smartuiSnapshot('Page Loaded'); -### Issue: Screenshots Show Blank or Incorrect Content +**Issue: Screenshots Show Blank or Incorrect Content** **Symptoms**: Screenshots captured but show blank pages or incorrect content @@ -568,7 +568,7 @@ cy.smartuiSnapshot('Page Loaded'); -### Issue: Build Execution Fails +**Issue: Build Execution Fails** **Symptoms**: `npx smartui exec` command fails @@ -590,7 +590,7 @@ cy.smartuiSnapshot('Page Loaded'); -### Issue: npm Dependencies Not Resolving +**Issue: npm Dependencies Not Resolving** **Symptoms**: npm cannot find `@lambdatest/cypress-driver` or `@lambdatest/smartui-cli` @@ -618,7 +618,7 @@ cy.smartuiSnapshot('Page Loaded'); -### Issue: Screenshot Names Not Matching Baseline +**Issue: Screenshot Names Not Matching Baseline** **Symptoms**: Screenshots appear as New" instead of comparing with baseline @@ -633,7 +633,7 @@ cy.smartuiSnapshot('Page Loaded'); 3. Avoid special characters in screenshot names 4. Check for case sensitivity issues -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-draw-on-ui.md b/docs/smartui-draw-on-ui.md index 4f5ebe89..83ffffcc 100644 --- a/docs/smartui-draw-on-ui.md +++ b/docs/smartui-draw-on-ui.md @@ -94,11 +94,11 @@ All four annotation methods are accessible from the same **Actions** button (ann -### What is Ignore Region? +**What is Ignore Region?** **Ignore Region** excludes specific areas from visual comparison. Ideal for dynamic content that changes frequently but isn't critical to your visual tests, such as timestamps, notification badges, or advertisements. -### When to Use +**When to Use** - Ignoring notification counters that change frequently - Excluding advertisement banners @@ -106,7 +106,7 @@ All four annotation methods are accessible from the same **Actions** button (ann - Hiding dynamic user-generated content - Excluding non-critical UI elements that vary between builds -### How to Use +**How to Use** **Step 1:** Click on the **Actions** button (annotation icon) to open the annotation tool. @@ -126,7 +126,7 @@ All four annotation methods are accessible from the same **Actions** button (ann Result of ignore region -### Example +**Example** Ignoring a "Last updated" timestamp in a dashboard that changes with each page load. @@ -134,11 +134,11 @@ Ignoring a "Last updated" timestamp in a dashboard that changes with each page l -### What is Select Region? +**What is Select Region?** **Select Region** focuses visual comparison on specific areas of your screenshot. Only the selected regions will be compared, while everything else is automatically ignored. This is useful when you want to test only critical UI components. -### When to Use +**When to Use** - Testing only the main content area - Focusing on specific form fields @@ -146,7 +146,7 @@ Ignoring a "Last updated" timestamp in a dashboard that changes with each page l - Isolating header or footer sections - Testing specific widgets or components in isolation -### How to Use +**How to Use** **Step 1:** Click on the **Actions** button (annotation icon) to open the annotation tool. @@ -160,7 +160,7 @@ Ignoring a "Last updated" timestamp in a dashboard that changes with each page l > **Note:** You can define multiple select regions. All selected regions will be compared, and everything outside these regions will be ignored. -### Example +**Example** Testing only the checkout form while ignoring the rest of the page, including header, footer, and sidebar elements. @@ -168,7 +168,7 @@ Testing only the checkout form while ignoring the rest of the page, including he -### What is Floating Region? +**What is Floating Region?** **Floating Region** handles elements that move or shift position within a defined boundary. This feature uses two regions: - **Blue Region:** Defines the boundary where the element might move to (the floating area) @@ -176,7 +176,7 @@ Testing only the checkout form while ignoring the rest of the page, including he Perfect for handling dynamic elements that may appear in different positions but should be tested for content consistency. -### When to Use +**When to Use** - Testing notification badges that may appear in different positions - Handling tooltips or popovers that can move @@ -184,7 +184,7 @@ Perfect for handling dynamic elements that may appear in different positions but - Comparing elements that shift based on content length - Handling dropdown menus or modals that may appear in different locations -### How to Use +**How to Use** **Step 1:** Click on the **Actions** button (annotation icon) to open the annotation tool. @@ -204,7 +204,7 @@ Perfect for handling dynamic elements that may appear in different positions but > **Tip:** Make the blue region large enough to encompass all possible positions of the element, and keep the yellow region focused on the specific element you want to test. -### Example +**Example** Testing a notification badge that may appear in different positions based on content length or screen size. @@ -212,11 +212,11 @@ Testing a notification badge that may appear in different positions based on con -### What is Ignore Colors? +**What is Ignore Colors?** **Ignore Colors** ignores color differences in specific regions while still comparing the structure and layout. Particularly useful when colors may vary due to themes, user preferences, or A/B testing, but the structure should remain consistent. -### When to Use +**When to Use** - Ignoring color changes in themed applications - Handling A/B testing color variations @@ -224,7 +224,7 @@ Testing a notification badge that may appear in different positions based on con - Testing structure while ignoring color differences in specific regions - Comparing layouts across different theme configurations -### How to Use +**How to Use** **Step 1:** Click on the **Actions** button (annotation icon) to open the annotation tool. @@ -242,7 +242,7 @@ Testing a notification badge that may appear in different positions based on con > **Note:** Ignore Colors is particularly effective when combined with other annotation types for comprehensive visual testing. -### Example +**Example** Ignoring color differences in a themed navigation bar while testing its structure and layout across different theme configurations. @@ -391,7 +391,7 @@ Follow these best practices to get the most out of the annotation tool: -### Annotations Not Applying +**Annotations Not Applying** **Issue:** Annotations are not being applied to future builds. @@ -405,7 +405,7 @@ Follow these best practices to get the most out of the annotation tool: -### Floating Region Not Working +**Floating Region Not Working** **Issue:** Floating region is still showing false positives. @@ -419,7 +419,7 @@ Follow these best practices to get the most out of the annotation tool: -### Ignore Colors Still Showing Differences +**Ignore Colors Still Showing Differences** **Issue:** Color differences are still being detected in ignore colors regions. @@ -433,7 +433,7 @@ Follow these best practices to get the most out of the annotation tool: -### Annotations Disappearing +**Annotations Disappearing** **Issue:** Annotations are not visible or have disappeared. diff --git a/docs/smartui-handle-dynamic-data.md b/docs/smartui-handle-dynamic-data.md index 0c3d8560..9baaeb9c 100644 --- a/docs/smartui-handle-dynamic-data.md +++ b/docs/smartui-handle-dynamic-data.md @@ -77,11 +77,11 @@ You should use dynamic data handling in the following scenarios: -## Ignore DOM Elements +**Ignore DOM Elements** Use `ignoreDOM` to exclude specific elements from visual comparison. This is useful when you want to compare the entire page but ignore certain dynamic elements. -### Syntax +**Syntax** ```javascript let options = { @@ -95,7 +95,7 @@ let options = { smartuiSnapshot(driver, 'Screenshot Name', options); ``` -### Examples by Selector Type +**Examples by Selector Type** @@ -262,11 +262,11 @@ options = { -## Select DOM Elements +**Select DOM Elements** Use `selectDOM` to include only specific elements in visual comparison. This is useful when you want to compare only certain parts of the page, ignoring everything else. -### Syntax +**Syntax** ```javascript let options = { @@ -280,7 +280,7 @@ let options = { smartuiSnapshot(driver, 'Screenshot Name', options); ``` -### Examples by Selector Type +**Examples by Selector Type** @@ -433,7 +433,7 @@ options = { -## Combining ignoreDOM and selectDOM +**Combining ignoreDOM and selectDOM** You can combine both `ignoreDOM` and `selectDOM` in the same options object. When both are specified, `selectDOM` is applied first to include elements, then `ignoreDOM` is applied to exclude specific elements from the selected set. @@ -449,9 +449,9 @@ let options = { await smartuiSnapshot(driver, 'Home Page', options); ``` -### Use Cases +**Use Cases** -#### Use Case 1: E-commerce Product Page +**Use Case 1: E-commerce Product Page** **Scenario**: Product pages display prices, stock counts, and user reviews that change frequently. @@ -471,7 +471,7 @@ let options = { await smartuiSnapshot(driver, 'Product Page', options); ``` -#### Use Case 2: Dashboard with Real-time Data +**Use Case 2: Dashboard with Real-time Data** **Scenario**: Dashboard displays live metrics, timestamps, and user-specific data. @@ -493,7 +493,7 @@ let options = { await smartuiSnapshot(driver, 'Dashboard', options); ``` -#### Use Case 3: News Article Page +**Use Case 3: News Article Page** **Scenario**: Article pages have timestamps, author info, and related articles that change. @@ -513,7 +513,7 @@ await smartuiSnapshot(driver, 'Article Page', options); -## Best Practices +**Best Practices** 1. **Use Specific Selectors**: Prefer IDs or data attributes over generic class names for more precise targeting. @@ -528,15 +528,14 @@ await smartuiSnapshot(driver, 'Article Page', options); 6. **Use Data Attributes**: Add `data-testid` attributes to elements you need to target for better test stability. - - + ## Troubleshooting - + -### Issue: Elements Not Being Ignored +**Issue: Elements Not Being Ignored** **Possible Causes:** - Selector is incorrect or doesn't match any elements @@ -562,7 +561,7 @@ await smartuiSnapshot(driver, 'Page', options); -### Issue: selectDOM Not Working +**Issue: selectDOM Not Working** **Possible Causes:** - No elements match the selectors @@ -577,7 +576,7 @@ await smartuiSnapshot(driver, 'Page', options); -### Issue: False Positives Still Occurring +**Issue: False Positives Still Occurring** **Possible Causes:** - Not all dynamic elements are ignored @@ -592,9 +591,6 @@ await smartuiSnapshot(driver, 'Page', options); - - - ## Additional Resources - [Comprehensive Troubleshooting Guide](/support/docs/smartui-troubleshooting-guide) - Detailed solutions for common issues diff --git a/docs/smartui-handle-lazy-loading.md b/docs/smartui-handle-lazy-loading.md index 3af5c52c..429af360 100644 --- a/docs/smartui-handle-lazy-loading.md +++ b/docs/smartui-handle-lazy-loading.md @@ -273,7 +273,7 @@ await smartuiSnapshot(driver, "Lazy Loaded Images"); -### Choose the Right Method +**Choose the Right Method** - **Simple lazy loading**: Use `waitForTimeout` in configuration - **Complex lazy loading**: Use programmatic scrolling @@ -282,7 +282,7 @@ await smartuiSnapshot(driver, "Lazy Loaded Images"); -### Optimize Wait Times +**Optimize Wait Times** - Start with shorter wait times and increase if needed - Balance between thorough loading and test execution time @@ -291,7 +291,7 @@ await smartuiSnapshot(driver, "Lazy Loaded Images"); -### Scroll Incrementally +**Scroll Incrementally** - Use smaller scroll steps (200-500px) for better coverage - Wait between scrolls to allow content to load @@ -300,7 +300,7 @@ await smartuiSnapshot(driver, "Lazy Loaded Images"); -### Return to Top +**Return to Top** - Always scroll back to top after loading lazy content - Ensures consistent baseline for comparison @@ -309,7 +309,7 @@ await smartuiSnapshot(driver, "Lazy Loaded Images"); -### Combine Methods +**Combine Methods** - Use `waitForTimeout` for initial page load - Add programmatic scrolling for lazy content @@ -318,7 +318,7 @@ await smartuiSnapshot(driver, "Lazy Loaded Images"); -### Combine Methods +**Combine Methods** - Use `waitForTimeout` for initial page load - Add programmatic scrolling for lazy content @@ -352,7 +352,7 @@ await smartuiSnapshot(driver, "Lazy Loaded Images"); -### Issue: Content Still Missing After Scrolling +**Issue: Content Still Missing After Scrolling** **Solutions:** 1. Increase wait times between scrolls @@ -362,7 +362,7 @@ await smartuiSnapshot(driver, "Lazy Loaded Images"); -### Issue: Test Takes Too Long +**Issue: Test Takes Too Long** **Solutions:** 1. Reduce scroll step size but increase scroll speed @@ -372,7 +372,7 @@ await smartuiSnapshot(driver, "Lazy Loaded Images"); -### Issue: Inconsistent Results +**Issue: Inconsistent Results** **Solutions:** 1. Ensure consistent scroll pattern diff --git a/docs/smartui-handle-sticky-elements.md b/docs/smartui-handle-sticky-elements.md index e03b0e8a..6b047987 100644 --- a/docs/smartui-handle-sticky-elements.md +++ b/docs/smartui-handle-sticky-elements.md @@ -178,35 +178,35 @@ await smartuiSnapshot(driver, 'Content Only', options); -### Trust Automatic Handling +**Trust Automatic Handling** SmartUI's automatic handling works for most cases. Only use manual configuration if you encounter specific issues. -### Test Sticky Element Pages +**Test Sticky Element Pages** Verify that pages with sticky elements work correctly with SmartUI before running full test suites. -### Review Snapshots +**Review Snapshots** Occasionally review captured snapshots to ensure sticky elements are handled correctly. -### Combine with Other Features +**Combine with Other Features** You can combine sticky element handling with other SmartUI features like dynamic data handling. -### Combine with Other Features +**Combine with Other Features** You can combine sticky element handling with other SmartUI features like dynamic data handling. @@ -218,7 +218,7 @@ You can combine sticky element handling with other SmartUI features like dynamic -### Issue: Sticky Elements Still Causing False Positives +**Issue: Sticky Elements Still Causing False Positives** **Symptoms**: Sticky elements appear to cause differences in comparisons @@ -240,7 +240,7 @@ await smartuiSnapshot(driver, 'Page', options); -### Issue: Sticky Elements Not Visible in Snapshots +**Issue: Sticky Elements Not Visible in Snapshots** **Symptoms**: Sticky elements don't appear in captured screenshots @@ -258,7 +258,7 @@ await smartuiSnapshot(driver, 'Page'); -### Issue: Sticky Elements Overlapping Content +**Issue: Sticky Elements Overlapping Content** **Symptoms**: Sticky elements appear to overlap with page content diff --git a/docs/smartui-handle-videos.md b/docs/smartui-handle-videos.md index 410a9c62..0ad67866 100644 --- a/docs/smartui-handle-videos.md +++ b/docs/smartui-handle-videos.md @@ -184,7 +184,7 @@ SmartUI handles standard HTML5 video elements: -### Allow Video Loading +**Allow Video Loading** Use appropriate `waitForTimeout` values to ensure videos are loaded before snapshots. @@ -192,7 +192,7 @@ Use appropriate `waitForTimeout` values to ensure videos are loaded before snaps -### Test Video Pages +**Test Video Pages** Verify that video pages work correctly with SmartUI before running full test suites. @@ -200,7 +200,7 @@ Verify that video pages work correctly with SmartUI before running full test sui -### Combine with Other Features +**Combine with Other Features** Use `ignoreDOM` to exclude video controls if needed. @@ -208,7 +208,7 @@ Use `ignoreDOM` to exclude video controls if needed. -### Document Video Content +**Document Video Content** Note which pages contain videos for better test planning. @@ -216,7 +216,7 @@ Note which pages contain videos for better test planning. -### Review First Frames +**Review First Frames** Occasionally review captured first frames to ensure they represent the intended baseline. @@ -228,7 +228,7 @@ Occasionally review captured first frames to ensure they represent the intended -### Issue: Videos Not Captured Correctly +**Issue: Videos Not Captured Correctly** **Symptoms**: Video areas appear blank or incorrect in snapshots @@ -247,7 +247,7 @@ await smartuiSnapshot(driver, 'Video Page'); -### Issue: False Positives from Video Areas +**Issue: False Positives from Video Areas** **Symptoms**: Video areas show differences even when page design is unchanged @@ -259,7 +259,7 @@ await smartuiSnapshot(driver, 'Video Page'); -### Issue: Embedded Videos (YouTube, Vimeo) +**Issue: Embedded Videos (YouTube, Vimeo)** **Symptoms**: Embedded videos via iframe may not be captured correctly diff --git a/docs/smartui-k6-setup.md b/docs/smartui-k6-setup.md index bd2b3ee4..ea2924f6 100644 --- a/docs/smartui-k6-setup.md +++ b/docs/smartui-k6-setup.md @@ -240,7 +240,7 @@ k6 run k6-smartui.js -### Screenshot Naming +**Screenshot Naming** - Use descriptive, consistent names for screenshots - Include page/component name in screenshot names @@ -256,7 +256,7 @@ await smartuiSnapshot(page, "ProductPage-MainContent"); -### Wait for Page Load +**Wait for Page Load** - Always wait for pages to fully load before taking screenshots - Use K6's built-in wait methods for dynamic content @@ -273,7 +273,7 @@ await smartuiSnapshot(page, Page Loaded"); -### Handle Dynamic Content +**Handle Dynamic Content** - Use `ignoreDOM` for elements that change between runs - Use `selectDOM` when you only need to compare specific areas @@ -282,7 +282,7 @@ await smartuiSnapshot(page, Page Loaded"); -### Configuration Management +**Configuration Management** - Keep SmartUI configuration in version control - Use environment variables for sensitive data @@ -291,18 +291,21 @@ await smartuiSnapshot(page, Page Loaded"); -### Test Organization +**Test Organization** - Group related screenshots in the same build - Use meaningful build names - Run tests in consistent environments + + + ## Troubleshooting -### Issue: Screenshots Not Appearing in Dashboard +**Issue: Screenshots Not Appearing in Dashboard** **Symptoms**: Tests run successfully but no screenshots appear in SmartUI dashboard @@ -332,7 +335,7 @@ await smartuiSnapshot(page, Page Loaded"); -### Issue: Project Not Found" Error +**Issue: Project Not Found" Error** **Symptoms**: Error message indicating project cannot be found @@ -350,7 +353,7 @@ await smartuiSnapshot(page, Page Loaded"); -### Issue: Screenshots Show Blank or Incorrect Content +**Issue: Screenshots Show Blank or Incorrect Content** **Symptoms**: Screenshots captured but show blank pages or incorrect content @@ -382,7 +385,7 @@ await smartuiSnapshot(page, Page Loaded"); -### Issue: K6 Browser Not Enabled +**Issue: K6 Browser Not Enabled** **Symptoms**: Tests fail with browser not enabled" error @@ -412,7 +415,7 @@ await smartuiSnapshot(page, Page Loaded"); -### Issue: Screenshot Status Not Approved +**Issue: Screenshot Status Not Approved** **Symptoms**: Screenshots appear but status is not Approved" @@ -436,7 +439,7 @@ await smartuiSnapshot(page, Page Loaded"); -### Issue: Screenshot Names Not Matching Baseline +**Issue: Screenshot Names Not Matching Baseline** **Symptoms**: Screenshots appear as New" instead of comparing with baseline @@ -451,7 +454,7 @@ await smartuiSnapshot(page, Page Loaded"); 3. Avoid special characters in screenshot names 4. Check for case sensitivity issues -### Getting Help +**Getting Help** If you encounter issues not covered here: @@ -500,9 +503,6 @@ For additional information about K6 framework please explore the documentation [ - - - ## Advanced Options for Screenshot Comparison **Build Configuration** - If you have multiple screenshots running the same test suite and want to run the comparison for the same test suite, want to add a build as a baseline from your test suite or need to access more SmartUI Build Config Options, click [here](https://www.lambdatest.com/support/docs/smart-ui-build-options/). diff --git a/docs/smartui-katalon-plugin.md b/docs/smartui-katalon-plugin.md index 4832ee43..3ac09834 100644 --- a/docs/smartui-katalon-plugin.md +++ b/docs/smartui-katalon-plugin.md @@ -189,7 +189,7 @@ CustomKeywords.'com.katalon.plugin.keyword.smartui.SmartKeywords.startServer'('B -### Server Management +**Server Management** - Always include `startServer()` before taking screenshots and `stopServer()` after. @@ -197,7 +197,7 @@ CustomKeywords.'com.katalon.plugin.keyword.smartui.SmartKeywords.startServer'('B -### Snapshot Naming +**Snapshot Naming** - Use descriptive snapshot names for easy identification in SmartUI. @@ -205,7 +205,7 @@ CustomKeywords.'com.katalon.plugin.keyword.smartui.SmartKeywords.startServer'('B -### CI/CD Integration +**CI/CD Integration** - For CI/CD pipelines, set `PROJECT_TOKEN` as an environment variable in your CI tool (Jenkins, GitHub Actions, etc.). @@ -213,7 +213,7 @@ CustomKeywords.'com.katalon.plugin.keyword.smartui.SmartKeywords.startServer'('B -### Reporting +**Reporting** - Combine with Katalon's built-in reporting for comprehensive test insights. diff --git a/docs/smartui-multiselect-bulkops.md b/docs/smartui-multiselect-bulkops.md new file mode 100644 index 00000000..78689a6e --- /dev/null +++ b/docs/smartui-multiselect-bulkops.md @@ -0,0 +1,217 @@ +--- +id: smartui-multiselect-bulkops +title: SmartUI Multiselect & Bulk Operations +description: Learn how to quickly approve, reject, or move multiple SmartUI screenshots to baseline using the multiselect workflow on the Builds dashboard. +slug: smartui-multiselect-bulkops/ +keywords: + - SmartUI multiselect + - SmartUI bulk approval + - SmartUI dashboard actions + - SmartUI baseline move + - Visual regression maintenance +--- +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"; + +The SmartUI dashboard now supports **multiselect** across every build tab (New, Changes Found, Under Screening, Approved, Rejected, Baseline). You can review screenshots faster by selecting: + +- A single screenshot for a quick action. +- Multiple targeted screenshots across the visible tab. +- **Select All** to apply the same action to every screenshot currently filtered tab. + +This guide explains the end-to-end workflow, supported actions, and best practices to avoid accidental approvals or baseline edits. + +> Need help diagnosing CLI, dashboard, or baseline issues? Jump to the [SmartUI Troubleshooting Guide](/support/docs/smartui-troubleshooting-guide/). + +--- + +## Where multiselect appears + +1. Sign in to [LambdaTest SmartUI](https://smartui.lambdatest.com/). +2. Open any project → choose a build. +3. Navigate across tabs (e.g., **New**, **Changes Found**). +4. Look for the **selection toolbar** above the screenshot grid. + +SmartUI multiselect toolbar on Builds dashboard + +### Selection states + +| State | Description | Screenshot | +| --- | --- | --- | +| None selected | Bulk action buttons stay disabled until at least one screenshot is selected. | No selection state | +| Single selection | Shows contextual details (name, viewport, status). Bulk buttons activate. | Single screenshot selected | +| Multi selection | Displays count (e.g., “3 selected”) and unlocks all bulk actions. | Multiple screenshots selected | + +Use the checkbox beside each screenshot card or the **Select All** checkbox in the toolbar to toggle selections quickly. + +--- + +## Bulk actions + +### Approve screenshots + +Ideal when only a subset of diffs are valid. + +1. Filter to **Failed** or **Pending** tab. +2. Select the screenshots that represent expected UI updates. +3. Click **Approve**. + +Approve bulk operation + +SmartUI will: +- Mark each screenshot as **Approved**. +- Move them to the **Approved** tab for auditing. +- Preserve audit logs with the approver name and timestamp. + +### Reject screenshots + +Use this when a diff is unexpected, unstable, or blocked by other issues. + +1. Select the screenshots within **Failed**/**Pending**. +2. Click **Reject**. + +Reject bulk operation + +Rejected screenshots move to the **Rejected** tab and remain available for future comparison runs. + +### Move approved screenshots to Baseline + +Once approved diffs represent the new expected UI, promote them to Baseline: + +1. Go to the **Approved** tab. +2. Select individual screenshots, curated subsets, or **Select All**. +3. Click **Move to Baseline**. + +Move to baseline bulk operation + +> Baseline moves update the reference snapshot for the next comparison. Ensure you only promote validated UI changes to keep noise low in future runs. + +--- + +## Multiselect workflow example + + + + +1. Filter by tab `Changes Found`. +2. Use **Select All** (only filtered screenshots are targeted). +3. Deselect any screenshot needing manual review. +4. Click **Approve** → confirm in the dialog. +5. Bulk approval completes with a toast confirmation and updated counters. + + + + + +1. Sort failures by **Severity**. +2. Select the unexpected diffs (e.g., CTA color regressions). +3. Click **Reject** to block them from merging. +4. Add a note (optional) so teammates understand the rejection reason. + + + + + +1. After QA approval, hop to the **Approved** tab. +2. Select only the screenshots that represent canonical UI. +3. Click **Move to Baseline**. +4. Confirm to overwrite the existing baseline for the same test name + viewport. + + + + +--- + +## Best practices + + + + +
    +
  • Apply filters (approver, status, tab) before using Select All.
  • +
  • Confirm the selected count matches expectations to avoid cross-build approvals.
  • +
+ +
+ + + +
    +
  • Bulk actions are powerful—always double-check each screenshot thumbnail.
  • +
  • Use single selection for high-risk diffs (checkout, payments, authentication).
  • +
+ +
+ + + +
    +
  • After approving or rejecting, verify the activity log for transparency.
  • +
  • If anything was mis-clicked, undo by moving screenshots back via their tab.
  • +
+ +
+ + + +
    +
  • Promote to baseline only after QA sign-off.
  • +
  • Keep a release branch baseline separate using Smart Git.
  • +
+ +
+
+ +--- + +## Troubleshooting + + + + +

Symptoms: Checkboxes or bulk buttons stay disabled.

+

Fixes:

+
    +
  • Confirm you are in the Builds view, not inside an individual screenshot diff.
  • +
  • Refresh the page or clear cache if the toolbar fails to render.
  • +
  • Ensure your role has approval permissions on the project.
  • +
+ +
+ + + +

Symptoms: Toast error when approving/rejecting.

+

Fixes:

+
    +
  • Retry after verifying network connectivity.
  • +
  • Confirm the build is still active (not archived).
  • +
  • Check SmartUI Troubleshooting Guide for API rate limits or backend incidents.
  • +
+ +
+ + + +

Symptoms: Move to Baseline button disabled or no visible changes after promotion.

+

Fixes:

+
    +
  • Only Approved screenshots can be promoted; re-approve if needed.
  • +
  • Baseline updates can take a minute to propagate—refresh or reopen the build.
  • +
  • Ensure the associated branch/build is not locked by automated workflows.
  • +
+ +
+
+ +--- + +## Next steps + +- Compare multiselect approval speeds with your previous manual workflow and document the improvement. +- Pair multiselect with [Smart Ignore](/support/docs/smartui-smartignore/) to reduce noise before bulk approvals. +- Leverage [baseline management](/support/docs/smartui-baseline-management/) to keep production and release baselines in sync after bulk moves. + diff --git a/docs/smartui-pdf-api-upload.md b/docs/smartui-pdf-api-upload.md index 1d5a55f5..e9530337 100644 --- a/docs/smartui-pdf-api-upload.md +++ b/docs/smartui-pdf-api-upload.md @@ -124,7 +124,7 @@ The API will return a JSON response containing: -### PDF File Management +**PDF File Management** - Use consistent naming conventions for PDF files - Organize PDFs in logical directory structures @@ -135,7 +135,7 @@ The API will return a JSON response containing: -### Project Token Management +**Project Token Management** - Store project token as environment variable - Never commit tokens to version control @@ -146,7 +146,7 @@ The API will return a JSON response containing: -### Build Naming +**Build Naming** - Use meaningful build names that include version info - Include date or version in build names @@ -161,7 +161,7 @@ buildName="PDF-Comparison-v1.0-$(date +%Y%m%d)" -### Error Handling +**Error Handling** - Always check API response status - Handle network failures gracefully @@ -172,7 +172,7 @@ buildName="PDF-Comparison-v1.0-$(date +%Y%m%d)" -### Batch Processing +**Batch Processing** - Process PDFs in batches for efficiency - Monitor upload progress @@ -187,7 +187,7 @@ buildName="PDF-Comparison-v1.0-$(date +%Y%m%d)" -### Issue: PDF Upload Fails +**Issue: PDF Upload Fails** **Symptoms**: PDF upload returns error or fails silently @@ -210,7 +210,7 @@ buildName="PDF-Comparison-v1.0-$(date +%Y%m%d)" -### Issue: "Project Not Found" Error +**Issue: "Project Not Found" Error** **Symptoms**: Error message indicating project cannot be found @@ -228,7 +228,7 @@ buildName="PDF-Comparison-v1.0-$(date +%Y%m%d)" -### Issue: Upload Returns Error Response +**Issue: Upload Returns Error Response** **Symptoms**: API returns error status or failure message @@ -248,7 +248,7 @@ buildName="PDF-Comparison-v1.0-$(date +%Y%m%d)" -### Issue: PDFs Not Appearing in Dashboard +**Issue: PDFs Not Appearing in Dashboard** **Symptoms**: Uploads complete but PDFs don't appear in SmartUI dashboard @@ -265,7 +265,7 @@ buildName="PDF-Comparison-v1.0-$(date +%Y%m%d)" 4. Check upload response for errors 5. Review API response for upload status -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-pdf-cli-upload.md b/docs/smartui-pdf-cli-upload.md index 2c187675..d5a6d200 100644 --- a/docs/smartui-pdf-cli-upload.md +++ b/docs/smartui-pdf-cli-upload.md @@ -187,7 +187,7 @@ Example for GitHub Actions: -### PDF File Management +**PDF File Management** - Use consistent naming conventions for PDF files - Organize PDFs in logical directory structures @@ -198,7 +198,7 @@ Example for GitHub Actions: -### Project Token Management +**Project Token Management** - Store project token as environment variable - Never commit tokens to version control @@ -209,7 +209,7 @@ Example for GitHub Actions: -### Build Naming +**Build Naming** - Use meaningful build names that include version info - Include date or version in build names @@ -224,7 +224,7 @@ smartui upload-pdf ./pdfs/ --buildName Release-v1.0-$(date +%Y%m%d)" -### Error Handling +**Error Handling** - Always check CLI exit codes - Handle network failures gracefully @@ -235,7 +235,7 @@ smartui upload-pdf ./pdfs/ --buildName Release-v1.0-$(date +%Y%m%d)" -### Batch Processing +**Batch Processing** - Process PDFs in batches for efficiency - Monitor upload progress @@ -250,7 +250,7 @@ smartui upload-pdf ./pdfs/ --buildName Release-v1.0-$(date +%Y%m%d)" -### Issue: PDF Upload Fails +**Issue: PDF Upload Fails** **Symptoms**: CLI command fails or returns error @@ -290,7 +290,7 @@ smartui upload-pdf ./pdfs/ --buildName Release-v1.0-$(date +%Y%m%d)" -### Issue: Project Not Found" Error +**Issue: Project Not Found" Error** **Symptoms**: Error message indicating project cannot be found @@ -308,7 +308,7 @@ smartui upload-pdf ./pdfs/ --buildName Release-v1.0-$(date +%Y%m%d)" -### Issue: CLI Command Not Found +**Issue: CLI Command Not Found** **Symptoms**: `smartui` command not recognized @@ -333,7 +333,7 @@ smartui upload-pdf ./pdfs/ --buildName Release-v1.0-$(date +%Y%m%d)" -### Issue: Upload Returns Error +**Issue: Upload Returns Error** **Symptoms**: CLI returns error status or failure message @@ -353,7 +353,7 @@ smartui upload-pdf ./pdfs/ --buildName Release-v1.0-$(date +%Y%m%d)" -### Issue: PDFs Not Appearing in Dashboard +**Issue: PDFs Not Appearing in Dashboard** **Symptoms**: Uploads complete but PDFs don't appear in SmartUI dashboard @@ -370,7 +370,7 @@ smartui upload-pdf ./pdfs/ --buildName Release-v1.0-$(date +%Y%m%d)" 4. Check CLI output for errors 5. Use `--fetch-results` to verify upload status -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-pdf-java-sdk.md b/docs/smartui-pdf-java-sdk.md index 25fe153d..e63d2264 100644 --- a/docs/smartui-pdf-java-sdk.md +++ b/docs/smartui-pdf-java-sdk.md @@ -287,7 +287,7 @@ public class SmartuiPdfErrorHandling { -### PDF File Management +**PDF File Management** - Use consistent naming conventions for PDF files - Organize PDFs in logical directory structures @@ -305,7 +305,7 @@ String[] pdfPaths = { -### Project Token Management +**Project Token Management** - Store project token as environment variable - Never commit tokens to version control @@ -315,7 +315,7 @@ String[] pdfPaths = { -### Build Naming +**Build Naming** - Use meaningful build names that include version info - Include date or version in build names @@ -329,7 +329,7 @@ config.withBuildName(PDF-Comparison-v1.0-" + LocalDate.now()); -### Error Handling +**Error Handling** - Always wrap upload calls in try-catch blocks - Log errors for debugging @@ -339,7 +339,7 @@ config.withBuildName(PDF-Comparison-v1.0-" + LocalDate.now()); -### Batch Processing +**Batch Processing** - Process PDFs in batches for efficiency - Monitor upload progress @@ -349,7 +349,7 @@ config.withBuildName(PDF-Comparison-v1.0-" + LocalDate.now()); -### Batch Processing +**Batch Processing** - Process PDFs in batches for efficiency - Monitor upload progress @@ -364,7 +364,7 @@ config.withBuildName(PDF-Comparison-v1.0-" + LocalDate.now()); -### Issue: PDF Upload Fails +**Issue: PDF Upload Fails** **Symptoms**: PDF upload returns error or fails silently @@ -401,7 +401,7 @@ config.withBuildName(PDF-Comparison-v1.0-" + LocalDate.now()); -### Issue: Project Not Found" Error +**Issue: Project Not Found" Error** **Symptoms**: Error message indicating project cannot be found @@ -419,7 +419,7 @@ config.withBuildName(PDF-Comparison-v1.0-" + LocalDate.now()); -### Issue: Upload Returns Null or Empty Result +**Issue: Upload Returns Null or Empty Result** **Symptoms**: Upload completes but result is null or empty @@ -449,7 +449,7 @@ config.withBuildName(PDF-Comparison-v1.0-" + LocalDate.now()); -### Issue: Maven Dependencies Not Resolving +**Issue: Maven Dependencies Not Resolving** **Symptoms**: Maven cannot find `lambdatest-java-sdk` or dependencies fail @@ -470,7 +470,7 @@ config.withBuildName(PDF-Comparison-v1.0-" + LocalDate.now()); -### Issue: Batch Upload Partially Fails +**Issue: Batch Upload Partially Fails** **Symptoms**: Some PDFs upload successfully, others fail @@ -500,7 +500,7 @@ config.withBuildName(PDF-Comparison-v1.0-" + LocalDate.now()); -### Issue: PDFs Not Appearing in Dashboard +**Issue: PDFs Not Appearing in Dashboard** **Symptoms**: Uploads complete but PDFs don't appear in SmartUI dashboard @@ -517,7 +517,7 @@ config.withBuildName(PDF-Comparison-v1.0-" + LocalDate.now()); 4. Check upload response for errors 5. Review test execution logs -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-playwright-java-sdk.md b/docs/smartui-playwright-java-sdk.md index 5dc1eadf..24f86679 100644 --- a/docs/smartui-playwright-java-sdk.md +++ b/docs/smartui-playwright-java-sdk.md @@ -441,7 +441,7 @@ public void tearDown() { -### Screenshot Naming +**Screenshot Naming** - Use descriptive, consistent names for screenshots - Include page/component name in screenshot names @@ -457,7 +457,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "ProductPage-MainContent"); -### Wait for Page Load +**Wait for Page Load** - Always wait for pages to fully load before taking screenshots - Use Playwright's built-in wait methods for dynamic content @@ -473,7 +473,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Page Loaded"); -### Handle Dynamic Content +**Handle Dynamic Content** - Use `ignoreDOM` for elements that change between runs - Use `selectDOM` when you only need to compare specific areas @@ -482,7 +482,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Page Loaded"); -### Configuration Management +**Configuration Management** - Keep `.smartui.json` in version control - Use environment variables for sensitive data @@ -491,18 +491,18 @@ SmartUISnapshot.smartuiSnapshot(driver, "Page Loaded"); -### Test Organization +**Test Organization** - Group related screenshots in the same build - Use meaningful build names - Run tests in consistent environments -## Troubleshooting +**Troubleshooting** -### Issue: Screenshots Not Appearing in Dashboard +**Issue: Screenshots Not Appearing in Dashboard** **Symptoms**: Tests run successfully but no screenshots appear in SmartUI dashboard @@ -532,7 +532,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Page Loaded"); -### Issue: Project Not Found" Error +**Issue: Project Not Found" Error** **Symptoms**: Error message indicating project cannot be found @@ -550,7 +550,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Page Loaded"); -### Issue: Screenshots Show Blank or Incorrect Content +**Issue: Screenshots Show Blank or Incorrect Content** **Symptoms**: Screenshots captured but show blank pages or incorrect content @@ -581,7 +581,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Page Loaded"); -### Issue: Build Execution Fails +**Issue: Build Execution Fails** **Symptoms**: `npx smartui exec` command fails @@ -603,7 +603,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Page Loaded"); -### Issue: Maven Dependencies Not Resolving +**Issue: Maven Dependencies Not Resolving** **Symptoms**: Maven cannot find `lambdatest-java-sdk` or dependencies fail @@ -624,7 +624,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Page Loaded"); -### Issue: Screenshot Names Not Matching Baseline +**Issue: Screenshot Names Not Matching Baseline** **Symptoms**: Screenshots appear as New" instead of comparing with baseline @@ -639,7 +639,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Page Loaded"); 3. Avoid special characters in screenshot names 4. Check for case sensitivity issues -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-playwright-python-sdk.md b/docs/smartui-playwright-python-sdk.md index 6b74beeb..2a02699e 100644 --- a/docs/smartui-playwright-python-sdk.md +++ b/docs/smartui-playwright-python-sdk.md @@ -436,7 +436,7 @@ smartui_snapshot(page,"", options) -### Screenshot Naming +**Screenshot Naming** - Use descriptive, consistent names for screenshots - Include page/component name in screenshot names @@ -452,7 +452,7 @@ smartui_snapshot(page, "ProductPage-MainContent") -### Wait for Page Load +**Wait for Page Load** - Always wait for pages to fully load before taking screenshots - Use Playwright's built-in wait methods for dynamic content @@ -469,7 +469,7 @@ smartui_snapshot(page, "Page Loaded") -### Handle Dynamic Content +**Handle Dynamic Content** - Use `ignoreDOM` for elements that change between runs - Use `selectDOM` when you only need to compare specific areas @@ -478,7 +478,7 @@ smartui_snapshot(page, "Page Loaded") -### Configuration Management +**Configuration Management** - Keep `.smartui.json` in version control - Use environment variables for sensitive data @@ -487,18 +487,18 @@ smartui_snapshot(page, "Page Loaded") -### Test Organization +**Test Organization** - Group related screenshots in the same build - Use meaningful build names - Run tests in consistent environments -## Troubleshooting +**Troubleshooting** -### Issue: Screenshots Not Appearing in Dashboard +**Issue: Screenshots Not Appearing in Dashboard** **Symptoms**: Tests run successfully but no screenshots appear in SmartUI dashboard @@ -528,7 +528,7 @@ smartui_snapshot(page, "Page Loaded") -### Issue: "Project Not Found" Error +**Issue: "Project Not Found" Error** **Symptoms**: Error message indicating project cannot be found @@ -546,7 +546,7 @@ smartui_snapshot(page, "Page Loaded") -### Issue: Screenshots Show Blank or Incorrect Content +**Issue: Screenshots Show Blank or Incorrect Content** **Symptoms**: Screenshots captured but show blank pages or incorrect content @@ -578,7 +578,7 @@ smartui_snapshot(page, "Page Loaded") -### Issue: Build Execution Fails +**Issue: Build Execution Fails** **Symptoms**: `npx smartui exec` command fails @@ -600,7 +600,7 @@ smartui_snapshot(page, "Page Loaded") -### Issue: pip Dependencies Not Resolving +**Issue: pip Dependencies Not Resolving** **Symptoms**: pip cannot find `lambdatest-playwright-driver` or package installation fails @@ -638,7 +638,7 @@ smartui_snapshot(page, "Page Loaded") -### Issue: Screenshot Names Not Matching Baseline +**Issue: Screenshot Names Not Matching Baseline** **Symptoms**: Screenshots appear as "New" instead of comparing with baseline @@ -653,7 +653,7 @@ smartui_snapshot(page, "Page Loaded") 3. Avoid special characters in screenshot names 4. Check for case sensitivity issues -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-playwright-sdk.md b/docs/smartui-playwright-sdk.md index b042ec8d..55bffe5e 100644 --- a/docs/smartui-playwright-sdk.md +++ b/docs/smartui-playwright-sdk.md @@ -466,7 +466,7 @@ const smartuiSnapshot = require('@lambdatest/playwright-driver'); -### Screenshot Naming +**Screenshot Naming** - Use descriptive, consistent names for screenshots - Include page/component name in screenshot names @@ -483,7 +483,7 @@ await smartuiSnapshot.smartuiSnapshot(page, "ProductPage-MainContent"); -### Wait for Page Load +**Wait for Page Load** - Always wait for pages to fully load before taking screenshots - Use Playwright's built-in wait methods for dynamic content @@ -500,7 +500,7 @@ await smartuiSnapshot.smartuiSnapshot(page, Page Loaded"); -### Handle Dynamic Content +**Handle Dynamic Content** - Use `ignoreDOM` for elements that change between runs - Use `selectDOM` when you only need to compare specific areas @@ -510,7 +510,7 @@ await smartuiSnapshot.smartuiSnapshot(page, Page Loaded"); -### Configuration Management +**Configuration Management** - Keep `.smartui.json` in version control - Use environment variables for sensitive data @@ -520,7 +520,7 @@ await smartuiSnapshot.smartuiSnapshot(page, Page Loaded"); -### Test Organization +**Test Organization** - Group related screenshots in the same build - Use meaningful build names @@ -534,7 +534,7 @@ await smartuiSnapshot.smartuiSnapshot(page, Page Loaded"); -### Issue: Screenshots Not Appearing in Dashboard +**Issue: Screenshots Not Appearing in Dashboard** **Symptoms**: Tests run successfully but no screenshots appear in SmartUI dashboard @@ -564,7 +564,7 @@ await smartuiSnapshot.smartuiSnapshot(page, Page Loaded"); -### Issue: Project Not Found" Error +**Issue: Project Not Found" Error** **Symptoms**: Error message indicating project cannot be found @@ -582,7 +582,7 @@ await smartuiSnapshot.smartuiSnapshot(page, Page Loaded"); -### Issue: Screenshots Show Blank or Incorrect Content +**Issue: Screenshots Show Blank or Incorrect Content** **Symptoms**: Screenshots captured but show blank pages or incorrect content @@ -613,7 +613,7 @@ await smartuiSnapshot.smartuiSnapshot(page, Page Loaded"); -### Issue: Build Execution Fails +**Issue: Build Execution Fails** **Symptoms**: `npx smartui exec` command fails @@ -635,7 +635,7 @@ await smartuiSnapshot.smartuiSnapshot(page, Page Loaded"); -### Issue: npm Dependencies Not Resolving +**Issue: npm Dependencies Not Resolving** **Symptoms**: npm cannot find `@lambdatest/playwright-driver` or `@lambdatest/smartui-cli` @@ -663,7 +663,7 @@ await smartuiSnapshot.smartuiSnapshot(page, Page Loaded"); -### Issue: Screenshot Names Not Matching Baseline +**Issue: Screenshot Names Not Matching Baseline** **Symptoms**: Screenshots appear as New" instead of comparing with baseline @@ -678,7 +678,7 @@ await smartuiSnapshot.smartuiSnapshot(page, Page Loaded"); 3. Avoid special characters in screenshot names 4. Check for case sensitivity issues -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-project-settings.md b/docs/smartui-project-settings.md index 004373cc..c15e2717 100644 --- a/docs/smartui-project-settings.md +++ b/docs/smartui-project-settings.md @@ -72,11 +72,11 @@ To access the Project Settings, follow these simple steps: -## Project Token +**Project Token** The Project Token is a unique identifier that authenticates your SmartUI project for executing tests locally with CLI and APIs. You'll find your Project Token in the Project Settings after creating a project. -### Setting Up Project Token +**Setting Up Project Token** Use this key to authenticate your SmartUI project for executing locally with CLI and APIs. @@ -120,7 +120,7 @@ Keep your Project Token secure and never commit it to version control. Use envir -## Basic Settings +**Basic Settings** cmd @@ -142,13 +142,13 @@ Altering Approvers will impact email notifications, which will be sent to the la -## Comparison Settings +**Comparison Settings** Comparison Settings Comparison settings allow you to fine-tune how SmartUI compares screenshots, balancing between highlighting important changes and ignoring noise. -### Pixel Threshold +**Pixel Threshold** Strike a balance between highlighting important changes and ignoring noise. The pixel threshold determines the sensitivity of the comparison algorithm. @@ -165,7 +165,7 @@ Strike a balance between highlighting important changes and ignoring noise. The Adjusting the Pixel Threshold in Comparison Settings will only affect new builds/screenshots captured after the update. ::: -### Error Highlight Color +**Error Highlight Color** Set the color to show/highlight the changes in the pixel differences on your test output. @@ -180,7 +180,7 @@ Set the color to show/highlight the changes in the pixel differences on your tes **Use Case**: Choose a color that provides good contrast against your page background for easier visual identification of differences. -### Custom Mismatch Acceptance +**Custom Mismatch Acceptance** Configure pixel-to-pixel acceptance percentage for auto-approval. @@ -194,7 +194,7 @@ Configure pixel-to-pixel acceptance percentage for auto-approval. **Use Case**: Automatically approve screenshots with differences below the acceptance threshold, reducing manual review time. -### Smart Ignore +**Smart Ignore** Highlight content changes while smartly ignoring layout shifts and displacement differences. @@ -207,7 +207,7 @@ Highlight content changes while smartly ignoring layout shifts and displacement For detailed information, refer to [Smart Ignore Documentation](/support/docs/smartui-smartignore). -### Bounding Boxes +**Bounding Boxes** Configure your areas to which needs to be ignored or select a specific area for comparison. @@ -216,11 +216,11 @@ Configure your areas to which needs to be ignored or select a specific area for - Focus comparison on specific areas (main content, critical UI) - Define regions of interest for comparison -### Advanced Comparison Settings +**Advanced Comparison Settings** Manage your Pixel to Pixel false positives and comparison view types. -#### Ignore Pixel Scaling Options +**Ignore Pixel Scaling Options** Choose options to remove the Pixel to Pixel false-positive rate in identifying the screenshot. @@ -233,7 +233,7 @@ Choose options to remove the Pixel to Pixel false-positive rate in identifying t **Use Case**: Reduce false positives from rendering differences, browser-specific rendering, or minor pixel variations. -#### Error Type Identifier +**Error Type Identifier** Show the differences in the output screen by identifying the pixel changes type and capture the intended view. @@ -246,7 +246,7 @@ Show the differences in the output screen by identifying the pixel changes type **Use Case**: Choose the view that best helps you identify and understand the differences in your screenshots. -#### Transparency +**Transparency** Strike a balance between highlighting differences and maintaining visibility of the underlying content. @@ -256,7 +256,7 @@ Strike a balance between highlighting differences and maintaining visibility of **Use Case**: Adjust transparency to see both the differences and the original content for better context. -#### Resize Image +**Resize Image** Ability to scale the test screenshot according to baseline. @@ -270,16 +270,16 @@ Ability to scale the test screenshot according to baseline. Changes to Project Settings will impact builds/comparisons executed after the changes and the previous builds/comparisons remain unaffected. ::: -#### Additional Information: +**Additional Information:** For detailed information on these options, refer to our [Comparison Settings Documentation](https://www.lambdatest.com/support/docs/test-settings-options/). -## Build Settings +**Build Settings** -### Smart Baseline +**Smart Baseline** cmd @@ -299,14 +299,14 @@ When **`Smart Baseline`** is turned on, the system automatically updates the bas Please note that this feature is not supported for projects integrated with `Git` as `Git`-based projects follow a [Git branching strategy](https://www.lambdatest.com/support/docs/smartui-github-app-integration/). ::: -### Git Settings +**Git Settings** Configure Git-related settings for your project, including the baseline branch name, auto-approval branches, GitHub repository linkage, and run status checks. -#### Additional Information: +**Additional Information:** For detailed information on these options, refer to our [Git Baseline Branching Documentation](https://www.lambdatest.com/support/docs/smartui-github-app-integration/). -### Overwrite Screenshot +**Overwrite Screenshot** cmd @@ -318,13 +318,13 @@ For detailed information on these options, refer to our [Git Baseline Branching -## Notifications +**Notifications** Notifications Settings Configure how you receive alerts and updates about your SmartUI project. -### Email Notifications +**Email Notifications** Receive email notifications whenever there are changes found in your build or the project baseline changes. @@ -335,7 +335,7 @@ Receive email notifications whenever there are changes found in your build or th **Use Case**: Stay informed about visual changes without constantly checking the dashboard. -### Slack Alerts +**Slack Alerts** Receive Slack alerts whenever there are changes found in your build. @@ -354,7 +354,7 @@ We are continually adding more notification channels for SmartUI. -## LambdaTest Badge +**LambdaTest Badge** Show the world that you are using LambdaTest for your visual regression testing. @@ -365,7 +365,7 @@ Show the world that you are using LambdaTest for your visual regression testing. **Use Case**: Add to your README or documentation to showcase your testing setup. -## Delete Project +**Delete Project** cmd diff --git a/docs/smartui-puppeteer-sdk.md b/docs/smartui-puppeteer-sdk.md index c243c650..c564d5b9 100644 --- a/docs/smartui-puppeteer-sdk.md +++ b/docs/smartui-puppeteer-sdk.md @@ -469,7 +469,7 @@ const { smartuiSnapshot } = require('@lambdatest/puppeteer-driver'); -### Screenshot Naming +**Screenshot Naming** - Use descriptive, consistent names for screenshots - Include page/component name in screenshot names @@ -486,7 +486,7 @@ await smartuiSnapshot(page, "ProductPage-MainContent"); -### Wait for Page Load +**Wait for Page Load** - Always wait for pages to fully load before taking screenshots - Use Puppeteer's built-in wait methods for dynamic content @@ -504,7 +504,7 @@ await smartuiSnapshot(page, Page Loaded"); -### Handle Dynamic Content +**Handle Dynamic Content** - Use `ignoreDOM` for elements that change between runs - Use `selectDOM` when you only need to compare specific areas @@ -514,7 +514,7 @@ await smartuiSnapshot(page, Page Loaded"); -### Configuration Management +**Configuration Management** - Keep `.smartui.json` in version control - Use environment variables for sensitive data @@ -524,7 +524,7 @@ await smartuiSnapshot(page, Page Loaded"); -### Test Organization +**Test Organization** - Group related screenshots in the same build - Use meaningful build names @@ -538,7 +538,7 @@ await smartuiSnapshot(page, Page Loaded"); -### Issue: Screenshots Not Appearing in Dashboard +**Issue: Screenshots Not Appearing in Dashboard** **Symptoms**: Tests run successfully but no screenshots appear in SmartUI dashboard @@ -568,7 +568,7 @@ await smartuiSnapshot(page, Page Loaded"); -### Issue: Project Not Found" Error +**Issue: Project Not Found" Error** **Symptoms**: Error message indicating project cannot be found @@ -586,7 +586,7 @@ await smartuiSnapshot(page, Page Loaded"); -### Issue: Screenshots Show Blank or Incorrect Content +**Issue: Screenshots Show Blank or Incorrect Content** **Symptoms**: Screenshots captured but show blank pages or incorrect content @@ -618,7 +618,7 @@ await smartuiSnapshot(page, Page Loaded"); -### Issue: Build Execution Fails +**Issue: Build Execution Fails** **Symptoms**: `npx smartui exec` command fails @@ -640,7 +640,7 @@ await smartuiSnapshot(page, Page Loaded"); -### Issue: npm Dependencies Not Resolving +**Issue: npm Dependencies Not Resolving** **Symptoms**: npm cannot find `@lambdatest/puppeteer-driver` or `@lambdatest/smartui-cli` @@ -668,7 +668,7 @@ await smartuiSnapshot(page, Page Loaded"); -### Issue: Screenshot Names Not Matching Baseline +**Issue: Screenshot Names Not Matching Baseline** **Symptoms**: Screenshots appear as New" instead of comparing with baseline @@ -683,7 +683,7 @@ await smartuiSnapshot(page, Page Loaded"); 3. Avoid special characters in screenshot names 4. Check for case sensitivity issues -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-sdk-config-options.md b/docs/smartui-sdk-config-options.md index aa263a74..8caf5be5 100644 --- a/docs/smartui-sdk-config-options.md +++ b/docs/smartui-sdk-config-options.md @@ -100,15 +100,15 @@ The SmartUI configuration file follows a JSON structure. Below is a sample confi -### browsers +**browsers** An array of browsers to capture screenshots from. Supported browsers include `chrome`, `firefox`, `safari`, and `edge`. -### viewports +**viewports** An array of arrays representing different screen resolutions for web browsers. Each inner array contains viewport sizes. Each web viewport is automatically rendered for each of the browser mentioned in the config. -#### For capturing fullpage screenshots +**For capturing fullpage screenshots** To capture a screenshot of the entire page, you only need to define the viewport width in your configuration settings. Specify the desired width parameters as demonstrated in the following example to ensure a fullpage capture. @@ -126,7 +126,7 @@ To capture a screenshot of the entire page, you only need to define the viewport ], ``` -#### For capturing viewport screenshots +**For capturing viewport screenshots** To capture a screenshot of the content currently visible in your viewport, rather than the entire page, it's important to define the viewport's width and height in your configuration settings. Specify the desired width and height parameters as demonstrated in the following example to ensure that the screenshot encompasses only the viewport area. @@ -151,7 +151,7 @@ To capture a screenshot of the content currently visible in your viewport, rathe -### devices +**devices** An array of mobile devices to capture screenshots from. List of supported device names can be found [here](#list-of-supported-device-viewports). @@ -160,11 +160,11 @@ An array of mobile devices to capture screenshots from. List of supported device SmartUI SDK will soon be supported simulation in case of iOS devices. ::: -### fullPage +**fullPage** Specifies whether to capture full-page screenshots for mobile devices. By default, `fullPage` is taken as true; set it to `false` in order to take a viewport screenshot on a mobile viewport. -### orientation +**orientation** Specifies the orientation of the mobile device. You can choose from `portrait` or `landscape` according to your usecase. By default, the orientation is taken as portrait. @@ -172,19 +172,19 @@ Specifies the orientation of the mobile device. You can choose from `portrait` o -### waitForPageRender +**waitForPageRender** If one or more URLs in your script require a relatively higher amount of time to load, you may use the `waitForPageRender` key in the config file to make sure the screenshots are rendered correctly. Avoid using the same in case your websites render in less than 30 seconds as it might increase the execution time of your tests. -### waitForTimeout +**waitForTimeout** If you are using any async components, you can add wait time for the page to load the DOM of your components. This can help avoid false-positive results for your tests. You can add the wait time in milliseconds, which might increase the execution time of your tests. -### enableJavaScript +**enableJavaScript** The `enableJavaScript` option is a boolean parameter that determines whether JavaScript is enabled for all snapshots within the project. Enabling JavaScript may lead to side-effects such as animations or redirects, potentially affecting the reliability of your snapshots. By default, this option is set to false. -### allowedHostnames +**allowedHostnames** The `allowedHostnames` option controls the capture of assets from specific hostnames. By default, the SmartUI SDK only captures assets that match the hostname of the snapshot location. For instance, if snapshots are taken on `https://xyz.com`, assets hosted on `https://cdn.xyz.com` will not be captured. To include assets from other hostnames, each additional hostname needs to be added to the allowedHostnames configuration. @@ -192,7 +192,7 @@ The `allowedHostnames` option controls the capture of assets from specific hostn -## List of supported Device viewports +**List of supported Device viewports** | IOS Devices | Android Devices | |------------------|------------------------| diff --git a/docs/smartui-sdk-tunnel.md b/docs/smartui-sdk-tunnel.md index f01438dd..3c403c78 100644 --- a/docs/smartui-sdk-tunnel.md +++ b/docs/smartui-sdk-tunnel.md @@ -145,7 +145,7 @@ The tunnel configuration automatically uses the following environment variables -### Automatic vs Manual Mode +**Automatic vs Manual Mode** - Use automatic mode for simple setups and quick testing - Use manual mode when you need more control over tunnel lifecycle @@ -153,7 +153,7 @@ The tunnel configuration automatically uses the following environment variables -### Credentials Management +**Credentials Management** - Prefer environment variables for sensitive information - Use config file for non-sensitive settings @@ -161,7 +161,7 @@ The tunnel configuration automatically uses the following environment variables -### Proxy Configuration +**Proxy Configuration** - Specify proxy settings in config when using corporate networks - Test proxy settings before running full test suite @@ -169,7 +169,7 @@ The tunnel configuration automatically uses the following environment variables -### Logging +**Logging** - Enable verbose logging (`"v": true`) for troubleshooting - Specify custom log file location for persistent logs @@ -177,7 +177,7 @@ The tunnel configuration automatically uses the following environment variables -### Directory Testing +**Directory Testing** - Always specify the directory to test when working with local files - Ensure the directory path is accessible and contains the necessary files diff --git a/docs/smartui-selenium-csharp-sdk.md b/docs/smartui-selenium-csharp-sdk.md index 79bec6c2..2dd7a683 100644 --- a/docs/smartui-selenium-csharp-sdk.md +++ b/docs/smartui-selenium-csharp-sdk.md @@ -543,7 +543,7 @@ await SmartUISnapshot.CaptureSnapshot(driver, "Screenshot Name",options); -### Screenshot Naming +**Screenshot Naming** - Use descriptive, consistent names for screenshots - Include page/component name in screenshot names @@ -559,7 +559,7 @@ await SmartUISnapshot.CaptureSnapshot(driver, "ProductPage-MainContent"); -### Wait for Page Load +**Wait for Page Load** - Always wait for pages to fully load before taking screenshots - Use Selenium's WebDriverWait for dynamic content @@ -579,7 +579,7 @@ await SmartUISnapshot.CaptureSnapshot(driver, "Page Loaded"); -### Handle Dynamic Content +**Handle Dynamic Content** - Use `ignoreDOM` for elements that change between runs - Use `selectDOM` when you only need to compare specific areas @@ -588,7 +588,7 @@ await SmartUISnapshot.CaptureSnapshot(driver, "Page Loaded"); -### Configuration Management +**Configuration Management** - Keep `.smartui.json` in version control - Use environment variables for sensitive data @@ -597,18 +597,18 @@ await SmartUISnapshot.CaptureSnapshot(driver, "Page Loaded"); -### Test Organization +**Test Organization** - Group related screenshots in the same build - Use meaningful build names - Run tests in consistent environments -## Troubleshooting +**Troubleshooting** -### Issue: Screenshots Not Appearing in Dashboard +**Issue: Screenshots Not Appearing in Dashboard** **Symptoms**: Tests run successfully but no screenshots appear in SmartUI dashboard @@ -638,7 +638,7 @@ await SmartUISnapshot.CaptureSnapshot(driver, "Page Loaded"); -### Issue: "Project Not Found" Error +**Issue: "Project Not Found" Error** **Symptoms**: Error message indicating project cannot be found @@ -656,7 +656,7 @@ await SmartUISnapshot.CaptureSnapshot(driver, "Page Loaded"); -### Issue: Screenshots Show Blank or Incorrect Content +**Issue: Screenshots Show Blank or Incorrect Content** **Symptoms**: Screenshots captured but show blank pages or incorrect content @@ -688,7 +688,7 @@ await SmartUISnapshot.CaptureSnapshot(driver, "Page Loaded"); -### Issue: Build Execution Fails +**Issue: Build Execution Fails** **Symptoms**: `npx smartui exec` command fails @@ -710,7 +710,7 @@ await SmartUISnapshot.CaptureSnapshot(driver, "Page Loaded"); -### Issue: NuGet Dependencies Not Resolving +**Issue: NuGet Dependencies Not Resolving** **Symptoms**: NuGet cannot find `LambdaTest.Selenium.Driver` package @@ -731,7 +731,7 @@ await SmartUISnapshot.CaptureSnapshot(driver, "Page Loaded"); -### Issue: Screenshot Names Not Matching Baseline +**Issue: Screenshot Names Not Matching Baseline** **Symptoms**: Screenshots appear as "New" instead of comparing with baseline @@ -746,7 +746,7 @@ await SmartUISnapshot.CaptureSnapshot(driver, "Page Loaded"); 3. Avoid special characters in screenshot names 4. Check for case sensitivity issues -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-selenium-java-sdk.md b/docs/smartui-selenium-java-sdk.md index f0e0c977..23bf274e 100644 --- a/docs/smartui-selenium-java-sdk.md +++ b/docs/smartui-selenium-java-sdk.md @@ -479,7 +479,7 @@ public void tearDown() { -### Screenshot Naming +**Screenshot Naming** - Use descriptive, consistent names for screenshots - Include page/component name in screenshot names @@ -496,7 +496,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "ProductPage-MainContent"); -### Wait for Page Load +**Wait for Page Load** - Always wait for pages to fully load before taking screenshots - Use explicit waits for dynamic content @@ -514,7 +514,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Page Loaded"); -### Handle Dynamic Content +**Handle Dynamic Content** - Use `ignoreDOM` for elements that change between runs - Use `selectDOM` when you only need to compare specific areas @@ -524,7 +524,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Page Loaded"); -### Configuration Management +**Configuration Management** - Keep `.smartui.json` in version control - Use environment variables for sensitive data @@ -534,7 +534,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Page Loaded"); -### Test Organization +**Test Organization** - Group related screenshots in the same build - Use meaningful build names @@ -548,7 +548,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Page Loaded"); -### Issue: Screenshots Not Appearing in Dashboard +**Issue: Screenshots Not Appearing in Dashboard** **Symptoms**: Tests run successfully but no screenshots appear in SmartUI dashboard @@ -578,7 +578,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Page Loaded"); -### Issue: Project Not Found" Error +**Issue: Project Not Found" Error** **Symptoms**: Error message indicating project cannot be found @@ -596,7 +596,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Page Loaded"); -### Issue: Screenshots Show Blank or Incorrect Content +**Issue: Screenshots Show Blank or Incorrect Content** **Symptoms**: Screenshots captured but show blank pages or incorrect content @@ -627,7 +627,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Page Loaded"); -### Issue: Build Execution Fails +**Issue: Build Execution Fails** **Symptoms**: `npx smartui exec` command fails @@ -649,7 +649,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Page Loaded"); -### Issue: Maven Dependencies Not Resolving +**Issue: Maven Dependencies Not Resolving** **Symptoms**: Maven cannot find `lambdatest-java-sdk` dependency @@ -670,7 +670,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Page Loaded"); -### Issue: Screenshot Names Not Matching Baseline +**Issue: Screenshot Names Not Matching Baseline** **Symptoms**: Screenshots appear as New" instead of comparing with baseline @@ -685,7 +685,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Page Loaded"); 3. Avoid special characters in screenshot names 4. Check for case sensitivity issues -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-selenium-js-sdk.md b/docs/smartui-selenium-js-sdk.md index ceb98e19..d858510b 100644 --- a/docs/smartui-selenium-js-sdk.md +++ b/docs/smartui-selenium-js-sdk.md @@ -457,7 +457,7 @@ const { smartuiSnapshot } = require('@lambdatest/selenium-driver'); -### Screenshot Naming +**Screenshot Naming** - Use descriptive, consistent names for screenshots - Include page/component name in screenshot names @@ -474,7 +474,7 @@ await smartuiSnapshot(driver, "ProductPage-MainContent"); -### Wait for Page Load +**Wait for Page Load** - Always wait for pages to fully load before taking screenshots - Use Selenium's WebDriverWait for dynamic content @@ -492,7 +492,7 @@ await smartuiSnapshot(driver, Page Loaded"); -### Handle Dynamic Content +**Handle Dynamic Content** - Use `ignoreDOM` for elements that change between runs - Use `selectDOM` when you only need to compare specific areas @@ -502,7 +502,7 @@ await smartuiSnapshot(driver, Page Loaded"); -### Configuration Management +**Configuration Management** - Keep `.smartui.json` in version control - Use environment variables for sensitive data @@ -512,7 +512,7 @@ await smartuiSnapshot(driver, Page Loaded"); -### Test Organization +**Test Organization** - Group related screenshots in the same build - Use meaningful build names @@ -526,7 +526,7 @@ await smartuiSnapshot(driver, Page Loaded"); -### Issue: Screenshots Not Appearing in Dashboard +**Issue: Screenshots Not Appearing in Dashboard** **Symptoms**: Tests run successfully but no screenshots appear in SmartUI dashboard @@ -556,7 +556,7 @@ await smartuiSnapshot(driver, Page Loaded"); -### Issue: Project Not Found" Error +**Issue: Project Not Found" Error** **Symptoms**: Error message indicating project cannot be found @@ -574,7 +574,7 @@ await smartuiSnapshot(driver, Page Loaded"); -### Issue: Screenshots Show Blank or Incorrect Content +**Issue: Screenshots Show Blank or Incorrect Content** **Symptoms**: Screenshots captured but show blank pages or incorrect content @@ -606,7 +606,7 @@ await smartuiSnapshot(driver, Page Loaded"); -### Issue: Build Execution Fails +**Issue: Build Execution Fails** **Symptoms**: `npx smartui exec` command fails @@ -628,7 +628,7 @@ await smartuiSnapshot(driver, Page Loaded"); -### Issue: npm Dependencies Not Resolving +**Issue: npm Dependencies Not Resolving** **Symptoms**: npm cannot find `@lambdatest/selenium-driver` or `@lambdatest/smartui-cli` @@ -656,7 +656,7 @@ await smartuiSnapshot(driver, Page Loaded"); -### Issue: Screenshot Names Not Matching Baseline +**Issue: Screenshot Names Not Matching Baseline** **Symptoms**: Screenshots appear as New" instead of comparing with baseline @@ -671,7 +671,7 @@ await smartuiSnapshot(driver, Page Loaded"); 3. Avoid special characters in screenshot names 4. Check for case sensitivity issues -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-selenium-python-sdk.md b/docs/smartui-selenium-python-sdk.md index 64006dc5..6332adab 100644 --- a/docs/smartui-selenium-python-sdk.md +++ b/docs/smartui-selenium-python-sdk.md @@ -466,7 +466,7 @@ if __name__ == "__main__": -### Screenshot Naming +**Screenshot Naming** - Use descriptive, consistent names for screenshots - Include page/component name in screenshot names @@ -483,7 +483,7 @@ smartui_snapshot(driver, "ProductPage-MainContent") -### Wait for Page Load +**Wait for Page Load** - Always wait for pages to fully load before taking screenshots - Use Selenium's WebDriverWait for dynamic content @@ -505,7 +505,7 @@ smartui_snapshot(driver, "Page Loaded") -### Handle Dynamic Content +**Handle Dynamic Content** - Use `ignoreDOM` for elements that change between runs - Use `selectDOM` when you only need to compare specific areas @@ -515,7 +515,7 @@ smartui_snapshot(driver, "Page Loaded") -### Configuration Management +**Configuration Management** - Keep `.smartui.json` in version control - Use environment variables for sensitive data @@ -525,7 +525,7 @@ smartui_snapshot(driver, "Page Loaded") -### Test Organization +**Test Organization** - Group related screenshots in the same build - Use meaningful build names @@ -539,7 +539,7 @@ smartui_snapshot(driver, "Page Loaded") -### Issue: Screenshots Not Appearing in Dashboard +**Issue: Screenshots Not Appearing in Dashboard** **Symptoms**: Tests run successfully but no screenshots appear in SmartUI dashboard @@ -569,7 +569,7 @@ smartui_snapshot(driver, "Page Loaded") -### Issue: "Project Not Found" Error +**Issue: "Project Not Found" Error** **Symptoms**: Error message indicating project cannot be found @@ -587,7 +587,7 @@ smartui_snapshot(driver, "Page Loaded") -### Issue: Screenshots Show Blank or Incorrect Content +**Issue: Screenshots Show Blank or Incorrect Content** **Symptoms**: Screenshots captured but show blank pages or incorrect content @@ -623,7 +623,7 @@ smartui_snapshot(driver, "Page Loaded") -### Issue: Build Execution Fails +**Issue: Build Execution Fails** **Symptoms**: `npx smartui exec` command fails @@ -645,7 +645,7 @@ smartui_snapshot(driver, "Page Loaded") -### Issue: pip Dependencies Not Resolving +**Issue: pip Dependencies Not Resolving** **Symptoms**: pip cannot find `lambdatest-selenium-driver` or package installation fails @@ -683,7 +683,7 @@ smartui_snapshot(driver, "Page Loaded") -### Issue: Screenshot Names Not Matching Baseline +**Issue: Screenshot Names Not Matching Baseline** **Symptoms**: Screenshots appear as "New" instead of comparing with baseline @@ -698,7 +698,7 @@ smartui_snapshot(driver, "Page Loaded") 3. Avoid special characters in screenshot names 4. Check for case sensitivity issues -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-selenium-ruby-sdk.md b/docs/smartui-selenium-ruby-sdk.md index 32573343..af181a92 100644 --- a/docs/smartui-selenium-ruby-sdk.md +++ b/docs/smartui-selenium-ruby-sdk.md @@ -451,7 +451,7 @@ end -### Screenshot Naming +**Screenshot Naming** - Use descriptive, consistent names for screenshots - Include page/component name in screenshot names @@ -467,7 +467,7 @@ Lambdatest::Selenium::Driver.smartui_snapshot(driver, "ProductPage-MainContent") -### Wait for Page Load +**Wait for Page Load** - Always wait for pages to fully load before taking screenshots - Use Selenium's wait methods for dynamic content @@ -486,7 +486,7 @@ Lambdatest::Selenium::Driver.smartui_snapshot(driver, Page Loaded") -### Handle Dynamic Content +**Handle Dynamic Content** - Use `ignoreDOM` for elements that change between runs - Use `selectDOM` when you only need to compare specific areas @@ -495,7 +495,7 @@ Lambdatest::Selenium::Driver.smartui_snapshot(driver, Page Loaded") -### Configuration Management +**Configuration Management** - Keep `.smartui.json` in version control - Use environment variables for sensitive data @@ -504,18 +504,18 @@ Lambdatest::Selenium::Driver.smartui_snapshot(driver, Page Loaded") -### Test Organization +**Test Organization** - Group related screenshots in the same build - Use meaningful build names - Run tests in consistent environments -## Troubleshooting +**Troubleshooting** -### Issue: Screenshots Not Appearing in Dashboard +**Issue: Screenshots Not Appearing in Dashboard** **Symptoms**: Tests run successfully but no screenshots appear in SmartUI dashboard @@ -545,7 +545,7 @@ Lambdatest::Selenium::Driver.smartui_snapshot(driver, Page Loaded") -### Issue: Project Not Found" Error +**Issue: Project Not Found" Error** **Symptoms**: Error message indicating project cannot be found @@ -563,7 +563,7 @@ Lambdatest::Selenium::Driver.smartui_snapshot(driver, Page Loaded") -### Issue: Screenshots Show Blank or Incorrect Content +**Issue: Screenshots Show Blank or Incorrect Content** **Symptoms**: Screenshots captured but show blank pages or incorrect content @@ -595,7 +595,7 @@ Lambdatest::Selenium::Driver.smartui_snapshot(driver, Page Loaded") -### Issue: Build Execution Fails +**Issue: Build Execution Fails** **Symptoms**: `npx smartui exec` command fails @@ -617,7 +617,7 @@ Lambdatest::Selenium::Driver.smartui_snapshot(driver, Page Loaded") -### Issue: Gem Dependencies Not Resolving +**Issue: Gem Dependencies Not Resolving** **Symptoms**: Bundler cannot find `lambdatest-selenium-driver` gem @@ -646,7 +646,7 @@ Lambdatest::Selenium::Driver.smartui_snapshot(driver, Page Loaded") -### Issue: Screenshot Names Not Matching Baseline +**Issue: Screenshot Names Not Matching Baseline** **Symptoms**: Screenshots appear as New" instead of comparing with baseline @@ -661,7 +661,7 @@ Lambdatest::Selenium::Driver.smartui_snapshot(driver, Page Loaded") 3. Avoid special characters in screenshot names 4. Check for case sensitivity issues -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-smart-git-strategy.md b/docs/smartui-smart-git-strategy.md index 5f5596c9..df4b2c56 100644 --- a/docs/smartui-smart-git-strategy.md +++ b/docs/smartui-smart-git-strategy.md @@ -197,7 +197,7 @@ The Smart Git management works consistently across all SmartUI CLI commands (`ex -### Branch Naming +**Branch Naming** Use clear, consistent branch naming conventions. @@ -205,7 +205,7 @@ Use clear, consistent branch naming conventions. -### Regular Updates +**Regular Updates** Keep branches up to date with their parent branches. @@ -213,7 +213,7 @@ Keep branches up to date with their parent branches. -### Approval Process +**Approval Process** Establish clear approval criteria for each branch. @@ -221,7 +221,7 @@ Establish clear approval criteria for each branch. -### Documentation +**Documentation** Document branch-specific visual changes. @@ -229,7 +229,7 @@ Document branch-specific visual changes. -### Cleanup +**Cleanup** Regularly clean up old branches and their builds. @@ -241,7 +241,7 @@ Regularly clean up old branches and their builds. -### Comparison Issues +**Comparison Issues** 1. **Comparison Issues**: - Verify Smart Git is enabled: `echo $SMART_GIT` @@ -252,7 +252,7 @@ Regularly clean up old branches and their builds. -### Approval Issues +**Approval Issues** 1. **Approval Issues**: - Verify you have necessary permissions diff --git a/docs/smartui-smartignore.md b/docs/smartui-smartignore.md index 88dcd1f0..1cfde101 100644 --- a/docs/smartui-smartignore.md +++ b/docs/smartui-smartignore.md @@ -125,14 +125,14 @@ Smart Ignore may not be suitable for: -### Start with Project-Level Toggle +**Start with Project-Level Toggle** Enable Smart Ignore at the project level for consistent behavior across all tests. You can still switch to other comparison modes per screenshot if needed. -### Combine with Other Features +**Combine with Other Features** Smart Ignore works well with: - Dynamic data handling for content that changes @@ -142,21 +142,21 @@ Smart Ignore works well with: -### Review Results Regularly +**Review Results Regularly** While Smart Ignore reduces false positives, regularly review results to ensure it's not hiding important changes. -### Use Per-Screenshot Mode for Testing +**Use Per-Screenshot Mode for Testing** When testing Smart Ignore, use per-screenshot mode to compare results with other comparison modes and find the best approach for each test case. -### Use Per-Screenshot Mode for Testing +**Use Per-Screenshot Mode for Testing** When testing Smart Ignore, use per-screenshot mode to compare results with other comparison modes and find the best approach for each test case. @@ -168,7 +168,7 @@ When testing Smart Ignore, use per-screenshot mode to compare results with other -### Issue: Smart Ignore Not Available +**Issue: Smart Ignore Not Available** **Symptoms**: Smart Ignore toggle or option is not visible @@ -180,7 +180,7 @@ When testing Smart Ignore, use per-screenshot mode to compare results with other -### Issue: Too Many Differences Still Shown +**Issue: Too Many Differences Still Shown** **Symptoms**: Smart Ignore still shows many differences @@ -193,7 +193,7 @@ When testing Smart Ignore, use per-screenshot mode to compare results with other -### Issue: Important Changes Hidden +**Issue: Important Changes Hidden** **Symptoms**: Smart Ignore hides changes you want to see @@ -206,7 +206,7 @@ When testing Smart Ignore, use per-screenshot mode to compare results with other -### Issue: Inconsistent Results +**Issue: Inconsistent Results** **Symptoms**: Smart Ignore shows different results for similar changes diff --git a/docs/smartui-testcafe-sdk.md b/docs/smartui-testcafe-sdk.md index 4379612a..e9e7bba5 100644 --- a/docs/smartui-testcafe-sdk.md +++ b/docs/smartui-testcafe-sdk.md @@ -430,7 +430,7 @@ test('Scroll through the page, then take a smartUI Snapshot', async t => { -### Screenshot Naming +**Screenshot Naming** - Use descriptive, consistent names for screenshots - Include page/component name in screenshot names @@ -446,7 +446,7 @@ await smartuiSnapshot(t, 'ProductPage-MainContent'); -### Wait for Page Load +**Wait for Page Load** - Always wait for pages to fully load before taking screenshots - Use TestCafe's built-in wait methods for dynamic content @@ -468,7 +468,7 @@ test('Take screenshot after page loads', async t ="> { -### Handle Dynamic Content +**Handle Dynamic Content** - Use `ignoreDOM` for elements that change between runs - Use `selectDOM` when you only need to compare specific areas @@ -477,7 +477,7 @@ test('Take screenshot after page loads', async t ="> { -### Configuration Management +**Configuration Management** - Keep `.smartui.json` in version control - Use environment variables for sensitive data @@ -486,18 +486,18 @@ test('Take screenshot after page loads', async t ="> { -### Test Organization +**Test Organization** - Group related screenshots in the same build - Use meaningful build names - Run tests in consistent environments -## Troubleshooting +**Troubleshooting** -### Issue: Screenshots Not Appearing in Dashboard +**Issue: Screenshots Not Appearing in Dashboard** **Symptoms**: Tests run successfully but no screenshots appear in SmartUI dashboard @@ -527,7 +527,7 @@ test('Take screenshot after page loads', async t ="> { -### Issue: Project Not Found" Error +**Issue: Project Not Found" Error** **Symptoms**: Error message indicating project cannot be found @@ -545,7 +545,7 @@ test('Take screenshot after page loads', async t ="> { -### Issue: Screenshots Show Blank or Incorrect Content +**Issue: Screenshots Show Blank or Incorrect Content** **Symptoms**: Screenshots captured but show blank pages or incorrect content @@ -577,7 +577,7 @@ test('Take screenshot after page loads', async t ="> { -### Issue: Build Execution Fails +**Issue: Build Execution Fails** **Symptoms**: `npx smartui exec` command fails @@ -599,7 +599,7 @@ test('Take screenshot after page loads', async t ="> { -### Issue: npm Dependencies Not Resolving +**Issue: npm Dependencies Not Resolving** **Symptoms**: npm cannot find `@lambdatest/testcafe-driver` or `@lambdatest/smartui-cli` @@ -627,7 +627,7 @@ test('Take screenshot after page loads', async t ="> { -### Issue: Screenshot Names Not Matching Baseline +**Issue: Screenshot Names Not Matching Baseline** **Symptoms**: Screenshots appear as New" instead of comparing with baseline @@ -642,7 +642,7 @@ test('Take screenshot after page loads', async t ="> { 3. Avoid special characters in screenshot names 4. Check for case sensitivity issues -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-troubleshooting-guide.md b/docs/smartui-troubleshooting-guide.md index e230162a..8bc7352a 100644 --- a/docs/smartui-troubleshooting-guide.md +++ b/docs/smartui-troubleshooting-guide.md @@ -65,7 +65,7 @@ Before diving into specific issues, run through this quick checklist: -### Issue: Screenshots Not Appearing in Dashboard +**Issue: Screenshots Not Appearing in Dashboard** **Symptoms**: - Tests run successfully but no screenshots appear in SmartUI dashboard @@ -352,7 +352,7 @@ Before diving into specific issues, run through this quick checklist: -### Issue: Screenshots Show Blank or Incorrect Content +**Issue: Screenshots Show Blank or Incorrect Content** **Symptoms**: - Screenshots captured but show blank pages @@ -420,7 +420,7 @@ Before diving into specific issues, run through this quick checklist: --- -### Issue: Screenshot Names Not Matching Baseline +**Issue: Screenshot Names Not Matching Baseline** **Symptoms**: - Screenshots appear as "New" instead of comparing with baseline @@ -469,7 +469,7 @@ Before diving into specific issues, run through this quick checklist: --- -### Issue: High Mismatch Percentage or False Positives +**Issue: High Mismatch Percentage or False Positives** **Symptoms**: - Mismatch percentage higher than expected @@ -519,7 +519,7 @@ Before diving into specific issues, run through this quick checklist: -### Issue: Build Execution Fails +**Issue: Build Execution Fails** **Symptoms**: - `npx smartui exec` command fails @@ -575,7 +575,7 @@ Before diving into specific issues, run through this quick checklist: --- -### Issue: Dependencies Not Resolving +**Issue: Dependencies Not Resolving** **Symptoms**: - Package manager cannot find dependencies @@ -638,7 +638,7 @@ Before diving into specific issues, run through this quick checklist: -### Issue: Pipeline/Workflow Fails with "Secret/Variable Not Found" +**Issue: Pipeline/Workflow Fails with "Secret/Variable Not Found"** **Symptoms**: - CI/CD pipeline fails @@ -693,7 +693,7 @@ Before diving into specific issues, run through this quick checklist: --- -### Issue: Tests Run But No Results in Dashboard (CI/CD) +**Issue: Tests Run But No Results in Dashboard (CI/CD)** **Symptoms**: - Pipeline completes successfully @@ -733,7 +733,7 @@ Before diving into specific issues, run through this quick checklist: -### Issue: Configuration File Errors +**Issue: Configuration File Errors** **Symptoms**: - "must NOT have additional properties" error @@ -770,7 +770,7 @@ Before diving into specific issues, run through this quick checklist: --- -### Issue: Environment Variables Not Persisting or Not Working +**Issue: Environment Variables Not Persisting or Not Working** **Symptoms**: - Environment variables work in one terminal but not another @@ -998,7 +998,7 @@ Before diving into specific issues, run through this quick checklist: -### Issue: Proxy Configuration Not Working +**Issue: Proxy Configuration Not Working** **Symptoms**: - Tests fail behind proxy @@ -1033,7 +1033,7 @@ Before diving into specific issues, run through this quick checklist: --- -### Issue: Tunnel Connection Issues +**Issue: Tunnel Connection Issues** **Symptoms**: - Tunnel connection fails diff --git a/docs/smartui-wdio-sdk.md b/docs/smartui-wdio-sdk.md index 515b2c8a..d16f28e1 100644 --- a/docs/smartui-wdio-sdk.md +++ b/docs/smartui-wdio-sdk.md @@ -409,7 +409,7 @@ let options = { -### Screenshot Naming +**Screenshot Naming** - Use descriptive, consistent names for screenshots - Include page/component name in screenshot names @@ -425,7 +425,7 @@ await smartuiSnapshot(driver, 'ProductPage-MainContent'); -### Wait for Page Load +**Wait for Page Load** - Always wait for pages to fully load before taking screenshots - Use WebdriverIO's built-in wait methods for dynamic content @@ -441,7 +441,7 @@ await smartuiSnapshot(driver, 'Page Loaded'); -### Handle Dynamic Content +**Handle Dynamic Content** - Use `ignoreDOM` for elements that change between runs - Use `selectDOM` when you only need to compare specific areas @@ -450,7 +450,7 @@ await smartuiSnapshot(driver, 'Page Loaded'); -### Configuration Management +**Configuration Management** - Keep `.smartui.json` in version control - Use environment variables for sensitive data @@ -459,18 +459,18 @@ await smartuiSnapshot(driver, 'Page Loaded'); -### Test Organization +**Test Organization** - Group related screenshots in the same build - Use meaningful build names - Run tests in consistent environments -## Troubleshooting +**Troubleshooting** -### Issue: Screenshots Not Appearing in Dashboard +**Issue: Screenshots Not Appearing in Dashboard** **Symptoms**: Tests run successfully but no screenshots appear in SmartUI dashboard @@ -500,7 +500,7 @@ await smartuiSnapshot(driver, 'Page Loaded'); -### Issue: Project Not Found" Error +**Issue: Project Not Found" Error** **Symptoms**: Error message indicating project cannot be found @@ -518,7 +518,7 @@ await smartuiSnapshot(driver, 'Page Loaded'); -### Issue: Screenshots Show Blank or Incorrect Content +**Issue: Screenshots Show Blank or Incorrect Content** **Symptoms**: Screenshots captured but show blank pages or incorrect content @@ -550,7 +550,7 @@ await smartuiSnapshot(driver, 'Page Loaded'); -### Issue: Build Execution Fails +**Issue: Build Execution Fails** **Symptoms**: `npx smartui exec` command fails @@ -572,7 +572,7 @@ await smartuiSnapshot(driver, 'Page Loaded'); -### Issue: npm Dependencies Not Resolving +**Issue: npm Dependencies Not Resolving** **Symptoms**: npm cannot find `@lambdatest/wdio-driver` or `@lambdatest/smartui-cli` @@ -600,7 +600,7 @@ await smartuiSnapshot(driver, 'Page Loaded'); -### Issue: Screenshot Names Not Matching Baseline +**Issue: Screenshot Names Not Matching Baseline** **Symptoms**: Screenshots appear as New" instead of comparing with baseline @@ -615,7 +615,7 @@ await smartuiSnapshot(driver, 'Page Loaded'); 3. Avoid special characters in screenshot names 4. Check for case sensitivity issues -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-with-azure.md b/docs/smartui-with-azure.md index 1f12237a..44cbb080 100644 --- a/docs/smartui-with-azure.md +++ b/docs/smartui-with-azure.md @@ -115,7 +115,7 @@ jobs: -### Secret Management +**Secret Management** - Never commit credentials to repository - Use Azure Pipeline Variables for all sensitive data @@ -126,7 +126,7 @@ jobs: -### Pipeline Optimization +**Pipeline Optimization** - Use parallel jobs for faster execution - Cache dependencies to speed up pipelines @@ -145,7 +145,7 @@ trigger: -### Build Naming +**Build Naming** - Use meaningful build names that include branch/commit info - Include commit SHA for traceability @@ -160,7 +160,7 @@ variables: -### Error Handling +**Error Handling** - Set up proper error handling in pipelines - Use pipeline status checks @@ -170,7 +170,7 @@ variables: -### Resource Management +**Resource Management** - Limit concurrent pipeline runs - Clean up old builds regularly @@ -180,7 +180,7 @@ variables: -### Resource Management +**Resource Management** - Limit concurrent pipeline runs - Clean up old builds regularly @@ -195,7 +195,7 @@ variables: -### Issue: Pipeline Fails with "Variable Not Found" +**Issue: Pipeline Fails with "Variable Not Found"** **Symptoms**: Pipeline fails with error about missing variables @@ -219,7 +219,7 @@ variables: -### Issue: PROJECT_TOKEN Not Available +**Issue: PROJECT_TOKEN Not Available** **Symptoms**: Pipeline prompts for PROJECT_TOKEN or token not found @@ -244,7 +244,7 @@ variables: -### Issue: Tests Run But No Results in Dashboard +**Issue: Tests Run But No Results in Dashboard** **Symptoms**: Pipeline completes but screenshots don't appear in SmartUI @@ -276,7 +276,7 @@ variables: -### Issue: Pipeline Times Out +**Issue: Pipeline Times Out** **Symptoms**: Pipeline execution exceeds time limit @@ -308,7 +308,7 @@ variables: -### Issue: Dependencies Installation Fails +**Issue: Dependencies Installation Fails** **Symptoms**: npm install or dependency installation fails @@ -340,7 +340,7 @@ variables: -### Issue: SmartUI CLI Not Found +**Issue: SmartUI CLI Not Found** **Symptoms**: `npx smartui` command fails with command not found" @@ -368,7 +368,7 @@ variables: npm install -g @lambdatest/smartui-cli ``` -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-with-bitbucket.md b/docs/smartui-with-bitbucket.md index ea9a45b8..8caacdaa 100644 --- a/docs/smartui-with-bitbucket.md +++ b/docs/smartui-with-bitbucket.md @@ -91,7 +91,7 @@ You can also store your *LT_USERNAME*, *LT_ACCESS_KEY* and *PROJECT_TOKEN* as se -### Secret Management +**Secret Management** - Never commit credentials to repository - Use Bitbucket Pipelines Variables for all sensitive data @@ -101,7 +101,7 @@ You can also store your *LT_USERNAME*, *LT_ACCESS_KEY* and *PROJECT_TOKEN* as se -### Pipeline Optimization +**Pipeline Optimization** - Use parallel steps for faster execution - Cache dependencies to speed up pipelines @@ -119,7 +119,7 @@ branches: -### Build Naming +**Build Naming** - Use meaningful build names that include branch/commit info - Include commit SHA for traceability @@ -134,7 +134,7 @@ variables: -### Error Handling +**Error Handling** - Set up proper error handling in pipelines - Use pipeline status checks @@ -144,7 +144,7 @@ variables: -### Resource Management +**Resource Management** - Limit concurrent pipeline runs - Clean up old builds regularly @@ -154,7 +154,7 @@ variables: -### Resource Management +**Resource Management** - Limit concurrent pipeline runs - Clean up old builds regularly @@ -169,7 +169,7 @@ variables: -### Issue: Pipeline Fails with "Variable Not Found" +**Issue: Pipeline Fails with "Variable Not Found"** **Symptoms**: Pipeline fails with error about missing variables @@ -192,7 +192,7 @@ variables: -### Issue: PROJECT_TOKEN Not Available +**Issue: PROJECT_TOKEN Not Available** **Symptoms**: Pipeline prompts for PROJECT_TOKEN or token not found @@ -217,7 +217,7 @@ variables: -### Issue: Tests Run But No Results in Dashboard +**Issue: Tests Run But No Results in Dashboard** **Symptoms**: Pipeline completes but screenshots don't appear in SmartUI @@ -245,7 +245,7 @@ variables: -### Issue: Pipeline Times Out +**Issue: Pipeline Times Out** **Symptoms**: Pipeline execution exceeds time limit @@ -273,7 +273,7 @@ variables: -### Issue: Dependencies Installation Fails +**Issue: Dependencies Installation Fails** **Symptoms**: npm install or dependency installation fails @@ -303,7 +303,7 @@ variables: -### Issue: SmartUI CLI Not Found +**Issue: SmartUI CLI Not Found** **Symptoms**: `npx smartui` command fails with command not found" @@ -330,7 +330,7 @@ variables: - npm install -g @lambdatest/smartui-cli ``` -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-with-buildkite.md b/docs/smartui-with-buildkite.md index 76042ee7..761c3ae5 100644 --- a/docs/smartui-with-buildkite.md +++ b/docs/smartui-with-buildkite.md @@ -105,7 +105,7 @@ steps: -### Secret Management +**Secret Management** - Never commit credentials to repository - Use Buildkite Environment Variables for all sensitive data @@ -116,7 +116,7 @@ steps: -### Pipeline Optimization +**Pipeline Optimization** - Use parallel steps for faster execution - Cache dependencies to speed up pipelines @@ -131,7 +131,7 @@ branches: main develop" -### Build Naming +**Build Naming** - Use meaningful build names that include branch/commit info - Include commit SHA for traceability @@ -146,7 +146,7 @@ env: -### Error Handling +**Error Handling** - Set up proper error handling in pipelines - Use pipeline status checks @@ -156,7 +156,7 @@ env: -### Resource Management +**Resource Management** - Limit concurrent pipeline runs - Clean up old builds regularly @@ -166,7 +166,7 @@ env: -### Resource Management +**Resource Management** - Limit concurrent pipeline runs - Clean up old builds regularly @@ -181,7 +181,7 @@ env: -### Issue: Pipeline Fails with "Variable Not Found" +**Issue: Pipeline Fails with "Variable Not Found"** **Symptoms**: Pipeline fails with error about missing environment variables @@ -205,7 +205,7 @@ env: -### Issue: PROJECT_TOKEN Not Available +**Issue: PROJECT_TOKEN Not Available** **Symptoms**: Pipeline prompts for PROJECT_TOKEN or token not found @@ -230,7 +230,7 @@ env: -### Issue: Tests Run But No Results in Dashboard +**Issue: Tests Run But No Results in Dashboard** **Symptoms**: Pipeline completes but screenshots don't appear in SmartUI @@ -260,7 +260,7 @@ env: -### Issue: Pipeline Times Out +**Issue: Pipeline Times Out** **Symptoms**: Pipeline execution exceeds time limit @@ -291,7 +291,7 @@ env: -### Issue: Dependencies Installation Fails +**Issue: Dependencies Installation Fails** **Symptoms**: npm install or dependency installation fails @@ -322,7 +322,7 @@ env: -### Issue: SmartUI CLI Not Found +**Issue: SmartUI CLI Not Found** **Symptoms**: `npx smartui` command fails with command not found" @@ -350,7 +350,7 @@ env: - npm install -g @lambdatest/smartui-cli ``` -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-with-circle-ci.md b/docs/smartui-with-circle-ci.md index 162285f5..a228b00b 100644 --- a/docs/smartui-with-circle-ci.md +++ b/docs/smartui-with-circle-ci.md @@ -113,7 +113,7 @@ workflows: -### Secret Management +**Secret Management** - Never commit credentials to repository - Use CircleCI Environment Variables for all sensitive data @@ -124,7 +124,7 @@ workflows: -### Pipeline Optimization +**Pipeline Optimization** - Use parallel jobs for faster execution - Cache dependencies to speed up pipelines @@ -148,7 +148,7 @@ workflows: -### Build Naming +**Build Naming** - Use meaningful build names that include branch/commit info - Include commit SHA for traceability @@ -163,7 +163,7 @@ environment: -### Error Handling +**Error Handling** - Set up proper error handling in pipelines - Use pipeline status checks @@ -173,7 +173,7 @@ environment: -### Resource Management +**Resource Management** - Limit concurrent pipeline runs - Clean up old builds regularly @@ -183,7 +183,7 @@ environment: -### Resource Management +**Resource Management** - Limit concurrent pipeline runs - Clean up old builds regularly @@ -198,7 +198,7 @@ environment: -### Issue: Pipeline Fails with "Variable Not Found" +**Issue: Pipeline Fails with "Variable Not Found"** **Symptoms**: Pipeline fails with error about missing environment variables @@ -222,7 +222,7 @@ environment: -### Issue: PROJECT_TOKEN Not Available +**Issue: PROJECT_TOKEN Not Available** **Symptoms**: Pipeline prompts for PROJECT_TOKEN or token not found @@ -247,7 +247,7 @@ environment: -### Issue: Tests Run But No Results in Dashboard +**Issue: Tests Run But No Results in Dashboard** **Symptoms**: Pipeline completes but screenshots don't appear in SmartUI @@ -278,7 +278,7 @@ environment: -### Issue: Pipeline Times Out +**Issue: Pipeline Times Out** **Symptoms**: Pipeline execution exceeds time limit @@ -311,7 +311,7 @@ environment: -### Issue: Dependencies Installation Fails +**Issue: Dependencies Installation Fails** **Symptoms**: npm install or dependency installation fails @@ -344,7 +344,7 @@ environment: -### Issue: SmartUI CLI Not Found +**Issue: SmartUI CLI Not Found** **Symptoms**: `npx smartui` command fails with command not found" @@ -374,7 +374,7 @@ environment: command: npm install -g @lambdatest/smartui-cli ``` -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-with-github-actions.md b/docs/smartui-with-github-actions.md index 11d5c108..2db93ca1 100644 --- a/docs/smartui-with-github-actions.md +++ b/docs/smartui-with-github-actions.md @@ -87,7 +87,7 @@ To run the new pipeline that you just created, click the **Run workflow** button -### Secret Management +**Secret Management** - Never commit credentials to repository - Use GitHub Secrets for all sensitive data @@ -97,7 +97,7 @@ To run the new pipeline that you just created, click the **Run workflow** button -### Workflow Optimization +**Workflow Optimization** - Use matrix strategies for parallel execution - Cache dependencies to speed up workflows @@ -116,7 +116,7 @@ on: -### Build Naming +**Build Naming** - Use meaningful build names that include branch/PR info - Include commit SHA for traceability @@ -133,7 +133,7 @@ on: -### Error Handling +**Error Handling** - Set up proper error handling in workflows - Use workflow status checks @@ -143,7 +143,7 @@ on: -### Resource Management +**Resource Management** - Limit concurrent workflow runs - Clean up old builds regularly @@ -153,7 +153,7 @@ on: -### Resource Management +**Resource Management** - Limit concurrent workflow runs - Clean up old builds regularly @@ -168,7 +168,7 @@ on: -### Issue: Workflow Fails with "Secret Not Found" +**Issue: Workflow Fails with "Secret Not Found"** **Symptoms**: Workflow fails with error about missing secrets @@ -191,7 +191,7 @@ on: -### Issue: PROJECT_TOKEN Prompt Appears +**Issue: PROJECT_TOKEN Prompt Appears** **Symptoms**: Workflow prompts for PROJECT_TOKEN during execution @@ -222,7 +222,7 @@ on: -### Issue: Tests Run But No Results in Dashboard +**Issue: Tests Run But No Results in Dashboard** **Symptoms**: Workflow completes but screenshots don't appear in SmartUI @@ -252,7 +252,7 @@ on: -### Issue: Workflow Times Out +**Issue: Workflow Times Out** **Symptoms**: Workflow execution exceeds time limit @@ -281,7 +281,7 @@ on: -### Issue: Dependencies Installation Fails +**Issue: Dependencies Installation Fails** **Symptoms**: npm install or dependency installation fails @@ -311,7 +311,7 @@ on: -### Issue: SmartUI CLI Not Found +**Issue: SmartUI CLI Not Found** **Symptoms**: `npx smartui` command fails with command not found" @@ -338,7 +338,7 @@ on: - run: npm install -g @lambdatest/smartui-cli ``` -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-with-gitlab.md b/docs/smartui-with-gitlab.md index c5d3e3b2..ff15276f 100644 --- a/docs/smartui-with-gitlab.md +++ b/docs/smartui-with-gitlab.md @@ -91,7 +91,7 @@ You can also store your *LT_USERNAME*, *LT_ACCESS_KEY* and *PROJECT_TOKEN* as se -### Secret Management +**Secret Management** - Never commit credentials to repository - Use GitLab CI/CD Variables for all sensitive data @@ -101,7 +101,7 @@ You can also store your *LT_USERNAME*, *LT_ACCESS_KEY* and *PROJECT_TOKEN* as se -### Pipeline Optimization +**Pipeline Optimization** - Use parallel jobs for faster execution - Cache dependencies to speed up pipelines @@ -119,7 +119,7 @@ only: -### Build Naming +**Build Naming** - Use meaningful build names that include branch/commit info - Include commit SHA for traceability @@ -134,7 +134,7 @@ variables: -### Error Handling +**Error Handling** - Set up proper error handling in pipelines - Use pipeline status checks @@ -144,7 +144,7 @@ variables: -### Resource Management +**Resource Management** - Limit concurrent pipeline runs - Clean up old builds regularly @@ -154,7 +154,7 @@ variables: -### Resource Management +**Resource Management** - Limit concurrent pipeline runs - Clean up old builds regularly @@ -169,7 +169,7 @@ variables: -### Issue: Pipeline Fails with "Variable Not Found" +**Issue: Pipeline Fails with "Variable Not Found"** **Symptoms**: Pipeline fails with error about missing CI/CD variables @@ -192,7 +192,7 @@ variables: -### Issue: PROJECT_TOKEN Not Available +**Issue: PROJECT_TOKEN Not Available** **Symptoms**: Pipeline prompts for PROJECT_TOKEN or token not found @@ -217,7 +217,7 @@ variables: -### Issue: Tests Run But No Results in Dashboard +**Issue: Tests Run But No Results in Dashboard** **Symptoms**: Pipeline completes but screenshots don't appear in SmartUI @@ -245,7 +245,7 @@ variables: -### Issue: Pipeline Times Out +**Issue: Pipeline Times Out** **Symptoms**: Pipeline execution exceeds time limit @@ -275,7 +275,7 @@ variables: -### Issue: Dependencies Installation Fails +**Issue: Dependencies Installation Fails** **Symptoms**: npm install or dependency installation fails @@ -304,7 +304,7 @@ variables: -### Issue: SmartUI CLI Not Found +**Issue: SmartUI CLI Not Found** **Symptoms**: `npx smartui` command fails with command not found" @@ -331,7 +331,7 @@ variables: - npm install -g @lambdatest/smartui-cli ``` -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-with-netlify.md b/docs/smartui-with-netlify.md index 6ab87ab3..036613b1 100644 --- a/docs/smartui-with-netlify.md +++ b/docs/smartui-with-netlify.md @@ -107,7 +107,7 @@ Your changes will be triggered and deployed. -### Project Naming +**Project Naming** - Use descriptive, consistent names for SmartUI projects - Match project names with your Netlify site names for easy identification @@ -117,7 +117,7 @@ Your changes will be triggered and deployed. -### Baseline Management +**Baseline Management** - Establish baseline from stable deployment - Review baseline before using for comparisons @@ -127,7 +127,7 @@ Your changes will be triggered and deployed. -### Deployment Strategy +**Deployment Strategy** - Deploy baseline before making changes - Test changes in staging before production @@ -137,7 +137,7 @@ Your changes will be triggered and deployed. -### Integration Configuration +**Integration Configuration** - Keep LambdaTest credentials secure - Use Netlify's environment variables for credentials @@ -147,7 +147,7 @@ Your changes will be triggered and deployed. -### Comparison Workflow +**Comparison Workflow** - Review visual differences carefully - Approve intentional changes promptly @@ -157,7 +157,7 @@ Your changes will be triggered and deployed. -### Comparison Workflow +**Comparison Workflow** - Review visual differences carefully - Approve intentional changes promptly @@ -172,7 +172,7 @@ Your changes will be triggered and deployed. -### Issue: Screenshots Not Appearing in Dashboard +**Issue: Screenshots Not Appearing in Dashboard** **Symptoms**: Deployments complete but no screenshots appear in SmartUI dashboard @@ -201,7 +201,7 @@ Your changes will be triggered and deployed. -### Issue: Project Not Found" Error +**Issue: Project Not Found" Error** **Symptoms**: Error indicating SmartUI project cannot be found @@ -225,7 +225,7 @@ Your changes will be triggered and deployed. -### Issue: Integration Not Triggering +**Issue: Integration Not Triggering** **Symptoms**: Deployments don't trigger SmartUI comparisons @@ -254,7 +254,7 @@ Your changes will be triggered and deployed. -### Issue: Baseline Not Set Correctly +**Issue: Baseline Not Set Correctly** **Symptoms**: Comparisons show unexpected differences or baseline issues @@ -281,7 +281,7 @@ Your changes will be triggered and deployed. -### Issue: Comparison Results Unexpected +**Issue: Comparison Results Unexpected** **Symptoms**: Visual differences don't match expected changes @@ -308,7 +308,7 @@ Your changes will be triggered and deployed. - Check pixel threshold settings - Adjust comparison settings if needed -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-with-semaphore.md b/docs/smartui-with-semaphore.md index 3fdf3ca6..3cb7fd8e 100644 --- a/docs/smartui-with-semaphore.md +++ b/docs/smartui-with-semaphore.md @@ -85,7 +85,7 @@ You can also store your *LT_USERNAME*, *LT_ACCESS_KEY* and *PROJECT_TOKEN* as se -### Secret Management +**Secret Management** - Never commit credentials to repository - Use Semaphore Secrets for all sensitive data @@ -95,7 +95,7 @@ You can also store your *LT_USERNAME*, *LT_ACCESS_KEY* and *PROJECT_TOKEN* as se -### Pipeline Optimization +**Pipeline Optimization** - Use parallel blocks for faster execution - Cache dependencies to speed up pipelines @@ -112,7 +112,7 @@ auto_cancel: -### Build Naming +**Build Naming** - Use meaningful build names that include branch/commit info - Include commit SHA for traceability @@ -128,7 +128,7 @@ env_vars: -### Error Handling +**Error Handling** - Set up proper error handling in pipelines - Use pipeline status checks @@ -138,7 +138,7 @@ env_vars: -### Resource Management +**Resource Management** - Limit concurrent pipeline runs - Clean up old builds regularly @@ -148,7 +148,7 @@ env_vars: -### Resource Management +**Resource Management** - Limit concurrent pipeline runs - Clean up old builds regularly @@ -163,7 +163,7 @@ env_vars: -### Issue: Pipeline Fails with "Secret Not Found" +**Issue: Pipeline Fails with "Secret Not Found"** **Symptoms**: Pipeline fails with error about missing secrets @@ -187,7 +187,7 @@ env_vars: -### Issue: PROJECT_TOKEN Not Available +**Issue: PROJECT_TOKEN Not Available** **Symptoms**: Pipeline prompts for PROJECT_TOKEN or token not found @@ -213,7 +213,7 @@ env_vars: -### Issue: Tests Run But No Results in Dashboard +**Issue: Tests Run But No Results in Dashboard** **Symptoms**: Pipeline completes but screenshots don't appear in SmartUI @@ -242,7 +242,7 @@ env_vars: -### Issue: Pipeline Times Out +**Issue: Pipeline Times Out** **Symptoms**: Pipeline execution exceeds time limit @@ -278,7 +278,7 @@ env_vars: -### Issue: Dependencies Installation Fails +**Issue: Dependencies Installation Fails** **Symptoms**: npm install or dependency installation fails @@ -310,7 +310,7 @@ env_vars: -### Issue: SmartUI CLI Not Found +**Issue: SmartUI CLI Not Found** **Symptoms**: `npx smartui` command fails with command not found" @@ -339,7 +339,7 @@ env_vars: - npm install -g @lambdatest/smartui-cli ``` -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/docs/smartui-with-travis-ci.md b/docs/smartui-with-travis-ci.md index be30ff00..2daff5d9 100644 --- a/docs/smartui-with-travis-ci.md +++ b/docs/smartui-with-travis-ci.md @@ -104,7 +104,7 @@ script: -### Secret Management +**Secret Management** - Never commit credentials to repository - Use Travis CI Environment Variables for all sensitive data @@ -115,7 +115,7 @@ script: -### Pipeline Optimization +**Pipeline Optimization** - Use matrix builds for parallel execution - Cache dependencies to speed up pipelines @@ -133,7 +133,7 @@ branches: -### Build Naming +**Build Naming** - Use meaningful build names that include branch/commit info - Include commit SHA for traceability @@ -149,7 +149,7 @@ env: -### Error Handling +**Error Handling** - Set up proper error handling in pipelines - Use pipeline status checks @@ -159,7 +159,7 @@ env: -### Resource Management +**Resource Management** - Limit concurrent pipeline runs - Clean up old builds regularly @@ -169,7 +169,7 @@ env: -### Resource Management +**Resource Management** - Limit concurrent pipeline runs - Clean up old builds regularly @@ -184,7 +184,7 @@ env: -### Issue: Pipeline Fails with "Variable Not Found" +**Issue: Pipeline Fails with "Variable Not Found"** **Symptoms**: Pipeline fails with error about missing environment variables @@ -208,7 +208,7 @@ env: -### Issue: PROJECT_TOKEN Not Available +**Issue: PROJECT_TOKEN Not Available** **Symptoms**: Pipeline prompts for PROJECT_TOKEN or token not found @@ -234,7 +234,7 @@ env: -### Issue: Tests Run But No Results in Dashboard +**Issue: Tests Run But No Results in Dashboard** **Symptoms**: Pipeline completes but screenshots don't appear in SmartUI @@ -262,7 +262,7 @@ env: -### Issue: Pipeline Times Out +**Issue: Pipeline Times Out** **Symptoms**: Pipeline execution exceeds time limit @@ -289,7 +289,7 @@ env: -### Issue: Dependencies Installation Fails +**Issue: Dependencies Installation Fails** **Symptoms**: npm install or dependency installation fails @@ -319,7 +319,7 @@ env: -### Issue: SmartUI CLI Not Found +**Issue: SmartUI CLI Not Found** **Symptoms**: `npx smartui` command fails with command not found" @@ -347,7 +347,7 @@ env: - npm install -g @lambdatest/smartui-cli ``` -### Getting Help +**Getting Help** If you encounter issues not covered here: diff --git a/sidebars.js b/sidebars.js index 8566b6a9..d94d0642 100644 --- a/sidebars.js +++ b/sidebars.js @@ -3244,11 +3244,6 @@ module.exports = { label: "Mobile SDKs", collapsed: true, items: [ - { - type: "doc", - label: "Appium SDK", - id: "smartui-appium-sdk", - }, { type: "doc", label: "Appium Java SDK", @@ -3368,6 +3363,11 @@ module.exports = { label: "Baseline Management", id: "smartui-baseline-management", }, + { + type: "doc", + label: "Multiselect & Bulk Operations", + id: "smartui-multiselect-bulkops", + }, { type: "doc", label: "Draw on UI",