nagios_check 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in nagios_check.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2003, 2004 Jim Weirich
+
+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,22 @@
+= Nagios Check 
+
+License:: MIT license (see MIT-LICENSE file) 
+Copyright:: 2011 Dominique Broeglin 
+
+
+== DESCRIPTION
+
+An easy to use DSL for building custom probes for the Nagios monitoring system.
+
+== FEATURES
+
+* Provide a simple to use DSL for building your own probes.
+* Decode command line options.
+* Report status data to Nagios. 
+* Report performance data to Nagios. 
+
+
+== RESOURCES
+
+* {Website}[https://github.com/dbroeglin/nagios_check]
+* {Source Code}[https://github.com/dbroeglin/nagios_check]

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/nagios_check.rb

@@ -0,0 +1,127 @@
+require "nagios_check/version"
+require 'optparse'
+require 'ostruct'
+require 'timeout'
+
+require 'nagios_check/range'
+
+module NagiosCheck
+  attr_reader :options
+  attr_accessor :message
+
+  def prepare
+    @values = {}
+    self.message = nil
+  end
+
+  def run
+    prepare
+    parse_options
+    return_val, status = 3, "UNKNOWN"
+    begin
+      if @timeout
+        check_with_timeout
+      else
+        check
+      end
+      return_val, status = finish
+    rescue Timeout::Error
+      store_message "TIMEOUT after #{@timeout}s"
+    rescue => e
+      store_message "INTERNAL ERROR: #{e}"
+    end
+    msg = status
+    msg += ': ' + message if message
+    if @values && !@values.empty? 
+      msg += '|' + @values.map do |name, value|
+        "#{name}=#{value};;;;"
+      end.join(' ')
+    end
+    puts msg 
+    exit return_val
+  end
+
+  def store_message(message)
+    self.message = message
+  end
+
+  def finish
+    value = @values.first.last
+    if @critical_range && !@critical_range.include?(value)
+      return [2, "CRITICAL"]
+    end
+    if @warning_range && !@warning_range.include?(value)
+      return [1, "WARNING"]
+    end
+    return [0, "OK"]
+  end
+
+  def store_value(name, value, opts = {})
+    @values[name] = value.to_f
+  end
+
+  module ClassMethods
+    def on(*args, &block)
+      @ons << [args, args.delete(:required), block]
+    end
+
+    def store(name, opts = {})
+      @defaults[name] = opts[:default] if opts.has_key?(:default)
+      Proc::new do |value|
+        self.options.send "#{name}=", value
+      end
+    end
+
+    def defaults
+      @defaults
+    end
+
+    def enable_warning(*args)
+      on("-w RANGE", *args) do |value| 
+        @warning_range = NagiosCheck::Range.new(value) 
+      end
+    end
+
+    def enable_critical(*args)
+      on("-c RANGE", *args) do |value| 
+        @critical_range = NagiosCheck::Range.new(value) 
+      end
+    end
+    
+    def enable_timeout(*args)
+      on("-t TIMEOUT", *args) do |value| 
+        @timeout = value.to_f 
+      end
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.instance_eval do 
+      @ons = []
+      @defaults = {}
+    end
+  end
+
+  private
+
+  def opt_parse
+    unless @opt_parse
+      opt_parse = OptionParser::new
+      self.class.instance_variable_get("@ons").each do |args, req, block|
+        opt_parse.on(*args) {|value| instance_exec(value, &block) }
+      end 
+      @opt_parse = opt_parse
+    end
+    @opt_parse 
+  end
+
+  def parse_options(argv = ARGV)
+    @options = OpenStruct::new(self.class.defaults)
+    opt_parse.parse!(argv)
+  end
+
+  def check_with_timeout
+    Timeout.timeout(@timeout) { check } 
+  end
+end

data/lib/nagios_check/range.rb

@@ -0,0 +1,37 @@
+module NagiosCheck
+  class Range
+    def initialize(string_range)
+      if string_range.nil? || string_range.empty?
+        raise RuntimeError, "Pattern should not be nil" 
+      end
+      @string_range = string_range
+      tokens = string_range.scan(/^(@)?(([-.0-9]+|~)?:)?([-.0-9]+)?$/).first
+      unless tokens
+        raise RuntimeError, "Pattern should be of form [@][~][min]:max" 
+      end
+      @exclusive = true if tokens.include? "@"
+      case tokens[2]
+      when nil, "" then @min = 0
+      when '~' then @min = nil
+      else @min = tokens[2].to_f
+      end
+      @max = tokens[3].nil? || tokens[3] == "" ? nil : tokens[3].to_f
+    end
+
+    def include?(value)
+      if @exclusive
+        (@min.nil? || value > @min) && (@max.nil? || value < @max)
+      else
+        (@min.nil? || value >= @min) && (@max.nil? || value <= @max)
+      end
+    end
+
+    def ===(value)
+      include?(value)
+    end
+
+    def to_s
+      "Range[#{@reversed ? "~" : ""}#{@inclusive ? "@" : ""}#{@min}:#{@max}]"
+    end
+  end
+end

data/lib/nagios_check/version.rb

@@ -0,0 +1,3 @@
+module NagiosCheck
+  VERSION = "0.0.1"
+end

data/nagios_check.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "nagios_check/version"
+
+Gem::Specification.new do |s|
+  s.name        = "nagios_check"
+  s.version     = NagiosCheck::VERSION
+  s.authors     = ["Dominique Broeglin"]
+  s.email       = ["dominique.broeglin@gmail.com"]
+  s.homepage    = "https://github.com/dbroeglin/nagios_check"
+  s.summary     = %q{Ruby Nagios Check Integration}
+  s.description = %q{An easy to use DSL for building custom probes for the Nagios monitoring system}
+
+  s.rubyforge_project = "nagios_check"
+
+  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"]
+end

data/spec/finish_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+def before_finish_test
+  before(:each) do 
+    subject.prepare 
+    description = example.metadata[:example_group][:example_group][:description_args].first 
+    if /^when options are '(.*)'$/ =~ description
+      subject.send :parse_options, $1.split 
+    end
+    
+    description = example.metadata[:example_group][:description_args].first 
+    if /^when value is (.*)$/ =~ description
+      subject.store_value 'val', $1.to_f 
+    end
+  end
+end
+
+class OkTestCheck
+  include NagiosCheck
+end
+
+class WarningTestCheck
+  include NagiosCheck
+  enable_warning
+end
+
+class CriticalTestCheck
+  include NagiosCheck
+  enable_warning
+  enable_critical
+end
+
+describe OkTestCheck do
+  before_finish_test
+  
+  context "when options are ''" do
+    context "when value is 0" do
+      specify { subject.finish.should == [0, "OK"] }
+    end
+    context "when value is 5" do
+      specify { subject.finish.should == [0, "OK"] }
+    end
+    context "when value is 10" do
+      specify { subject.finish.should == [0, "OK"] }
+    end
+  end
+
+end
+
+describe WarningTestCheck do
+  before_finish_test 
+
+  context "when options are '-w 10'" do
+    context "when value is -1" do
+      specify { subject.finish.should == [1, "WARNING"] }
+    end
+    context "when value is 0" do
+      specify { subject.finish.should == [0, "OK"] }
+    end
+    context "when value is 5" do
+      specify { subject.finish.should == [0, "OK"] }
+    end
+    context "when value is 10" do
+      specify { subject.finish.should == [0, "OK"] }
+    end
+    context "when value is 11" do
+      specify { subject.finish.should == [1, "WARNING"] }
+    end
+  end
+end
+
+describe CriticalTestCheck do
+  before_finish_test 
+
+  context "when options are '-w 10 -c 20'" do
+    context "when value is -1" do
+      specify { subject.finish.should == [2, "CRITICAL"] }
+    end
+    context "when value is 0" do
+      specify { subject.finish.should == [0, "OK"] }
+    end
+    context "when value is 5" do
+      specify { subject.finish.should == [0, "OK"] }
+    end
+    context "when value is 10" do
+      specify { subject.finish.should == [0, "OK"] }
+    end
+    context "when value is 15" do
+      specify { subject.finish.should == [1, "WARNING"] }
+    end
+    context "when value is 20" do
+      specify { subject.finish.should == [1, "WARNING"] }
+    end
+    context "when value is 21" do
+      specify { subject.finish.should == [2, "CRITICAL"] }
+    end
+  end
+end

data/spec/range_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+
+require 'pp'
+
+describe NagiosCheck::Range do
+  subject { @range }
+  before(:each) do 
+    description = example.metadata[:example_group][:description_args].first 
+    if /^when pattern is (.*)/ =~ description
+      @range = NagiosCheck::Range::new($1)
+    end
+  end
+
+  context "when pattern is 10" do
+    it { should_not contain -1 } 
+    it { should     contain 0 } 
+    it { should     contain 0.1 } 
+    it { should     contain 1 } 
+    it { should     contain 9 } 
+    it { should     contain 9.9 } 
+    it { should     contain 10 } 
+    it { should     contain 10.0 } 
+    it { should_not contain 10.1 } 
+  end
+
+  context "when pattern is :10" do
+    it { should_not contain -1 } 
+    it { should     contain 0 } 
+    it { should     contain 0.1 } 
+    it { should     contain 1 } 
+    it { should     contain 9 } 
+    it { should     contain 9.9 } 
+    it { should     contain 10 } 
+    it { should     contain 10.0 } 
+    it { should_not contain 10.1 } 
+  end
+  
+  context "when pattern is @:10" do
+    it { should_not contain -1 } 
+    it { should_not contain 0 } 
+    it { should     contain 5 } 
+    it { should_not contain 10 } 
+    it { should_not contain 10.0 } 
+    it { should_not contain 11 } 
+  end
+
+  context "when pattern is 10:" do
+    it { should_not contain -1 } 
+    it { should_not contain 1 } 
+    it { should_not contain 9.9 } 
+    it { should     contain 10 } 
+    it { should     contain 10.0 } 
+    it { should     contain 10.1 } 
+    it { should     contain 11 } 
+  end
+  
+  context "when pattern is @10:" do
+    it { should_not contain -1 } 
+    it { should_not contain 1 } 
+    it { should_not contain 9.9 } 
+    it { should_not contain 10 } 
+    it { should_not contain 10.0 } 
+    it { should     contain 10.1 } 
+    it { should     contain 11 } 
+  end
+
+  context "when pattern is 10:11" do
+    it { should_not contain -1 } 
+    it { should_not contain 1 } 
+    it { should_not contain 9.9 } 
+    it { should     contain 10 } 
+    it { should     contain 10.0 } 
+    it { should     contain 10.1 } 
+    it { should     contain 10.9 } 
+    it { should     contain 11 } 
+    it { should_not contain 11.1 } 
+    it { should_not contain 12 } 
+  end
+  
+  context "when pattern is @10:11" do
+    it { should_not contain -1 } 
+    it { should_not contain 1 } 
+    it { should_not contain 9.9 } 
+    it { should_not contain 10 } 
+    it { should_not contain 10.0 } 
+    it { should     contain 10.1 } 
+    it { should_not contain 11 } 
+    it { should_not contain 11.1 } 
+    it { should_not contain 12 } 
+  end
+
+  context "when pattern is @10.05:11.05" do
+    it { should_not contain -1 } 
+    it { should_not contain 1 } 
+    it { should_not contain 9.9 } 
+    it { should_not contain 10 } 
+    it { should_not contain 10.0 } 
+    it { should     contain 10.1 } 
+    it { should     contain 11 } 
+    it { should_not contain 11.1 } 
+    it { should_not contain 12 } 
+  end
+
+  context "when pattern is -1:1" do
+    it { should_not contain -2 } 
+    it { should     contain -1 } 
+    it { should     contain -0.9 } 
+    it { should     contain 0 } 
+    it { should     contain 0.9 } 
+    it { should     contain 1 } 
+    it { should_not contain 2 } 
+  end
+  
+  context "when pattern is ~:1" do
+    it { should     contain -2 } 
+    it { should     contain -1 } 
+    it { should     contain 0 } 
+    it { should     contain 1 } 
+    it { should_not contain 2 } 
+  end
+  
+  context "when pattern is @~:1" do
+    it { should     contain -2 } 
+    it { should     contain -1 } 
+    it { should     contain 0 } 
+    it { should_not contain 1 } 
+    it { should_not contain 2 } 
+  end
+
+  context "when nil pattern" do 
+    it "raises an error" do
+      lambda { NagiosCheck::Range.new nil }.should raise_error
+    end
+  end
+  
+  context "when empty pattern" do 
+    it "raises an error" do
+      lambda { NagiosCheck::Range.new "" }.should raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'nagios_check'
+
+module Matchers
+  class Contain
+    def initialize(expected)
+      @expected = expected
+    end
+
+    def matches?(actual)
+      @actual = actual
+      @actual.include? @expected
+    end
+
+    def failure_message
+      "expected #{@actual} to contain #{@expected}" 
+    end
+
+    def negative_failure_message
+      "expected #{@actual} not to contain #{@expected}"
+    end
+  end
+
+  def contain(value)
+    Contain::new(value)
+  end
+end
+
+RSpec.configure do |config|  
+  config.include(Matchers)  
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: nagios_check
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dominique Broeglin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-22 00:00:00.000000000Z
+dependencies: []
+description: An easy to use DSL for building custom probes for the Nagios monitoring
+  system
+email:
+- dominique.broeglin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/nagios_check.rb
+- lib/nagios_check/range.rb
+- lib/nagios_check/version.rb
+- nagios_check.gemspec
+- spec/finish_spec.rb
+- spec/range_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dbroeglin/nagios_check
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: nagios_check
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Ruby Nagios Check Integration
+test_files:
+- spec/finish_spec.rb
+- spec/range_spec.rb
+- spec/spec_helper.rb