steto 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*~
+coverage/
+README.html

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in steto.gemspec
+gemspec
+
+gem 'guard'
+gem 'guard-rspec'
+
+# gem 'cocaine', :path => "~/share/projects/tryphon.org/cocaine"

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/License.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 20012 Alban Peignier, Florent Peyraud, Tryphon
+
+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.textile

@@ -0,0 +1,53 @@
+h1. Steto
+
+Steto is a simple to check system status.
+
+This first release can :
+
+* use Nagios plugin
+* define a check with a simple block
+* configure via an extensible DSL
+* run checks with several threads
+* report via several customizable Reporters
+
+h2. Sample
+
+<pre>
+require 'steto'
+
+Steto.config do
+  # complete syntax
+  check :load, Steto::NagiosCheck, :command => "/usr/lib/nagios/plugins/check_load", :options => { :warning => "1,0.5,0.5", :critical => "1,1,1"} 
+
+  # shortcut for nagios
+  nagios :disk_space, "check_disk", :warning => "10%"
+
+  # make your helpers
+  def ping(host)
+    nagios "ping_#{host.split('.')[1]}", "check_ping", :hostname => host, :warning => "100,1%", :critical => "300,20%", :use_ipv4 => true
+  end
+
+  ping "www.google.com" 
+  ping "stream.tryphon.eu"
+
+  def process(name)
+    nagios "process_#{name}", "check_procs", :critical => "1:", :command => name
+  end
+
+  process "apache2"
+  process "icecast2"
+  
+  # check in one line
+  check :if_link do
+    `sudo /sbin/ethtool eth2` =~ /Link detected: yes/ ? :ok : :critical
+  end
+
+  # load external files
+  Dir["/etc/steto/**/*.rb")].each { |f| load f }
+
+  report Steto::LoggerReporter
+  report Steto::BeepReporter
+end
+
+Steto.default_engine.check.report
+</pre>

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.rcov = true
+  t.rcov_opts = %w{--exclude osx\/objc,gems\/,spec\/}
+end
+
+task :readme do
+  require 'RedCloth'
+  File.open("README.html","w") do |f|
+    f.write RedCloth.new(IO.read("README.textile")).to_html
+  end
+end

data/config-sample.rb

@@ -0,0 +1,16 @@
+Steto::config do
+  register :proc, NagiosCheck, :plugin => "/usr/lib/nagios/plugins/check_procs" do |attributes|
+    { :warning => "1:1", :critical => "1:1" }.merge attributes
+  end 
+
+  check :proc, :command => "caed"
+  check :proc, :command => "rdcatchd"
+  check :proc, :command => "ripcd"
+
+  notifier :beep, :if => Proc.new { |set| set.any? { |c| c.status.nok? } } do |checkers|
+    system "beep -d 1000 -r 15" 
+  end
+  notifier :email, EmailNotifier, :to => "root@...", :if => &:critical?
+  notifier :syslog, SyslogNotifier
+end
+

data/lib/steto/base_check.rb

@@ -0,0 +1,28 @@
+module Steto
+  class BaseCheck
+    attr_accessor :name
+
+    def attributes=(attributes = {})
+      attributes.each { |k,v| send "#{k}=", v }
+    end
+
+    def check_if_needed
+      check unless @status
+    end
+
+    def status
+      check_if_needed
+      @status
+    end
+
+    def status=(status)
+      @status = Status.new status
+    end
+
+    attr_accessor :text
+    def text
+      check_if_needed
+      @text
+    end
+  end
+end

data/lib/steto/beep_reporter.rb

@@ -0,0 +1,15 @@
+module Steto
+  class BeepReporter
+    def report(checks)
+      if checks.any? { |c| c.status.critical? }
+        beep 2
+      elsif checks.any? { |c| c.status.warning? }
+        beep
+      end
+    end
+
+    def beep(count = 1)
+      system "beep -r #{count}"
+    end
+  end
+end

data/lib/steto/cocaine_ext.rb

@@ -0,0 +1,19 @@
+require 'cocaine/command_line'
+
+module Cocaine
+  class CommandLine
+
+    attr_reader :exit_status
+
+    alias_method :run_without_exit_status, :run
+    def run_with_exit_status
+      begin
+        run_without_exit_status
+      ensure
+        @exit_status = $?.exitstatus
+      end
+    end
+    alias_method :run, :run_with_exit_status
+
+  end
+end

data/lib/steto/config.rb

