Firefox specific functionality

Selenium 4 requires Firefox 78 or greater. It is recommended to always use the latest version of geckodriver.

Options

Capabilities common to all browsers are described on the Options page.

Capabilities unique to Firefox can be found at Mozilla’s page for firefoxOptions

Starting a Firefox session with basic defined options looks like this:

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    FirefoxOptions options = new FirefoxOptions();
    driver = new FirefoxDriver(options);

    options = webdriver.FirefoxOptions()
    driver = webdriver.Firefox(options=options)

            var options = new FirefoxOptions();
            driver = new FirefoxDriver(options);

      options = Selenium::WebDriver::Options.firefox
      @driver = Selenium::WebDriver.for :firefox, options: options

      let options = new firefox.Options();
      driver = await env.builder()
        .setFirefoxOptions(options)
        .build();

Arguments

The args parameter is for a list of Command line switches used when starting the browser.
Commonly used args include -headless and "-profile", "/path/to/profile"

Add an argument to options:

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    options.addArguments("-headless");

    options.add_argument("-headless")

            options.AddArgument("-headless");

      options.args << '-headless'

    let driver = await env.builder()
      .setFirefoxOptions(options.addArguments('--headless'))
      .build();

Start browser in a specified location

The binary parameter takes the path of an alternate location of browser to use. For example, with this parameter you can use geckodriver to drive Firefox Nightly instead of the production version when both are present on your computer.

Add a browser location to options:

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    options.setBinary(getFirefoxLocation());

    options.binary_location = firefox_bin

            options.BinaryLocation = GetFirefoxLocation();

      options.binary = firefox_location

Profiles

There are several ways to work with Firefox profiles.

Move Code

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

FirefoxProfile profile = new FirefoxProfile();
FirefoxOptions options = new FirefoxOptions();
options.setProfile(profile);
driver = new FirefoxDriver(options);
  

from selenium.webdriver.firefox.options import Options
from selenium.webdriver.firefox.firefox_profile import FirefoxProfile
options=Options()
firefox_profile = FirefoxProfile()
firefox_profile.set_preference("javascript.enabled", False)
options.profile = firefox_profile
  

var options = new FirefoxOptions();
var profile = new FirefoxProfile();
options.Profile = profile;
var driver = new FirefoxDriver(options);
  

      profile = Selenium::WebDriver::Firefox::Profile.new
        profile['browser.download.dir'] = '/tmp/webdriver-downloads'
        options = Selenium::WebDriver::Firefox::Options.new(profile: profile)

const { Builder } = require("selenium-webdriver");
const firefox = require('selenium-webdriver/firefox');

const options = new firefox.Options();
let profile = '/path to custom profile';
options.setProfile(profile);
const driver = new Builder()
    .forBrowser('firefox')
    .setFirefoxOptions(options)
    .build();
  

val options = FirefoxOptions()
options.profile = FirefoxProfile()
driver = FirefoxDriver(options)
  

Service

Service settings common to all browsers are described on the Service page.

Log output

Getting driver logs can be helpful for debugging various issues. The Service class lets you direct where the logs will go. Logging output is ignored unless the user directs it somewhere.

File output

To change the logging output to save to a specific file:

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    FirefoxDriverService service =
        new GeckoDriverService.Builder().withLogFile(logLocation).build();

    service = webdriver.FirefoxService(log_output=log_path, service_args=['--log', 'debug'])

      service.log = file_name

Console output

To change the logging output to display in the console:

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    FirefoxDriverService service =
        new GeckoDriverService.Builder().withLogOutput(System.out).build();

    service = webdriver.FirefoxService(log_output=subprocess.STDOUT)

      service.log = $stdout

Log level

There are 7 available log levels: fatal, error, warn, info, config, debug, trace. If logging is specified the level defaults to info.

Note that -v is equivalent to -log debug and -vv is equivalent to log trace, so this examples is just for setting the log level generically:

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    FirefoxDriverService service =
        new GeckoDriverService.Builder().withLogLevel(FirefoxDriverLogLevel.DEBUG).build();

    service = webdriver.FirefoxService(log_output=log_path, service_args=['--log', 'debug'])

      service.args += %w[--log debug]

Truncated Logs

The driver logs everything that gets sent to it, including string representations of large binaries, so Firefox truncates lines by default. To turn off truncation:

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    FirefoxDriverService service =
        new GeckoDriverService.Builder().withTruncatedLogs(false).build();

    service = webdriver.FirefoxService(service_args=['--log-no-truncate', '--log', 'debug'], log_output=log_path)

      service.args << '--log-no-truncate'

Profile Root

The default directory for profiles is the system temporary directory. If you do not have access to that directory, or want profiles to be created some place specific, you can change the profile root directory:

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    FirefoxDriverService service =
        new GeckoDriverService.Builder().withProfileRoot(profileDirectory).build();

    service = webdriver.FirefoxService(service_args=['--profile-root', temp_dir])

      service.args += ['--profile-root', root_directory]

Special Features

Some browsers have implemented additional features that are unique to them.

Add-ons

Unlike Chrome, Firefox extensions are not added as part of capabilities as mentioned in this issue, they are created after starting the driver.

The following examples are for local webdrivers. For remote webdrivers, please refer to the Remote WebDriver page.

Installation

A signed xpi file you would get from Mozilla Addon page

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    driver.install_addon(addon_path_xpi)

            driver.InstallAddOnFromFile(Path.GetFullPath(extensionFilePath));

      driver.install_addon(extension_file_path)

    const xpiPath = path.resolve('./test/resources/extensions/selenium-example.xpi')
    let driver = await env.builder().build();
    let id = await driver.installAddon(xpiPath);

Uninstallation

Uninstalling an addon requires knowing its id. The id can be obtained from the return value when installing the add-on.

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    String id = driver.installExtension(xpiPath);

    driver.uninstall_addon(id)

            driver.UninstallAddOn(extensionId);

      driver.uninstall_addon(extension_id)

    await driver.uninstallAddon(id);

Unsigned installation

When working with an unfinished or unpublished extension, it will likely not be signed. As such, it can only be installed as “temporary.” This can be done by passing in either a zip file or a directory, here’s an example with a directory:

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

    driver = startFirefoxDriver();

    driver.install_addon(addon_path_dir, temporary=True)

            driver.InstallAddOnFromDirectory(Path.GetFullPath(extensionDirPath), true);

      driver.install_addon(extension_dir_path, true)

    const xpiPath = path.resolve('./test/resources/extensions/selenium-example')
    let driver = await env.builder().build();
    let id = await driver.installAddon(xpiPath, true);

Full page screenshots

The following examples are for local webdrivers. For remote webdrivers, please refer to the Remote WebDriver page.

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

        screenshot = driver.save_full_page_screenshot(File.join(dir, 'screenshot.png'))

Context

The following examples are for local webdrivers. For remote webdrivers, please refer to the Remote WebDriver page.

• Java
• Python
• CSharp
• Ruby
• JavaScript
• Kotlin

      driver.context = 'content'