README.rdoc in frameworks-capybara-0.2.34 vs README.rdoc in frameworks-capybara-0.3.0.rc1
- old
+ new
@@ -1,7 +1,5 @@
-= Build Status {<img src="https://secure.travis-ci.org/bbc-frameworks/frameworks-capybara.png"/>}[https://secure.travis-ci.org/bbc-frameworks/frameworks-capybara]
-
= frameworks-capybara
Gem to simplify the configuration of Capybara when using multiple drivers, also exposes other useful utility methods.
Although utilising Capybara's API to run tests is extremely simple the configuration and setup of the tool can be a little confusing, particularly if you want to avoid ending up with a spaghetti like env.rb file
@@ -25,30 +23,23 @@
require 'frameworks-capybara'
The following environment variables can be set to configure your tests:
- ENVIRONMENT - this must be one of either 'sandbox', 'sandbox6', 'int', 'test', 'stage', 'live'
+ ENVIRONMENT - this must be one of either 'sandbox', 'int', 'test', 'stage', 'live'
BROWSER - this must be one of either 'ie', 'firefox', 'chrome', 'headless', 'remote'
HTTP_PROXY - url of proxy if required e.g. 'http://proxyhost:80', when running a headless browser this sets the proxy for the browser itself, when running a remote browser this sets the proxy for the client which will connect to the remote selenium server
PLATFORM - used when specifying remote test on a grid that provides a choice of platforms, this must be one of either 'WINDOWS' or 'LINUX'
REMOTE_BROWSER - used when specifying remote test, must be one of either 'ie', 'firefox', 'chrome', 'headless', 'remote':w
REMOTE_BROWSER_VERSION - used when specifying remote test on a grid the provides a choice of browser versions for a given browser
REMOTE_URL - URL of remote Selenium-Webdriver server e.g. http://yourremotehost:4444/wd/hub
FIREFOX_PROFILE - specify a firefox profile to use when running in-browser tests (local or remote)
- FIREFOX_PREFS - specify a json string of additional preferences e.g. FIREFOX_PREFS='{"javascript.enabled": false}'
- FIREFOX_CERT_PATH - specify optional directory containing Firefox profile certificate (.db) files
- FIREFOX_CERT_PREFIX - specify optional prefix for locating Firefox profile certificate files (e.g. <prefix>-<file>.db)
- CREATE_NEW_FF_PROFILE - create a new Firefox profile with name provided by FIREFOX_PROFILE
CELERITY_JS_ENABLED (string - 'true', 'false') - determines whether Celerity (HTMLUnit) attempts to execute javascript
XVFB - (string - 'true', 'false') - determines whether XVFB is used to run browser (i.e. headless Firefox on *nix platform)
FW_CERT_LOCATION - path to client certificate (combined pem)
CHROME_SWITCHES - pass in any allowed switches for the Selenium chrome driver (http://peter.sh/experiments/chromium-command-line-switches/) e.g. CHROME_SWITCHES="--user-agent=Mozilla/5.0 (PLAYSTATION 3; 3.55)"
- PROJECT_NAME - optional project name description which gets displayed in Cucumber html reports
- TEAM_NAME - optional team name description which gets displayed in Cucumber html reports
- BROWSER_CLI_ARGS - optional additional arguments to pass to local browser processes
Here is a sample cucumber.yml:
<%intenv='ENVIRONMENT=int'%>
<%testenv='ENVIRONMENT=test'%>
@@ -77,27 +68,17 @@
@base_url
@base_static_url
@base_open_url
-Finally this gem contains some useful monkey-patches to core libraries e.g. Capybara-Mechanize, Selenium-Webdriver and Cucumber.
+Finally this gem contains some useful monkey-patches to core libraries e.g. Capybara, Selenium-Webdriver and Cucumber.
== Release instructions
* Run tests - 'rake'
-* If you have not published with 'gem' before, run 'gem push' to enter your credentials (ignore failed publish error at the end)
* Bump version - manually update file in lib/version.rb
-* Update the CHANGES[https://github.com/bbc-frameworks/frameworks-capybara/blob/master/CHANGES] log (see file for convention).
-* Run 'bundle install --binstubs --path vendor' to pick up new version in Gemfile
-* Commit 'Gemfile.lock' changes
+* Run 'bundle install' to pick up new version in Gemfile
* Release - 'rake release'
-
-You should see something like:
-
- frameworks-capybara 0.2.23 built to pkg/frameworks-capybara-0.2.23.gem
- Tagged v0.2.23
- Pushed git commits and tags
- Pushed frameworks-capybara 0.2.23 to rubygems.org
== Contributing to frameworks-capybara
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it