Guides¶
Comprehensive guides for using and developing with Intel® ESQ.
Available Guides¶
- Developer Guide - Complete guide for integrating pytest tests into the Intel® ESQ framework
- Optimization Guide - Performance optimization techniques
- Troubleshooting Guide - Common issues and solutions
Developer Guide Sections¶
| Section | Description |
|---|---|
| Overview & Architecture | Framework structure and component overview |
| Writing Tests | Step-by-step guide and the 7-step execution pattern |
| Profile & Test Config | Profile YAML structure and config.yml KPI definitions |
| System Requirements | All hardware and software requirement flags |
| Fixtures Reference | Built-in pytest fixtures reference |
| Results & Metrics | Result and Metrics classes |
| KPI Validation | Defining and validating KPI thresholds |
| Asset Management | Managing models, videos, and file assets |
| Modular Telemetry | Background metric collection during test execution |
| Best Practices & Advanced Topics | Design guidelines and advanced patterns |
| Allure Report Customization | Customizing the bundled Allure3 report UI |