Firefox configuration in Selenium Python - Framework Patterns

Framework Mode - Firefox configuration

Folder Structure

selenium-python-project/
├── tests/
│   ├── test_login.py
│   └── test_search.py
├── pages/
│   ├── base_page.py
│   └── login_page.py
├── utils/
│   ├── firefox_options.py
│   └── webdriver_factory.py
├── config/
│   ├── config.yaml
│   └── credentials.yaml
├── reports/
│   └── test_report.html
├── conftest.py
└── requirements.txt

Test Framework Layers

• Driver Layer: webdriver_factory.py creates and configures Firefox WebDriver instances with desired options.
• Page Objects: Classes in pages/ represent web pages, encapsulating locators and actions.
• Tests: Test scripts in tests/ use pytest to run tests with Firefox browser.
• Utilities: Helper modules like firefox_options.py define Firefox-specific settings (headless mode, preferences).
• Configuration: YAML files in config/ store environment variables, URLs, and credentials.

Configuration Patterns

Use config.yaml to define environment URLs and browser settings. Use firefox_options.py to set Firefox preferences like headless mode, download folder, and disable notifications.

Example snippet from firefox_options.py:

from selenium.webdriver.firefox.options import Options

def get_firefox_options(headless: bool = False) -> Options:
    options = Options()
    if headless:
        options.headless = True
    # Disable notifications
    options.set_preference("dom.webnotifications.enabled", False)
    # Set download folder
    options.set_preference("browser.download.folderList", 2)
    options.set_preference("browser.download.dir", "/tmp/downloads")
    options.set_preference("browser.helperApps.neverAsk.saveToDisk", "application/pdf")
    return options

In webdriver_factory.py, create Firefox driver with these options:

from selenium import webdriver
from utils.firefox_options import get_firefox_options

def create_firefox_driver(headless: bool = False):
    options = get_firefox_options(headless)
    driver = webdriver.Firefox(options=options)
    driver.implicitly_wait(10)
    return driver

Test Reporting and CI/CD Integration

• Use pytest with pytest-html plugin to generate HTML reports saved in reports/ folder.
• Configure CI pipelines (GitHub Actions, Jenkins) to run tests on Firefox browser using headless mode for speed.
• Store test reports as artifacts in CI for easy access and review.
• Use environment variables in CI to switch between headless and headed modes or different Firefox versions.

Best Practices for Firefox Configuration

1. Use Firefox Options Object: Always configure Firefox preferences and options via the Options class to keep setup clean and reusable.
2. Headless Mode for CI: Run Firefox in headless mode in CI environments to save resources and avoid UI dependencies.
3. Explicit Preferences: Set preferences like disabling notifications and setting download folders to avoid unexpected popups during tests.
4. Centralize Configuration: Keep browser options and environment settings in separate utility and config files for easy maintenance.
5. Implicit and Explicit Waits: Use waits to handle dynamic page elements reliably with Firefox.

Self Check

Where would you add a new Firefox preference to disable the PDF viewer in this framework structure?

Key Result

Use a dedicated Firefox options utility to configure browser preferences and create WebDriver instances for clean, reusable test setup.

Practice

1. What is the main purpose of using FirefoxOptions() in Selenium tests?

easy

A. To configure Firefox browser settings before starting the test

B. To write test assertions for Firefox browser

C. To locate elements on a Firefox webpage

D. To generate test reports for Firefox tests

Solution

1. Step 1: Understand the role of FirefoxOptions

   FirefoxOptions() is used to set browser preferences like headless mode or disable notifications before launching Firefox.

2. Step 2: Differentiate from other Selenium tasks

   Locating elements, assertions, and reports are separate tasks not handled by FirefoxOptions().

3. Final Answer:

   To configure Firefox browser settings before starting the test -> Option A

4. Quick Check:

   FirefoxOptions() = configure browser [OK]

Hint: Options set browser behavior before test starts [OK]

Common Mistakes:

• Confusing options with element locators
• Thinking options generate reports
• Mixing options with assertions

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