@@ -0,0 +1,39 @@
+module Steto
+  class Config
+    attr_accessor :engine
+
+    def initialize(engine)
+      @engine = engine
+    end
+
+    def configure(&block)
+      instance_eval &block
+    end
+
+    def check(name, check_class = nil, attributes = {}, &block)
+      name = name.to_sym
+      check =
+        if check_class
+          check_class.new attributes.merge(:name => name)
+        else
+          ProcCheck.new :name => name, &block
+        end
+      engine.checks << check
+    end
+
+    def nagios(name, command, options = {})
+      check name, Steto::NagiosCheck, :command => "/usr/lib/nagios/plugins/#{command}", :options => options
+    end
+
+    def report(reporter_class = nil, &block)
+      reporter =
+        if reporter_class
+          reporter_class.new
+        else
+          ProcReporter.new &block
+        end
+      engine.reporters << reporter
+    end
+    
+  end
+end

data/lib/steto/engine.rb

@@ -0,0 +1,37 @@
+require 'logger'
+require 'parallel'
+
+module Steto
+  class Engine
+    attr_reader :checks, :reporters
+
+    def initialize
+      @checks = []
+      @reporters = []
+    end
+
+    def config(&block)
+      @config ||= Config.new(self)
+      @config.configure(&block) if block_given?
+      @config
+    end
+
+    def check
+      Parallel.each(checks, :in_threads => 4) do |check|
+        check.check
+      end
+      self
+    end
+
+    def report(reporter = nil)
+      if reporter
+        reporter.report(checks)
+      else
+        reporters.each do |reporter|
+          report reporter
+        end
+      end
+      self
+    end
+  end
+end

data/lib/steto/logger_reporter.rb

@@ -0,0 +1,28 @@
+module Steto
+  class LoggerReporter
+    attr_accessor :logger
+
+    def logger
+      @logger ||= Logger.new($stderr)
+    end
+
+    def report(checks)
+      checks.each do |check|
+        level = 
+          case check.status
+          when "warning"
+            :warn 
+          when /critical|unknown/
+            :error
+          else
+            :debug
+          end
+
+        message = "#{check.name} is #{check.status}"
+        message += ": #{check.text}" if check.text
+
+        logger.send level, message
+      end
+    end
+  end
+end

data/lib/steto/nagios_check.rb

@@ -0,0 +1,40 @@
+require 'cocaine'
+
+module Steto
+  class NagiosCheck < BaseCheck
+
+    attr_accessor :command, :options
+    
+    def initialize(attributes = {})
+      self.options = {}
+      self.attributes = attributes
+    end
+
+    def check
+      self.text = command_line.run.chomp
+      self.status = status_from_command_line
+    end
+
+    def command_line
+      # => "--critical=:critical --warning=:warning"
+      params = options.map do |option, value| 
+        option = option.to_s.gsub("_","-")
+        unless value == true
+          "--#{option}=:#{option}"
+        else
+          "--#{option}"
+        end
+      end.sort.join(' ')
+      @command_line ||= Cocaine::CommandLine.new(command, params, options.merge(:expected_outcodes => [0, 1, 2, 3]))
+    end
+
+    def status_from_command_line
+      { 0 => :ok,
+        1 => :warning,
+        2 => :critical,
+        3 => :unknown
+      }[command_line.exit_status]
+    end
+
+  end
+end

data/lib/steto/proc_check.rb

@@ -0,0 +1,13 @@
+module Steto
+  class ProcCheck < BaseCheck
+
+    def initialize(attributes = {}, &block)
+      self.attributes = attributes
+      @block = block
+    end
+
+    def check
+      self.status = @block.call
+    end
+  end
+end

data/lib/steto/proc_reporter.rb

@@ -0,0 +1,11 @@
+module Steto
+  class ProcReporter
+    def initialize(&block)
+      @block = block
+    end
+
+    def report(checks)
+      @block.call checks
+    end
+  end
+end

data/lib/steto/status.rb

@@ -0,0 +1,19 @@
+module Steto
+  class Status < String
+
+    def initialize(value)
+      super value.to_s
+    end
+
+    %w{ok warning critical unknown}.each do |state|
+      define_method("#{state}?") do 
+        to_s == state
+      end
+    end
+
+    def nok?
+      not ok?
+    end
+
+  end
+end

data/lib/steto/version.rb

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

data/lib/steto.rb

