auxesis-cucumber-nagios 0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Lindsay Holmwood
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,106 @@
+Dependencies
+============
+
+ - ruby1.8
+ - rake
+ - rubygems
+
+
+Setting up
+==========
+
+To install dependencies, run:
+
+    rake deps
+
+
+Writing Features
+================
+
+I suggest you put your features under under features/$fqdn/$name.feature.
+
+You'll want to have a read of the Cucumber documentation, 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
+    
+      Scenario: Searching for things
+        Given I visit "http://www.google.com"
+        When I fill in "q" with "wikipedia"
+        And I press "Google Search"
+        Then I should see "www.wikipedia.org"
+
+There's a collection of steps that will cover most of the things you'll be 
+testing for in features/steps/webrat_steps.rb. 
+
+You can write custom steps for testing specific output and behaviour, e.g.
+in features/smh.com.au/smh.feature: 
+
+    Feature: smh.com.au
+      It should be up
+      And provide links to content
+    
+      Scenario: Visiting home page
+        When I go to http://smh.com.au/
+        Then I should see site navigation
+        And there should be a section named "Opinion"
+
+There aren't steps for "Then I should see site navigation", so you have to 
+write one yourself. :-) In features/smh.com.au/steps/smh_steps.rb: 
+
+    Then /^I should see site navigation$/ do                                                                    
+      doc = Nokogiri::HTML(response.body.to_s)                                                                  
+      doc.css("ul#nav li a").size.should > 5                                                                    
+    end
+
+You can use Nokogiri for testing responses with XPath matchers and CSS 
+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
+
+
+Running
+=======
+
+Invoke the cucumber feature with the cucumber-nagios script: 
+
+    bin/cucumber-nagios features/myblog.feature
+
+cucumber-nagios can be run from anywhere: 
+
+    /path/to/bin/cucumber-nagios /path/to/features/smh/smh.feature
+
+It should return a standard Nagios-formatted response string: 
+
+    Critical: 0, Warning: 0, 2 okay | value=2.000000;;;;
+
+Steps that fail will show up in the "Critical" total, and steps that pass 
+show up in the "okay" total. 
+
+The value printed at the end is a total of the steps completed minus the 
+failing steps: 
+
+    Critical: 1, Warning: 0, 2 okay | value=2.000000;;;;
+
+
+Caveats
+=======
+
+You may want to think about keeping to one scenario to a file, otherwise 
+you'll get multiple lines of output for a test:
+
+    Critical: 1, Warning: 0, 2 okay | value=2.000000;;;;
+    Critical: 1, Warning: 0, 4 okay | value=4.000000;;;;
+
+I assume Nagios will 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.
+
+
+

data/Rakefile

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby 
+
+require 'rubygems'
+require 'bin/common'
+Gem.clear_paths
+Gem.path.unshift(File.join(File.dirname(__FILE__), 'gems'))
+
+begin 
+  require 'cucumber/rake/task'
+   
+  Cucumber::Rake::Task.new do |t|
+    t.binary = "bin/cucumber"
+    t.cucumber_opts = "--require bin/common.rb --format Nagios::NagiosFormatter"
+  end
+rescue LoadError
+end
+
+
+desc "freeze deps"
+task :deps do 
+  deps = ['cucumber', 'webrat', 'mechanize']
+  deps.each do |dep|
+    puts "installing #{dep}"
+    system("gem install #{dep} -i gems --no-rdoc --no-ri")
+  end
+end

data/bin/common.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby 
+
+require 'rubygems'
+
+Gem.clear_paths
+Gem.path << File.expand_path(File.join(File.dirname(__FILE__), '..', 'gems'))
+

data/bin/cucumber

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# Add '.rb' to work around a bug in IronRuby's File#dirname
+$:.unshift(File.dirname(__FILE__ + '.rb') + '/../lib') unless $:.include?(File.dirname(__FILE__ + '.rb') + '/../lib')
+
+begin 
+  require 'common'
+rescue LoadError
+  require 'bin/common'
+end
+
+require 'cucumber/cli'
+Cucumber::CLI.execute(ARGV)

data/bin/cucumber-nagios

@@ -0,0 +1,26 @@
+#!/bin/sh
+
+if [ "$#" != "1" ]; then
+	echo "Usage: $0 <feature>"
+	exit 99
+fi
+
+dirname=$(dirname $0)
+feature=$1
+
+if [ ! -e "$feature" ]; then
+	echo "Error: feature file doesn't exist!"
+	exit 98
+fi
+
+$dirname/cucumber --require $dirname/common.rb \
+				 					--require features/ \
+				 					--format Nagios::NagiosFormatter \
+				 					$feature
+retval=$?
+
+if [ "$retval" -eq "1" ]; then
+	exit 2
+else
+	exit $retval
+fi