easy

A. options = FirefoxOptions()
options.set_headless(True)

B. options = FirefoxOptions()
options.add_argument('--headless')

C. options = FirefoxOptions()
options.headless = True

D. options = FirefoxOptions()
options.enable_headless()

Solution

1. Step 1: Recall correct syntax for headless mode

   In Selenium Python, options.headless = True is the standard way to enable headless mode for Firefox.

2. Step 2: Check other options for correctness

   set_headless() and enable_headless() are not valid methods. add_argument('--headless') works for Chrome but not recommended for Firefox.

3. Final Answer:

   options = FirefoxOptions() options.headless = True -> Option C

4. Quick Check:

   Set options.headless = True for Firefox headless [OK]

Hint: Use options.headless = True for Firefox headless mode [OK]

Common Mistakes:

• Using Chrome syntax like add_argument('--headless')
• Calling non-existent methods like set_headless()
• Forgetting to create FirefoxOptions instance

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

from selenium.webdriver import Firefox
from selenium.webdriver.firefox.options import Options

options = Options()
options.headless = True
browser = Firefox(options=options)
print(browser.capabilities['moz:headless'])
browser.quit()

medium

A. KeyError exception

B. True

C. None

D. False

Solution

1. Step 1: Understand headless option effect on capabilities

   Setting options.headless = True tells Firefox to run without UI, reflected in capabilities under key 'moz:headless' as True.

2. Step 2: Check the print statement output

   The print statement accesses browser.capabilities['moz:headless'], which will be True because headless mode is enabled.

3. Final Answer:

   True -> Option B

4. Quick Check:

   Headless mode enabled means moz:headless = True [OK]

Hint: Check capabilities key 'moz:headless' for headless status [OK]

Common Mistakes:

• Assuming 'moz:headless' key is missing
• Expecting False when headless is set True
• Confusing capabilities with options

4. Identify the error in the following Firefox configuration code and select the fix:

from selenium.webdriver import Firefox
from selenium.webdriver.firefox.options import Options

options = Options()
options.headless(True)
browser = Firefox(options=options)
browser.quit()

medium

A. Change options.headless(True) to options.headless = True

B. Import FirefoxOptions instead of Options

C. Add browser.quit() before creating browser

D. Remove options argument from Firefox() constructor

Solution

1. Step 1: Identify incorrect method call

   The line options.headless(True) incorrectly calls headless as a method, but it is a property to set.

2. Step 2: Correct syntax for setting headless

   It should be options.headless = True to enable headless mode properly.

3. Final Answer:

   Change options.headless(True) to options.headless = True -> Option A

4. Quick Check:

   Set headless as property, not method [OK]

Hint: Use assignment (=), not function call, for headless [OK]

Common Mistakes:

• Calling headless as a method
• Confusing Options class import
• Misplacing browser.quit() call

5. You want to disable Firefox notifications during Selenium tests to avoid pop-ups. Which code snippet correctly sets this preference using FirefoxOptions?

hard

A. options = FirefoxOptions()
options.set_capability('notifications', False)

B. options = FirefoxOptions()
options.add_argument('--disable-notifications')

C. options = FirefoxOptions()
options.headless = False
options.disable_notifications = True

D. options = FirefoxOptions()
options.set_preference('dom.webnotifications.enabled', False)

Solution

1. Step 1: Identify correct method to set Firefox preferences

   Use options.set_preference() to set Firefox-specific preferences like disabling notifications.

2. Step 2: Verify preference key and value

   The key 'dom.webnotifications.enabled' controls notifications; setting it to False disables them.

3. Final Answer:

   options = FirefoxOptions() options.set_preference('dom.webnotifications.enabled', False) -> Option D

4. Quick Check:

   Use set_preference with correct key to disable notifications [OK]

Hint: Use set_preference('dom.webnotifications.enabled', False) [OK]

Common Mistakes:

• Using add_argument for Firefox preferences
• Setting non-existent properties like disable_notifications
• Confusing capabilities with preferences