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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 12 additions & 12 deletions docs/smartui-appium-hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -512,7 +512,7 @@ Please note that this webhook is only applicable to <b>native app screenshots</b
<Tabs className='docs__val' groupId='best-practices'>
<TabItem value='screenshot-naming' label='Screenshot Naming' default>

### Screenshot Naming
**Screenshot Naming**

- Use descriptive, consistent names for screenshots
- Include screen/component name in screenshot names
Expand All @@ -528,7 +528,7 @@ await driver.execute("smartui.takeScreenshot=CheckoutScreen-PaymentForm");
</TabItem>
<TabItem value='wait-for-screen-load' label='Wait for Screen Load'>

### 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
Expand All @@ -544,7 +544,7 @@ await driver.execute("smartui.takeScreenshot=Screen Loaded");
</TabItem>
<TabItem value='handle-dynamic-content' label='Handle Dynamic Content'>

### 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
Expand All @@ -553,7 +553,7 @@ await driver.execute("smartui.takeScreenshot=Screen Loaded");
</TabItem>
<TabItem value='smart-crop-configuration' label='Smart Crop Configuration'>

### Smart Crop Configuration
**Smart Crop Configuration**

- Enable `cropStatusBar` to focus on core UI elements
- Enable `cropNavigationBar` for Android devices
Expand All @@ -562,7 +562,7 @@ await driver.execute("smartui.takeScreenshot=Screen Loaded");
</TabItem>
<TabItem value='test-organization' label='Test Organization'>

### Test Organization
**Test Organization**

- Group related screenshots in the same build
- Use meaningful build names
Expand All @@ -571,7 +571,7 @@ await driver.execute("smartui.takeScreenshot=Screen Loaded");
</TabItem>
<TabItem value='test-organization-1' label='Test Organization'>

### Test Organization
**Test Organization**

- Group related screenshots in the same build
- Use meaningful build names
Expand All @@ -585,7 +585,7 @@ await driver.execute("smartui.takeScreenshot=Screen Loaded");
<Tabs className='docs__val' groupId='troubleshooting'>
<TabItem value='screenshots-not-captured' label='Screenshots Not Captured' default>

### Issue: Screenshots Not Captured
**Issue: Screenshots Not Captured**

**Symptoms**: Tests run but no screenshots appear in SmartUI dashboard

Expand Down Expand Up @@ -620,7 +620,7 @@ await driver.execute("smartui.takeScreenshot=Screen Loaded");
</TabItem>
<TabItem value='project-not-found-error' label='Project Not Found Error'>

### Issue: "Project Not Found" Error
**Issue: "Project Not Found" Error**

**Symptoms**: Error indicating SmartUI project cannot be found

Expand All @@ -638,7 +638,7 @@ await driver.execute("smartui.takeScreenshot=Screen Loaded");
</TabItem>
<TabItem value='screenshots-show-blank-or-incorrect-content' label='Screenshots Show Blank or Incorrect Content'>

### Issue: Screenshots Show Blank or Incorrect Content
**Issue: Screenshots Show Blank or Incorrect Content**

**Symptoms**: Screenshots captured but show blank screens or incorrect content

Expand Down Expand Up @@ -666,7 +666,7 @@ await driver.execute("smartui.takeScreenshot=Screen Loaded");
</TabItem>
<TabItem value='full-page-screenshot-issues' label='Full Page Screenshot Issues'>

### Issue: Full Page Screenshot Issues
**Issue: Full Page Screenshot Issues**

**Symptoms**: Full page screenshots incomplete or incorrect

Expand All @@ -692,7 +692,7 @@ await driver.execute("smartui.takeScreenshot=Screen Loaded");
</TabItem>
<TabItem value='ignoreboxes-selectboxes-not-working' label='ignoreBoxes/selectBoxes Not Working'>

### Issue: ignoreBoxes/selectBoxes Not Working
**Issue: ignoreBoxes/selectBoxes Not Working**

**Symptoms**: Dynamic content still causing false positives

Expand All @@ -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:

Expand Down
26 changes: 13 additions & 13 deletions docs/smartui-appium-java-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ After test execution, visit your SmartUI project dashboard to:
<Tabs className='docs__val' groupId='best-practices'>
<TabItem value='screenshot-naming' label='Screenshot Naming' default>

### Screenshot Naming
**Screenshot Naming**

- Use descriptive, consistent names for screenshots
- Include screen/component name in screenshot names
Expand All @@ -328,7 +328,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "CheckoutScreen-PaymentForm");
</TabItem>
<TabItem value='wait-for-screen-load' label='Wait for Screen Load'>

### 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
Expand All @@ -344,7 +344,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Screen Loaded");
</TabItem>
<TabItem value='handle-dynamic-content' label='Handle Dynamic Content'>

### 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
Expand All @@ -353,7 +353,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Screen Loaded");
</TabItem>
<TabItem value='device-configuration' label='Device Configuration'>

### Device Configuration
**Device Configuration**

- Use consistent `deviceName` and `platform` combinations across builds
- Document device configurations for reference
Expand All @@ -362,18 +362,18 @@ SmartUISnapshot.smartuiSnapshot(driver, "Screen Loaded");
</TabItem>
<TabItem value='test-organization' label='Test Organization'>

### Test Organization
**Test Organization**

- Group related screenshots in the same build
- Use meaningful build names
- Run tests on consistent device configurations

## Troubleshooting
**Troubleshooting**

<Tabs className='docs__val' groupId='troubleshooting'>
<TabItem value='screenshots-not-captured' label='Screenshots Not Captured' default>

### Issue: Screenshots Not Captured
**Issue: Screenshots Not Captured**

**Symptoms**: Tests run but no screenshots appear in SmartUI dashboard

