Browser options and capabilities in Selenium Python - Framework Patterns

Framework Mode - Browser options and capabilities

Folder Structure

selenium-python-project/
├── src/
│   ├── pages/
│   │   └── login_page.py
│   ├── tests/
│   │   └── test_login.py
│   ├── utils/
│   │   └── browser_factory.py
│   └── config/
│       └── config.yaml
├── requirements.txt
└── pytest.ini

Test Framework Layers

• Browser Factory Layer: Handles browser options and capabilities setup. Creates WebDriver instances with desired settings.
• Page Object Layer: Contains page classes representing UI pages, using WebDriver instances from the factory.
• Test Layer: Contains test cases that use page objects and browser instances to perform actions and assertions.
• Utilities Layer: Helper functions and classes, e.g., for logging, waits, or reading configs.
• Configuration Layer: Stores environment settings, browser preferences, and credentials in files like YAML.

Configuration Patterns

• Environment Config: Use a YAML file (e.g., config.yaml) to store URLs, browser names, and headless mode flags.
• Browser Options Setup: In browser_factory.py, read config and set browser options (like ChromeOptions) accordingly.
• Capabilities: Add capabilities such as disabling notifications or setting window size via options.
• Dynamic Selection: Allow tests to select browser type and options via command line or config file.

Test Reporting and CI/CD Integration

• Use pytest with plugins like pytest-html to generate readable HTML reports showing pass/fail results.
• Integrate with CI/CD tools (e.g., GitHub Actions, Jenkins) to run tests automatically on code changes.
• Configure CI to run tests with different browser options (headless, headed) by passing config parameters.
• Store screenshots on failure using browser options to help debug UI issues.

Best Practices

1. Centralize Browser Setup: Keep browser options and capabilities setup in one place (browser factory) for easy maintenance.
2. Use Config Files: Store browser preferences and environment details outside code to change easily without edits.
3. Support Multiple Browsers: Design factory to support Chrome, Firefox, Edge with their specific options and capabilities.
4. Use Explicit Waits: Combine browser options with waits to handle dynamic page loading reliably.
5. Run Headless for CI: Use headless mode in CI environments to save resources and speed up tests.

Self Check

Where would you add a new browser option to disable browser notifications in this framework structure?

Key Result

Centralize browser options and capabilities setup in a factory layer configured via external files for flexible, maintainable Selenium tests.