Firefox 固有のCapability

Selenium 4 には Firefox 78 以降が必要です。 常に最新バージョンの geckodriver を使用することをお勧めします。

オプション

全ブラウザに共通のCapabilityについては、オプションページで説明しています。

Firefox に固有のCapabilityは、Mozilla のページの firefoxOptions にあります。

基本的な定義済みのオプションを使用して Firefox セッションを開始すると、以下のようになります。

• 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();

さまざまなCapabilityを備えた一般的な使用例をいくつか示します。

引数

args パラメータは、ブラウザの起動時に使用するコマンドラインスイッチのリストです。 一般的に使用される引数には、 -headless と "-profile" 、"/path/to/profile" が含まれます。

オプションに引数を追加します。

• 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();

指定したロケーションでブラウザを起動する

binary パラメーターは、使用するブラウザーの別のロケーションのパスを取ります。 たとえば、このパラメーターを使用すると、geckodriver を使用して、製品版とFirefox Nightlyの両方がコンピューターに存在する場合、 製品版の代わりに Firefox Nightly を駆動できます 。

オプションにブラウザーのロケーションを追加します。

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

    options.setBinary(getFirefoxLocation());

    options.binary_location = firefox_bin

            options.BinaryLocation = GetFirefoxLocation();

      options.binary = firefox_location

プロファイル

Firefoxプロファイルを操作するにはいくつかの方法があります。

FirefoxProfile profile = new FirefoxProfile();
FirefoxOptions options = new FirefoxOptions();
options.setProfile(profile);
driver = new RemoteWebDriver(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 RemoteWebDriver(options);
  

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

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 = RemoteWebDriver(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

アドオン

Chromeとは異なり、Firefoxの拡張機能はCapabilityの一部として追加されるのではなく、ドライバーの起動後に作成されます。

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.

インストール

Mozilla Add-Onsページ から取得する署名付きxpiファイル

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

    driver.installExtension(xpiPath);

    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);

アンインストール

アドオンをアンインストールするには、そのIDを知る必要があります。 IDはアドオンインストール時の戻り値から取得できます。

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

    driver.uninstallExtension(id);

    driver.uninstall_addon(id)

            driver.UninstallAddOn(extensionId);

      driver.uninstall_addon(extension_id)

    await driver.uninstallAddon(id);

署名なしのインストール

未完成または未公開の拡張機能を使用する場合、署名されていない可能性があります。 そのため、“一時的なもの” としてのみインストールできます。 これは、zipファイルまたはディレクトリを渡すことで実行できます。ディレクトリの例を次に示します。

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

    driver.installExtension(path, true);

    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);

ページ全体のスクリーンショット

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

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

コンテキスト

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

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