data/bin/cucumber-nagios-gen

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'templater'
+
+module CucumberNagiosGenerators
+
+  extend Templater::Manifold
+
+  class ProjectGenerator < Templater::Generator
+    def self.source_root
+      File.join(File.dirname(__FILE__), '..', 'lib', 'generators', 'project')
+    end
+
+    def destination_root
+      # takes :name from first_argument
+      File.join(@destination_root, name)
+    end
+
+    desc "Generate a new self-contained cucumber-nagios project."
+    first_argument :name, :required => true, :desc => "Project name"
+
+    file '.gitignore', '.gitignore'
+    file '.bzrignore', '.bzrignore'
+    glob!
+
+  end
+
+  desc "Generate a cucumber-nagios project."
+  add :project, ProjectGenerator
+
+end
+
+
+CucumberNagiosGenerators.run_cli Dir.pwd, 'cucumber-nagios-gen', '0.1', ARGV

data/cucumber-nagios.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name = 'cucumber-nagios'
+  s.version = '0.2'
+  s.date = '2009-03-04'
+  
+  s.summary = "web app testing plugin for Nagios using Cucumber/Webrat/Mechanize"
+  s.description = "cucumber-nagios lets you write high-level behavioural tests for your web applications that can be plugged into Nagios"
+  
+  s.authors = ['Lindsay Holmwood']
+  s.email = 'lindsay@holmwood.id.au'
+  s.homepage = 'http://holmwood.id.au/~lindsay/2009/02/23/web-app-integration-testing-for-sysadmins-with-cucumber-nagios/'
+  s.has_rdoc = false
+
+  s.add_dependency('templater', '>= 0.5')
+  
+  s.files = %w(bin/common.rb bin/cucumber bin/cucumber-nagios bin/cucumber-nagios-gen cucumber-nagios.gemspec lib/generators/project/Rakefile lib/generators/project/features lib/generators/project/features/steps lib/generators/project/features/steps/result_steps.rb lib/generators/project/features/steps/webrat_steps.rb lib/generators/project/features/support lib/generators/project/features/support/env.rb lib/generators/project/features/support/nagios.rb lib/generators/project/bin lib/generators/project/bin/common.rb lib/generators/project/bin/cucumber lib/generators/project/bin/cucumber-nagios lib/generators/project/bin/cucumber-nagios-gen lib/generators/project/.bzrignore lib/generators/project/.gitignore lib/generators/project/README LICENSE README.md Rakefile)
+end
+
+

