nagios_check 0.0.1 → 0.0.2

data/README.md

@@ -0,0 +1,75 @@
+NagiosCheck
+============
+
+Description
+-----------
+
+NagiosCheck is a simple and efficient tool for building custom probes for the
+Nagios monitoring system. It alleviates the pain of parsing command line
+options, writing and formatting the check results according to the Nagios 
+plugin API.
+
+Installation
+------------
+ 
+``` bash
+gem install nagios_check
+```
+
+Features
+--------
+
+* Provide a simple to use DSL for building your own probes.
+* Parse command line options.
+* Report status data to Nagios (handles exceptions as UNKNOWN status).
+* Provide a Nagios like range description format for the WARNING and CRITICAL states.
+* Provide a simple timeout functionality to be more Nagios friendly.
+* Report performance data to Nagios.
+
+Usage and documentation
+-----------------------
+
+NagiosCheck is a module. To use it simply include it in a class and declare
+how the check should behave:
+
+``` ruby
+require "nagios_check"
+
+class SimpleCheck
+  include NagiosCheck
+
+  on "-H HOST", :required, &store(:host)
+  on "-P PORT",            &store(:port, default: 8080, transform: :to_i)
+
+  enable_warning
+  enable_critical
+  enable_timeout
+
+  def check
+    time = do_some_check(options.host, options.port)
+    store_value :duration, time
+  end
+end
+
+SimpleCheck.new.run
+```
+
+The command can then be used by Nagios:
+
+``` bash
+  ruby simple_check.rb -H my_host -P my_port -w 4 -c 8 -t 10
+```
+
+If the value returned by `do_some_check` is between 0 and 4 inclusive the result is OK.  If it is greater than 4 and less than 8 inclusive the result is WARNING. If it is greater than 8 the result is CRITICAL. See [Nagios Developer Guidelines][nagios-dev] for more details on how the arguments of `-w` and `-c` are interpreted.
+
+If the check method lasts more than 10 seconds, it times out and the returned value is UNKNOWN.
+
+License
+-------
+Released under the MIT License.  See the [MIT-LICENSE][license] file for further details.
+
+[license]: https://github.com/dbroeglin/nagios_check/blob/master/MIT-LICENSE 
+[nagios-dev]: http://nagiosplug.sourceforge.net/developer-guidelines.html
+
+Copyright 2011 Dominique Broeglin 
+

data/lib/nagios_check.rb

@@ -62,12 +62,14 @@ module NagiosCheck
 
   module ClassMethods
     def on(*args, &block)
-      @ons << [args, args.delete(:required), block]
+      @ons << [args, args.delete(:mandatory), block]
     end
 
     def store(name, opts = {})
       @defaults[name] = opts[:default] if opts.has_key?(:default)
+      transform = opts[:transform]
       Proc::new do |value|
+        value = value.send transform if transform
         self.options.send "#{name}=", value
       end
     end
@@ -108,8 +110,10 @@ module NagiosCheck
   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) }
+      self.class.instance_variable_get("@ons").each do |args, mand, block|
+        opt_parse.on(*args) do |value| 
+          instance_exec(value, &block) 
+        end
       end 
       @opt_parse = opt_parse
     end
@@ -121,7 +125,11 @@ module NagiosCheck
     opt_parse.parse!(argv)
   end
 
+
   def check_with_timeout
     Timeout.timeout(@timeout) { check } 
   end
+
+  class MissingOption < StandardError
+  end
 end

data/lib/nagios_check/version.rb

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

data/spec/options_spec.rb

@@ -0,0 +1,92 @@
+describe NagiosCheck do
+  context "when no options specified" do
+    subject do
+      Class::new do
+        include NagiosCheck
+      end.new
+    end
+
+    specify { subject.send :parse_options, [] }
+  end
+  
+  context "when warning is specified" do
+    subject do
+      Class::new do
+        include NagiosCheck
+        enable_warning
+      end.new
+    end
+
+    it("works with no arguments"){ subject.send :parse_options, %w{} }
+    specify { subject.send :parse_options, %w{-w 10} }
+   
+    it "fails if -w has no argument" do
+      lambda {
+        subject.send :parse_options, %w{-w} 
+      }.should raise_error(OptionParser::MissingArgument)
+    end
+    it "fails if -c is given" do
+      lambda {
+        subject.send :parse_options, %w{-c} 
+      }.should raise_error(OptionParser::InvalidOption)
+    end
+  end
+  
+  context "when critical is specified" do
+    subject do
+      Class::new do
+        include NagiosCheck
+        enable_critical
+      end.new
+    end
+
+    it("works with no arguments"){ subject.send :parse_options, %w{} }
+    specify { subject.send :parse_options, %w{-c 10} }
+   
+    it "fails if -c has no argument" do
+      lambda {
+        subject.send :parse_options, %w{-c} 
+      }.should raise_error(OptionParser::MissingArgument)
+    end
+   
+    it "fails if -w is given" do
+      lambda {
+        subject.send :parse_options, %w{-w} 
+      }.should raise_error(OptionParser::InvalidOption)
+    end
+  end
+  
+  context "when a non mandatory option is specified" do
+    subject do
+      Class::new do
+        include NagiosCheck
+        on "-a VALUE", &store(:a)
+        on "-b VALUE", &store(:b, transform: :to_i)
+      end.new
+    end
+
+    it("works with no arguments"){ subject.send :parse_options, %w{} }
+
+    it "works with '-a 10'" do
+      subject.send :parse_options, %w{-a 10}
+      subject.options.a.should == "10"
+    end   
+    
+    it "works with '-b 20' and converts to int" do
+      subject.send :parse_options, %w{-b 20}
+      subject.options.b.should == 20
+    end   
+
+    it "fails if -a has no argument" do
+      lambda {
+        subject.send :parse_options, %w{-a} 
+      }.should raise_error(OptionParser::MissingArgument)
+    end
+   
+    it "fails if -w is given" do
+      lambda {
+        subject.send :parse_options, %w{-w} 
+      }.should raise_error(OptionParser::InvalidOption)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nagios_check
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-22 00:00:00.000000000Z
+date: 2011-11-30 00:00:00.000000000Z
 dependencies: []
 description: An easy to use DSL for building custom probes for the Nagios monitoring
   system
@@ -22,13 +22,14 @@ files:
 - .gitignore
 - Gemfile
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - lib/nagios_check.rb
 - lib/nagios_check/range.rb
 - lib/nagios_check/version.rb
 - nagios_check.gemspec
 - spec/finish_spec.rb
+- spec/options_spec.rb
 - spec/range_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/dbroeglin/nagios_check
@@ -57,5 +58,6 @@ specification_version: 3
 summary: Ruby Nagios Check Integration
 test_files:
 - spec/finish_spec.rb
+- spec/options_spec.rb
 - spec/range_spec.rb
 - spec/spec_helper.rb

data/README.rdoc

@@ -1,22 +0,0 @@
-= 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]