nagiosplugin 0.0.7 → 1.0.0

data/.gitignore

@@ -3,3 +3,4 @@
 Gemfile.lock
 pkg/*
 tmp/*
+vendor/*

data/README.md

@@ -1,6 +1,6 @@
 # NagiosPlugin
 
-NagiosPlugin is a simple framework for writing [Nagios](http://www.nagios.org/) Plugins.
+A simple framework for writing [Nagios](http://www.nagios.org/) Plugins.
 
 ## Installation
 
@@ -8,42 +8,35 @@ NagiosPlugin is a simple framework for writing [Nagios](http://www.nagios.org/)
 
 ## Usage
 
-Create your executable plugin (which will be called by nagios), `require "nagiosplugin"` and subclass from `NagiosPlugin::Plugin`.
-You must define the methods `critical?` and `warning?` which determine the plugin status during a check based on their boolean return value (`ok?` returns true by default but can be overwritten).
+Create your executable file (which will be called by nagios), `require
+'nagiosplugin'` and subclass from `NagiosPlugin::Plugin`.
 
-The optional method `measure` will be called *first* on every check to take samples.
-Additional plugin output after the service name and status can be printed by defining `output` with some fancy content.
-
-Run `check!` on your *class* to ensure a proper plugin output (= stdout & exit status).
+Then define a check method in your class which figures out the status
+for what you want to check and calls the corresponding status method
+(`ok`, `warning`, `critical` or `unknown`) to display a status message
+and exit imediately.
 
 Here's a simple example plugin named `check_u2d`:
 
-````Ruby
+```Ruby
 #!/usr/bin/env ruby
 require 'nagiosplugin'
 
 class UnicornToDwarfRatio < NagiosPlugin::Plugin
-	def measure
-		@unicorns, @dwarves = ... # The algorithm is your homework.
-	end
-	
-	def critical?
-		@unicorns < @dwarves
-	end
-	
-	def warning?
-		@unicorns == @dwarves
-	end
-	
-	def output
-		"#{unicorns.to_f/@dwarves.to_f} unicorns/dwarves"
-	end
+	def check
+    unicorn_to_dwarf_ratio = ... # We still need an alogrithm for this.
+    msg = "#{unicorn_to_dwarf_ratio} unicorns/dwarves"
+
+    critical(msg) if unicorn_to_dwarf_ratio < 0.0
+    warning(msg) if unicorn_to_dwarf_ratio == 0.0
+    ok(msg)
+  end
 end
 
-UnicornToDwarfRatio.check!
+UnicornToDwarfRatio.run
 ```
 
-Please also take a look at features to see what's going on...
+Take a look below `features` to see what's going on...
 
 ## Note on Patches/Pull Requests
 
@@ -56,4 +49,4 @@ Please also take a look at features to see what's going on...
 
 ## Copyright
 
-Copyright (c) 2011 Björn Albers. See LICENSE for details.
+Copyright (c) 2011-2012 Björn Albers. See LICENSE for details.

data/Rakefile

@@ -1,14 +1,14 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
-require "cucumber/rake/task"
+require 'cucumber/rake/task'
 Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = "--format pretty"
+  t.cucumber_opts = '--format pretty'
 end
 
-require "rspec/core/rake_task"
+require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new do |t|
   t.rspec_opts = %w[--color]
-  t.pattern = "./spec/**/*_spec.rb"
+  t.pattern = './spec/**/*_spec.rb'
 end
 
 task :default => :features

data/features/plugin_output.feature

@@ -1,46 +1,50 @@
 Feature: Plugin Output
 