data/lib/generators/project/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+*~
+.#*
+.bzr
+.bzrignore
+gems/specifications/*
+gems/gems/*
+gems/bin/*

data/lib/generators/project/README

@@ -0,0 +1,45 @@
+THINGS YOU SHOULD DO
+====================
+
+ 1. freeze your project
+ 2. version control your project
+
+
+Freezing
+========
+
+Freezing your dependencies 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, run:
+
+ $ rake deps
+
+
+Redeploying
+===========
+
+Just run the freezer again: 
+
+ $ rake deps
+
+
+Version control
+===============
+
+I highly recommend storing your cucumber-nagios features 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 your project.

data/lib/generators/project/Rakefile

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby 
+
+require 'rubygems'
+require 'bin/common'
+Gem.clear_paths
+Gem.path.unshift(File.join(File.dirname(__FILE__), 'gems'))
+
+begin 
+  require 'cucumber/rake/task'
+   
+  Cucumber::Rake::Task.new do |t|
+    t.binary = "bin/cucumber"
+    t.cucumber_opts = "--require bin/common.rb --format Nagios::NagiosFormatter"
+  end
+rescue LoadError
+end
+
+
+desc "freeze deps"
+task :deps do 
+  deps = ['cucumber', 'webrat', 'mechanize']
+  deps.each do |dep|
+    puts "installing #{dep}"
+    system("gem install #{dep} -i gems --no-rdoc --no-ri")
+  end
+end

data/lib/generators/project/bin/common.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby 
+
+require 'rubygems'
+
+Gem.clear_paths
+Gem.path << File.expand_path(File.join(File.dirname(__FILE__), '..', 'gems'))
+

data/lib/generators/project/bin/cucumber

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# Add '.rb' to work around a bug in IronRuby's File#dirname
+$:.unshift(File.dirname(__FILE__ + '.rb') + '/../lib') unless $:.include?(File.dirname(__FILE__ + '.rb') + '/../lib')
+
+begin 
+  require 'common'
+rescue LoadError
+  require 'bin/common'
+end
+
+require 'cucumber/cli'
+Cucumber::CLI.execute(ARGV)

data/lib/generators/project/bin/cucumber-nagios

@@ -0,0 +1,26 @@
+#!/bin/sh
+
+if [ "$#" != "1" ]; then
+	echo "Usage: $0 <feature>"
+	exit 99
+fi
+
+dirname=$(dirname $0)
+feature=$1
+
+if [ ! -e "$feature" ]; then
+	echo "Error: feature file doesn't exist!"
+	exit 98
+fi
+
+$dirname/cucumber --require $dirname/common.rb \
+				 					--require features/ \
+				 					--format Nagios::NagiosFormatter \
+				 					$feature
+retval=$?
+
+if [ "$retval" -eq "1" ]; then
+	exit 2
+else
+	exit $retval
+fi

data/lib/generators/project/bin/cucumber-nagios-gen

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'templater'
+
+module CucumberNagiosGenerators
+
+  extend Templater::Manifold
+
+  class ProjectGenerator < Templater::Generator
+    def self.source_root
+      File.join(File.dirname(__FILE__), '..', 'lib', 'generators', 'project')
+    end
+
+    def destination_root
+      # takes :name from first_argument
+      File.join(@destination_root, name)
+    end
+
+    desc "Generate a new self-contained cucumber-nagios project."
+    first_argument :name, :required => true, :desc => "Project name"
+
+    glob!
+    #file :rakefile, 'Rakefile'
+
+  end
+
+  desc "Generate a cucumber-nagios project."
+  add :project, ProjectGenerator
+
+end
+
+
+CucumberNagiosGenerators.run_cli Dir.pwd, 'cucumber-nagios-gen', '0.1', ARGV

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

@@ -0,0 +1,15 @@
+Then /^I should see "(.*)"$/ do |text|
+  response.body.to_s.should =~ /#{text}/m
+end
+
+Then /^I should not see "(.*)"$/ do |text|
+  response.body.to_s.should_not =~ /#{text}/m
+end
+
+Then /^I should see an? (\w+) message$/ do |message_type|
+  response.should have_xpath("//*[@class='#{message_type}']")
+end
+
+Then /^the (.*) ?request should fail/ do |_|
+  response.should_not be_successful
+end

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

@@ -0,0 +1,36 @@
+When /^I go to (.*)$/ do |path|
+  visit path
+end
+
+When /^I press "(.*)"$/ do |button|
+  click_button(button)
+end
+
+When /^I follow "(.*)"$/ do |link|
+  click_link(link)
+end
+
+When /^I fill in "(.*)" with "(.*)"$/ do |field, value|
+  fill_in(field, :with => value) 
+end
+
+When /^I select "(.*)" from "(.*)"$/ do |value, field|
+  select(value, :from => field) 
+end
+
+When /^I check "(.*)"$/ do |field|
+  check(field) 
+end
+
+When /^I uncheck "(.*)"$/ do |field|
+  uncheck(field) 
+end
+
+When /^I choose "(.*)"$/ do |field|
+  choose(field)
+end
+
+When /^I attach the file at "(.*)" to "(.*)" $/ do |path, field|
+  attach_file(field, path)
+end
+

data/lib/generators/project/features/support/env.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby 
+
+require 'rubygems'                                                                                      
+require 'webrat'
+require 'webrat/mechanize'
+
+class MechanizeWorld < Webrat::MechanizeSession
+  require 'spec'
+  include Spec::Matchers
+end
+
+World do
+  MechanizeWorld.new
+end
+
+def response
+  webrat_session.response
+end
+
+

data/lib/generators/project/features/support/nagios.rb

@@ -0,0 +1,32 @@
+# features/support/nagios.rb
+require 'rubygems'
+
+module Nagios
+  class NagiosFormatter
+    def initialize(io, step_mother, options={})
+      @failed = []
+      @passed = []
+    end
+
+    def step_passed(step, name, params)
+      @passed << step
+    end
+
+    def step_failed(step, name, params)
+      @failed << step
+    end
+
+    def scenario_executed(scenario)
+      @total = @failed.size + @passed.size
+      message = ""
+      message += "Critical: #{@failed.size}, "
+      message += "Warning: 0, "
+      message += "#{@passed.size} okay"
+      # nagios performance data
+      message += " | passed=#{@passed.size}"
+      message += ", failed=#{@failed.size}, total=#{@total}"
+      puts message
+    end
+  end
+end
+

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: auxesis-cucumber-nagios
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- Lindsay Holmwood
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-04 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: templater
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.5"
+    version: 
+description: cucumber-nagios lets you write high-level behavioural tests for your web applications that can be plugged into Nagios
+email: lindsay@holmwood.id.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/common.rb
+- bin/cucumber
+- bin/cucumber-nagios
+- bin/cucumber-nagios-gen
+- cucumber-nagios.gemspec
+- lib/generators/project/Rakefile
+- lib/generators/project/features
+- lib/generators/project/features/steps
+- lib/generators/project/features/steps/result_steps.rb
+- lib/generators/project/features/steps/webrat_steps.rb
+- lib/generators/project/features/support
+- lib/generators/project/features/support/env.rb
+- lib/generators/project/features/support/nagios.rb
+- lib/generators/project/bin
+- lib/generators/project/bin/common.rb
+- lib/generators/project/bin/cucumber
+- lib/generators/project/bin/cucumber-nagios
+- lib/generators/project/bin/cucumber-nagios-gen
+- lib/generators/project/.bzrignore
+- lib/generators/project/.gitignore
+- lib/generators/project/README
+- LICENSE
+- README.md
+- Rakefile
+has_rdoc: false
+homepage: http://holmwood.id.au/~lindsay/2009/02/23/web-app-integration-testing-for-sysadmins-with-cucumber-nagios/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: web app testing plugin for Nagios using Cucumber/Webrat/Mechanize
+test_files: []
+