Selenium Cookbook

This cookbook installs and configures Selenium and WebDriver components (http://www.seleniumhq.org/).

This cookbook comes with the following:

Recipes:

• hub - Installs and configures a selenium-grid hub.
• node - Installs and configures a selenium-grid node with support for ChromeDriver, FirefoxDriver, HtmlUnitDriver, InternetExplorerDriver, and SafariDriver.

Resource/Providers:

• selenium_hub - Installs and configures selenium-grid hubs.
• selenium_node - Installs and configures selenium-grid nodes with the same support as node recipe.

PhantomJS has been deprecated and is no longer supported. It will be removed in the next major release. Please use
ghostdriver cookbook instead.

Requirements

• Chef 11.14 or higher (sensitive attribute introduced)

Platforms

• CentOS, RedHat
• Mac OS X
• Ubuntu
• Windows

Cookbooks

These cookbooks are referenced with suggests, so be sure to depend on cookbooks that apply:

• windows
• nssm - Required by Windows services only (e.g. Hub and HtmlUnit running in background)
• macosx_autologin - Required by Mac OS X GUI services
• safari - Required by safaridriver
• macosx_gui_login - Required by safaridriver

Usage

See selenium_test
cookbook for working cross platform examples. Note that provided examples in this cookbook have passwords
unencrypted for simplicity.

Recipes

hub

Installs and configures a selenium-grid hub.

Requirements

• Java must be installed outside of this cookbook.

Example

Install selenium-grid hub

include_recipe 'selenium::hub'

Attributes

This is a partial list of attributes available. See
hub
resource for the complete listing of attributes.

• node['selenium']['hub']['service_name'] - The name of the service. Defaults to 'selenium_hub'
• node['selenium']['hub']['host'] - Defaults to 'null'
• node['selenium']['hub']['port'] - Defaults to 4444
• node['selenium']['hub']['jvm_args'] - Defaults to nil
• node['selenium']['hub']['newSessionWaitTimeout'] - Defaults to -1
• node['selenium']['hub']['servlets'] - Defaults to []
• node['selenium']['hub']['prioritizer'] - Defaults to 'null'
• node['selenium']['hub']['capabilityMatcher'] - Defaults to 'org.openqa.grid.internal.utils.DefaultCapabilityMatcher'
• node['selenium']['hub']['throwOnCapabilityNotPresent'] - Defaults to true
• node['selenium']['hub']['nodePolling'] - Defaults to 5000
• node['selenium']['hub']['cleanUpCycle'] - Defaults to 5000
• node['selenium']['hub']['timeout'] - Defaults to 30_000
• node['selenium']['hub']['browserTimeout'] - Defaults to 0
• node['selenium']['hub']['maxSession'] - Defaults to 5
• node['selenium']['hub']['jettyMaxThreads'] - Defaults to -1

node

Installs and configures a selenium-grid node with support for
ChromeDriver,
FirefoxDriver,
HtmlUnitDriver,
InternetExplorerDriver, and
SafariDriver.

Requirements

• Java must be installed outside of this cookbook.
• Browsers (e.g., chrome, firefox, etc...) must be installed outside of this cookbook.
• Linux nodes without a physical monitor require a headless display (e.g., xvfb, x11vnc, etc...) and must be installed and configured outside this cookbook.
• Mac OS X/Windows nodes (with the exception of HtmlUnitDriver) must run as a GUI service and that requires a username and password for automatic login. Note that Windows password is stored unencrypted under windows registry HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Winlogon and Mac OS X password is stored encrypted under /etc/kcpassword but it can be easily decrypted.

Example

Install selenium-grid node with Chrome, Firefox, HtmlUnit and Internet Explorer capability

node.set['selenium']['node']['username'] = 'vagrant' if platform?('windows', 'mac_os_x')
node.set['selenium']['node']['password'] = 'vagrant' if platform?('windows', 'mac_os_x')

node.set['selenium']['node']['capabilities'] = [
  {
    browserName: 'chrome',
    maxInstances: 5,
    seleniumProtocol: 'WebDriver'
  },
  {
    browserName: 'firefox',
    maxInstances: 5,
    seleniumProtocol: 'WebDriver'
  },
  {
    browserName: 'htmlunit',
    maxInstances: 1,
    platform: 'ANY',
    seleniumProtocol: 'WebDriver'
  },
  {
    browserName: 'internet explorer',
    maxInstances: 1,
    seleniumProtocol: 'WebDriver'
  }
]

include_recipe 'selenium::node'

Attributes

This is a partial list of attributes available. See
node
resource for the complete listing of attributes.

• node['selenium']['node']['service_name'] - The name of the service or Windows foreground startup script. Defaults to 'selenium_node'
• node['selenium']['node']['host'] - Defaults to 'ip'
• node['selenium']['node']['port'] - Defaults to 5555
• node['selenium']['node']['jvm_args'] - Defaults to nil
• node['selenium']['node']['proxy'] - Defaults to 'org.openqa.grid.selenium.proxy.DefaultRemoteProxy'
• node['selenium']['node']['maxSession'] - Defaults to 5
• node['selenium']['node']['register'] - Defaults to true
• node['selenium']['node']['registerCycle'] - Defaults to 5000
• node['selenium']['node']['hubPort'] - Selenium-grid hub hostname. Defaults to 4444
• node['selenium']['node']['hubHost'] - Selenium-grid hub port. Defaults to 'ip'
• node['selenium']['node']['capabilities'] - Defaults to []. The following drivers are supported and installed based on capabilities:
  • ChromeDriver - Installed if capabilities contains browser name chrome
  • FirefoxDriver - Pre-installed with Selenium server
  • HtmlUnitDriver - Pre-installed with Selenium server
  • InternetExplorerDriver - 32-bit or 64-bit installed if capabilities contains browser name internet explorer
  • SafariDriver - Installed if capabilities contains browser name safari
• node['selenium']['node']['additional_args'] - Defaults to []
• node['selenium']['node']['display'] - Defaults to ':0'
• Mac OS X/Windows only - Set both username and password to run as a GUI service or leave nil to run service in background (HtmlUnit only):
  • username - Defaults to nil.
  • password - Defaults to nil. Note that Windows password is stored unencrypted under windows registry HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Winlogon and Mac OS X password is stored encrypted under /etc/kcpassword but it can be easily decrypted.
  • domain - Optional for Windows only. Defaults to nil.

Resource/Providers

selenium_hub

Installs and configures selenium-grid hubs.

Requirements

• Java must be installed outside of this cookbook.

Example

Install selenium-grid hub

selenium_hub 'selenium_hub' do
  action :install
end

Attributes

This is a partial list of attributes available. See
hub
resource for the complete listing of attributes.

• name - Name attribute. The name of the service.
• host - Hostname. Defaults to null.
• port - Port. Defaults to 4444.

selenium_node

Installs and configures selenium-grid nodes with support for
ChromeDriver,
FirefoxDriver,
HtmlUnitDriver,
InternetExplorerDriver, and
SafariDriver.

Requirements

• Java must be installed outside of this cookbook.
• Browsers (e.g., chrome, firefox, etc...) must be installed outside of this cookbook.
• Linux nodes without a physical monitor require a headless display (e.g., xvfb, x11vnc, etc...) and must be installed and configured outside this cookbook.
• Mac OS X/Windows nodes (with the exception of HtmlUnitDriver) must run as a GUI service and that requires a username and password for automatic login. Note that Windows password is stored unencrypted under windows registry HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Winlogon and Mac OS X password is stored encrypted under /etc/kcpassword but it can be easily decrypted.

Example

Install selenium-grid node with Chrome, Firefox, HtmlUnit and Internet Explorer capability

selenium_node 'selenium_node' do
  username 'vagrant' if platform?('windows', 'mac_os_x')
  password 'vagrant' if platform?('windows', 'mac_os_x')
  capabilities [
    {
      browserName: 'chrome',
      maxInstances: 5,
      seleniumProtocol: 'WebDriver'
    },
    {
      browserName: 'firefox',
      maxInstances: 5,
      seleniumProtocol: 'WebDriver'
    },
    {
      browserName: 'htmlunit',
      maxInstances: 1,
      platform: 'ANY',
      seleniumProtocol: 'WebDriver'
    },
    {
      browserName: 'internet explorer',
      maxInstances: 1,
      seleniumProtocol: 'WebDriver'
    }
  ]
  action :install
end

Attributes

This is a partial list of attributes available. See
node
resource for the complete listing of attributes.

• name - Name attribute. The name of the service or Windows foreground startup script.
• host - Hostname. Defaults to null.
• port - Port. Defaults to 5555.
• hubHost - Selenium-grid hub hostname. Defaults to ip.
• hubPort - Selenium-grid hub port. Defaults to 4444.
• capabilities - The following drivers are supported and installed based on capabilities:
  • ChromeDriver - Installed if capabilities contains browser name chrome
  • FirefoxDriver - Pre-installed with Selenium server
  • HtmlUnitDriver - Pre-installed with Selenium server
  • InternetExplorerDriver - 32-bit or 64-bit installed if capabilities contains browser name internet explorer
  • SafariDriver - Installed if capabilities contains browser name safari
• Mac OS X/Windows only - Set both username and password to run as a GUI service or leave nil to run service in background (HtmlUnit only):
  • username - Defaults to nil.
  • password - Defaults to nil. Note that Windows password is stored unencrypted under windows registry HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Winlogon and Mac OS X password is stored encrypted under /etc/kcpassword but it can be easily decrypted.
  • domain - Optional for Windows only. Defaults to nil.

ChefSpec Matchers

The Selenium cookbook includes custom ChefSpec matchers you can use to test
your own cookbooks.

Example Matcher Usage

expect(chef_run).to install_selenium_hub('resource_name').with(
  port: '4444'
)

Selenium Cookbook Matchers

• install_selenium_hub(resource_name)
• install_selenium_node(resource_name)

Getting Help

• Ask specific questions on Stack Overflow.
• Report bugs and discuss potential features in Github issues.

Contributing

Please refer to CONTRIBUTING.

License

MIT - see the accompanying LICENSE file for details.