Chrome configuration in Selenium Python - Framework Patterns

Framework Mode - Chrome configuration

Folder Structure

selenium-python-project/
├── src/
│   ├── pages/
│   │   └── login_page.py
│   ├── tests/
│   │   └── test_login.py
│   ├── utils/
│   │   └── chrome_options.py
│   └── config/
│       └── config.yaml
├── drivers/
│   └── chromedriver.exe (or chromedriver for Linux/Mac)
├── requirements.txt
└── pytest.ini

Test Framework Layers

• Driver Layer: Manages the Chrome WebDriver setup and teardown using selenium.webdriver.Chrome.
• Page Objects: Python classes representing web pages, using locators and methods to interact with page elements.
• Tests: Pytest test functions or classes that use page objects and driver instances to perform test scenarios.
• Utilities: Helper modules like chrome_options.py to configure ChromeDriver options (headless mode, window size, etc.).
• Configuration: YAML or similar files to store environment variables, browser preferences, and credentials.

Configuration Patterns

Use a config.yaml file to store settings like:

• Browser options (e.g., headless: true/false)
• Window size
• Implicit wait times
• URLs and credentials

Example chrome_options.py utility to read config and apply Chrome options:

from selenium.webdriver.chrome.options import Options
import yaml

class ChromeOptionsFactory:
    @staticmethod
    def get_options(config_path='src/config/config.yaml') -> Options:
        options = Options()
        with open(config_path, 'r') as file:
            config = yaml.safe_load(file)
        chrome_cfg = config.get('chrome', {})

        if chrome_cfg.get('headless', False):
            options.add_argument('--headless=new')  # modern headless mode
        if window_size := chrome_cfg.get('window_size'):
            options.add_argument(f'--window-size={window_size}')
        if chrome_cfg.get('disable_gpu', False):
            options.add_argument('--disable-gpu')
        # Add more options as needed

        return options

In test setup, use this factory to create the driver:

from selenium import webdriver
from src.utils.chrome_options import ChromeOptionsFactory

def create_driver():
    options = ChromeOptionsFactory.get_options()
    driver = webdriver.Chrome(options=options)
    driver.implicitly_wait(10)  # seconds
    return driver

Test Reporting and CI/CD Integration

• Use pytest with plugins like pytest-html to generate readable HTML reports.
• Configure CI pipelines (GitHub Actions, Jenkins, GitLab CI) to run tests on code push or pull requests.
• Store ChromeDriver binaries in drivers/ and ensure CI agents have compatible Chrome versions.
• Use environment variables or config files to switch between headless and headed modes in CI vs local runs.

Best Practices for Chrome Configuration Framework

1. Separate configuration from code: Keep Chrome options and environment settings in config files, not hardcoded.
2. Use explicit waits: Avoid relying only on implicit waits; use WebDriverWait for better stability.
3. Support headless mode: Enable headless Chrome for faster CI runs but allow easy switching to headed mode for debugging.
4. Keep drivers updated: Match ChromeDriver version with installed Chrome browser to avoid compatibility issues.
5. Use Page Object Model: Encapsulate page interactions to keep tests clean and maintainable.

Self Check

Where in this folder structure would you add a new utility to configure Chrome browser options for different environments?

Key Result

Organize Chrome WebDriver setup using config files and utility classes for flexible, maintainable test automation.

Practice

1. What is the main purpose of using Options() in Selenium with Chrome?

easy

A. To locate elements on the web page

B. To handle exceptions during test execution

C. To write assertions for test validation

D. To customize Chrome browser settings before starting tests

Solution

1. Step 1: Understand the role of Options()

   The Options() class in Selenium is used to set Chrome browser configurations like headless mode, window size, or disabling notifications before launching the browser.

2. Step 2: Differentiate from other Selenium features

   Locating elements, writing assertions, and handling exceptions are separate tasks unrelated to browser configuration.

3. Final Answer:

   To customize Chrome browser settings before starting tests -> Option D

4. Quick Check:

   Options() = Customize browser [OK]

Hint: Options() sets browser behavior before tests run [OK]

Common Mistakes:

• Confusing Options() with element locators
• Thinking Options() handles test assertions
• Assuming Options() manages exceptions

2. Which of the following is the correct way to add headless mode to Chrome using Selenium in Python?

easy

