assassin 0.4.2

data/LICENSE

@@ -0,0 +1 @@
+Ruby

data/README.md

@@ -0,0 +1,44 @@
+NAME
+----
+  assassin.rb
+
+SYNOPSIS
+--------
+  no zombies ever, not even on `exit!` or `kill -9`
+
+USAGE
+-----
+  pipe = IO.popen 'program-that-must-not-be-zombied'
+
+  Assassin.at_exit_kill(pipe.pid)
+
+  also see lib/assassin.rb and test/assassin_test.rb
+
+DESCRIPTION
+-----------
+  assassin.rb is a small (~ 60 loc), simple, reliable methodology of ensuring
+  that child processes are *always* cleaned up, regardless of the manner in
+  which the parent program is shut down.
+
+  the basic concept it to generate, start, and detach another script that
+  monitors the parent process and, when that process no longer exists, ensures
+  through escalation of signals that a child process is shut down and does not
+  become a zombie.
+
+  this becomes espcially important for libraries which spawn processes, such
+  as via `IO.popen` that need to ensure those children are cleaned up, but
+  which cannot control whether client code may call `exit`.  this approach
+  also handles being `kill -9`d - something no `at_exit{}` handler can
+  promise.
+
+INSTALL
+-------
+  gem install assassin
+
+URI
+---
+  http://github.com/ahoward/assassin
+
+HISTORY
+-------
+  - 0.4.2. initial release

data/Rakefile

