nagios-probe 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 David Abdemoulaie
+
+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.rdoc

@@ -0,0 +1,69 @@
+= nagios-probe
+
+Provides an easy to use API for generating custom probes and communicating probe success/failure to Nagios.
+
+== Installation
+
+    # gem install nagios-probe
+
+== Usage
+
+Simply create a subclass of Nagios::Probe and define the following methods:
+
+* check_crit
+* check_warn
+* check_ok (optional*)
+* crit_message
+* warn_message
+* ok_message
+
+*check_ok is defined in the base class to always return true.
+
+    class MyProbe < Nagios::Probe
+      def check_crit
+        true
+      end
+
+      def check_warn
+        false
+      end
+
+      def crit_message
+        "Things are bad"
+      end
+
+      def warn_message
+        "Things aren't going well"
+      end
+
+      def ok_message
+        "Nothing to see here"
+      end
+    end
+
+To use your probe you *must* wrap it in a begin/rescue block to catch any exceptions and accurately report the status to Nagios.
+
+    begin
+      options = {} # Nagios::Probe constructor accepts a single optional param that is assigned to @opts
+      probe = MyProbe.new(options)
+      probe.run
+    rescue Exception => e
+      puts "Unknown: " + e
+      exit Nagios::UNKNOWN
+    end
+
+    puts probe.message
+    exit probe.retval
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 David Abdemoulaie. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "nagios-probe"
+    gem.summary = "A very simple tool to assist with creating custom nagios probes in Ruby"
+    gem.description = "Provides an easy to use API for generating custom probes and communicating probe success/failure to Nagios"
+    gem.email = "dave@hobodave.com"
+    gem.homepage = "http://github.com/hobodave/nagios-probe"
+    gem.authors = ["David Abdemoulaie"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "nagios-probe #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/nagios-probe.rb

@@ -0,0 +1,80 @@
+module Nagios
+  OK = 0
+  WARNING = 1
+  CRITICAL = 2
+  UNKNOWN = 3
+
+  def crit(message)
+    "Critical: #{message}"
+  end
+
+  def warn(message)
+    "Warning: #{message}"
+  end
+
+  def ok(message)
+    "OK: #{message}"
+  end
+
+  class Probe
+    include Nagios
+    attr_reader :retval, :message
+
+    def initialize(opts = {})
+      @opts = opts
+      @retval = OK
+      @message = ok(ok_message)
+    end
+
+    def crit?
+      is_crit = check_crit
+      return false unless is_crit
+      @retval = CRITICAL
+      @message = crit(crit_message)
+      true
+    end
+
+    def warn?
+      is_warn = check_warn
+      return false unless is_warn
+      @retval = WARNING
+      @message = warn(warn_message)
+      true
+    end
+
+    def ok?
+      is_ok = check_ok
+      return false unless is_ok
+      @retval = OK
+      @message = ok(ok_message)
+      true
+    end
+
+    def check_ok
+      true
+    end
+
+    def run
+      if !crit?
+        if !warn?
+          if !ok?
+            @retval = UNKNOWN
+            raise RuntimeError, "crit? warn? and ok? all returned false"
+          end
+        end
+      end
+    end
+
+    def crit_message
+      "Default message - override crit_message."
+    end
+
+    def warn_message
+      "Default message - override warn_message."
+    end
+
+    def ok_message
+      "Default message - override ok_message."
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'nagios-probe'
+
+class Test::Unit::TestCase
+end
+
+class CriticalProbe < Nagios::Probe
+  def check_crit
+    true
+  end
+end
+
+class WarnProbe < Nagios::Probe
+  def check_crit
+    false
+  end
+
+  def check_warn
+    true
+  end
+end
+
+class OKProbe < Nagios::Probe
+  def check_crit
+    false
+  end
+
+  def check_warn
+    false
+  end
+end
+
+class BadProbe < Nagios::Probe
+  def check_crit
+    false
+  end
+  alias :check_warn :check_crit
+  alias :check_ok :check_crit
+end
+
+class AllTrueProbe < Nagios::Probe
+  def check_crit
+    true
+  end
+  alias :check_warn :check_crit
+  alias :check_ok :check_crit
+end

data/test/test_nagios-probe.rb

@@ -0,0 +1,42 @@
+require 'helper'
+
+class TestNagiosProbe < Test::Unit::TestCase
+  context "A probe" do
+    setup do
+      @crit = CriticalProbe.new
+      @warn = WarnProbe.new
+      @ok = OKProbe.new
+    end
+
+    should "have retval of 2 when critical" do
+      @crit.run
+      assert_equal 2, @crit.retval
+    end
+
+    should "have retval of 1 when warn" do
+      @warn.run
+      assert_equal 1, @warn.retval
+    end
+
+    should "have retval of 0 when OK" do
+      @ok.run
+      assert_equal 0, @ok.retval
+    end
+
+    should "return default message when no user overrides are defined" do
+      @crit.run
+      @warn.run
+      @ok.run
+      assert_equal "Critical: Default message - override crit_message.", @crit.message
+      assert_equal "Warning: Default message - override warn_message.", @warn.message
+      assert_equal "OK: Default message - override ok_message.", @ok.message
+    end
+
+    should "throw exception when all valid statuses are false (Critical, Warning, OK)" do
+      @bad = BadProbe.new
+      assert_raise RuntimeError do
+        @bad.run
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: nagios-probe
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- David Abdemoulaie
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-14 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Provides an easy to use API for generating custom probes and communicating probe success/failure to Nagios
+email: dave@hobodave.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/nagios-probe.rb
+- test/helper.rb
+- test/test_nagios-probe.rb
+has_rdoc: true
+homepage: http://github.com/hobodave/nagios-probe
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: A very simple tool to assist with creating custom nagios probes in Ruby
+test_files: 
+- test/helper.rb
+- test/test_nagios-probe.rb