Puppet selenium Module

Table of Contents

1. Overview
2. Description
3. Usage
   • Simple
   • Example "profiles/roles"
   • Files
   • selenium
   • selenium::server
   • selenium::hub
   • selenium::node
4. Why Another Module?
5. Limitations
   • Tested Platforms
6. Versioning
7. Support
8. See Also

Overview

Manages Selenium Server 2 - Standalone and Grid

Description

This is a puppet module for installation and configuration of the Selenium Server 2 browser automation package. Support is provided for configuring Selenium Server in standalone mode along with the grid modes of hub and node.

The design intent of this module is to only manage Selenium server and not any of the other packages that might be required to required to create a selenium server profile/role.

Usage

Simple

Stand alone server setup with display :99 (default is :0).

class { 'selenium::server': display => ':99' }

Grid in a box setup with the Selenium node talking to the hub via 127.0.0.1.

class { 'selenium::hub': }
class { 'selenium::node': }

Example "profiles"/"roles"

Here are some examples "profiles" and "roles" based on Craig Dunn's blog post on Designing Puppet – Roles and Profiles..

These examples assume the presence of these two modules in your Puppet environment.

• puppetlabs-java
• p0deje/display

Selenium Server Profile

class mysite::profile::seleniumserver {
  include java

  # WSXGA+ 1680x1050 -- should nicely fit on a 1920x1280 screen
  class { 'display':
    width  => 1680,
    height => 1050,
  } ->
  class { 'selenium::server': }

  Class['java'] -> Class['selenium::server']
}

Selenium Hub Profile

class mysite::profile::seleniumhub {
  include java

  class { 'selenium::hub': }

  Class['java'] -> Class['selenium::hub']
}

Selenium Node Profile

class mysite::profile::seleniumnode {
  include java

  # WSXGA+ 1680x1050 -- should nicely fit on a 1920x1280 screen
  class { 'display':
    width  => 1680,
    height => 1050,
  } ->
  class { 'selenium::node':
    # If your intending to have node(s) that don't sit on the same system as
    # the hub, you need to point the node at a hub by passing in the hub's url
    # in or using an exported resource from the hub system. Eg.
    # hub => 'http://<myseleniumhub>:4444/grid/register',
  }

  Class['java'] -> Class['selenium::node']
}

Selenium Server Role

class mysite::role::seleniumserver {
  include mysite::profile::seleniumserver
}

Selenium Hub Role

class mysite::role::seleniumhub {
  include mysite::profile::seleniumhub
  include mysite::profile::seleniumnode
}

Files

Unless class selenium has $install_root changed from the default, these files paths will be used. Note that the log files and init scripts are only created for the relevant configured service.

The log files will have the mode 0644 so that they can be inspected by users other than the selenium role account.

/opt/selenium
|-- jars
|   `-- selenium-server-standalone-x.xx.x.jar
`-- log
    |-- hub_stderr.log
    |-- hub_stdout.log
    |-- node_stderr.log
    |-- node_stdout.log
    |-- server_stderr.log
    `-- server_stdout.log
/var/log/selenium -> /opt/selenium/log
/etc/init.d/seleniumhub
/etc/init.d/seleniumnode
/etc/init.d/seleniumserver

selenium

This class controls common configuration values used by the selenium::{server,hub,node} classes. It is automatically included in the manifest by those classes and it need not be explicitly declared except to override the default values.

# defaults
class { 'selenium':
  user         => 'selenium',
  group        => 'selenium',
  install_root => '/opt/selenium',
  java         => 'java',
  version      => '2.39.0',
  url          => undef,
}

• user

  String defaults to: selenium

  The name/uid of the system role account to execute the server process under and will have ownership of files.

• group

  String defaults to: selenium

  The group/gid of the system role account and group ownership of files.

• install_root

  String defaults to: /opt/selenium

  The dirname under which Selenium Server files (including logs) will be created.

• java

  String defaults to: java

  The path of the java interpreter to use.

• version

  String defaults to: 2.39.0 (the latest release as of 2013-12-20)

  The version of Selenium Server to download. Used to form the URL used to fetch the jar file.

• url

  String defaults to: undef

  If defined, url will be used to download the Selenium Server jar file. However, the version parameter just match the version of the downloaded file as this information is needed when starting up the server (this may change to be be automatically parsed from the url in a later release).

selenium::server

# defaults
class { 'selenium::server':
  display => ':0',
  options => '-Dwebdriver.enable.native.events=1',
}

• display

  String defaults to: :0

  The name of the X display to render too. This is set as an environment variable passed to Selenium Server

• options

  String defaults to: -Dwebdriver.enable.native.events=1

  Options passed to Selenium Server at startup.

selenium::hub

Note that by default selenium::server and selenium::hub will try to listen on the same TCP port (4444) and only one of them will be able to function.

# defaults
class { 'selenium::hub':
  options => '-role hub',
}

• options`

  String defaults to: -role hub

  Options passed to Selenium Server Hub at startup.

selenium::node

# defaults
class { 'selenium::node':
  display => ':0',
  options => '-Dwebdriver.enable.native.events=1 -role node',
  hub     => 'http://localhost:4444/grid/register',
}

• display

  String defaults to: :0

  The name of the X display to render too. This is set as an environment variable passed to Selenium Server

• options

  String defaults to: -Dwebdriver.enable.native.events=1 -role node

  Options passed to Selenium Server Node at startup.

• hub

  String defaults to: http://localhost:4444/grid/register

  The URL of the Selenium Server Hub to connect to.

Why Another Module?

At the time work on this module was started, there were no other Selenium Server modules published on the Puppet Forge. A number of existing modules were identified on github but none of them fit the author's needs of:

• Allowing the external setup of things like Xvfb, java, etc. and to allow the composition of site specific profiles/roles.
• Supporting a mixed environment of Scientific, Centos, and RedHat Linux (basically $::osfamily == 'RedHat'
• Enough rspec-puppet coverage to prevent regressions

The later is the most important issue. Attempting to add additional $::operatingsystem/$::osfamily support to a puppet module without rspec-puppet tests is a process fraught with peril.

The modules that were identified were:

• adamgoucher/selenium-puppet
  • Mostly aimed at Windows but with some Linux/POSIX support
  • no rspec-puppet tests (deal breaker)
• StoryIQ/puppet-selenium-grid
  • Debian only
  • no rspec-puppet tests (deal breaker)
• kayakco/puppet-selenium
  • Unreleased deps (deal breaker)
  • Very role like with lots of magic setup (deal breaker)
  • debian-ish (may support Centos)
  • Doesn't appear to be in a ready state

Limitations

At present, only support for $::osfamily == 'RedHat' has been implemented. Adding other Linux distributions will required the addition of platform specific init scripts.

Tested Platforms

• el6.x

Versioning

This module is versioned according to the Semantic Versioning 2.0.0 specification.

Support

Please log tickets and issues at github

See Also

• Selenium
• Designing Puppet – Roles and Profiles.
• puppetlabs-java
• p0deje/display
• maestrodev/wget
• rodjek/logrotate