-	In order to comply with official nagios plugin development guidelines
-	As a sysadmin building my own nagios plugins
-	I want to return a nagios compatible plugin output
-
-	Scenario Outline: CRITICAL, WARNING and OK
-		When I run a plugin with the following methods:
-			"""
-	    def critical?;	<crit>	end
-	    def warning?;		<warn>	end
-			"""
-		Then the exit status should be <code>
-		And the plugin should print "<status>"
-		
-		Examples:
-		 | crit  | warn  | code | status   |
-		 | true  | true  | 2    | CRITICAL |
-		 | true  | false | 2    | CRITICAL |
-		 | false | true  | 1    | WARNING  |
-		 | false | false | 0    | OK       |
-
-	Scenario Outline: UNKNOWN when all status checks return false
-		When I run a plugin with the following methods:
-			"""
-  		def critical?;	false		end
-  		def warning?;		false		end
-			def ok?;				<ok>		end
-			"""
-		Then the exit status should be <code>
-		And the plugin should print "<status>"
-		
-		Examples:
-		 | ok    | code | status                                     |
-		 | true  | 0    | OK                                         |
-		 | false | 3    | UNKNOWN: All status checks returned false! |
-
-	Scenario: UNKNOWN when an exception was raised
-		When I run a plugin with the following methods:
-			"""
-			def critical?
-				raise "OOPS!"
-			end
-			"""
-		Then the exit status should be 3
-		And the plugin should print "UNKNOWN: OOPS!"
+  In order to comply with official nagios plugin development guidelines
+  As a sysadmin building my own nagios plugins
+  I want to return a nagios compatible plugin output
+
+  Scenario Outline: UNKNOWN, CRITICAL, WARNING and OK
+    Given a file named "check_foo.rb" with:
+      """
+      require 'nagiosplugin'
+
+      class Foo < NagiosPlugin::Plugin
+        def check
+          case ARGV.first
+            when 'UNKNOWN'  then unknown  'no clue, sorry'
+            when 'CRITICAL' then critical 'booooom!'
+            when 'WARNING'  then warning  'it could be worse'
+            when 'OK'       then ok       'all is fine'
+          end
+        end
+      end
+
+      Foo.run
+      """
+    When I run `ruby check_foo.rb <status>`
+    Then the exit status should be <code>
+    And the stdout should contain "<status>"
+
+    Examples:
+     | status   | code |
+     | UNKNOWN  | 3    |
+     | CRITICAL | 2    |
+     | WARNING  | 1    |
+     | OK       | 0    |
+
+  Scenario: UNKNOWN when no status method was called
+    Given a file named "check_foo" with:
+      """
+      require 'nagiosplugin'
+
+      class Foo < NagiosPlugin::Plugin
+        def check
+        end
+      end
+
+      Foo.run
+      """
+    When I run `ruby check_foo`
+    Then the exit status should be 3
+    And the stdout should contain "UNKNOWN"

data/features/steps/dev_steps.rb

@@ -6,7 +6,7 @@ When /^I run a plugin with the following methods:$/ do |methods|
 			class Foo < NagiosPlugin::Plugin
         #{methods}
   		end
