README.md in cucumber-nagios-0.5.0 vs README.md in cucumber-nagios-0.5.1

- old
+ new

@@ -14,17 +14,18 @@ Quickstart ========== - 0. `gem sources -a http://gems.github.com` - 1. `gem install auxesis-cucumber-nagios` - 2. `cucumber-nagios-gen project bunch-o-tests` - 3. `cd bunch-o-tests` - 4. `rake deps` - 5. `bin/cucumber-nagios-gen feature ebay.com.au bidding` - 6. `bin/cucumber-nagios features/ebay.com.au/bidding.feature` + 0. `gem install gemcutter` + 1. `gem tumble` + 2. `gem install cucumber-nagios` + 3. `cucumber-nagios-gen project bunch-o-tests` + 4. `cd bunch-o-tests` + 5. `gem bundle` + 6. `bin/cucumber-nagios-gen feature ebay.com.au bidding` + 7. `bin/cucumber-nagios features/ebay.com.au/bidding.feature` Setting up a project ==================== @@ -36,31 +37,42 @@ Check the `README` within this directory for specific instructions for managing the project. -Freezing -======== +Bundling dependencies +===================== -** This is really manky at the moment. cucumber-nagios will be switching to -wycats' bundler at the next major release! ** +Bundling cucumber-nagios's dependencies allows you to drop your cucumber-nagios +project to any machine and have it run. This can be useful if you want to +develop your tests on one machine, and deploy them to another (like a production +Nagios server). -Freezing your dependencies into your project allows you to drop your -`cucumber-nagios` project to any machine and have it run. Its only requirement is -Ruby and Rake. +You'll need to bundle your dependencies to use cucumber-nagios. -To freeze your project, within your project directory run: +First you need to make sure the following dependencies are installed: - $ rake deps + - RubyGems + - bundler gem (automatically pulled in by the cucumber-nagios gem) -Redeploying -=========== +To bundle your dependencies, within your project directory run: -Once you've copied your project around, Just run the freezer again: + $ gem bundle - $ rake deps +Deploying to production +======================= + +Once you've copied your project around, just run the bundler again: + + $ gem bundle + +You'll need to have RubyGems and the bundler gem installed on the system +you're deploying too. I know, this is not optimal, but hopefully the bundler +gem will handle this better in the future. + + Writing features ================ Once you've set up a project, you can use the `bin/cucumber-nagios-gen` command to generate new features. It takes two arguments: the site you're testing, and @@ -77,12 +89,13 @@ As for writing features, you'll want to have a read of the [Cucumber documentation](http://wiki.github.com/aslakhellesoy/cucumber), however your tests will look something like this: Feature: google.com.au - It should be up - And I should be able to search for things + To broaden their knowledge + A user should be able + To search for things Scenario: Searching for things Given I visit "http://www.google.com" When I fill in "q" with "wikipedia" And I press "Google Search" @@ -115,13 +128,11 @@ selectors. I suggest you use `bin/cucumber` directly so you can get better feedback when writing your tests: - bin/cucumber --require bin/common.rb \ - --require features/ - features/smh/smh.feature + bin/cucumber --require features/ features/smh/smh.feature This will output using the default 'pretty' formatter. Running ======= @@ -220,5 +231,7 @@ $ bzr init $ bzr add $ bzr commit -m 'created cucumber-nagios project' `.bzrignore` and `.gitignores` are created when you generate a project. + +