@@ -0,0 +1,26 @@
+require "steto/version"
+
+module Steto
+
+  def self.default_engine
+    @default_engine ||= Engine.new
+  end
+
+  def self.config(&block)
+    default_engine.config(&block)
+  end
+end
+
+require 'steto/cocaine_ext'
+
+require 'steto/status'
+require 'steto/base_check'
+require 'steto/nagios_check'
+require 'steto/proc_check'
+
+require 'steto/proc_reporter'
+require 'steto/logger_reporter'
+require 'steto/beep_reporter'
+
+require 'steto/engine'
+require 'steto/config'

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rspec'
+
+require 'steto' # and any other gems you need
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/spec/steto/beep_reporter_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Steto::BeepReporter do
+
+  it "should beep twice when one of checks is critical" do
+    subject.should_receive(:beep).with(2)
+    subject.report [ mock :status => Steto::Status.new(:critical) ]
+  end
+
+  it "should beep when one of checks is warning" do
+    subject.should_receive(:beep)
+    subject.report [ mock :status => Steto::Status.new(:warning) ]
+  end
+
+  it "should not beep when no check is warning or critical" do
+    subject.should_not_receive(:beep)
+    subject.report [ mock :status => Steto::Status.new(:info) ]
+  end
+
+end

data/spec/steto/config_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Steto::Config do
+
+  let(:engine) { Steto::Engine.new }
+
+  subject { Steto::Config.new(engine) }
+
+  describe "#check" do
+    
+    it "should use the given name for check" do
+      subject.check "dummy", Steto::ProcCheck
+      engine.checks.first.name.should == :dummy
+    end
+
+    it "should create a Check of given class" do
+      Steto::ProcCheck.should_receive(:new).with(:name => :dummy, :key1 => "value1")
+      subject.check "dummy", Steto::ProcCheck, :key1 => "value1"
+    end
+
+    it "should accept a block and create a ProcCheck" do
+      subject.check("dummy") {}
+      engine.checks.first.should be_an_instance_of(Steto::ProcCheck)
+    end
+
+  end
+
+  describe "#nagios" do
+    
+    it "should create Steto::NagiosCheck with given command and options" do
+      subject.should_receive(:check).with "dummy", Steto::NagiosCheck, :command => "/usr/lib/nagios/plugins/check_dummy", :options => { :key1 => "value1" }
+      subject.nagios "dummy", "check_dummy", :key1 => "value1"
+    end
+
+  end
+
+  describe "#report" do
+    
+    it "should create a Reporter of given class" do
+      subject.report Steto::ProcReporter
+      engine.reporters.first.should be_instance_of(Steto::ProcReporter)
+    end
+
+    it "should accept a block and create a ProcReporter" do
+      subject.report {}
+      engine.reporters.first.should be_instance_of(Steto::ProcReporter)
+    end
+
+  end
+
+  describe "#configure" do
+
+    it "should eval the given block" do
+      subject.should_receive(:check)
+      subject.configure do
+        check
+      end
+    end
+    
+  end
+
+end

data/spec/steto/engine_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Steto::Engine do
+
+  describe "#check" do
+
+    it "should check every check" do
+      3.times do
+        subject.checks << check = mock
+        check.should_receive :check
+      end
+      subject.check
+    end
+
+  end
+
+  describe "#config" do
+    
+    context "without block" do
+      
+      it "should return the engine Config" do
+        subject.config.engine.should == subject
+      end
+
+    end
+
+    context "with block" do
+      
+      it "should configure with block" do
+        subject.config.should_receive(:configure).and_yield
+        subject.config { }
+      end
+
+    end
+    
+  end
+
+  describe "#report" do
+
+    before(:each) do
+      subject.stub :checks => "checks"
+    end
+
+    let(:reporter) { mock } 
+    
+    context "with a reporter is given" do
+
+      it "should create report with it" do
+        reporter.should_receive(:report).with(subject.checks)
+        subject.report reporter
+      end
+                                         
+    end
+
+    context "without argument" do
+
+      it "should use all predefined reporters" do
+        subject.reporters << reporter
+        reporter.should_receive(:report).with(subject.checks)
+        subject.report
+      end
+                                 
+    end
+
+  end
+
+end

data/spec/steto/logger_reporter_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Steto::LoggerReporter do
+
+  def check(status, attributes = {})
+    attributes = { 
+      :name => "dummy", 
+      :text => "Dummy check", 
+      :status => Steto::Status.new(status) 
+    }.merge(attributes)
+
+    mock attributes
+  end
+
+  it "should log in warn the warning checks" do
+    subject.logger.should_receive(:warn)
+    subject.report [ check(:warning) ]
+  end
+
+  it "should log in error the critical checks" do
+    subject.logger.should_receive(:error)
+    subject.report [ check(:critical) ]
+  end
+
+  it "should log in debug the ok/unknown checks" do
+    subject.logger.should_receive(:debug)
+    subject.report [ check(:ok) ]
+  end
+
+  it "should include name and status in message" do
+    subject.logger.should_receive(:debug).with("dummy is ok")
+    subject.report [ check(:ok, :name => "dummy", :text => nil) ]
+  end
+
+  it "should include text when available in message" do
+    subject.logger.should_receive(:debug).with("dummy is ok: text")
+    subject.report [ check(:ok, :name => "dummy", :text => "text") ]
+  end
+
+end