-			Foo.check!
+			Foo.new.run
 			"""
 		When I run `ruby check_foo`
   }

data/features/support/env.rb

@@ -1 +1 @@
-require "aruba/cucumber"
+require 'aruba/cucumber'

data/lib/nagiosplugin.rb

@@ -1,2 +1,2 @@
-require "nagiosplugin/version"
-require "nagiosplugin/plugin"
+require 'nagiosplugin/version'
+require 'nagiosplugin/plugin'

data/lib/nagiosplugin/plugin.rb

@@ -1,61 +1,67 @@
 module NagiosPlugin
-  EXIT_CODES = {
-    :ok       => 0,
-    :warning  => 1,
-    :critical => 2,
-    :unknown  => 3,
-  }
-  
-  PluginError = Class.new(StandardError)
-  
   class Plugin
-    def self.check!
-      plugin = self.new
-      plugin.check
-    rescue Exception => e
-      puts [plugin.prefix, e.to_s].join(' ')
-    else
-      puts plugin.message
-    ensure
-      exit plugin.code
+    # All allowed statuses sorted by their corresponding exit status.
+    STATUS = [:ok, :warning, :critical, :unknown]
+
+    # A custom status error which will be raised through the status methods.
+    class StatusError < StandardError
+      # @param [Symbol] status the status (must be {NagiosPlugin::Plugin::STATUS a valid status})
+      # @param [String] message the message you want to display
+      def initialize(status, message)
+        @status, @message = status.to_sym, message
+      end
+
+      # @return [Symbol] the status
+      def status
+        (STATUS.include?(@status) && @status) || STATUS.last
+      end
+
+      # @return [String] the status and message
+      def to_s
+        "#{status.to_s.upcase}: #{@message}"
+      end
+
+      # @return [Fixnum] the status converted into an exit code
+      def to_i
+        STATUS.find_index(status)
+      end
     end
-    
-    def check
-      measure if respond_to?(:measure)
-      set_status
-    rescue Exception
-      @status = :unknown
-      raise
+
+    class << self
+      # Create new instance and run it.
+      def run(*args)
+        self.new(*args).run
+      end
     end
-    
-    def message
-      [prefix, (output if respond_to?(:output))].compact.join(' ')
-    end
-    
-    def prefix
-      "#{self.class.name.upcase} #{status.to_s.upcase}:"
-    end
-    
-    def code
-      EXIT_CODES[status]
-    end
-    
-    def status
-      @status || :unknown
-    end
-    
-    alias_method :to_s, :message
-    alias_method :to_i, :code
-  
-  protected
-  
-    def set_status
-      @status = [:critical, :warning, :ok].select { |s| send("#{s}?") }.first
-      raise PluginError, "All status checks returned false!" if @status.nil?
-    end
-    
-    def ok?
-      true
+
+    # The methods for each status.
+    #
+    # They should be called in your check method and will raise an appropriate
+    # StatusError.
+    #
+    # @param [String] message
+    STATUS.each do |status|
+      define_method(status) do |message|
+        raise StatusError.new(status, message)
+      end
     end
+
+   # Run check and return result in a nagios-compatible format.
+   #
+   # It will...
+   # - execute your check method
+   # - output the result in a nagios-compatible format (SERVICE STATUS: Message)
+   # - exit according to the status
+   def run
+     check
+   rescue StatusError => e
+   rescue => e
+     e = StatusError.new(:unknown, ([e.to_s, nil] + e.backtrace).join("\n"))
+   else
+     e = StatusError.new(:unknown, 'no status method was called')
+   ensure
+     puts [self.class.name.upcase, e.to_s].join(' ')
+     exit e.to_i
+   end
   end
 end

data/lib/nagiosplugin/version.rb

@@ -1,3 +1,3 @@
 module NagiosPlugin
-  VERSION = "0.0.7"
+  VERSION = '1.0.0'
 end

data/nagiosplugin.gemspec

@@ -1,25 +1,25 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "nagiosplugin/version"
+$:.push File.expand_path('../lib', __FILE__)
+require 'nagiosplugin/version'
 
 Gem::Specification.new do |s|
-  s.name        = "nagiosplugin"
+  s.name        = 'nagiosplugin'
   s.version     = NagiosPlugin::VERSION
-  s.authors     = ["Björn Albers"]
-  s.email       = ["bjoernalbers@googlemail.com"]
-  s.homepage    = "https://github.com/bjoernalbers/nagiosplugin"
+  s.authors     = ['Björn Albers']
+  s.email       = ['bjoernalbers@googlemail.com']
+  s.homepage    = 'https://github.com/bjoernalbers/nagiosplugin'
   s.summary     = "#{s.name}-#{s.version}"
-  s.description = "Yet another framework for writing Nagios Plugins"
+  s.description = 'A simple framework for writing Nagios Plugins'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 
-  s.add_development_dependency "rake"
-  s.add_development_dependency "cucumber"
-  s.add_development_dependency "aruba"
-  s.add_development_dependency "guard-cucumber"
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'cucumber'
+  s.add_development_dependency 'aruba'
+  s.add_development_dependency 'guard-cucumber'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'guard-rspec'
 end

data/spec/nagiosplugin/plugin_spec.rb

@@ -1,68 +1,120 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe NagiosPlugin::Plugin do
-  before :each do
-    @plugin = NagiosPlugin::Plugin.new
+  before do
+    class MyPlugin < NagiosPlugin::Plugin; end
+    @plugin = MyPlugin.new
   end
-  
-  it "should be unknown when not checked yet" do
-    @plugin.status.should eql(:unknown)
-  end
-  
-  [
-    {:critical? => false, :warning? => false, :status => :ok      },
-    {:critical? => false, :warning? => true,  :status => :warning },
-    {:critical? => true,  :warning? => false, :status => :critical},
-    {:critical? => true,  :warning? => true,  :status => :critical}
-  ].each do |result|
-    it "should be #{result[:status].to_s} if checked so" do
-      @plugin.stub(:critical?).and_return(result[:critical?])
-      @plugin.stub(:warning?).and_return(result[:warning?])
-      @plugin.check
-      @plugin.status.should eql(result[:status])
+
+  describe '#run' do
+    before do
+      @plugin.stub(:puts)
+      @plugin.stub(:exit)
     end
-  end
-  
-  it "should raise when all checks return false" do
-    [:critical?, :warning?, :ok?].each do |m|
-      @plugin.stub(m).and_return(false)
+
+    it 'should run the check method' do
+      @plugin.should_receive(:check).with(no_args)
+      @plugin.run
+    end
+
+    it 'should output the class name' do
+      def @plugin.check; end
+      @plugin.should_receive(:puts).with(/MYPLUGIN/)
+      @plugin.run
+    end
+
+    context 'when an unknown exception was raised' do
+      before do
+        StandardError.any_instance.stub(:backtrace).and_return(%w[foo bar baz])
+        def @plugin.check
+          raise StandardError, 'Oops!'
+        end
+      end
+
+      it 'should output the execptions message' do
+        @plugin.should_receive(:puts).with(/Oops!/)
+        @plugin.run
+      end
+
+      it 'should output the exceptions backtrace' do
+        @plugin.should_receive(:puts).with(/foo\nbar\nbaz/)
+        @plugin.run
+      end
+
+      it 'should exit unknown' do
+        @plugin.should_receive(:exit).with(3)
+        @plugin.run
+      end
+    end
+
+    context 'when no exception was raised' do
+      before { def @plugin.check; end }
+
+      it 'should display a hint for the developer' do
+        @plugin.should_receive(:puts).with(/no status method was called/i)
+        @plugin.run
+      end
+
+      it 'should exit unknown' do
+        @plugin.should_receive(:exit).with(3)
+        @plugin.run
+      end
+    end
+
+    context 'when a status error was raised' do
+      before do
+        def @plugin.check
+          raise NagiosPlugin::Plugin::StatusError.new(:ok, 'hello, world.')
+        end
+      end
+
+      it 'should output the status type' do
+        @plugin.should_receive(:puts).with(/OK/)
+        @plugin.run
+      end
+
+      it 'should output the status message' do
+        @plugin.should_receive(:puts).with(/hello, world\./)
+        @plugin.run
+      end
+
+      it 'should exit with the exit status from status error' do
+        @plugin.should_receive(:exit).with(0)
+        @plugin.run
+      end
     end
-    lambda { @plugin.check }.should raise_error(NagiosPlugin::PluginError)
-    @plugin.status.should eql(:unknown)
   end
-  
-
-  it "should raise if check methods are undefined" do
-    lambda { @plugin.check }.should raise_error(NoMethodError)
-    @plugin.status.should eql(:unknown)
-    
-    @plugin.instance_exec { def critical?; false end }
-    lambda { @plugin.check }.should raise_error(NoMethodError)
-    @plugin.status.should eql(:unknown)
-    
-    @plugin.instance_exec { def warning?; false end }
-    lambda { @plugin.check }.should_not raise_error(NoMethodError)
-    @plugin.status.should_not eql(:unknown)
+end
+
+
+describe NagiosPlugin::Plugin::StatusError do
+  def create_status(status, msg = '')
+    NagiosPlugin::Plugin::StatusError.new(status, msg)
   end
-  
-  it "should also represent the status as exit code" do
-    {
-      :ok => 0,
-      :warning => 1,
-      :critical => 2,
-      :unknown => 3
-    }.each_pair do |status,code|
-      @plugin.stub(:status).and_return(status)
-      @plugin.code.should eql(code)
+
+  %w[ok warning critical unknown].each_with_index do |s,i|
+    context "when #{s}" do
+      before { @status = create_status(s.to_sym) }
+
+      it 'should include status in the exception message' do
+        @status.to_s.should include(s.upcase)
+      end
+
+      it "should convert to #{i}" do
+        @status.to_i.should eql(i)
+      end
     end
   end
-  
-  it "should alias to_s to message" do
-    def @plugin.output; "hello, world" end
-    @plugin.to_s.should eql(@plugin.message)
-  end
-  
-  it "should alias to_i to code" do
-    @plugin.to_i.should eql(@plugin.code)
+
+  context 'when initialized with invalid status' do
+    before { @status = create_status(:invalid) }
+
+    it 'should include unknown status in the exception message' do
+      @status.to_s.should include('UNKNOWN')
+    end
+
+    it 'should convert to 3' do
+      @status.to_i.should eql(3)
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1 +1 @@
-require "nagiosplugin"
+require 'nagiosplugin'

metadata

@@ -1,91 +1,117 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: nagiosplugin
-version: !ruby/object:Gem::Version
-  version: 0.0.7
+version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
-authors:
-- Björn Albers
+authors: 
+- "Bj\xC3\xB6rn Albers"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-13 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &70198850133720 !ruby/object:Gem::Requirement
+
+date: 2012-03-29 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  name: rake
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *70198850133720
-- !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70198850131720 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *70198850131720
-- !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &70198850130120 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *70198850130120
-- !ruby/object:Gem::Dependency
   name: guard-cucumber
-  requirement: &70198850129120 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *70198850129120
-- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70198850128200 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
-  version_requirements: *70198850128200
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: &70198850127260 !ruby/object:Gem::Requirement
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *70198850127260
-description: Yet another framework for writing Nagios Plugins
-email:
+  name: guard-rspec
+  version_requirements: *id006
+description: A simple framework for writing Nagios Plugins
+email: 
 - bjoernalbers@googlemail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
-- .rvmrc
 - Gemfile
 - Guardfile
 - LICENSE
@@ -102,35 +128,38 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/bjoernalbers/nagiosplugin
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -2385574504671783555
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -2385574504671783555
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: nagiosplugin-0.0.7
-test_files:
+summary: nagiosplugin-1.0.0
+test_files: 
 - features/plugin_output.feature
 - features/steps/dev_steps.rb
 - features/support/env.rb

data/.rvmrc

@@ -1 +0,0 @@
-rvm use 1.9.2@nagiosplugin --create