mhs-immortalize 0.2.5

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 BehindLogic
+
+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,17 @@
+= immortalize
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (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) 2010 BehindLogic. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mhs-immortalize"
+    gem.summary = %Q{Restarts a specified process if it dies.}
+    gem.description = %Q{Watch a specific process, restart it if it dies.}
+    gem.email = "humans+rubygems@mutuallyhuman.com"
+    gem.homepage = "http://github.com/mhs/immortalize"
+    gem.authors = ["Mutually Human Software", "BehindLogic"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "immortalize #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.5

data/bin/immortalize

@@ -0,0 +1,350 @@
+#!/usr/bin/env ruby
+
+# Usage:
+#   immortalize run "command --with-args --etc"
+#   immortalize remove "command --with-args --etc"
+#   immortalize inspect
+#   immortalize # << run this from a cron job every minute to check and restart failed processes. 
+#   * starts process
+#   * logs the start command with pid
+#   * when run from cron (without args), check all logged start commands and currently logged pid to see if it's running
+#     * if not running, immediately remove pid from log, but leave command; start process again via: immortalize "command --with-args --etc"
+require 'time'
+require 'yaml'
+require 'sha1'
+require 'ftools'
+require 'optparse'
+$options = {}
+
+require 'rubygems'
+require 'merb-core'
+require 'merb-mailer'
+Merb::Mailer.delivery_method = :sendmail
+
+optparse = OptionParser.new do |opts|
+  opts.banner = <<-ENDBANNER
+Usage: #{$0} [run|remove|inspect] [options]
+
+To add (and start) a command:
+#{$0} run "command" --notify admin@email.com --max_failures 5
+To change a command's options, just re-add it.
+You can group commands by adding a --group option, which allows
+you to perform future actions on all commands in the group.
+
+To stop a daemon:
+#{$0} stop "command"
+#{$0} stop 1 # <- 1 is an index as in 'immortalize list' below
+#{$0} stop all
+
+To remove a command:
+#{$0} remove "command"
+#{$0} remove 1 # <- 1 is an index as in 'immortalize list' below
+#{$0} remove all
+
+To inspect the current list of immortal commands:
+#{$0} list
+
+To install the immortalize cron job (which does the actual work):
+immortalize setup
+
+Run this command with no arguments as a cron job, to run every minute:
+* * * * * immortalize
+
+Options:
+ENDBANNER
+
+  $options[:notify] = nil
+  opts.on( '--notify EMAIL', "The email address to which failure notifications should be sent." ) do |email|
+    $options[:notify] = email
+  end
+
+  $options[:max_failures] = 5
+  opts.on('--max_failures NUM', "Notify on NUM or more failures within an hour (default 5)") do |num|
+    $options[:max_failures] = num.to_i
+  end
+
+  $options[:group] = nil
+  opts.on('--group GROUP', "Set the group of immortal commands that this command belongs to.") do |group|
+    $options[:group] = group
+  end
+
+  $log_location = "#{ENV['HOME']}/.immortalize"
+  opts.on('--log-location PATH', "Manually set the location for immortalize to keep its registry and cron.log (default #{$log_location})") do |path|
+    if !File.directory?(path)
+      warn "`#{path}' is not a valid path."
+      exit 1
+    end
+    $log_location = path
+  end
+
+  opts.on( '-h', '--help', 'Display this screen' ) do
+    puts opts
+    exit
+  end
+end
+optparse.parse!
+
+
+`mkdir -p "#{$log_location}"` unless File.directory?($log_location)
+$registry_filename = "#{$log_location}/registry.yaml"
+File.open($registry_filename, 'w'){|f| f << {}.to_yaml} unless File.exists?($registry_filename)
+unless $registry = YAML.load_file($registry_filename)
+  File.open($registry_filename, 'w'){|f| f << {}.to_yaml}
+  $registry = {}
+end
+
+$action = ARGV[0]
+
+def notify(immortal, message)
+  m = Merb::Mailer.new(
+    :to      => immortal[:notify],
+    :from    => "immortalize@video.iremix.org",
+    :subject => "ImmortalCommand `#{immortal[:command]}' keeps dying!",
+    :text    => message
+  )
+  m.deliver!
+end
+
+class Time
+  def beginning_of_day
+    Time.mktime(year, month, day).send(gmt? ? :gmt : :localtime)
+  end
+end
+
+class Immortal
+  def self.new(identifier)
+    if $registry[identifier]
+      obj = allocate
+      obj.send :initialize, identifier
+      obj
+    else
+      puts "tried:\n\t#{identifier}commands:\n\t#{$registry.values.map {|r| r[:command]}.join("\n\t")}"
+    end
+  end
+
+  def self.in_group(group)
+    $registry.select {|k,i| i[:group] == group}.collect { |k,i| new(k) }
+  end
+
+  attr_reader :identifier
+  def initialize(identifier)
+    @identifier = identifier
+    @reg = $registry[identifier]
+  end
+
+  def [](key)
+    @reg[key]
+  end
+
+  def running?
+    @reg[:pid] && `ps #{@reg[:pid]} | grep "#{@reg[:pid]}" | grep -v "grep"` =~ /#{@reg[:pid]}/
+  end
+
+  def failures
+    @failures ||= File.exists?(failure_log_file) ? File.readlines(failure_log_file).map {|t| Time.parse(t) } : []
+  end
+
+  def start!
+    # Run the command and gather the pid
+    pid = nil
+    open("|#{@reg[:command]} 1>/dev/null & echo $!") do |f|
+      pid = f.sysread(5).chomp.to_i
+    end
+    # Log the pid
+    puts "pid #{pid}"
+    $registry[identifier][:pid] = pid
+  end
+  def stop!
+    if running?
+      pid = $registry[identifier].delete(:pid)
+      `kill -TERM #{pid}`
+      puts "attempted to kill pid #{pid}: \"#{@reg[:command]}\""
+    else
+      warn "\"#{@reg[:command]}\" not running!"
+      false
+    end
+  end
+
+  def failed!
+    failures << Time.now
+    File.open(failure_log_file, 'a') do |log|
+      log << "#{Time.now}\n"
+    end
+  end
+
+  def frequent_failures?
+    # If it failed :max_failures times or more within the last hour.
+    failures.length >= self[:max_failures] && failures[0-self[:max_failures]] > Time.now - 3600
+  end
+  def failures_today
+    failures.select {|f| f > Time.now.beginning_of_day}
+  end
+  def failures_this_hour
+    failures_today.select {|f| f > Time.now - 3600}
+  end
+
+  def inspect
+    self[:command] + (" (group=#{self[:group]})" if self[:group]).to_s + (failures.length >= self[:max_failures].to_i ? "\n\tLast #{self[:max_failures]} failures: #{failures[-5..1].join(", ")}" : '')
+  end
+
+  private
+  def failure_log_file
+    "#{$log_location}/#{@identifier}"
+  end
+end
+
+# Curate the command string
+$command_string = nil
+if ARGV[1].to_s.length > 1 && ARGV[1] !~ /^\d+$/ && ARGV[1] != 'all'
+  $command_string = ARGV[1]
+  # Complain about the string if it does not have proper output redirections
+  cmds = $command_string.split(/; ?/)
+  last_cmd = cmds.pop
+  lst,out_s = last_cmd.split(/(?: \d)? ?>/,2)
+  cmds << lst
+  outs = last_cmd.scan(/(?: \d)? ?>>? ?\S+/)
+  outs = outs.map {|o| o.sub(/^ ?(>>)? ?/,"\\1").sub(/^>/,"1>").sub(/^ /,'') }
+  unless outs.any? {|o| o =~ /^2>/}
+    warn "Appending default STDERR redirection: 2>&1 (STDERR > STDOUT)"
+    outs << "2>&1"
+  end
+  unless outs.any? {|o| o =~ /^1>/}
+    warn "#{$command_string}\nInvalid command: You need to add proper STDOUT redirection, ex: >/dev/null or 1>log/run.log"
+    exit
+  end
+  $command_string = cmds.join('; ') + ' ' + outs.join(' ')
+end
+
+
+# Main logic
+unless ::Object.const_defined?(:IRB)
+  case $action
+  when 'setup'
+    crons = `crontab -l 2>/dev/null`.split(/\n/)
+    crons.reject! {|c| c =~ /immortalize.*>?> #{$log_location}\/cron.log/}
+    crons << "* * * * * #{$0} --log-location=\"#{$log_location}\" >> #{$log_location}/cron.log 2>&1\n"
+    puts "Installing crons:\n\t#{crons.join("\n\t")}"
+    f = IO.popen("crontab -", 'w')
+    f << crons.join("\n")
+    f.close
+    crons = `crontab -l 2>/dev/null`.split(/\n/)
+    puts "Installed crons:\n\t#{crons.join("\n\t")}"
+  when 'list'
+    # puts $registry.inspect
+    puts "Immortalized:"
+    keys = $registry.keys.sort
+    keys.each_with_index do |identifier,i|
+      puts "\t#{i+1}) " + Immortal.new(identifier).inspect
+    end
+    puts "\nTo remove jobs, for example job #1, from this list, run `immortalize remove 1`"
+    exit
+
+  when 'stop'
+    if ARGV[1] =~ /^\d+$/
+      identifier = $registry.keys.sort[ARGV[1].to_i-1]
+      immortal = Immortal.new(identifier)
+      immortal.stop!
+    elsif ARGV[1] == 'all'
+      $registry.keys.each do |identifier|
+        immortal = Immortal.new(identifier)
+        immortal.stop!
+      end
+    else
+      if $command_string
+        identifier = SHA1.hexdigest($command_string)
+        immortal = Immortal.new(identifier)
+        immortal.stop!
+      elsif $options[:group]
+        Immortal.in_group($options[:group]).each do |immortal|
+          immortal.stop!
+        end
+      end
+    end
+    
+  when 'run'
+    if $options[:notify].nil?
+      warn "Must include --notify EMAIL_ADDRESS when adding a command!"
+      exit
+    end
+
+    # Running with a given command.
+    identifier = SHA1.hexdigest($command_string)
+
+    # Create the command
+    $registry[identifier] ||= {
+      :command => $command_string,
+      :group => $options[:group]
+    }
+    $registry[identifier].merge!($options)
+
+    immortal = Immortal.new(identifier)
+    # Start the process if it isn't already running
+    if immortal.running?
+      puts "`#{immortal[:command]}' is already running with pid #{immortal[:pid]}"
+    else
+      print "Starting `#{immortal[:command]}'... "
+      immortal.start!
+    end
+
+  when 'remove'
+    if ARGV[1] =~ /^\d+$/
+      identifier = $registry.keys.sort[ARGV[1].to_i-1]
+      reg = $registry.delete(identifier)
+      puts "Deleted #{identifier}: \"#{reg[:command]}\""
+    elsif ARGV[1] == 'all'
+      $registry.keys.each do |identifier|
+        reg = $registry.delete(identifier)
+        puts "Deleted #{identifier}: \"#{reg[:command]}\""
+      end
+    else
+      if $command_string
+        identifier = SHA1.hexdigest($command_string)
+        reg = $registry.delete(identifier)
+        puts "Deleted #{identifier}: \"#{reg[:command]}\""
+      elsif $options[:group]
+        Immortal.in_group($options[:group]).each do |immortal|
+          reg = $registry.delete(immortal.identifier)
+          puts "Deleted #{immortal.identifier}: \"#{reg[:command]}\""
+        end
+      end
+    end
+
+  when nil
+    # Running bare from cron.
+    # Check all logged commands with pids.
+    puts "[#{Time.now.strftime("%Y-%m-%d %H:%M:%S")}] #{$registry.length} jobs"
+    $registry.keys.sort.each_with_index do |identifier,i|
+      immortal = Immortal.new(identifier)
+    
+      # Check if running
+      if immortal.running?
+        # puts "  #{i+1}) `#{immortal[:command]}' is running fine..."
+      else
+        puts "  #{i+1}) `#{immortal[:command]}' HAS DIED! Reviving..."
+        # Mark the failure
+        immortal.failed!
+        # Notify if failures have been frequent
+        if immortal.frequent_failures?
+          puts "  #{i+1}) FREQUENT FAILURE ON #{identifier} (`#{immortal[:command]}')"
+          notify(immortal, "ImmortalCommand failure!\n\nCommand `#{immortal[:command]}' failed at #{Time.now}, threshold is #{immortal[:max_failures]} / hour.\n\n#{immortal.failures_today.size} failures so far today, #{immortal.failures_this_hour.size} in the past hour.")
+        end
+        # Start it
+        immortal.start!
+      end
+    end
+  else
+    puts optparse
+  end
+end
+
+# Save the registry
+File.open("#{$log_location}/registry.yaml~", 'w') do |r|
+  r << $registry.to_yaml
+end
+# Swap files back out IF registry was written correctly.
+if File.read("#{$log_location}/registry.yaml~") == $registry.to_yaml
+  File.delete("#{$log_location}/registry.yaml")
+  File.move("#{$log_location}/registry.yaml~", "#{$log_location}/registry.yaml")
+else
+  raise "PROBLEM WRITING TO #{$log_location}/registry.yaml!"
+end

data/immortalize.gemspec

@@ -0,0 +1,47 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{immortalize}
+  s.version = "0.2.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mutually Human Software", "BehindLogic"]
+  s.date = %q{2010-06-23}
+  s.default_executable = %q{immortalize}
+  s.description = %q{Watch a specific process, restart it if it dies.}
+  s.email = %q{humans+rubygems@mutuallyhuman.com}
+  s.executables = ["immortalize"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/immortalize",
+     "immortalize.gemspec"
+  ]
+  s.homepage = %q{http://github.com/mhs/immortalize}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Restarts a specified process if it dies.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: mhs-immortalize
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 5
+  version: 0.2.5
+platform: ruby
+authors: 
+- Mutually Human Software
+- BehindLogic
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-23 00:00:00 -04:00
+default_executable: immortalize
+dependencies: []
+
+description: Watch a specific process, restart it if it dies.
+email: humans+rubygems@mutuallyhuman.com
+executables: 
+- immortalize
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/immortalize
+- immortalize.gemspec
+has_rdoc: true
+homepage: http://github.com/mhs/immortalize
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Restarts a specified process if it dies.
+test_files: []
+