Performance metrics collection in Selenium Python - Framework Patterns

Framework Mode - Performance metrics collection

Folder Structure

performance_metrics_project/
├── tests/
│   ├── test_performance.py
│   └── __init__.py
├── pages/
│   ├── base_page.py
│   └── home_page.py
├── utils/
│   ├── performance_helper.py
│   └── __init__.py
├── config/
│   ├── config.yaml
│   └── __init__.py
├── reports/
│   └── performance_report.html
├── conftest.py
└── pytest.ini

Test Framework Layers

• Driver Layer: Selenium WebDriver setup and teardown managed in conftest.py using pytest fixtures.
• Page Objects: Classes in pages/ folder representing web pages, encapsulating element locators and actions.
• Tests: Test scripts in tests/ folder that use page objects and utilities to perform performance metric collection and assertions.
• Utilities: Helper functions in utils/performance_helper.py to extract and process performance metrics from browser logs or JavaScript.
• Configuration: Environment settings, URLs, browser options, and credentials stored in config/config.yaml and loaded at runtime.
• Reports: Generated performance reports saved in reports/ folder, e.g., HTML or JSON format.

Configuration Patterns

• Environment Config: Use config/config.yaml to define URLs, browser types, and timeouts for different environments (dev, staging, prod).
• Browser Options: Configure Selenium WebDriver options (headless, logging preferences) in conftest.py based on config values.
• Credentials: Store sensitive data securely outside the repo or use environment variables; load them in fixtures if needed.
• Dynamic Config Loading: Use pytest command line options or environment variables to select environment and browser at test runtime.

Test Reporting and CI/CD Integration

• Performance Reports: Generate HTML or JSON reports summarizing metrics like page load time, resource timings, and custom timings using utilities.
• Logging: Capture browser console logs and performance logs during test execution for detailed analysis.
• CI/CD Integration: Integrate tests with CI tools (e.g., GitHub Actions, Jenkins) to run performance tests on each build or deployment.
• Alerts: Configure thresholds for performance metrics and fail tests or send notifications if thresholds are exceeded.

Framework Design Principles

1. Separation of Concerns: Keep page objects, test logic, and performance metric extraction separate for clarity and reuse.
2. Use Browser Performance APIs: Leverage browser APIs like Navigation Timing and Resource Timing for accurate metrics.
3. Explicit Waits: Use explicit waits to ensure page elements are loaded before collecting performance data.
4. Configurable Thresholds: Allow performance thresholds to be configurable to adapt to different environments or test goals.
5. Reusable Utilities: Create helper functions to parse and format performance data to avoid duplication.

Self Check

Where in this folder structure would you add a new utility function to parse custom performance metrics from browser logs?

Key Result

Organize Selenium Python tests with clear layers: page objects, tests, utilities, config, and reporting for effective performance metrics collection.