Browser-specific workarounds in Selenium Python - Framework Patterns

Framework Mode - Browser-specific workarounds

Folder Structure

selenium_project/
├── src/
│   ├── pages/
│   │   ├── base_page.py          # Base page with common methods
│   │   ├── login_page.py         # Login page object
│   │   └── dashboard_page.py     # Dashboard page object
│   ├── tests/
│   │   ├── test_login.py         # Login tests
│   │   └── test_dashboard.py     # Dashboard tests
│   ├── utils/
│   │   ├── browser_factory.py    # Browser setup with workarounds
│   │   ├── config.py             # Configuration loader
│   │   └── helpers.py            # Helper functions
│   └── conftest.py               # Pytest fixtures
├── reports/                      # Test reports output
├── requirements.txt             # Dependencies
└── pytest.ini                   # Pytest configuration

Test Framework Layers

• Driver Layer: browser_factory.py manages WebDriver creation. It applies browser-specific options and workarounds here.
• Page Objects: Classes in pages/ represent UI pages. They use driver instances from the driver layer.
• Tests: Test scripts in tests/ use page objects and fixtures to run scenarios.
• Utilities: Helper functions and config management in utils/ support the framework.
• Configuration: config.py loads environment variables, browser choice, and credentials.

Configuration Patterns

• Use config.py to read environment variables or config files for browser type (e.g., Chrome, Firefox, Edge).
• In browser_factory.py, apply browser-specific options and workarounds based on the selected browser.
• Example: For Chrome, disable extensions; for Firefox, set preferences; for Edge, handle known bugs.
• Use Pytest command-line options or environment variables to switch browsers easily.
• Store sensitive data like credentials securely outside the code, accessed via environment variables.

Test Reporting and CI/CD Integration

• Use Pytest built-in reporting with options for verbose and junit XML output.
• Generate HTML reports using plugins like pytest-html for easy visualization.
• Integrate with CI/CD pipelines (e.g., GitHub Actions, Jenkins) to run tests on multiple browsers automatically.
• Configure CI jobs to pass browser choice as environment variables to test runs.
• Collect logs and screenshots on failures, especially for browser-specific issues, to aid debugging.

Best Practices for Browser-Specific Workarounds

1. Centralize browser setup: Keep all browser-specific code in one place (browser_factory.py) to avoid duplication.
2. Use feature detection: Prefer detecting browser capabilities over hardcoding browser names when possible.
3. Keep workarounds minimal: Only add workarounds for known issues to keep tests stable and maintainable.
4. Document workarounds: Comment why a workaround exists and link to bug reports or browser issues.
5. Test on all supported browsers regularly: Run tests in CI on all browsers to catch regressions early.

Self Check

Where in this folder structure would you add a new workaround for a Firefox-specific bug that requires a special browser option?

Key Result

Centralize browser-specific workarounds in the browser factory layer for maintainable Selenium Python tests.