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.

Practice

1. What is the main purpose of using Options in Selenium WebDriver for browsers?

easy

A. To customize browser settings like headless mode or window size

B. To write test assertions for page elements

C. To locate elements on a web page

D. To generate test reports automatically

Solution

1. Step 1: Understand what Options configure

   Options allow you to set how the browser behaves during tests, such as running headless or setting window size.

2. Step 2: Differentiate Options from other tasks

   Options do not handle locating elements, assertions, or reports; those are separate tasks.

3. Final Answer:

   To customize browser settings like headless mode or window size -> Option A

4. Quick Check:

   Options = Browser customization [OK]

Hint: Options control browser behavior, not test logic [OK]

Common Mistakes:

• Confusing Options with element locators
• Thinking Options generate reports
• Mixing Options with assertion logic

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

easy

A. options = webdriver.ChromeOptions()
options.add_argument('--headless')

B. options = webdriver.ChromeOptions()
options.set_headless(True)

C. options = webdriver.ChromeOptions()
options.headless = True

D. options = webdriver.ChromeOptions()
options.add_option('headless')

Solution

1. Step 1: Recall correct method to add arguments

   In Selenium Python, add_argument is used to add command line switches like '--headless'.

2. Step 2: Check each option's syntax

   Only options = webdriver.ChromeOptions() options.add_argument('--headless') uses add_argument('--headless') correctly; others use invalid or non-existent methods.

3. Final Answer:

   options = webdriver.ChromeOptions() options.add_argument('--headless') -> Option A

4. Quick Check:

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

Hint: Use add_argument('--headless') to enable headless mode [OK]

Common Mistakes:

• Using non-existent set_headless method
• Assigning headless attribute directly
• Using add_option instead of add_argument

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

from selenium import webdriver
options = webdriver.FirefoxOptions()
options.set_preference('dom.webnotifications.enabled', False)
driver = webdriver.Firefox(options=options)
driver.get('https://example.com')

medium

A. Code will raise an error due to invalid method

B. Firefox will launch but notifications will still appear

C. Firefox will launch with notifications disabled on the page

D. Firefox will launch in headless mode

Solution

1. Step 1: Understand set_preference usage

   The method set_preference sets Firefox preferences; here it disables web notifications.

2. Step 2: Analyze the effect on browser behavior

   Passing these options to Firefox disables notifications on pages, so no pop-ups appear.

3. Final Answer:

   Firefox will launch with notifications disabled on the page -> Option C

4. Quick Check:

   set_preference disables notifications [OK]

Hint: set_preference disables features like notifications [OK]

Common Mistakes:

• Assuming notifications still appear
• Confusing set_preference with add_argument
• Thinking code runs headless by default

4. Identify the error in this Selenium Python code snippet that tries to disable browser notifications in Chrome:

from selenium import webdriver
options = webdriver.ChromeOptions()
options.set_preference('profile.default_content_setting_values.notifications', 2)
driver = webdriver.Chrome(options=options)

medium

A. The value 2 is invalid for disabling notifications

B. set_preference is not a method of ChromeOptions

C. Options must be passed as capabilities, not options

D. ChromeOptions cannot disable notifications

Solution

1. Step 1: Check ChromeOptions methods

   ChromeOptions does not have a method called set_preference; this is Firefox-specific.

2. Step 2: Correct way to disable notifications in Chrome

   Chrome uses add_experimental_option with 'prefs' dictionary to disable notifications.

3. Final Answer:

   set_preference is not a method of ChromeOptions -> Option B

4. Quick Check:

   Use add_experimental_option for Chrome prefs [OK]

Hint: ChromeOptions uses add_experimental_option, not set_preference [OK]

Common Mistakes:

• Using Firefox methods on ChromeOptions
• Passing wrong values for notification settings
• Confusing options with capabilities

5. You want to run Chrome in headless mode, disable notifications, and accept insecure certificates using Selenium in Python. Which code snippet correctly sets all these options?

hard

A. options = webdriver.ChromeOptions()
options.headless = True
options.add_experimental_option('prefs', {'notifications': 0})
options.set_capability('acceptInsecureCerts', False)
driver = webdriver.Chrome(options=options)

B. options = webdriver.ChromeOptions()
options.add_argument('headless')
options.set_preference('notifications', False)
options.set_capability('acceptInsecureCerts', True)
driver = webdriver.Chrome(options=options)

C. options = webdriver.ChromeOptions()
options.add_argument('--headless')
options.add_argument('--disable-notifications')
options.accept_insecure_certs = True
driver = webdriver.Chrome(options=options)

D. options = webdriver.ChromeOptions()
options.add_argument('--headless')
options.add_experimental_option('prefs', {'profile.default_content_setting_values.notifications': 2})
options.set_capability('acceptInsecureCerts', True)
driver = webdriver.Chrome(options=options)

Solution

1. Step 1: Set headless mode correctly

   Use add_argument('--headless') to enable headless mode in ChromeOptions.

2. Step 2: Disable notifications properly

   Use add_experimental_option('prefs', {'profile.default_content_setting_values.notifications': 2}) to disable notifications.

3. Step 3: Accept insecure certificates

   Set capability acceptInsecureCerts to True using set_capability.

4. Final Answer:

   options = webdriver.ChromeOptions() options.add_argument('--headless') options.add_experimental_option('prefs', {'profile.default_content_setting_values.notifications': 2}) options.set_capability('acceptInsecureCerts', True) driver = webdriver.Chrome(options=options) -> Option D

5. Quick Check:

   Combine add_argument, add_experimental_option, set_capability [OK]

Hint: Use add_argument, add_experimental_option, set_capability together [OK]

Common Mistakes:

• Missing '--' in headless argument
• Using set_preference on ChromeOptions
• Setting acceptInsecureCerts to False by mistake