Rainforest-cli

A command line interface to interact with RainforestQA.

Installation

$ gem install rainforest-cli

Basic Usage

To use the cli client, you'll need your API token from a test settings page from inside Rainforest.

Run all of your tests

rainforest run all --token YOUR_TOKEN_HERE

Run all in the foreground and report

rainforest run all --fg --token YOUR_TOKEN_HERE

Run all tests with tag 'run-me' and abort previous in-progress runs.

rainforest run --tag run-me --fg --conflict abort --token YOUR_TOKEN_HERE 

Options

Required:

• --token <your-rainforest-token> - you must supply your token (get it from any tests API tab)

The options are:

• --browsers ie8 or --browsers ie8,chrome - specficy the browsers you wish to run against. This overrides the test own settings. Valid browsers are ie8, ie9, chrome, firefox and safari.
• --tag run-me - only run tests which have this tag (recommended if you have lots of test-steps)!)
• --conflict abort - if you trigger rainforest more than once, anything running will be aborted and a fresh run started
• --fail-fast - fail the build as soon as the first failed result comes in. If you don't pass this it will wait until 100% of the run is done
• --fg - results in the foreground - this is what you want to make the build pass / fail dependent on rainforest results
• --site-id - only run tests for a specific site. Get in touch with us for help on getting that you site id if you are unable to.
• --custom-url - use a custom url for this run. Example use case: an ad-hoc QA environment with Fourchette. You will need to specify a site_id too for this to work. Please note that we will be creating environments under the hood and will not affect your test permanently.
• --git-trigger - only trigger a run when the last commit (for a git repo in the current working directory) has contains @rainforest and a list of one or more tags. E.g. "Fix checkout process. @rainforest #checkout" would trigger a run for everything tagged checkout. This over-rides --tag and any tests specified. If no @rainforest is detected it will exit 0.

Contributing

1. Fork it
2. Make sure you init the submodules (git submodule init && git submodule update)
3. Create your feature branch (git checkout -b my-new-feature)
4. Commit your changes (git commit -am 'Add some feature')
5. Push to the branch (git push origin my-new-feature)
6. Create new Pull Request