nagiosplugin 1.2.0 → 1.3.0

data/README.md

@@ -39,6 +39,13 @@ Profit... and maybe also fun.
   (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.
 
+## Acknowledgments
+
+Thanks to the following contributors for improving NagiosPlugin:
+
+* [szuecs (Sandor Szücs)](https://github.com/szuecs): Adding default
+  options, perfdata stuff and helpful sample code.
+
 ## Copyright
 
 Copyright (c) 2011-2012 Björn Albers. See LICENSE for details.

data/examples/check_file_exists.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.dirname(__FILE__) + "/lib")
+
+require "nagiosplugin"
+require "nagiosplugin/default_options"
+
+class MyPlugin < NagiosPlugin::Plugin
+  include NagiosPlugin::DefaultOptions
+
+  VERSION = 1.0
+
+  class << self
+    def run(*args)
+      self.new(*args).run
+    end
+  end
+
+  def parse_options(*args)
+    @options = {}
+    OptionParser.new do |opts|
+      opts.banner  = "% #{File.basename($0)} --filename <file>"
+      opts.separator ""
+      opts.separator "Specific options:"
+      opts.separator ""
+
+      opts.on('-f', '--filename <name>', 'Filename that should exist.') do |s|
+        @options[:filename] = s
+      end
+
+      yield(opts) if block_given?
+
+      begin
+        opts.parse!(args)
+        @options
+      rescue => e
+        puts "#{e}\n\n#{opts}"
+        exit(3)
+      end
+    end
+  end
+
+  def initialize(*args)
+    parse_options(*args, &default_options)
+    @warn = @options[:warn] if @options[:warn]
+    @crit = @options[:crit] if @options[:crit]
+    @reverse = @options[:reverse] if @options[:reverse]
+    @filename = @options[:filename]
+  end
+
+  def check
+    if File.executable?(@filename)
+      ok("#{@filename} is excutable")
+    elsif File.exists?(@filename)
+      warning("#{@filename} is not excutable")
+    else
+      critical("#{@filename} does not exist")
+    end
+  end
+end
+
+MyPlugin.run(*ARGV)

data/examples/check_perfdata.rb

@@ -0,0 +1,30 @@
+require "nagiosplugin"
+require "nagiosplugin/plugin"
+require "nagiosplugin/perfdata"
+
+class CheckPerfdata < NagiosPlugin::Plugin
+  include NagiosPlugin::Perfdata
+
+  def check
+    sleep 0.4
+    pd = PerfData.new
+    pd.val = 40
+    pd.warn = 25
+    pd.crit = 50
+    pd.min = 1
+    pd.max = 90
+    pd.uom = "%"
+
+    @perfdata = {
+      :pd => pd,
+      :baz => PerfData.new(1),
+      :foo => PerfData.new(1,2,3),
+      :bar => PerfData.new(4,5,6,7,8),
+    }
+    ok('super perfdata')
+    sleep 0.2
+  end
+
+end
+
+CheckPerfdata.run

data/lib/nagiosplugin/default_options.rb

@@ -0,0 +1,78 @@
+require "optparse"
+
+module NagiosPlugin
+  module DefaultOptions
+    def parse_num(s)
+      if s.include? "."
+        s.to_f
+      else
+        s.to_i
+      end
+    end
+
+    def parse_start_num(s)
+      if s.include? '~'
+        s.delete!('~')
+        Float::MIN
+      else
+        parse_num(s)
+      end
+    end
+    def parse_reverse(s)
+      if s.include? '@'
+        s.delete!('@')
+        @options[:invert] = true
+      end
+    end
+
+    def parse_nagios_style(s)
+      parse_reverse(s)
+
+      if not s.include? ':'
+        s = ":" + s
+      end
+
+      start, stop = s.split(':')
+      if start.empty?
+        # :m
+        start = 0
+        stop = parse_num(stop)
+      elsif stop.empty?
+        # n:
+        start = parse_start_num(start)
+        stop = Float::MAX
+      else
+        # n:m
+        start = parse_start_num(start)
+        stop = parse_num(stop)
+      end
+      start..stop
+    end
+
+    def default_options
+      lambda do |opts|
+        opts.separator ""
+        opts.separator "Default options:"
+        opts.separator ""
+
+        opts.on('-h', '--help', 'Display this help.') do
+          puts "#{opts}"
+          exit(3)
+        end
+
+        opts.on('-V', '--version', 'Print version.') do |s|
+          puts "#{File.basename($0)} #{VERSION}"
+          exit(3)
+        end
+
+        opts.on('-w', '--warn <n:m>', 'Warning threshold.') do |s|
+          @options[:warn] = parse_nagios_style(s)
+        end
+
+        opts.on('-c', '--crit <n:m>', 'Critical threshold.') do |s|
+          @options[:crit] = parse_nagios_style(s)
+        end
+      end
+    end
+  end
+end

data/lib/nagiosplugin/perfdata.rb

@@ -0,0 +1,40 @@
+module NagiosPlugin
+  module Perfdata
+    _perfdata = Struct.new :val, :warn, :crit, :min, :max, :uom
+    PerfData = _perfdata
+
+    def get_perfdata
+      if @perfdata.class == PerfData
+        @perfdata.select {|e| e}.join(';')
+      else
+        @perfdata.map do |k,v|
+          "#{k}=" + v.select {|e| e}.join(';')
+        end.join(' ')
+      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
+      t1 = Time.now
+      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
+      t2 = Time.now
+      msg = [service, e.to_s].join(' ')
+      perfdata = get_perfdata
+      t = t2 - t1
+      puts "#{msg}|time=#{t} #{perfdata}"
+      exit e.to_i
+    end
+
+  end
+end

data/lib/nagiosplugin/plugin.rb

@@ -1,6 +1,42 @@
+require "optparse"
+
 module NagiosPlugin
   class Plugin
     class << self
+      def parse_options(options, &blk2)
+        OptionParser.new do |opts|
+          opts.banner  = "% #{$0} [options]"
+          opts.separator ""
+          opts.separator "Specific options:"
+          opts.separator ""
+
+          opts.on('-h', '--help', 'Display this help.') do
+            abort "#{opts}"
+          end
+
+          opts.on('-r', '--reverse', 'Reverse thresholds.') do |b|
+            options[:reverse] = b
+          end
+
+          opts.on('-w', '--warn <n>', 'Warning threshold.') do |s|
+            options[:warn] = s.to_i
+          end
+
+          opts.on('-c', '--crit <n>', 'Critical threshold.') do |s|
+            options[:crit] = s.to_i
+          end
+
+          blk2.call(opts)
+
+          begin
+            opts.parse!
+          rescue => e
+            abort "#{e}\n\n#{opts}"
+          end
+        end
+
+        options
+      end
 
       # Create new instance and run it.
       def run(*args)
@@ -25,6 +61,13 @@ module NagiosPlugin
     make :critical
     make :unknown
 
+    def initialize(options={})
+      @warn = options[:warn] if options[:warn]
+      @crit = options[:crit] if options[:crit]
+      @reverse = options[:reverse] if options[:reverse]
+    end
+
+
     # Overwrite this check method and call a status method within.
     def check
       unknown 'please overwrite the `check` method in your class'
@@ -58,5 +101,6 @@ module NagiosPlugin
       puts [service, e.to_s].join(' ')
       exit e.to_i
     end
+
   end
 end

data/lib/nagiosplugin/version.rb

@@ -1,3 +1,3 @@
 module NagiosPlugin
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/spec/nagiosplugin/plugin_spec.rb

@@ -4,6 +4,27 @@ describe NagiosPlugin::Plugin do
   before do
     class MyPlugin < NagiosPlugin::Plugin; end
     @plugin = MyPlugin.new
+
+    class MergedOptionsPlugin < NagiosPlugin::Plugin
+      def initialize(options, &blk)
+        super(options, &blk)
+        @foo = options[:foo]
+      end
+      attr_reader :warn, :crit, :reverse, :foo
+    end
+    @plugin_with_options = MergedOptionsPlugin.new({:warn => 5, :crit => 1, :reverse => true, :foo => "bar"})  do |opts|
+      opts.on('--foo <s>', 'A test option.') do |s|
+        options[:foo] = s
+      end
+    end
+  end
+
+  describe '#initialize' do
+    it "should have attributes" do
+      @plugin_with_options.should satisfy { |o|
+        o.warn == 5 and o.crit == 1 and o.reverse and o.foo == "bar"
+      }
+    end
   end
 
   describe '#run' do

metadata

@@ -1,89 +1,116 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: nagiosplugin
-version: !ruby/object:Gem::Version
-  version: 1.2.0
+version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: 
+  segments: 
+  - 1
+  - 3
+  - 0
+  version: 1.3.0
 platform: ruby
-authors:
-- Björn Albers
+authors: 
+- "Bj\xC3\xB6rn Albers"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-02 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &70139107324480 !ruby/object:Gem::Requirement
+
+date: 2012-08-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  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
   type: :development
+  name: rake
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *70139107324480
-- !ruby/object:Gem::Dependency
+  type: :development
   name: cucumber
-  requirement: &70139107323900 !ruby/object:Gem::Requirement
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !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: *70139107323900
-- !ruby/object:Gem::Dependency
+  type: :development
   name: aruba
-  requirement: &70139107323300 !ruby/object:Gem::Requirement
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !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: *70139107323300
-- !ruby/object:Gem::Dependency
+  type: :development
   name: guard-cucumber
-  requirement: &70139107322640 !ruby/object:Gem::Requirement
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !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: *70139107322640
-- !ruby/object:Gem::Dependency
+  type: :development
   name: rspec
-  requirement: &70139107322100 !ruby/object:Gem::Requirement
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  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: *70139107322100
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: &70139107321640 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
-  prerelease: false
-  version_requirements: *70139107321640
+  name: guard-rspec
+  version_requirements: *id006
 description: The one Nagios Plugin framework, forged in the fires of Mount Doom.
-email:
+email: 
 - bjoernalbers@googlemail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -91,10 +118,14 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- examples/check_file_exists.rb
+- examples/check_perfdata.rb
 - features/nagiosplugin_usage.feature
 - features/steps/dev_steps.rb
 - features/support/env.rb
 - lib/nagiosplugin.rb
+- lib/nagiosplugin/default_options.rb
+- lib/nagiosplugin/perfdata.rb
 - lib/nagiosplugin/plugin.rb
 - lib/nagiosplugin/status_error.rb
 - lib/nagiosplugin/version.rb
@@ -104,35 +135,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: -1071120004356893242
-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: -1071120004356893242
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: nagiosplugin-1.2.0
-test_files:
+summary: nagiosplugin-1.3.0
+test_files: 
 - features/nagiosplugin_usage.feature
 - features/steps/dev_steps.rb
 - features/support/env.rb