nagi 0.2.0 → 0.2.1

data/NEWS

@@ -1,3 +1,6 @@
+0.2.1: 2012-05-31
+- Added force parameter for DSL status methods
+
 0.2.0: 2012-05-31
 - Added support for collecting multiple statuses during check
 

data/README.md

@@ -121,6 +121,10 @@ is given. It can be set to either `:severe`, in which case the most severe
 status will be returned at the end, or `:all` which will use the most severe
 status code but also combine all status messages into one.
 
+However, one can still force a status to return from the check, and ignore
+the collected statues, by setting the second parameter (`force`) to `true`
+for the status methods.
+
 This example checks used space on all disk drives, and returns critical if
 any of the drives are above a threshold:
 
@@ -136,7 +140,12 @@ Nagi do
   collect :all
 
   check do |args|
-    execute('df').lines.each do |line|
+		begin
+			output = execute('df')
+		rescue StandardError => e
+			critical "df failed: #{e.message}", true
+		end
+    output.lines.each do |line|
       if line =~ /^.*?(\d+)%\s*(.*)$/
         if $1.to_i > args[:percentage].to_i
           critical "#{$2} #{$1}% used"
@@ -193,14 +202,16 @@ parsed command-line arguments as a hash. It should use one of the methods `ok`,
 or the block raises an unhandled exception, an Unknown status will be returned.
 
 The `collect` setting (see above) can be used to collect statuses and continue
-the check, rather than returning the first status encountered.
+the check, rather than returning the first status encountered. However, if
+`true` is passed as the second parameter of the status method, it will
+return the status regardless of the `collect` setting.
 
 * `check` *block*: the code block the the check. Parsed command-line arguments
   are passed as a hash.
-* `ok` *message*: returns an OK status.
-* `warning` *message*: returns a Warning status.
-* `critical` *message*: returns a Critical status.
-* `unknown` *message*: returns an Unknown status.
+* `ok` *message*, *force=false*: returns an OK status.
+* `warning` *message*, *force=false*: returns a Warning status.
+* `critical` *message*, *force=false*: returns a Critical status.
+* `unknown` *message*, *force=false*: returns an Unknown status.
 * `execute` *command*: executes a shell command, and returns any output (both
   stdout and stderr). If the command exits with a non-zero status, it will
   throw an exception. The shell is set to use the `pipefail` option, so non-zero

data/lib/nagi/dsl.rb

@@ -39,9 +39,9 @@ module Nagi
       @collect = type
     end
 
-    def critical(message)
+    def critical(message, force=false)
       status = Nagi::Status::Critical.new(message)
-      throw :status, status unless @collect
+      throw :status, status if force or not @collect
       @collected.push(status)
       return status
     end
@@ -54,9 +54,9 @@ module Nagi
       @plugin.name = name
     end
 
-    def ok(message)
+    def ok(message, force=false)
       status = Nagi::Status::OK.new(message)
-      throw :status, status unless @collect
+      throw :status, status if force or not @collect
       @collected.push(status)
       return status
     end
@@ -69,9 +69,9 @@ module Nagi
       @plugin.optionparser.switch(name, *args)
     end
 
-    def unknown(message)
+    def unknown(message, force=false)
       status = Nagi::Status::Unknown.new(message)
-      throw :status, status unless @collect
+      throw :status, status if force or not @collect
       @collected.push(status)
       return status
     end
@@ -80,9 +80,9 @@ module Nagi
       @plugin.version = version
     end
 
-    def warning(message)
+    def warning(message, force=false)
       status = Nagi::Status::Warning.new(message)
-      throw :status, status unless @collect
+      throw :status, status if force or not @collect
       @collected.push(status)
       return status
     end

data/lib/nagi/version.rb

@@ -1,3 +1,3 @@
 module Nagi
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/spec/nagi/dsl_spec.rb

@@ -96,6 +96,7 @@ describe Nagi::DSL do
     it 'throws :status with critical status' do
       catch(:status) do
         @dsl.critical('message')
+        nil
       end.class.should eq Nagi::Status::Critical
     end
 
@@ -103,6 +104,14 @@ describe Nagi::DSL do
       @dsl.collect(:all)
       @dsl.critical('message').class.should eq Nagi::Status::Critical
     end
+
+    it 'throws :status when collection is enabled if forced' do
+      @dsl.collect(:all)
+      catch(:status) do
+        @dsl.critical('message', true)
+        nil
+      end.class.should eq Nagi::Status::Critical
+    end
   end
 
   describe '.execute' do
@@ -122,6 +131,7 @@ describe Nagi::DSL do
     it 'throws :status with ok status' do
       catch(:status) do
         @dsl.ok('message')
+        nil
       end.class.should eq Nagi::Status::OK
     end
 
@@ -129,6 +139,14 @@ describe Nagi::DSL do
       @dsl.collect(:all)
       @dsl.ok('message').class.should eq Nagi::Status::OK
     end
+
+    it 'throws :status when collection is enabled if forced' do
+      @dsl.collect(:all)
+      catch(:status) do
+        @dsl.ok('message', true)
+        nil
+      end.class.should eq Nagi::Status::OK
+    end
   end
 
   describe '.prefix' do
@@ -150,6 +168,7 @@ describe Nagi::DSL do
     it 'throws :status with unknown status' do
       catch(:status) do
         @dsl.unknown('message')
+        nil
       end.class.should eq Nagi::Status::Unknown
     end
 
@@ -157,6 +176,14 @@ describe Nagi::DSL do
       @dsl.collect(:all)
       @dsl.unknown('message').class.should eq Nagi::Status::Unknown
     end
+
+    it 'throws :status when collection is enabled if forced' do
+      @dsl.collect(:all)
+      catch(:status) do
+        @dsl.unknown('message', true)
+        nil
+      end.class.should eq Nagi::Status::Unknown
+    end
   end
 
   describe '.version' do
@@ -170,6 +197,7 @@ describe Nagi::DSL do
     it 'throws :status with warning status' do
       catch(:status) do
         @dsl.warning('message')
+        nil
       end.class.should eq Nagi::Status::Warning
     end
 
@@ -177,5 +205,13 @@ describe Nagi::DSL do
       @dsl.collect(:all)
       @dsl.warning('message').class.should eq Nagi::Status::Warning
     end
+
+    it 'throws :status when collection is enabled if forced' do
+      @dsl.collect(:all)
+      catch(:status) do
+        @dsl.warning('message', true)
+        nil
+      end.class.should eq Nagi::Status::Warning
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nagi
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-31 00:00:00.000000000Z
+date: 2012-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70342039915540 !ruby/object:Gem::Requirement
+  requirement: &70118921103600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70342039915540
+  version_requirements: *70118921103600
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70342039911220 !ruby/object:Gem::Requirement
+  requirement: &70118921102940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70342039911220
+  version_requirements: *70118921102940
 description: A DSL for writing Nagios plugins
 email:
 - erik@bengler.no
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A DSL for writing Nagios plugins