auxesis-cucumber-nagios 0.3.1 → 0.3.4

data/README.md

@@ -13,6 +13,18 @@ As Bradley Taylor [put it](http://bradley.is/post/82649218/testing-dash-metrics-
     agile developer instantly.”
 
 
+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
+
+
 Setting up a project
 ====================
 
@@ -26,12 +38,41 @@ Check the `README` within this directory for specific instructions for managing
 the project. 
 
 
-Writing Features
+Freezing 
+========
+
+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.
+
+To freeze your project, within your project directory run:
+
+    $ rake deps
+
+Redeploying
+===========
+
+Once you've copied your project around, Just run the freezer again: 
+
+    $ rake deps
+
+Writing features
 ================
 
-Within your project, I suggest you put your features under under `features/$fqdn/$name.feature`.
+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 
+feature you're testing: 
+
+    bin/cucumber-nagios-gen feature gnome.org navigation
+
+This will spit out two files: 
+
+    features/gnome.org/navigation.feature
+    features/gnome.org/steps/navigation_steps.rb
 
-You'll want to have a read of the Cucumber documentation, however 
+
+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
@@ -77,6 +118,7 @@ writing your tests:
                  --require features/ 
                  features/smh/smh.feature
 
+This will output using the default 'pretty' formatter. 
 
 Running
 =======
@@ -100,8 +142,11 @@ The value printed at the end is in Nagios's Performance Data format, so it
 can be graphed and the like.
 
 
-Caveats
-=======
+Quirks & Caveats
+================
+
+Multiple scenarios
+------------------
 
 You may want to think about keeping to one scenario to a file, otherwise 
 you'll get multiple lines of output for a test:
@@ -112,5 +157,33 @@ you'll get multiple lines of output for a test:
 That said, Nagios should only read the last line, so this might be an ok 
 behaviour when you want to test for an aggregate of failures across a site.
 
+Failure *is* an option (exceptions are good)
+--------------------------------------------
+
+Exceptions raised within your tests will appear in the failed totals, so you 
+don't need to worry about trying to catch them in your own custom steps. 
+
+i.e. if you try fetching a page on a server that is down, or the page returns 
+a 404, the exception raised by Mechanize just gets treated by Cucumber as a 
+test failure. 
+
+
+Version control
+===============
+
+I highly recommend storing your cucumber-nagios projects in a version control
+system!
+
+To get up and running with git: 
+
+    $ git init
+    $ git add .
+    $ git commit -m 'created cucumber-nagios project'
+
+To get up and running with bzr:
 
+    $ bzr init
+    $ bzr add
+    $ bzr commit -m 'created cucumber-nagios project'
 
+.bzrignore and .gitignores are created when you generate a project.

data/lib/generators/project/README

@@ -23,12 +23,21 @@ Just run the freezer again:
 
  $ rake deps
 
+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 
+feature you're testing: 
+
+  bin/cucumber-nagios-gen feature gnome.org navigation
+
 
 Version control
 ===============
 
 I highly recommend storing your cucumber-nagios features in a version control
-system. 
+system!
 
 To get up and running with git: 
 

data/lib/generators/project/Rakefile

@@ -24,6 +24,8 @@ task :deps do
           'mechanize' => ">= 0.9.1", 
           'rspec' => ">= 1.1.12"}
 
+  puts "\ninstalling dependencies. this will take a few minutes."
+
   deps.each_pair do |dep, version|
     puts "\ninstalling #{dep} (#{version})"
     system("gem install #{dep} --version '#{version}' -i gems --no-rdoc --no-ri")

data/lib/generators/project/features/steps/result_steps.rb

@@ -11,9 +11,9 @@ Then /^I should see an? (\w+) message$/ do |message_type|
 end
 
 Then /^the (.*) ?request should succeed/ do |_|
-  response.should be_successful
+  success_code?.should be_true
 end
 
 Then /^the (.*) ?request should fail/ do |_|
-  response.should_not be_successful
+  success_code?.should be_false
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: auxesis-cucumber-nagios
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.4
 platform: ruby
 authors: 
 - Lindsay Holmwood
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-05 00:00:00 -08:00
+date: 2009-03-06 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency