README

WDIO Firefox Profile Service

You want to run your Firefox browser with a specific extension or need to set couple preferences? Selenium allows you to use a profile for the Firefox browser by passing this profile as base64 string to the firefox_profile property in your desired capabilities. This requires to build that profile and convert it into base64. This service for the wdio testrunner takes the work of compiling the profile out of your hand and let's you define your desired options comfortable from the wdio.conf.js file.

To find all possible options just open about:config in your Firefox browser or go to mozillaZine website to find the whole documentation about each setting. In Addition to that you can define compiled (as *.xpi) Firefox extensions that should get installed before the test starts.

Installation

The easiest way is to keep @wdio/firefox-profile-service as a devDependency in your package.json, via:

npm install @wdio/firefox-profile-service --save-dev

Instructions on how to install WebdriverIO can be found here.

Configuration

Setup your profile by adding the firefox-profile service to your service list. Then define your settings in the firefoxProfile property like this:

// wdio.conf.js
export.config = {
    // ...
    services: [
        ['firefox-profile', {
            extensions: [
                '/path/to/extensionA.xpi', // path to .xpi file
                '/path/to/extensionB' // or path to unpacked Firefox extension
            ],
            'xpinstall.signatures.required': false,
            'browser.startup.homepage': 'https://webdriver.io',
            legacy: true // only use for firefox <= 55
        }]
    ],
    // ...
};

If you have built a custom Firefox extension that you want to install in the browser make sure to set 'xpinstall.signatures.required': false as profile flag since Firefox extensions are required to be signed by Mozilla.

To use custom unsigned extensions you will also need to use Firefox Developer Edition since the regular Firefox 48 and newer do not allow this.

Options

Contains all settings as key value pair. You can find all available settings on the about:config page.

extensions

Add one or multiple extensions to the browser session. All entries can be either an absolute path to the .xpi file or the path to an unpacked Firefox extension directory.

Type: String[]
Default: []

profileDirectory

Create Firefox profile based on an existing one by setting an absolute path to that profile.

Type: String
Default: null

proxy

Set network proxy settings. The parameter proxy is a hash which structure depends on the value of mandatory proxyType key, which takes one of the following string values:

direct - direct connection (no proxy)
system - use operating system proxy settings
pac - use automatic proxy configuration set based on the value of autoconfigUrl key
manual - manual proxy settings defined separately for different protocols using values from following keys: ftpProxy, httpProxy, sslProxy, socksProxy

Type: Object
Default: null
Example:

Automatic Proxy:

// wdio.conf.js
export.config = {
    // ...
    services: [
        ['firefox-profile', {
            proxy: {
                proxyType: 'pac',
                autoconfigUrl: 'http://myserver/proxy.pac'
            }
        }]
    ],
    // ...
};

Manual HTTP Proxy:

// wdio.conf.js
export.config = {
    // ...
    services: [
        ['firefox-profile', {
            proxy: {
                proxyType: 'manual',
                httpProxy: '127.0.0.1:8080'
            }
        }]
    ],
    // ...
};

Manual HTTP and HTTPS Proxy:

// wdio.conf.js
export.config = {
    // ...
    services: [
        ['firefox-profile', {
            proxy: {
                proxyType: 'manual',
                httpProxy: '127.0.0.1:8080',
                sslProxy: '127.0.0.1:8080'
            }
        }]
    ],
    // ...
};

legacy

Please set this flag to true if you use Firefox v55 or lower.

Type: Boolean
Default: false

For more information on WebdriverIO see the homepage.

Usage no npm install needed!