rainforest

Rainforest CLI NodeJS

npm install rainforest
10 downloads in the last week
10 downloads in the last month

rainforest Build Status Code Climate

A command line interface to interact with RainforestQA.

Installation

$ npm install -g rainforest

Make sure you install it globally so that the rainforest command is accessible from anywhere on your system

Examples

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 tests with test ids 123, 345

rainforest run --tests 123,345 --token YOUR_TOKEN_HERE 

Run all tests with tags tag1, tag2, tag3

rainforest run --tags tag1,tag2,tag3 --token YOUR_TOKEN_HERE 

Run all tests with tag tag1 and on browsers chrome and safari

rainforest run --tags tag1 --browsers chrome,safari --token YOUR_TOKEN_HERE 

Run all tests with tag tag1 and also specify a webhook where Rainforest can POST a notification back

rainforest run --tags tag1 --webhook http://your-url.com/callback --token YOUR_TOKEN_HERE 

Run all tests with tag tag1 and abort any previous runs for this test suite

rainforest run --tags tag1 --conflict abort --token YOUR_TOKEN_HERE 

Documentation

  Usage: rainforest run [options]

  Options:

    -h, --help                 output usage information
    -a, --all                  Run All Tests
    -t, --tags <tags>          Specify test tags you want to use
    -b, --browsers <browsers>  Specify which browsers you want to test against
    -x, --tests <tests>        Specify comma seperated test IDs to execute
    -w, --webhook <url>        Specify if you would like to use a webhook URL
    -c, --conflict <conflict>  Specify if you would like to abort previously running tests
    --token <api_token>        Assign your API token for this command

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

You get extra attention, if your PR includes specs/tests.

  1. Fork or clone the project.
  2. Create your feature branch ($ git checkout -b my-new-feature)
  3. Install the dependencies by doing: $ npm install in the project directory.
  4. Run the specs runner/project watcher by doing $ grunt
    • Now, any time you change files, specs will run. Sort of like Guard for Ruby projects.
  5. Add your bug fixes or new feature code.
    • New features should include new specs/tests.
    • Bug fixes should ideally include exposing specs/tests.
  6. Commit your changes ($ git commit -am 'Add some feature')
  7. Push to the branch ($ git push origin my-new-feature)
  8. Open your Pull Request!

License

Copyright (c) 2013 Jasdeep Singh
Licensed under the MIT license.

npm loves you