Overview
The Add Snippet step allows you to include pre-built, reusable test snippets into your test cases. Snippets are modular test components that can be created once and reused across multiple test cases, promoting consistency and reducing duplication in your test folder.Form Fields
| Field Name | Type | Required | Description |
|---|---|---|---|
| Snippet | select | Yes | Select from available snippets in your workspace |
Form Configuration
Snippet Selection
The form provides a dropdown containing all available snippets:- Snippet Dropdown: Lists all snippets created in your workspace
- Snippet Titles: Each snippet is identified by its descriptive title
- Validation: Ensures selected snippet contains valid steps before saving
Example
Login Snippet
Add a reusable login flow:- Snippet: “User Login Flow”
- Navigate to login page
- Fill username field
- Fill password field
- Click login button
- Wait for navigation
- Verify dashboard loads
Advanced Features
Editing Params
- Parameter Toggle: Turn on the Pass Params toggle to send parameters into a snippet. Click Edit Params to quickly add or modify the values for steps you want the snippet to receive.
- Fill - Override text values when filling form fields
- Select Option - Override option values when selecting from dropdowns
- Wait for Time - Override timeout duration values
- Press Keys - Override key combination values
Best Practices
Snippet Design
- Single Purpose: Create snippets that serve a specific, well-defined purpose
- Modular Components: Design snippets as independent modules that don’t depend on external state
- Clear Naming: Use descriptive titles that clearly indicate the snippet’s functionality
Parameter Passing Strategy
- Identify Parameterizable Steps: Focus on steps that benefit from dynamic values (Fill, Select Option, Start Condition, Wait for Time, Press Keys)
- Default Values: Always provide sensible default values in snippets for parameters that might not be passed
- Parameter Naming: Use clear, descriptive parameter names that indicate their purpose
- Test with Parameters: Validate snippets work correctly both with and without parameter overrides
Common Issues
Snippet Not Loading
- Problem: Selected snippet fails to load or shows as unavailable
- Solution: Verify snippet exists and contains valid steps
- Troubleshooting: Check network connectivity and refresh the snippet list
Missing Steps in Snippet
- Problem: Snippet appears to load but contains no executable steps
- Solution: Verify snippet was created properly with actual test steps
- Prevention: Always validate snippet contents before saving to test cases
Snippet Execution Failures
- Problem: Snippet steps fail during test execution
- Solution: Test snippet independently to identify failing steps
- Debugging: Review snippet steps for outdated selectors or invalid logic
Performance Issues
- Problem: Snippet loading causes delays in test case editing
- Solution: Check network connection and snippet size
- Optimization: Consider breaking large snippets into smaller, focused components
Cache Problems
- Problem: Snippet changes don’t appear in test cases
- Solution: Clear snippet cache or refresh the test case editor
- Prevention: Allow time for cache updates after snippet modifications
Related Steps
- Navigate - Often used within snippets for navigation
- Fill - Commonly included in form-related snippets
- Click - Frequently used for interaction snippets
- Verify Value - Often included in validation snippets
- Extract Text - Used for data capture snippets