@@ -0,0 +1,394 @@
+This.rubyforge_project = 'codeforpeople'
+This.author = "Ara T. Howard"
+This.email = "ara.t.howard@gmail.com"
+This.homepage = "https://github.com/ahoward/#{ This.lib }"
+
+task :license do
+  open('LICENSE', 'w'){|fd| fd.puts "same as ruby's"}
+end
+
+task :default do
+  puts((Rake::Task.tasks.map{|task| task.name.gsub(/::/,':')} - ['default']).sort)
+end
+
+task :test do
+  run_tests!
+end
+
+namespace :test do
+  task(:unit){ run_tests!(:unit) }
+  task(:functional){ run_tests!(:functional) }
+  task(:integration){ run_tests!(:integration) }
+end
+
+def run_tests!(which = nil)
+  which ||= '**'
+  test_dir = File.join(This.dir, "test")
+  test_glob ||= File.join(test_dir, "#{ which }/**_test.rb")
+  test_rbs = Dir.glob(test_glob).sort
+        
+  div = ('=' * 119)
+  line = ('-' * 119)
+
+  test_rbs.each_with_index do |test_rb, index|
+    testno = index + 1
+    command = "#{ This.ruby } -w -I ./lib -I ./test/lib #{ test_rb }"
+
+    puts
+    say(div, :color => :cyan, :bold => true)
+    say("@#{ testno } => ", :bold => true, :method => :print)
+    say(command, :color => :cyan, :bold => true)
+    say(line, :color => :cyan, :bold => true)
+
+    system(command)
+
+    say(line, :color => :cyan, :bold => true)
+
+    status = $?.exitstatus
+
+    if status.zero? 
+      say("@#{ testno } <= ", :bold => true, :color => :white, :method => :print)
+      say("SUCCESS", :color => :green, :bold => true)
+    else
+      say("@#{ testno } <= ", :bold => true, :color => :white, :method => :print)
+      say("FAILURE", :color => :red, :bold => true)
+    end
+    say(line, :color => :cyan, :bold => true)
+
+    exit(status) unless status.zero?
+  end
+end
+
+
+task :gemspec do
+  ignore_extensions = ['git', 'svn', 'tmp', /sw./, 'bak', 'gem']
+  ignore_directories = ['pkg']
+  ignore_files = ['test/log']
+
+  shiteless = 
+    lambda do |list|
+      list.delete_if do |entry|
+        next unless test(?e, entry)
+        extension = File.basename(entry).split(%r/[.]/).last
+        ignore_extensions.any?{|ext| ext === extension}
+      end
+      list.delete_if do |entry|
+        next unless test(?d, entry)
+        dirname = File.expand_path(entry)
+        ignore_directories.any?{|dir| File.expand_path(dir) == dirname}
+      end
+      list.delete_if do |entry|
+        next unless test(?f, entry)
+        filename = File.expand_path(entry)
+        ignore_files.any?{|file| File.expand_path(file) == filename}
+      end
+    end
+
+  lib         = This.lib
+  object      = This.object
+  version     = This.version
+  files       = shiteless[Dir::glob("**/**")]
+  executables = shiteless[Dir::glob("bin/*")].map{|exe| File.basename(exe)}
+  #has_rdoc    = true #File.exist?('doc')
+  test_files  = "test/#{ lib }.rb" if File.file?("test/#{ lib }.rb")
+  summary     = object.respond_to?(:summary) ? object.summary : "summary: #{ lib } kicks the ass"
+  description = object.respond_to?(:description) ? object.description : "description: #{ lib } kicks the ass"
+  license     = object.respond_to?(:license) ? object.license : "same as ruby's"
+
+  if This.extensions.nil?
+    This.extensions = []
+    extensions = This.extensions
+    %w( Makefile configure extconf.rb ).each do |ext|
+      extensions << ext if File.exists?(ext)
+    end
+  end
+  extensions = [extensions].flatten.compact
+
+  if This.dependencies.nil?
+    dependencies = []
+  else
+    case This.dependencies
+      when Hash
+        dependencies = This.dependencies.values
+      when Array
+        dependencies = This.dependencies
+    end
+  end
+
+  template = 
+    if test(?e, 'gemspec.erb')
+      Template{ IO.read('gemspec.erb') }
+    else
+      Template {
+        <<-__
+          ## <%= lib %>.gemspec
+          #
+
+          Gem::Specification::new do |spec|
+            spec.name = <%= lib.inspect %>
+            spec.version = <%= version.inspect %>
+            spec.platform = Gem::Platform::RUBY
+            spec.summary = <%= lib.inspect %>
+            spec.description = <%= description.inspect %>
+            spec.license = <%= license.inspect %>
+
+            spec.files =\n<%= files.sort.pretty_inspect %>
+            spec.executables = <%= executables.inspect %>
+            
+            spec.require_path = "lib"
+
+            spec.test_files = <%= test_files.inspect %>
+
+            <% dependencies.each do |lib_version| %>
+              spec.add_dependency(*<%= Array(lib_version).flatten.inspect %>)
+            <% end %>
+
+            spec.extensions.push(*<%= extensions.inspect %>)
+
+            spec.rubyforge_project = <%= This.rubyforge_project.inspect %>
+            spec.author = <%= This.author.inspect %>
+            spec.email = <%= This.email.inspect %>
+            spec.homepage = <%= This.homepage.inspect %>
+          end
+        __
+      }
+    end
+
+  Fu.mkdir_p(This.pkgdir)
+  gemspec = "#{ lib }.gemspec"
+  open(gemspec, "w"){|fd| fd.puts(template)}
+  This.gemspec = gemspec
+end
+
+task :gem => [:clean, :gemspec] do
+  Fu.mkdir_p(This.pkgdir)
+  before = Dir['*.gem']
+  cmd = "gem build #{ This.gemspec }"
+  `#{ cmd }`
+  after = Dir['*.gem']
+  gem = ((after - before).first || after.first) or abort('no gem!')
+  Fu.mv(gem, This.pkgdir)
+  This.gem = File.join(This.pkgdir, File.basename(gem))
+end
+
+task :readme do
+  samples = ''
+  prompt = '~ > '
+  lib = This.lib
+  version = This.version
+
+  Dir['sample*/*'].sort.each do |sample|
+    samples << "\n" << "  <========< #{ sample } >========>" << "\n\n"
+
+    cmd = "cat #{ sample }"
+    samples << Util.indent(prompt + cmd, 2) << "\n\n"
+    samples << Util.indent(`#{ cmd }`, 4) << "\n"
+
+    cmd = "ruby #{ sample }"
+    samples << Util.indent(prompt + cmd, 2) << "\n\n"
+
+    cmd = "ruby -e'STDOUT.sync=true; exec %(ruby -I ./lib #{ sample })'"
+    samples << Util.indent(`#{ cmd } 2>&1`, 4) << "\n"
+  end
+
+  template = 
+    if test(?e, 'README.erb')
+      Template{ IO.read('README.erb') }
+    else
+      Template {
+        <<-__
+          NAME
+            #{ lib }
+
+          DESCRIPTION
+
+          INSTALL
+            gem install #{ lib }
+
+          SAMPLES
+            #{ samples }
+        __
+      }
+    end
+
+  open("README", "w"){|fd| fd.puts template}
+end
+
+
+task :clean do
+  Dir[File.join(This.pkgdir, '**/**')].each{|entry| Fu.rm_rf(entry)}
+end
+
+
+task :release => [:clean, :gemspec, :gem] do
+  gems = Dir[File.join(This.pkgdir, '*.gem')].flatten
+  raise "which one? : #{ gems.inspect }" if gems.size > 1
+  raise "no gems?" if gems.size < 1
+
+  cmd = "gem push #{ This.gem }"
+  puts cmd
+  puts
+  system(cmd)
+  abort("cmd(#{ cmd }) failed with (#{ $?.inspect })") unless $?.exitstatus.zero?
+
+  cmd = "rubyforge login && rubyforge add_release #{ This.rubyforge_project } #{ This.lib } #{ This.version } #{ This.gem }"
+  puts cmd
+  puts
+  system(cmd)
+  abort("cmd(#{ cmd }) failed with (#{ $?.inspect })") unless $?.exitstatus.zero?
+end
+
+
+
+
+
+BEGIN {
+# support for this rakefile
+#
+  $VERBOSE = nil
+
+  require 'ostruct'
+  require 'erb'
+  require 'fileutils'
+  require 'rbconfig'
+  require 'pp'
+
+# fu shortcut
+#
+  Fu = FileUtils
+
+# cache a bunch of stuff about this rakefile/environment
+#
+  This = OpenStruct.new
+
+  This.file = File.expand_path(__FILE__)
+  This.dir = File.dirname(This.file)
+  This.pkgdir = File.join(This.dir, 'pkg')
+
+# grok lib
+#
+  lib = ENV['LIB']
+  unless lib
+    lib = File.basename(Dir.pwd).sub(/[-].*$/, '')
+  end
+  This.lib = lib
+
+# grok version
+#
+  version = ENV['VERSION']
+  unless version
+    require "./lib/#{ This.lib }"
+    This.name = lib.capitalize
+    This.object = eval(This.name)
+    version = This.object.send(:version)
+  end
+  This.version = version
+
+# see if dependencies are export by the module
+#
+  if This.object.respond_to?(:dependencies)
+    This.dependencies = This.object.dependencies
+  end
+
+# we need to know the name of the lib an it's version
+#
+  abort('no lib') unless This.lib
+  abort('no version') unless This.version
+
+# discover full path to this ruby executable
+#
+  c = Config::CONFIG
+  bindir = c["bindir"] || c['BINDIR']
+  ruby_install_name = c['ruby_install_name'] || c['RUBY_INSTALL_NAME'] || 'ruby'
+  ruby_ext = c['EXEEXT'] || ''
+  ruby = File.join(bindir, (ruby_install_name + ruby_ext))
+  This.ruby = ruby
+
+# some utils
+#
+  module Util
+    def indent(s, n = 2)
+      s = unindent(s)
+      ws = ' ' * n
+      s.gsub(%r/^/, ws)
+    end
+
+    def unindent(s)
+      indent = nil
+      s.each_line do |line|
+      next if line =~ %r/^\s*$/
+      indent = line[%r/^\s*/] and break
+    end
+    indent ? s.gsub(%r/^#{ indent }/, "") : s
+  end
+    extend self
+  end
+
+# template support
+#
+  class Template
+    def initialize(&block)
+      @block = block
+      @template = block.call.to_s
+    end
+    def expand(b=nil)
+      ERB.new(Util.unindent(@template)).result((b||@block).binding)
+    end
+    alias_method 'to_s', 'expand'
+  end
+  def Template(*args, &block) Template.new(*args, &block) end
+
+# colored console output support
+#
+  This.ansi = {
+    :clear      => "\e[0m",
+    :reset      => "\e[0m",
+    :erase_line => "\e[K",
+    :erase_char => "\e[P",
+    :bold       => "\e[1m",
+    :dark       => "\e[2m",
+    :underline  => "\e[4m",
+    :underscore => "\e[4m",
+    :blink      => "\e[5m",
+    :reverse    => "\e[7m",
+    :concealed  => "\e[8m",
+    :black      => "\e[30m",
+    :red        => "\e[31m",
+    :green      => "\e[32m",
+    :yellow     => "\e[33m",
+    :blue       => "\e[34m",
+    :magenta    => "\e[35m",
+    :cyan       => "\e[36m",
+    :white      => "\e[37m",
+    :on_black   => "\e[40m",
+    :on_red     => "\e[41m",
+    :on_green   => "\e[42m",
+    :on_yellow  => "\e[43m",
+    :on_blue    => "\e[44m",
+    :on_magenta => "\e[45m",
+    :on_cyan    => "\e[46m",
+    :on_white   => "\e[47m"
+  }
+  def say(phrase, *args)
+    options = args.last.is_a?(Hash) ? args.pop : {}
+    options[:color] = args.shift.to_s.to_sym unless args.empty?
+    keys = options.keys
+    keys.each{|key| options[key.to_s.to_sym] = options.delete(key)}
+
+    color = options[:color]
+    bold = options.has_key?(:bold)
+
+    parts = [phrase]
+    parts.unshift(This.ansi[color]) if color
+    parts.unshift(This.ansi[:bold]) if bold
+    parts.push(This.ansi[:clear]) if parts.size > 1
+
+    method = options[:method] || :puts
+
+    Kernel.send(method, parts.join)
+  end
+
+# always run out of the project dir
+#
+  Dir.chdir(This.dir)
+}

data/assassin.gemspec

@@ -0,0 +1,40 @@
+## assassin.gemspec
+#
+
+Gem::Specification::new do |spec|
+  spec.name = "assassin"
+  spec.version = "0.4.2"
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = "assassin"
+  spec.description = "no zombies ever, not even on `exit!` or `kill -9`"
+  spec.license = "same as ruby's"
+
+  spec.files =
+["LICENSE",
+ "README.md",
+ "Rakefile",
+ "assassin.gemspec",
+ "lib",
+ "lib/assassin.rb",
+ "test",
+ "test/assassin_test.rb",
+ "test/child.rb",
+ "test/lib",
+ "test/lib/testing.rb",
+ "test/parent.rb"]
+
+  spec.executables = []
+  
+  spec.require_path = "lib"
+
+  spec.test_files = nil
+
+  
+
+  spec.extensions.push(*[])
+
+  spec.rubyforge_project = "codeforpeople"
+  spec.author = "Ara T. Howard"
+  spec.email = "ara.t.howard@gmail.com"
+  spec.homepage = "https://github.com/ahoward/assassin"
+end

data/lib/assassin.rb

@@ -0,0 +1,89 @@
+require 'tmpdir'
+require 'securerandom'
+
+class Assassin
+  Version = '0.4.2' unless defined?(Version)
+
+  def Assassin.version
+    Version
+  end
+
+  def Assassin.description
+    'no zombies ever, not even on `exit!` or `kill -9`'
+  end
+
+  def Assassin.at_exit_kill(*args, &block)
+    new(*args, &block)
+  end
+
+  def Assassin.ate(*args, &block)
+    new(*args, &block)
+  end
+
+  attr_accessor :parent_pid
+  attr_accessor :child_pid
+  attr_accessor :pid
+  attr_accessor :path
+
+  def initialize(child_pid, options = {})
+    @child_pid = child_pid.to_s.to_i
+    @parent_pid = Process.pid
+    @options = Assassin.options_for(options)
+    @pid, @path = Assassin.generate(@child_pid, @options)
+  end
+
+  def Assassin.options_for(options)
+    options.inject({}){|h, kv| k,v = kv; h.update(k.to_s.to_sym => v)}
+  end
+
+  def Assassin.generate(child_pid, options = {})
+    path = File.join(Dir.tmpdir, "assassin-#{ child_pid }-#{ SecureRandom.uuid }.rb")
+    script = Assassin.script_for(child_pid, options)
+    IO.binwrite(path, script)
+    pid = Process.spawn "ruby #{ path }"
+    [pid, path]
+  end
+
+  def Assassin.script_for(child_pid, options = {})
+    parent_pid = Process.pid
+
+    script = <<-__
+      Process.daemon
+
+      require 'fileutils'
+      at_exit{ FileUtils.rm_f(__FILE__) }
+
+      parent_pid = #{ parent_pid }
+      child_pid = #{ child_pid }
+
+      m = 24*60*60
+      n = 42
+      
+      m.times do
+        begin
+          Process.kill(0, parent_pid)
+        rescue Object => e
+          if e.is_a?(Errno::ESRCH)
+            n.times do
+              begin
+                Process.kill(15, child_pid) rescue nil
+                sleep(rand + rand)
+                Process.kill(9, child_pid) rescue nil
+                sleep(rand + rand)
+                Process.kill(0, child_pid)
+              rescue Errno::ESRCH
+                break
+              end
+            end
+          end
+
+          exit
+        end
+
+        sleep(1)
+      end
+    __
+
+    return script
+  end
+end

data/test/assassin_test.rb

@@ -0,0 +1,100 @@
+# -*- encoding : utf-8 -*-
+require 'testing'
+require 'assassin'
+require 'yaml'
+
+Testing Assassin do
+  testing 'that not using assassin.rb leaks zombie processes' do
+    assert do
+      parent_pid, child_pid = `#{ TESTDIR }/parent.rb`.scan(/\d+/).map(&:to_i)
+
+      parent_was_killed = false
+      child_was_killed = false
+
+      10.times do
+        begin
+          Process.kill(0, parent_pid)
+          sleep(rand)
+        rescue Errno::ESRCH
+          parent_was_killed = true
+          break
+        end
+      end
+
+      10.times do
+        begin
+          Process.kill(0, child_pid)
+          sleep(rand)
+        rescue Errno::ESRCH
+          child_was_killed = true
+          break
+        end
+      end
+
+      cleanup!(parent_pid, child_pid)
+
+      parent_was_killed && !child_was_killed
+    end
+  end
+
+  testing 'that __using__ assassin.rb does __not__ leak zombie processes' do
+    assert do
+      parent_pid, child_pid = `#{ TESTDIR }/parent.rb assassin`.scan(/\d+/).map(&:to_i)
+
+      parent_was_killed = false
+      child_was_killed = false
+
+      10.times do
+        begin
+          Process.kill(0, parent_pid)
+          sleep(rand)
+        rescue Errno::ESRCH
+          parent_was_killed = true
+          break
+        end
+      end
+
+      10.times do
+        begin
+          Process.kill(0, child_pid)
+          sleep(rand)
+        rescue Errno::ESRCH
+          child_was_killed = true
+          break
+        end
+      end
+
+      cleanup!(parent_pid, child_pid)
+
+      parent_was_killed && child_was_killed
+    end
+  end
+
+protected
+
+  def cleanup!(*pids)
+    pids.flatten.compact.each do |pid|
+      pid = pid.to_s.to_i
+      begin
+        Process.kill(9, pid) rescue nil
+        Process.kill(-9, pid) rescue nil
+        `kill -9 #{ pid } 2>&1`
+      rescue
+      end
+    end
+  end
+end
+
+
+
+
+
+
+BEGIN {
+  TESTDIR = File.dirname(File.expand_path(__FILE__))
+  TESTLIBDIR = File.join(TESTDIR, 'lib')
+  ROOTDIR = File.dirname(TESTDIR)
+  LIBDIR = File.join(ROOTDIR, 'lib')
+  $LOAD_PATH.push(LIBDIR)
+  $LOAD_PATH.push(TESTLIBDIR)
+}

data/test/child.rb

@@ -0,0 +1,9 @@
+#! /usr/bin/env ruby
+ 
+#
+  STDOUT.sync = true
+  STDERR.sync = true
+  puts Process.pid rescue nil
+
+#
+  loop{ sleep }

data/test/lib/testing.rb

@@ -0,0 +1,74 @@
+# -*- encoding : utf-8 -*-
+# simple testing support
+#
+  require 'test/unit'
+
+  def Testing(*args, &block)
+    Class.new(Test::Unit::TestCase) do
+      eval("This=self")
+
+      def self.slug_for(*args)
+        string = args.flatten.compact.join('-')
+        words = string.to_s.scan(%r/\w+/)
+        words.map!{|word| word.gsub %r/[^0-9a-zA-Z_-]/, ''}
+        words.delete_if{|word| word.nil? or word.strip.empty?}
+        words.join('-').downcase
+      end
+
+      def This.testing_subclass_count
+        @testing_subclass_count ||= 1
+      ensure
+        @testing_subclass_count += 1
+      end
+
+      slug = slug_for(*args).gsub(%r/-/,'_')
+      name = ['TESTING', '%03d' % This.testing_subclass_count, slug].delete_if{|part| part.empty?}.join('_')
+      name = name.upcase!
+      const_set(:Name, name)
+      def self.name() const_get(:Name) end
+
+      def self.testno()
+        '%05d' % (@testno ||= 0)
+      ensure
+        @testno += 1
+      end
+
+      def self.testing(*args, &block)
+        define_method("test_#{ testno }_#{ slug_for(*args) }", &block)
+      end
+
+      alias_method '__assert__', 'assert'
+
+      def assert(*args, &block)
+        if block
+          label = "assert(#{ args.join ' ' })"
+          result = nil
+          assert_nothing_raised{ result = block.call }
+          __assert__(result, label)
+          result
+        else
+          result = args.shift
+          label = "assert(#{ args.join ' ' })"
+          __assert__(result, label)
+          result
+        end
+      end
+
+      def subclass_of exception
+        class << exception
+          def ==(other) super or self > other end
+        end
+        exception
+      end
+
+      alias_method '__assert_raises__', 'assert_raises'
+
+      def assert_raises(*args, &block)
+        args.push(subclass_of(Exception)) if args.empty?
+        __assert_raises__(*args, &block)
+      end
+
+      module_eval(&block)
+      self
+    end
+  end

data/test/parent.rb

@@ -0,0 +1,25 @@
+#! /usr/bin/env ruby
+
+#
+  STDOUT.sync = true
+  STDERR.sync = true
+  puts Process.pid
+
+#
+  TESTDIR = File.dirname(__FILE__)
+  ROOTDIR = File.dirname(TESTDIR)
+  LIBDIR = File.join(ROOTDIR, 'lib')
+
+#
+  child_program = "#{ TESTDIR }/child.rb"
+  child = IO.popen(child_program)
+  puts child.pid
+
+#
+  if ARGV.first.to_s =~ /assassin/
+    require "#{ LIBDIR }/assassin.rb"
+    Assassin.at_exit_kill(child.pid)
+  end
+
+#
+  exit!

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: assassin
+version: !ruby/object:Gem::Version
+  version: 0.4.2
+  prerelease: 
+platform: ruby
+authors:
+- Ara T. Howard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-17 00:00:00.000000000 Z
+dependencies: []
+description: no zombies ever, not even on `exit!` or `kill -9`
+email: ara.t.howard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- assassin.gemspec
+- lib/assassin.rb
+- test/assassin_test.rb
+- test/child.rb
+- test/lib/testing.rb
+- test/parent.rb
+homepage: https://github.com/ahoward/assassin
+licenses:
+- same as ruby's
+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: codeforpeople
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: assassin
+test_files: []
+has_rdoc: