From 48bc2ceb7f5052539ce3160e19311693f3577466 Mon Sep 17 00:00:00 2001 From: Joshua Hoblitt Date: Tue, 27 May 2014 12:04:16 -0700 Subject: [PATCH 1/3] change README MD so class parameters are a subsection Changing the class parameters markup from a list to a sub-sub-sub-sub-subsection creates a direct HTML anchor that is useful to cut'n'paste as a URL. --- README.md | 113 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 58 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 7d15ac5..2a9d0f7 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,11 @@ Puppet selenium Module * [Simple](#simple) * [Example "profiles/roles"](#example-profilesroles) * [Files](#files) - * [`selenium`](#selenium) - * [`selenium::server`](#seleniumserver) - * [`selenium::hub`](#seleniumhub) - * [`selenium::node`](#seleniumnode) + * [Classes](#classes) + * [`selenium`](#selenium) + * [`selenium::server`](#seleniumserver) + * [`selenium::hub`](#seleniumhub) + * [`selenium::node`](#seleniumnode) 4. [Why Another Module?](#why-another-module) 5. [Limitations](#limitations) * [Tested Platforms](#tested-platforms) @@ -177,7 +178,9 @@ other than the selenium role account. /etc/init.d/seleniumserver ``` -### `selenium` +### Classes + +#### `selenium` This class controls common configuration values used by the `selenium::{server,hub,node}` classes. It is automatically included in the @@ -197,55 +200,55 @@ class { 'selenium': } ``` - * `user` +##### `user` - `String` defaults to: `selenium` +`String` defaults to: `selenium` - The name/uid of the system role account to execute the server process under - and will have ownership of files. +The name/uid of the system role account to execute the server process under and +will have ownership of files. - * `group` +##### `group` - `String` defaults to: `selenium` +`String` defaults to: `selenium` - The group/gid of the system role account and group ownership of files. +The group/gid of the system role account and group ownership of files. - * `install_root` +##### `install_root` - `String` defaults to: `/opt/selenium` +`String` defaults to: `/opt/selenium` - The dirname under which Selenium Server files (including logs) will be - created. +The dirname under which Selenium Server files (including logs) will be +created. - * `java` +##### `java` - `String` defaults to: `java` +`String` defaults to: `java` - The path of the `java` interpreter to use. +The path of the `java` interpreter to use. - * `version` +##### `version` - `String` defaults to: `2.41.0` (the latest release as of 2014-05-22) +`String` defaults to: `2.41.0` (the latest release as of 2014-05-22) - The version of Selenium Server to download. Used to form the URL used to - fetch the jar file. +The version of Selenium Server to download. Used to form the URL used to fetch +the jar file. - * `url` +##### `url` - `String` defaults to: `undef` +`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). +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). - * `download_timeout` +##### `download_timeout` - `String` defaults to: `90` +`String` defaults to: `90` - Timeout to download of the package. +Timeout to download of the package. -### `selenium::server` +#### `selenium::server` ```puppet # defaults @@ -255,20 +258,20 @@ class { 'selenium::server': } ``` - * `display` +##### `display` - `String` defaults to: `:0` +`String` defaults to: `:0` - The name of the `X` display to render too. This is set as an environment - variable passed to Selenium Server +The name of the `X` display to render too. This is set as an environment +variable passed to Selenium Server - * `options` +##### `options` - `String` defaults to: `-Dwebdriver.enable.native.events=1` +`String` defaults to: `-Dwebdriver.enable.native.events=1` - Options passed to Selenium Server at startup. +Options passed to Selenium Server at startup. -### `selenium::hub` +#### `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. @@ -280,13 +283,13 @@ class { 'selenium::hub': } ``` - * options` +##### `options` - `String` defaults to: `-role hub` +`String` defaults to: `-role hub` - Options passed to Selenium Server Hub at startup. +Options passed to Selenium Server Hub at startup. -### `selenium::node` +#### `selenium::node` ```puppet # defaults @@ -297,24 +300,24 @@ class { 'selenium::node': } ``` - * `display` +##### `display` - `String` defaults to: `:0` +`String` defaults to: `:0` - The name of the `X` display to render too. This is set as an environment - variable passed to Selenium Server +The name of the `X` display to render too. This is set as an environment +variable passed to Selenium Server - * `options` +##### `options` - `String` defaults to: `-Dwebdriver.enable.native.events=1 -role node` +`String` defaults to: `-Dwebdriver.enable.native.events=1 -role node` - Options passed to Selenium Server Node at startup. +Options passed to Selenium Server Node at startup. - * `hub` +##### `hub` - `String` defaults to: `http://localhost:4444/grid/register` +`String` defaults to: `http://localhost:4444/grid/register` - The URL of the Selenium Server Hub to connect to. +The URL of the Selenium Server Hub to connect to. Why Another Module? From 5f10d31d41473e0b376e71368ec3828a4dd536cb Mon Sep 17 00:00:00 2001 From: Joshua Hoblitt Date: Tue, 27 May 2014 12:14:18 -0700 Subject: [PATCH 2/3] minor README grammar tweak --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2a9d0f7..a25dda5 100644 --- a/README.md +++ b/README.md @@ -158,7 +158,7 @@ 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 +The log files are set to mode `0644`, so that they can be inspected by users other than the selenium role account. ``` From 36ecd001dde9d09b6c8d0ce552b4333deb5aba70 Mon Sep 17 00:00:00 2001 From: Joshua Hoblitt Date: Tue, 27 May 2014 12:15:54 -0700 Subject: [PATCH 3/3] bump version to v0.2.2 --- CHANGELOG.md | 17 +++++++++++++++++ Modulefile | 2 +- 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 04e7ba6..c2ea80f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,22 @@ #### [Current] + * [5f10d31](../../commit/5f10d31) - __(Joshua Hoblitt)__ minor README grammar tweak + * [48bc2ce](../../commit/48bc2ce) - __(Joshua Hoblitt)__ change README MD so class parameters are a subsection + +Changing the class parameters markup from a list to a +sub-sub-sub-sub-subsection creates a direct HTML anchor that is useful +to cut'n'paste as a URL. + + * [8a40c58](../../commit/8a40c58) - __(Joshua Hoblitt)__ Merge pull request [#11](../../issues/11) from jhoblitt/feature/jar-2.41.0 + +update default selenium jar version to 2.41.0 + * [c6daae6](../../commit/c6daae6) - __(Joshua Hoblitt)__ update default selenium jar version to 2.41.0 + +#### v0.2.1 + * [fa644ee](../../commit/fa644ee) - __(Joshua Hoblitt)__ Merge pull request [#10](../../issues/10) from jhoblitt/feature/v0.2.1 + +bump version to v0.2.1 + * [a19c6ca](../../commit/a19c6ca) - __(Joshua Hoblitt)__ bump version to v0.2.1 * [a93d574](../../commit/a93d574) - __(Joshua Hoblitt)__ update rspec to cover PR [#9](../../issues/9) * [e070184](../../commit/e070184) - __(Joshua Hoblitt)__ Merge pull request [#9](../../issues/9) from KlavsKlavsen/master * [eb5c321](../../commit/eb5c321) - __(Joshua Hoblitt)__ update .gitignore diff --git a/Modulefile b/Modulefile index ccc89ed..ccdd128 100644 --- a/Modulefile +++ b/Modulefile @@ -1,5 +1,5 @@ name 'jhoblitt-selenium' -version '0.2.1' +version '0.2.2' author 'Joshua Hoblitt ' license 'Apache'