nagi 0.2.2 → 0.2.3

data/NEWS

@@ -1,3 +1,6 @@
+0.2.3: 2013-02-19
+- Added fallback option
+
 0.2.2: 2012-06-26
 - Fixed quote escaping in Utility::execute(). Again.
 

data/README.md

@@ -181,6 +181,9 @@ These describe the program, and are usually given first, if necessary.
   returning. *type* can be either `:severe` or `:all` - `:severe` will
   return the last, most severe status, and `:all` will use the most severe
   status but join all the status messages together into one.
+* `fallback` *status*, *message*: a default status to return if the check
+  doesn't explicitly return one. *status* can be `:ok`, `:warning`, `:critical`,
+  or `:unknown`.
 
 ### Command-line arguments
 

data/lib/nagi/dsl.rb

@@ -50,6 +50,16 @@ module Nagi
       return Nagi::Utility.execute(command)
     end
 
+    def fallback(status, message)
+      @plugin.fallback = case status
+        when :ok then Nagi::Status::OK.new(message)
+        when :warning then Nagi::Status::Warning.new(message)
+        when :critical then Nagi::Status::Critical.new(message)
+        when :unknown then Nagi::Status::Unknown.new(message)
+        else raise "Unknown fallback status #{status}"
+      end
+    end
+
     def name(name)
       @plugin.name = name
     end

data/lib/nagi/plugin.rb

@@ -1,6 +1,6 @@
 module Nagi
   class Plugin
-    attr_accessor :name, :optionparser, :prefix, :version
+    attr_accessor :fallback, :name, :optionparser, :prefix, :version
 
     def initialize
       @optionparser = Nagi::OptionParser.new
@@ -22,8 +22,8 @@ module Nagi
       rescue StandardError => e
         status = Nagi::Status::Unknown.new(e.message)
       end
-      if not status.is_a?Nagi::Status::Status
-        status = Nagi::Status::Unknown.new('Check did not provide a status')
+      unless status.is_a?Nagi::Status::Status
+      status = @fallback || Nagi::Status::Unknown.new('Check did not provide a status')
       end
       return status
     end

data/lib/nagi/version.rb

@@ -1,3 +1,3 @@
 module Nagi
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/spec/nagi/dsl_spec.rb

@@ -120,6 +120,18 @@ describe Nagi::DSL do
     end
   end
 
+  describe '.fallback' do
+    it 'sets plugin fallback' do
+      @dsl.fallback(:ok, 'Fallback')
+      @dsl.plugin.fallback.class.should eq Nagi::Status::OK
+      @dsl.plugin.fallback.message.should eq 'Fallback'
+    end
+
+    it 'raises exception on unknown status' do
+      lambda{ @dsl.fallback(:invalid, 'Invalid') }.should raise_error
+    end
+  end
+
   describe '.name' do
     it 'sets plugin name' do
       @dsl.name('name')

data/spec/nagi/plugin_spec.rb

@@ -5,6 +5,13 @@ describe Nagi::Plugin do
     @plugin = Nagi::Plugin.new
   end
 
+  describe '#fallback' do
+    it 'sets fallback' do
+      @plugin.fallback = 'test'
+      @plugin.fallback.should eq 'test'
+    end
+  end
+
   describe '#optionparser' do
     it 'contains OptionParser' do
       @plugin.optionparser.class.should eq Nagi::OptionParser
@@ -70,6 +77,25 @@ describe Nagi::Plugin do
       @plugin.run([]).class.should eq Nagi::Status::OK
     end
 
+    it 'returns check status even when fallback is set' do
+      @plugin.fallback = Nagi::Status::Unknown.new('Fallback')
+      class << @plugin
+        def check(options)
+          return Nagi::Status::OK.new('ok')
+        end
+      end
+      @plugin.run([]).class.should eq Nagi::Status::OK
+    end
+
+    it 'returns fallback status if set and no other status' do
+      @plugin.fallback = Nagi::Status::OK.new('Fallback')
+      class << @plugin
+        def check(options)
+        end
+      end
+      @plugin.run([]).should eq @plugin.fallback
+    end
+
     it 'returns unknown status on check exception' do
       class << @plugin
         def check(options)
@@ -79,6 +105,14 @@ describe Nagi::Plugin do
       @plugin.run([]).class.should eq Nagi::Status::Unknown
     end
 
+    it 'returns unknown status if no status' do
+      class << @plugin
+        def check(options)
+        end
+      end
+      @plugin.run([]).class.should eq Nagi::Status::Unknown
+    end
+
     it 'doesnt catch errors from optionparser' do
       lambda { @plugin.run(['--invalid']) }.should raise_error ArgumentError
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nagi
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-26 00:00:00.000000000Z
+date: 2013-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70365699752920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70365699752920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70365699751780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +37,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70365699751780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A DSL for writing Nagios plugins
 email:
 - erik@bengler.no
@@ -71,15 +81,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1119432202314492190
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1119432202314492190
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A DSL for writing Nagios plugins