All browser configuration is done by editing
conf/env.yaml, or creating a local override in
conf/env.local.yaml. Local overrides are preferred. For more information about configuration
All yaml examples in this document are snippets from
Local vs. Remote¶
Most WebDrivers can operate in two modes, as a local WebDriver or through a Remote WebDriver. The local WebDriver will launch a browser in the calling environment (such as your desktop), while the Remote WebDriver will connect to a remote selenium server (hence the name) and attempt to run the browser there.
Examples for each mode will be provided, where appropriate. Note that capitalization is extremely
important when specifying either
browserName, as indicated in the examples
Some help for setting up the remote selenium server can be found in the Selenium over VNC document.
Standalone Selenium Server¶
A Selenium Server is needed in order to run Remote Selenium WebDriver. You can install and run the Standalone Selenium Server which is a very common method. Although you may run this locally, it is still setup as a Remote webdriver as described above.
For more information, view the Selenium over VNC document.
A variant of the Remote webdriver, WebDriver Wharf will spawn docker containers running the selenium standalone server on request.
Remote drivers take a “desired_capabilities” dictionary. Details on what keys and expected
value types can be used in this dictionary can be found in the selenium documentation:
Selenium, by default, looks for the selenium server on localhost port 4444. If the selenium server
is running on a different machine, you’ll need to add a
command_executor option to
webdriver_options in the examples below to the machine running the selenium server.
command_exector must be a URL to a selenium server hub, which by default is at the
path on the selenium server.
browser: webdriver: Remote webdriver_options: command_executor: http://selenium-server-hostname:port/wd/hub desired_capabilities: browserName: browser
Each browser has its own set of capabilities, and those capabilities will usually not apply from one browser to another.
While most selenium identifiers have been translated from
python_identifiers, the keys of
desired_capabilitiesare not altered in any way. No name translation should have to be done for
browserNamedoes not become
Regardless of which Webdriver you use,
hostname must be set for each appliance listed in
It is assumed that the website at the
hostname will be a working CFME UI. You can specify
ui_port to switch between http/https or change the web server port, respectively.
hostname is not solely used by the browser. Other functionality, such as the SSH and SOAP
clients, derive their destination addresses from the
Firefox has built-in support for selenium (and vice-versa). No additional configuration should be required to use the Firefox browser.
browser: webdriver: Firefox
browser: webdriver: Remote webdriver_options: desired_capabilities: browserName: firefox
browser: webdriver: Remote webdriver_options: desired_capabilities: browserName: firefox webdriver_wharf: http://wharf.host:4899/
In order to use Chrome with selenium, you must first install the
chromedriver executable. This
executable should be somewhere on your
Download chromedriver. Use the latest available release for your architecture.
browser: webdriver: Chrome
browser: webdriver: Remote webdriver_options: desired_capabilities: browserName: chrome
browser: webdriver: Remote webdriver_options: desired_capabilities: browserName: chrome webdriver_wharf: http://wharf.host:4899/
Like Firefox, Safari is natively supported by selenium. Usage is equally simple, with the exception that you’ll probably need to be running selenium on OS X.
browser: webdriver: Safari
browser: webdriver: Remote webdriver_options: # If selenium is running remotely, remember to update command_executor #command_executor: http://safari_host/wd/hub desired_capabilities: browserName: safari
Like Chrome &
chromedriver, Internet Explorer needs a separate executable to work with selenium,
InternetExplorerDriver is a server that only runs in Windows, and
should be running before starting selenium in either Local or Remote mode.
For more information, visit https://code.google.com/p/selenium/wiki/InternetExplorerDriver
browser: webdriver: Ie
browser: webdriver: Remote webdriver_options: # If selenium is running remotely, remember to update command_executor #command_executor: http://windows_host/wd/hub desired_capabilities: browserName: internet explorer # platform must be WINDOWS for IE platform: WINDOWS
By providing selenium servers on a multitude of platforms, Sauce Labs is able to help us test in “exotic” environments. In order to test against appliances behind firewalls, sauce-connect must be used:
sauce-connect tunnels are used by default if they’re running, so the same
be used to use the sauce labs service whether sauce-connect is running or not:
Internet Explorer Sauce¶
The following example is our “worst-case scenario”, which is running a very recent release of Internet Explorer in a very recent release of Windows:
browser: webdriver: Remote webdriver_options: command_executor: http://username:email@example.com:80/wd/hub desired_capabilities: browserName: internet explorer platform: Windows 8.1 version: 11 screen-resolution: 1280x1024
The above configuration, at the time of this writing, ran our test suite with no issues.
More information on sauce-specific options allowed in desired_capabilities can be found in the sauce labs documentation:
Python values for the browser constants used in the sauce labs “platform” page can be found here: https://code.google.com/p/selenium/source/browse/py/selenium/webdriver/common/desired_capabilities.py