makesure 0.0.1

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+gem "pony", ">= 1.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.4)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    pony (1.1)
+      mail (> 2.0)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  pony (>= 1.0)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Eric Waller
+
+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.rdoc

@@ -0,0 +1,19 @@
+= makesure
+
+Description goes here.
+
+== Contributing to makesure
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Eric Waller. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+require './lib/makesure/version.rb'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "makesure"
+  gem.version = Makesure::Version::STRING
+  gem.homepage = "http://github.com/seatgeek/makesure"
+  gem.license = "MIT"
+  gem.summary = %Q{Continuous (Production) Verification: Define and Monitor Systems in Ruby}
+  gem.description = %Q{Makesure is a set of tools to define, verify and monitor systems in a unix environment. It allows you to schedule commands that constitue a system via cron (and monitors the execution of those commands), it gives you a way to verify the state of a system (and alerts you when there are problems), and it provides a simple mechanism for collecting statistics about that system.}
+  gem.email = "eric@seatgeek.com"
+  gem.authors = ["Eric Waller"]
+  gem.add_runtime_dependency 'pony', '>= 1.0'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "makesure #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/makesure

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'makesure'
+require 'optparse'
+
+cron_path = '/etc/cron.d/makesure.cron'
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: makesure [options] COMMAND"
+
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on("-c", "--cron <path to file>", "Where should makesure put its cron entries? Must be a file that will be loaded by cron") do |path|
+    cron_path = path
+  end
+
+  opts.on("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.separator ""
+  opts.separator "Commands:"
+  opts.separator "  init    Creates an initial Makesurefile"
+  opts.separator "  update  Updates cron with commands scheduled by your system definitions"
+end
+
+parser.parse!
+
+case ARGV[0]
+when 'init'
+  dir = File.expand_path(ARGV[1] || '.')
+  abort "#{dir} is not a directory" unless File.directory?(dir)
+  
+  file = "Makesurefile"
+  if File.exists?(file)
+    warn "[skip] '#{file}' already exists"
+  elsif File.exists?(file.downcase)
+    warn "[skip] '#{file.downcase}' exists, which could conflict with `#{file}'"
+  else
+    puts "[add] writing '#{file}'"
+    File.open(file, "w") do |f|
+      f.write(<<-FILE)
+# Tell makesure how to get in touch when things break
+# (hint: Makesure.alert_options are passed almost directly to Pony.mail)
+Makesure.alert_options = {
+  :to   => 'dev@example.com', # who should hear about it when something's wrong?
+  :via  => :smtp, # how should makesure send email (:smtp or :sendmail)
+  :via_options => {
+    :address              => 'smtp.gmail.com',
+    :port                 => '587',
+    :enable_starttls_auto => true,
+    :user_name            => 'user',
+    :password             => 'password',
+    :authentication       => :plain, # :plain, :login, :cram_md5, no auth by default
+    :domain               => "localhost.localdomain" # the HELO domain provided by the client to the server
+  }
+}
+
+Makesure.uid = "nobody" # what user should makesure run its tasks as (this can be set per system as well)
+
+# Tell makesure about your systems
+Dir['systems/*.rb', 'lib/systems/*.rb'].each { |sys| load(sys) }
+FILE
+    end
+  end
+when 'update'
+  Makesure.load_system_defs
+  Makesure::Cron.new(:cron_path => cron_path)
+else
+  puts parser.help
+end

data/bin/makesure-runner

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'makesure'
+require 'optparse'
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: makesure-runner [options] COMMAND"
+
+  opts.separator ""
+  opts.separator "Options:"
+
+  # opts.on("-c", "--cron <path to file>", "path to the file makesure should write your cron specs") do |path|
+  #   cron_path = path
+  # end
+
+  opts.on("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.separator ""
+  opts.separator "Commands:"
+  opts.separator "  run COMMAND        Runs the specified COMMAND and monitors its output"
+  opts.separator "  verify SYSTEM      Verfies the state of the specified SYSTEM"
+  opts.separator "  summarize SYSTEM   Collects summary data for the specified SYSTEM"
+end
+
+parser.parse!
+
+case ARGV[0]
+when 'run'
+  cmd = ARGV[1]
+  
+  Makesure.load_system_defs
+  Makesure::Runner.new(cmd).run!
+  
+when 'verify'
+  sys  = ARGV[1]
+  vrfy = ARGV[2]
+  
+  Makesure.load_system_defs
+  system = Makesure.system_with_name(sys)
+  abort "Couldn't find system: #{sys}" unless system
+  verify = system.verify_with_name(vrfy)
+  abort "Couldn't find verify: #{vrfy}" unless verify
+  
+  Makesure.log "Running verify #{sys} #{vrfy}"
+  verify.run!
+  
+when 'summarize'
+  sys  = ARGV[1]
+  smrz = ARGV[2]
+  
+  Makesure.load_system_defs
+  system = Makesure.system_with_name(sys)
+  abort "Couldn't find system: #{sys}" unless system
+  summarize = system.summarize_with_name(smrz)
+  abort "Couldn't find summarize: #{smrz}" unless summarize
+  
+  Makesure.log "Running summarize #{sys} #{smrz}"
+  summarize.run!
+  
+else
+  puts parser.help
+end
+

data/lib/makesure/cmd.rb

@@ -0,0 +1,14 @@
+module Makesure
+  
+  class Cmd
+    
+    attr_reader :cron, :command
+    
+    def initialize(cron, command)
+      @cron    = cron
+      @command = command
+    end
+    
+  end
+  
+end

data/lib/makesure/cron.rb

@@ -0,0 +1,48 @@
+module Makesure
+
+  class Cron
+    
+    # specify a file (or directory containing files) to load system specifications from
+    def initialize(opts = {})
+      opts = {
+        :cron_path => "/etc/cron.d/makesure.cron"
+      }.merge(opts)
+      
+      Makesure.log "updating '#{opts[:cron_path]}'"
+      
+      cron_file = File.expand_path(opts[:cron_path])
+      crontab = build_crontab_output
+      Makesure.debug "#{cron_file}:\n#{crontab}"
+      
+      File.open(cron_file, "w") do |f|
+        f.write(crontab)
+      end
+    end
+
+    def build_crontab_output
+      crontab = ""
+      crontab << "# Autogenerated by makesure: you probably don't want to edit this file\n"
+      Makesure.systems.each do |s|
+        uid = s.uid || Makesure.uid
+        crontab << "\n"
+        crontab << "## Tasks for '#{s.name}'\n"
+        crontab << "# Commands\n"
+        s.cmds.each do |c|
+          crontab << "#{c.cron}\t"
+          crontab << "#{uid} " if uid
+          crontab << "makesure-runner run #{c.command.inspect}\n"
+        end
+        crontab << "# Verification\n"
+        s.verifies.each do |v|
+          crontab << "#{v.cron}\t"
+          crontab << "#{uid} " if uid
+          crontab << "makesure-runner verify #{s.name} #{v.name}\n"
+        end
+        # TODO summarizes
+      end
+      crontab
+    end
+
+  end
+
+end

data/lib/makesure/runner.rb

@@ -0,0 +1,50 @@
+module Makesure
+  
+  class Runner
+    
+    attr_accessor :cmd
+    
+    def initialize(cmd, opts = {})
+      @cmd = cmd
+      @opts = {
+        :test => "val"
+      }.merge(opts)
+    end
+    
+    def run!
+      io = IO.popen(cmd)
+      Makesure.log "Running cmd '#{cmd}' with pid #{io.pid}"
+
+      Process.wait # needed to populate $?
+      # seems to grab the exitstatus of the last cmd in a chain, ie:
+      #   ls -al | grep -i file-that-exits                        # exits w/ 0
+      #   ls -al | grep -i -file-that-does-not-exist              # exits w/ 1
+      #   ls -al | grep -i -file-that-does-not-exist | echo "yay" # exits w/ 0
+      exitstatus = $?.exitstatus
+
+      Makesure.log "cmd exited with status #{exitstatus}"
+
+      output = io.read
+
+      unless exitstatus == 0
+        Makesure.warn "oh shitttt something broke, tell everybody!"
+        body = ""
+        body << "[#{Time.now.to_s}] #{cmd.inspect} [pid #{io.pid}] exited with status #{exitstatus}, output follows:\n\n"
+        body << output
+        Makesure.send_alert("ERROR in command alert: #{cmd.inspect}", body)
+      end
+
+      if output.empty?
+        Makesure.log "no output"
+      else
+        Makesure.log ">>> begin output"
+        output.each_line do |l|
+          Makesure.log l
+        end
+        Makesure.log "<<< end output"
+      end
+    end
+
+  end
+
+end

data/lib/makesure/summarize.rb

@@ -0,0 +1,32 @@
+module Makesure
+  
+  class Summarize
+    
+    attr_reader :name, :cron, :blk
+    
+    def initialize(name, cron, blk)
+      @name = name
+      @cron = cron
+      @blk  = blk
+    end
+    
+    def run!
+      begin
+        
+        blk.call
+        
+      rescue Exception => e
+        Makesure.warn "Uh oh, something's up"
+        Makesure.warn "\t" + e.message
+        
+        # send an email with the details
+        
+        return false
+      end
+      
+      true
+    end
+    
+  end
+  
+end

data/lib/makesure/system.rb

@@ -0,0 +1,46 @@
+module Makesure
+  
+  class System
+    
+    attr_reader :name, :cmds, :verifies, :summarizes
+    
+    attr_accessor :uid
+    
+    def initialize(name)
+      @name = name
+      
+      @cmds       = []
+      @verifies   = []
+      @summarizes = []
+    end
+    
+    # DSL stuff
+    
+    def schedule(cron_spec, cmd)
+      Makesure.debug("scheduling '#{cmd}' at '#{cron_spec}'")
+      @cmds << Cmd.new(cron_spec, cmd)
+    end
+    
+    def verify(name, cron_spec, &blk)
+      Makesure.debug("scheduling verify at '#{cron_spec}'")
+      @verifies << Verify.new(name, cron_spec, blk)
+    end
+    
+    def summarize(name, cron_spec, &blk)
+      Makesure.debug("scheduling summarize at '#{cron_spec}'")
+      @summarizes << Summarize.new(name, cron_spec, blk)
+    end
+    
+    # internal use
+    
+    def verify_with_name(name)
+      verifies.find { |v| v.name.to_s == name.to_s }
+    end
+    
+    def summarize_with_name(name)
+      summarizes.find { |s| s.name.to_s == name.to_s }
+    end
+    
+  end
+  
+end

data/lib/makesure/verify.rb

@@ -0,0 +1,38 @@
+module Makesure
+  
+  class Verify
+    
+    attr_reader :name, :cron, :blk
+    
+    def initialize(name, cron, blk)
+      @name = name
+      @cron = cron
+      @blk  = blk
+    end
+    
+    def run!
+      begin
+        
+        blk.call
+        
+      rescue Exception => e
+        Makesure.warn "Uh oh, something's up"
+        Makesure.warn "\t" + e.message
+        
+        # send an email with the details
+        body = ""
+        body << "[#{Time.now.to_s}] Verification failure:\n\n"
+        body << e.backtrace.join("\n")
+        Makesure.send_alert("FAILED verification alert: #{e.message}", body)
+        
+        return false
+      #else
+      #ensure
+      end
+      
+      true
+    end
+    
+  end
+  
+end

data/lib/makesure/version.rb

@@ -0,0 +1,9 @@
+module Makesure
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+
+    STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

data/lib/makesure.rb

@@ -0,0 +1,75 @@
+require 'pony'
+
+require 'makesure/runner'
+require 'makesure/cron'
+require 'makesure/system'
+require 'makesure/cmd'
+require 'makesure/verify'
+require 'makesure/summarize'
+require 'makesure/version'
+
+module Makesure
+  
+  @alert_options = {}
+  @systems = []
+  
+  extend self
+  
+  # global options
+  attr_accessor :uid,
+                :alert_options,
+                :log_level
+  
+  def load_system_defs
+    file = File.join(Dir.pwd, "Makesurefile")
+    Makesure.log("Loading #{file}")
+    load(file)
+    abort "No system specifications found" unless Makesure.systems.size > 0
+    Makesure.log "Loaded #{Makesure.systems.size} system specifications"
+    true
+  rescue Exception => e
+    if e.instance_of?(SystemExit)
+      raise
+    else
+      Makesure.warn "There was an error loading #{file}"
+      Makesure.warn "\t" + e.message
+      Makesure.warn "\t" + e.backtrace.join("\n\t")
+      false
+    end
+  end
+  
+  def system_with_name(name)
+    systems.find { |s| s.name.to_s == name.to_s }
+  end
+  
+  def send_alert(title, details = "")
+    opts = { :from => "makesure@unknown" }.merge(Makesure.alert_options)
+    Makesure.log "Sending alert to #{opts[:to]}: #{title}"
+    msg = Pony.mail(opts.merge(:subject => title, :body => details))
+  end
+  
+  # DSL stuff
+  
+  attr_reader :systems
+  
+  def system(name)
+    Makesure.debug "Reading specification for system '#{name}'"
+    s = Makesure::System.new(name)
+    yield s
+    @systems << s
+  end
+  
+  # internal utils
+  
+  def log(msg, level = :info)
+    puts "[#{Time.now.to_s}] #{level.to_s.upcase}: #{msg}"
+  end
+  
+  def warn(msg)
+    log(msg, :warn)
+  end
+  
+  def debug(msg)
+    log(msg, :debug) if log_level == :debug
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'makesure'
+
+class Test::Unit::TestCase
+end

data/test/test_makesure.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestMakesure < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification 
+name: makesure
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Eric Waller
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-24 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: pony
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: pony
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id006
+description: Makesure is a set of tools to define, verify and monitor systems in a unix environment. It allows you to schedule commands that constitue a system via cron (and monitors the execution of those commands), it gives you a way to verify the state of a system (and alerts you when there are problems), and it provides a simple mechanism for collecting statistics about that system.
+email: eric@seatgeek.com
+executables: 
+- makesure
+- makesure-runner
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .bundle/config
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- bin/makesure
+- bin/makesure-runner
+- lib/makesure.rb
+- lib/makesure/cmd.rb
+- lib/makesure/cron.rb
+- lib/makesure/runner.rb
+- lib/makesure/summarize.rb
+- lib/makesure/system.rb
+- lib/makesure/verify.rb
+- lib/makesure/version.rb
+- test/helper.rb
+- test/test_makesure.rb
+has_rdoc: true
+homepage: http://github.com/seatgeek/makesure
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -344166319
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: "Continuous (Production) Verification: Define and Monitor Systems in Ruby"
+test_files: 
+- test/helper.rb
+- test/test_makesure.rb