data/spec/steto/nagios_check_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Steto::NagiosCheck do
+
+  describe "#status" do
+
+    it "should be ok when nagios check returns OK status" do
+      Steto::NagiosCheck.new(:command => "/usr/lib/nagios/plugins/check_dummy 0").status.should be_ok
+    end
+
+    it "should be warning when nagios check returns WARNING status" do
+      Steto::NagiosCheck.new(:command => "/usr/lib/nagios/plugins/check_dummy 1").status.should be_warning
+    end
+
+    it "should be critical when nagios check returns CRITICAL status" do
+      Steto::NagiosCheck.new(:command => "/usr/lib/nagios/plugins/check_dummy 2").status.should be_critical
+    end
+
+    it "should be unknown when nagios check returns UNKNOWN status" do
+      Steto::NagiosCheck.new(:command => "/usr/lib/nagios/plugins/check_dummy 3").status.should be_unknown
+    end
+    
+  end
+
+  describe "#text" do
+
+    it "should be text returned by nagios check" do
+      Steto::NagiosCheck.new(:command => "/usr/lib/nagios/plugins/check_dummy 0 'additionnal text'").text.should == "OK: additionnal text"
+    end
+
+  end
+
+  describe "#command_line" do
+
+    it "should use command as binary" do
+      subject.stub :command => "dummy"
+      subject.command_line.command.should == "dummy"
+    end
+
+    it "should use options as parameters" do
+      subject.stub :command => "dummy"
+      subject.stub :options => { :warning => "1,0.5,0.5", :critical => "1,1,1" }
+      subject.command_line.command.should == "dummy --critical='1,1,1' --warning='1,0.5,0.5'"
+    end
+    
+  end
+
+end

data/steto.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "steto/version"
+
+Gem::Specification.new do |s|
+  s.name        = "steto"
+  s.version     = Steto::VERSION
+  s.authors     = ["Alban Peignier", "Florent Peyraud"]
+  s.email       = ["alban@tryphon.eu", "florent@tryphon.eu"]
+  s.homepage    = "https://github.com/tryphon/steto"
+  s.summary     = %q{Check system status}
+  s.description = %q{Ruby engine to check system status (with Nagios or custom checks)}
+
+  s.rubyforge_project = "steto"
+
+  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"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rcov"
+  s.add_development_dependency "RedCloth"
+
+  s.add_runtime_dependency "cocaine"
+  s.add_runtime_dependency "parallel"
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification 
+name: steto
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alban Peignier
+- Florent Peyraud
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rspec
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rake
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: RedCloth
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: cocaine
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: parallel
+  version_requirements: *id006
+description: Ruby engine to check system status (with Nagios or custom checks)
+email: 
+- alban@tryphon.eu
+- florent@tryphon.eu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Guardfile
+- License.txt
+- README.textile
+- Rakefile
+- config-sample.rb
+- lib/steto.rb
+- lib/steto/base_check.rb
+- lib/steto/beep_reporter.rb
+- lib/steto/cocaine_ext.rb
+- lib/steto/config.rb
+- lib/steto/engine.rb
+- lib/steto/logger_reporter.rb
+- lib/steto/nagios_check.rb
+- lib/steto/proc_check.rb
+- lib/steto/proc_reporter.rb
+- lib/steto/status.rb
+- lib/steto/version.rb
+- spec/spec_helper.rb
+- spec/steto/beep_reporter_spec.rb
+- spec/steto/config_spec.rb
+- spec/steto/engine_spec.rb
+- spec/steto/logger_reporter_spec.rb
+- spec/steto/nagios_check_spec.rb
+- steto.gemspec
+homepage: https://github.com/tryphon/steto
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: steto
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Check system status
+test_files: 
+- spec/spec_helper.rb
+- spec/steto/beep_reporter_spec.rb
+- spec/steto/config_spec.rb
+- spec/steto/engine_spec.rb
+- spec/steto/logger_reporter_spec.rb
+- spec/steto/nagios_check_spec.rb