nagiosplugin 0.0.1

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@nagiosplugin --create

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'cucumber' do
+  watch(%r{^lib/.+$})                 { 'features' }
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})    { 'features' }
+  watch(%r{^features/steps/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Björn Albers
+
+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.md

@@ -0,0 +1,52 @@
+# NagiosPlugin
+
+NagiosPlugin is a simple framework for writing [Nagios](http://www.nagios.org/) Plugins.
+
+## Installation
+
+	`gem install nagiosplugin`
+
+## Usage
+
+Create your executable plugin (which will be called by nagios), `require "nagiosplugin"` and subclass from `NagiosPlugin::Plugin`.
+You must define the methods `critical?` and `warning?` which determine the plugin status during a check based on their boolean return value (`ok?` returns true by default but can be overwritten).
+The optional method `measure` will be called *first* on every check to take samples.
+Run `check!` on your *class* to ensure a proper plugin output (= stdout & exit status).
+
+Here's a simple example plugin named `check_u2d`:
+
+````Ruby
+#!/usr/bin/env ruby
+require 'nagiosplugin'
+
+class UnicornToDwarfRatio < NagiosPlugin::Plugin
+	def measure
+		@unicorns, @dwarves = ... # The algorithm is your homework.
+	end
+	
+	def critical?
+		@unicorns < @dwarves
+	end
+	
+	def warning?
+		@unicorns == @dwarves
+	end
+end
+
+UnicornToDwarfRatio.check!
+```
+
+Please also take a look at features to see what's going on...
+
+## Note on Patches/Pull Requests
+
+* Fork the project and run `bundle install` to resolve all development dependencies.
+* Add specs and/or features for it. This is important so I don't break it in a future version unintentionally.
+* Make your feature addition or bug fix.
+* Commit, do not mess with the Rakefile or gemspec.
+  (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.
+
+## Copyright
+
+Copyright (c) 2011 Björn Albers. See LICENSE for details.

data/Rakefile

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

data/features/plugin_output.feature

@@ -0,0 +1,72 @@
+Feature: Plugin Output
+
+	In order to comply with official nagios plugin development guidelines
+	As a sysadmin building my own nagios plugins
+	I want to return a nagios compatible plugin output
+
+	Scenario Outline: CRITICAL, WARNING and OK
+		Given a file named "check_foo" with:
+			"""
+			require 'nagiosplugin'
+			class Foo < NagiosPlugin::Plugin
+	      def critical?;	<crit>	end
+	      def warning?;		<warn>	end
+	    end
+			Foo.check!
+			"""
+		When I run `ruby check_foo`
+		Then the exit status should be <code>
+		And the stdout should contain:
+			"""
+			FOO <status>
+			
+			"""
+		Examples:
+		 | crit  | warn  | code | status   |
+		 | true  | true  | 2    | CRITICAL |
+		 | true  | false | 2    | CRITICAL |
+		 | false | true  | 1    | WARNING  |
+		 | false | false | 0    | OK       |
+
+	Scenario Outline: UNKNOWN when all status checks return false
+		Given a file named "check_bar" with:
+			"""
+			require 'nagiosplugin'
+			class Bar < NagiosPlugin::Plugin
+  		  def critical?;	false		end
+  		  def warning?;		false		end
+				def ok?;				<ok>		end
+  		end
+			Bar.check!
+			"""
+		When I run `ruby check_bar`
+		Then the exit status should be <code>
+		# And the stdout should contain exactly:
+		And the stdout should contain:
+			"""
+			BAR <status>
+			
+			"""
+		Examples:
+		 | ok    | code | status                                     |
+		 | true  | 0    | OK                                         |
+		 | false | 3    | UNKNOWN                                    |
+		 # | false | 3    | UNKNOWN: All status checks returned false! |
+
+	Scenario: UNKNOWN when an exception was raised
+		Given a file named "check_baz" with:
+			"""
+			require 'nagiosplugin'
+			class Baz < NagiosPlugin::Plugin
+				def critical?
+					raise "OOPS!"
+				end
+			end
+			Baz.check!
+			"""
+		When I run `ruby check_baz`
+		Then the exit status should be 3
+		And the stdout should contain:
+			"""
+			BAZ UNKNOWN
+			"""

data/features/support/env.rb

@@ -0,0 +1 @@
+require "aruba/cucumber"

data/lib/nagiosplugin.rb

@@ -0,0 +1,2 @@
+require "nagiosplugin/version"
+require "nagiosplugin/plugin"

data/lib/nagiosplugin/plugin.rb

@@ -0,0 +1,51 @@
+module NagiosPlugin
+  EXIT_CODES = {
+    :ok       => 0,
+    :warning  => 1,
+    :critical => 2,
+    :unknown  => 3,
+  }
+  
+  class Plugin
+    def initialize
+      @status = :unknown
+    end
+    
+    def self.check!
+      plugin = self.new
+      plugin.check
+    ensure
+      puts plugin.message
+      exit plugin.code
+    end
+    
+    def check
+      measure if respond_to?(:measure)
+      @status = [:critical, :warning, :ok].select { |s| send("#{s}?") }.first
+      raise if @status.nil?
+    rescue
+      @status = :unknown
+      raise
+    end
+    
+    def message
+      "#{service} #{status}"
+    end
+    
+    def service
+      self.class.name.upcase
+    end
+    
+    def status
+      @status.upcase
+    end
+    
+    def code
+      EXIT_CODES[@status]
+    end
+    
+    def ok?
+      true
+    end
+  end
+end

data/lib/nagiosplugin/version.rb

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

data/nagiosplugin.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "nagiosplugin/version"
+
+Gem::Specification.new do |s|
+  s.name        = "nagiosplugin"
+  s.version     = NagiosPlugin::VERSION
+  s.authors     = ["Björn Albers"]
+  s.email       = ["bjoernalbers@googlemail.com"]
+  s.homepage    = "https://github.com/bjoernalbers/nagiosplugin"
+  s.summary     = "#{s.name}-#{s.version}"
+  s.description = "Yet another framework for writing Nagios Plugins"
+
+  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"]
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "cucumber"
+  s.add_development_dependency "aruba"
+  s.add_development_dependency 'guard-cucumber'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: nagiosplugin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Björn Albers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70231877033500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70231877033500
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &70231877022080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70231877022080
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &70231877021460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70231877021460
+- !ruby/object:Gem::Dependency
+  name: guard-cucumber
+  requirement: &70231877020820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70231877020820
+description: Yet another framework for writing Nagios Plugins
+email:
+- bjoernalbers@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- features/plugin_output.feature
+- features/support/env.rb
+- lib/nagiosplugin.rb
+- lib/nagiosplugin/plugin.rb
+- lib/nagiosplugin/version.rb
+- nagiosplugin.gemspec
+homepage: https://github.com/bjoernalbers/nagiosplugin
+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: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: nagiosplugin-0.0.1
+test_files:
+- features/plugin_output.feature
+- features/support/env.rb