Why evidence collection supports debugging in Selenium Python - Framework Benefits

Framework Mode - Why evidence collection supports debugging

Folder Structure

selenium-python-framework/
├── tests/
│   ├── test_login.py
│   └── test_checkout.py
├── pages/
│   ├── login_page.py
│   └── checkout_page.py
├── utils/
│   ├── logger.py
│   ├── screenshot_helper.py
│   └── evidence_collector.py
├── config/
│   ├── config.yaml
│   └── env.py
├── reports/
│   └── test_report.html
├── conftest.py
└── requirements.txt

Test Framework Layers

• Driver Layer: Manages Selenium WebDriver setup and teardown (in conftest.py).
• Page Objects: Classes in pages/ that represent web pages with locators and actions.
• Tests: Test scripts in tests/ that use page objects and assertions.
• Utilities: Helper modules in utils/ for logging, screenshots, and evidence collection.
• Configuration: Files in config/ for environment settings, credentials, and browser options.
• Reports: Generated test reports stored in reports/ for test results and evidence.

Configuration Patterns

• Environment Settings: Use config/config.yaml to define URLs, timeouts, and environment-specific data.
• Browser Options: Configure browser type and headless mode in env.py or via command line arguments.
• Credentials: Store sensitive data securely, e.g., environment variables or encrypted files, accessed in config/env.py.
• Evidence Settings: Configure when to capture screenshots or logs (e.g., on failure) in config.yaml.

Test Reporting and CI/CD Integration

• Test Reports: Generate HTML reports with embedded screenshots and logs for failed tests.
• Evidence Collection: Automatically save screenshots and logs during test failures to reports/evidence/.
• CI/CD Integration: Integrate with pipelines (e.g., GitHub Actions, Jenkins) to run tests and publish reports.
• Notifications: Configure alerts with links to evidence for quick debugging.

Best Practices for Evidence Collection Supporting Debugging

1. Capture Screenshots on Failure: Automatically take screenshots when a test fails to see the exact page state.
2. Save Browser Logs: Collect console logs to detect JavaScript errors or warnings.
3. Use Clear Naming Conventions: Name evidence files with test name and timestamp for easy identification.
4. Keep Evidence Organized: Store evidence in structured folders by date and test suite.
5. Integrate Evidence in Reports: Embed screenshots and logs in test reports for quick access during debugging.

Self Check

Where in this framework structure would you add a new utility to capture browser console logs during test failures?

Key Result

Collecting screenshots and logs automatically during test failures helps quickly find and fix bugs.