A. options.add_argument('--headless')

B. options.set_headless(True)

C. options.add_argument('headless')

D. options.headless = True

Solution

1. Step 1: Recall correct syntax for headless argument

   In Selenium, Chrome headless mode is enabled by adding the argument '--headless' with two dashes.

2. Step 2: Check each option's correctness

   options.add_argument('headless') misses dashes, options.set_headless(True) and D are invalid methods or attributes for Chrome Options.

3. Final Answer:

   options.add_argument('--headless') -> Option A

4. Quick Check:

   Headless argument needs '--' prefix [OK]

Hint: Use '--headless' with add_argument() for headless mode [OK]

Common Mistakes:

• Omitting dashes in argument string
• Using non-existent methods like set_headless()
• Assigning headless attribute directly

3. What will be the effect of the following code snippet?

from selenium import webdriver
from selenium.webdriver.chrome.options import Options
options = Options()
options.add_argument('--incognito')
driver = webdriver.Chrome(options=options)
driver.get('https://example.com')

medium

A. Chrome opens in incognito mode and loads example.com

B. Chrome opens in normal mode and loads example.com

C. Chrome opens but fails to load example.com

D. Code raises a syntax error

Solution

1. Step 1: Analyze the use of add_argument('--incognito')

   The code adds the '--incognito' argument to Chrome options, which launches the browser in incognito mode.

2. Step 2: Confirm driver behavior

   The driver is created with these options and navigates to 'https://example.com' successfully without errors.

3. Final Answer:

   Chrome opens in incognito mode and loads example.com -> Option A

4. Quick Check:

   --incognito argument = incognito mode [OK]

Hint: Adding '--incognito' opens Chrome in private mode [OK]

Common Mistakes:

• Assuming incognito disables page loading
• Thinking code causes syntax errors
• Confusing incognito with headless mode

4. Identify the error in this Selenium Chrome configuration code:

from selenium import webdriver
from selenium.webdriver.chrome.options import Options
options = Options()
options.add_argument('disable-notifications')
driver = webdriver.Chrome(options=options)

medium

A. No error, code runs fine

B. Missing double dashes in argument string

C. webdriver.Chrome() does not accept options parameter

D. Options() class is not imported correctly

Solution

1. Step 1: Check argument syntax for disabling notifications

   The argument to disable notifications must start with two dashes: '--disable-notifications'. The code misses these dashes.

2. Step 2: Verify other parts of the code

   Options() is imported correctly and webdriver.Chrome accepts options parameter, so no errors there.

3. Final Answer:

   Missing double dashes in argument string -> Option B

4. Quick Check:

   Arguments need '--' prefix [OK]

Hint: Always prefix Chrome arguments with '--' [OK]

Common Mistakes:

• Forgetting dashes in argument strings
• Assuming options parameter is invalid
• Misimporting Options class

5. You want to run Chrome in headless mode and disable pop-up notifications during tests. Which code snippet correctly sets both options?

hard

A. options = Options()
options.headless = True
options.add_argument('disable-notifications')

B. options = Options()
options.add_argument('--headless')
options.add_argument('disable-notifications')

C. options = Options()
options.add_argument('--headless')
options.add_argument('--disable-notifications')

D. options = Options()
options.set_headless(True)
options.add_argument('--disable-notifications')

Solution

1. Step 1: Confirm correct syntax for headless and disabling notifications

   Both arguments must have double dashes: '--headless' and '--disable-notifications'. options = Options() options.add_argument('--headless') options.add_argument('--disable-notifications') uses both correctly.

2. Step 2: Check invalid methods or missing dashes in other options

   options = Options() options.add_argument('--headless') options.add_argument('disable-notifications') misses dashes for disable-notifications, options = Options() options.headless = True options.add_argument('disable-notifications') assigns headless attribute incorrectly, options = Options() options.set_headless(True) options.add_argument('--disable-notifications') uses non-existent set_headless() method.

3. Final Answer:

   options.add_argument('--headless') and options.add_argument('--disable-notifications') -> Option C

4. Quick Check:

   Use '--' prefix for all Chrome options [OK]

Hint: Use '--' before all Chrome option arguments [OK]

Common Mistakes:

• Missing dashes in argument strings
• Using invalid methods like set_headless()
• Assigning headless as attribute instead of argument