Expand Down Expand Up @@ -407,7 +407,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Screen Loaded");
</TabItem>
<TabItem value='project-not-found-error' label='Project Not Found Error'>

### Issue: Project Not Found" Error
**Issue: Project Not Found" Error**

**Symptoms**: Error indicating SmartUI project cannot be found

Expand All @@ -426,7 +426,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Screen Loaded");
</TabItem>
<TabItem value='screenshots-show-blank-or-incorrect-content' label='Screenshots Show Blank or Incorrect Content'>

### Issue: Screenshots Show Blank or Incorrect Content
**Issue: Screenshots Show Blank or Incorrect Content**

**Symptoms**: Screenshots captured but show blank screens or incorrect content

Expand Down Expand Up @@ -455,7 +455,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Screen Loaded");
</TabItem>
<TabItem value='ignoreboxes-selectboxes-not-working' label='ignoreBoxes/selectBoxes Not Working'>

### Issue: ignoreBoxes/selectBoxes Not Working
**Issue: ignoreBoxes/selectBoxes Not Working**

**Symptoms**: Dynamic content still causing false positives

Expand All @@ -478,7 +478,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Screen Loaded");
</TabItem>
<TabItem value='maven-dependencies-not-resolving' label='Maven Dependencies Not Resolving'>

### Issue: Maven Dependencies Not Resolving
**Issue: Maven Dependencies Not Resolving**

**Symptoms**: Maven cannot find `lambdatest-java-sdk` or dependencies fail

Expand All @@ -499,7 +499,7 @@ SmartUISnapshot.smartuiSnapshot(driver, "Screen Loaded");
</TabItem>
<TabItem value='screenshot-names-not-matching-baseline' label='Screenshot Names Not Matching Baseline'>

### Issue: Screenshot Names Not Matching Baseline
**Issue: Screenshot Names Not Matching Baseline**

**Symptoms**: Screenshots appear as New" instead of comparing with baseline

Expand All @@ -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:

Expand Down
16 changes: 8 additions & 8 deletions docs/smartui-baseline-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ npx smartui --markBaseline capture urls.json
<Tabs className='docs__val' groupId='best-practices'>
<TabItem value='baseline-selection' label='Baseline Selection' default>

### Baseline Selection
**Baseline Selection**

- Choose stable builds as baselines
- Document baseline selection criteria
Expand All @@ -145,7 +145,7 @@ npx smartui --markBaseline capture urls.json

<TabItem value='branch-management' label='Branch Management'>

### Branch Management
**Branch Management**

- Clear branch naming conventions
- Document branch purposes
Expand All @@ -155,7 +155,7 @@ npx smartui --markBaseline capture urls.json

<TabItem value='build-management' label='Build Management'>

### Build Management
**Build Management**

- Meaningful build names
- Document build purposes
Expand All @@ -165,7 +165,7 @@ npx smartui --markBaseline capture urls.json

<TabItem value='approval-process' label='Approval Process'>

### Approval Process
**Approval Process**

- Clear approval criteria
- Document approval decisions
Expand All @@ -179,7 +179,7 @@ npx smartui --markBaseline capture urls.json
<Tabs className='docs__val' groupId='troubleshooting'>
<TabItem value='common-issues' label='Common Issues' default>

### Common Issues
**Common Issues**

1. **Baseline Issues**:
- Verify baseline exists
Expand All @@ -200,7 +200,7 @@ npx smartui --markBaseline capture urls.json

<TabItem value='baseline-not-found' label='Baseline Not Found'>

### Baseline Not Found
**Baseline Not Found**

**Error**: Baseline branch or build does not exist

Expand All @@ -218,7 +218,7 @@ npx smartui --baselineBranch "main" exec -- <command>

<TabItem value='permission-denied' label='Permission Denied'>

### Permission Denied
**Permission Denied**

**Error**: Insufficient permissions to set baseline

Expand All @@ -231,7 +231,7 @@ npx smartui --baselineBranch "main" exec -- <command>

<TabItem value='baseline-mismatch' label='Baseline Mismatch'>

### Baseline Mismatch
**Baseline Mismatch**

**Error**: Screenshot names don't match between baseline and current build

Expand Down
6 changes: 3 additions & 3 deletions docs/smartui-branch-merging.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ npx smartui merge branch --source release/v1.0.0 --target main
<Tabs className='docs__val' groupId='best-practices'>
<TabItem value='merge-planning' label='Merge Planning' default>

### Merge Planning
**Merge Planning**

- Plan merges in advance
- Document merge strategies
Expand All @@ -145,7 +145,7 @@ npx smartui merge branch --source release/v1.0.0 --target main
</TabItem>
<TabItem value='branch-management' label='Branch Management' >

### Branch Management
**Branch Management**

- Keep branches up to date
- Clean up merged branches
Expand All @@ -154,7 +154,7 @@ npx smartui merge branch --source release/v1.0.0 --target main
</TabItem>
<TabItem value='approval-process' label='Approval Process' >

### Approval Process
**Approval Process**

- Establish clear approval criteria
- Document approval decisions
Expand Down
6 changes: 3 additions & 3 deletions docs/smartui-build-merging.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ npx smartui merge build --source hotfix-build-202 --target prod-build-456
<Tabs className='docs__val' groupId='best-practices'>
<TabItem value='build-management' label='Build Management' default>

### Build Management
**Build Management**

- Use meaningful build names
- Document build purposes
Expand All @@ -132,13 +132,13 @@ npx smartui merge build --source hotfix-build-202 --target prod-build-456
</TabItem>
<TabItem value='merge-planning' label='Merge Planning' >

### 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.

Expand Down
Loading
Loading