ringleader 1.1.2 → 1.1.3

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source "https://rubygems.org"
 
 gemspec
 

data/Rakefile

@@ -1,2 +1,14 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
+# encoding: utf-8
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+desc 'Default: run unit tests.'
+task :default => :spec
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = ["-c", "-f progress"]
+end

data/dev_scripts/Procfile

@@ -4,4 +4,5 @@ listen: ncat -k -l 10001
 # slow_echo: sleep 10 && ruby echo_server.rb
 # echo: ruby echo_server.rb
 # sleep: sleep 30
-stubborn: ruby stubborn.rb
+# stubborn: ruby stubborn.rb
+orphans: ruby bad_parent.rb

data/dev_scripts/bad_parent.rb

@@ -0,0 +1,15 @@
+trap("INT")  { STDERR.puts "#{$$} ignoring INT" }
+trap("HUP")  { STDERR.puts "#{$$} ignoring HUP" }
+trap("TERM") { STDERR.puts "#{$$} ignoring TERM" }
+
+@extra = 0
+3.times do |n|
+  STDERR.puts "#{$$} forking (#{n})"
+  if pid = fork
+    STDERR.puts "#{$$} forked child #{pid}"
+    break
+  else
+    @extra += 1
+  end
+end
+sleep 10 + @extra * 2 # do clean up, eventually, with parent dying first

data/dev_scripts/test.yml

@@ -2,9 +2,10 @@
 test:
   dir: "./dev_scripts"
   # command: "ncat -k -l 10001"
-  command: "bundle exec foreman start 2>&1 | tee fail.log"
+  command: "bundle exec foreman start"
   # command: sleep 10
   server_port: 10000
   app_port: 10001
-  idle_timeout: 10
+  idle_timeout: 5
   startup_timeout: 5
+  kill_with: "INT"

data/lib/ringleader.rb

@@ -11,6 +11,7 @@ require "trollop"
 require "rainbow"
 require "color"
 require "pathname"
+require 'sys/proctable'
 
 module Ringleader
 end

data/lib/ringleader/app.rb

@@ -11,7 +11,7 @@ module Ringleader
     def initialize(config)
       @config = config
       @process = Process.new(config)
-      enable! unless config.disabled
+      async.enable unless config.disabled
       start if config.run_on_load
     end
 
@@ -51,7 +51,7 @@ module Ringleader
       return if @server
       @server = TCPServer.new @config.host, @config.server_port
       @enabled = true
-      run!
+      async.run
     rescue Errno::EADDRINUSE
       error "could not bind to #{@config.host}:#{@config.server_port} for #{@config.name}!"
       @server = nil
@@ -73,7 +73,7 @@ module Ringleader
 
     def run
       info "listening for connections for #{@config.name} on #{@config.host}:#{@config.server_port}"
-      loop { handle_connection! @server.accept }
+      loop { async.handle_connection @server.accept }
     rescue IOError
       @server.close if @server
     end
@@ -84,7 +84,7 @@ module Ringleader
 
       started = @process.start
       if started
-        proxy_to_app! socket
+        async.proxy_to_app socket
         reset_activity_timer
       else
         error "could not start app"

data/lib/ringleader/cli.rb

@@ -2,19 +2,22 @@ module Ringleader
   class CLI
     include Celluloid::Logger
 
+    RC_FILE = File.expand_path('~/.ringleaderrc')
+
     def run(argv)
-      # hide "shutdown" info message until after opts are validated
-      Celluloid.logger.level = ::Logger::ERROR
+      configure_logging
 
       opts = nil
       Trollop.with_standard_exception_handling parser do
-        opts = parser.parse argv
+        opts = merge_rc_opts(parser.parse(argv))
       end
 
       die "must provide a filename" if argv.empty?
       die "could not find config file #{argv.first}" unless File.exist?(argv.first)
 
-      configure_logging(opts.verbose ? "debug" : "info")
+      if opts.verbose?
+        Celluloid.logger.level = ::Logger::DEBUG
+      end
 
       apps = Config.new(argv.first, opts.boring).apps
 
@@ -30,8 +33,10 @@ module Ringleader
       sleep
     end
 
-    def configure_logging(level)
-      Celluloid.logger.level = ::Logger.const_get(level.upcase)
+    def configure_logging
+      # set to INFO at first to hide celluloid's shutdown message until after
+      # opts are validated.
+      Celluloid.logger.level = ::Logger::INFO
       format = "%5s %s.%06d | %s\n"
       date_format = "%H:%M:%S"
       Celluloid.logger.formatter = lambda do |severity, time, progname, msg|
@@ -117,20 +122,37 @@ something like this:
 OPTIONS
         banner
 
-        opt "verbose", "log at debug level",
-          :long => "--verbose", :short => "-v",
-          :type => :boolean, :default => false
-        opt "host", "host for web control panel",
-          :long => "--host", :short => "-H",
-          :default => "localhost"
-        opt "port", "port for the web control panel",
-          :long => "--port", :short => "-p",
-          :type => :integer, :default => 42000
-        opt "boring", "use boring colors instead of a fabulous rainbow",
-          :long => "--boring", :short => "-b",
-          :type => :boolean, :default => false
+        opt :verbose, "log at debug level",
+          :short => "-v", :default => false
+        opt :host, "host for web control panel",
+          :short => "-H", :default => "localhost"
+        opt :port, "port for the web control panel",
+          :short => "-p", :default => 42000
+        opt :boring, "use boring colors instead of a fabulous rainbow",
+          :short => "-b", :default => false
+
+      end
+    end
+
+    def merge_rc_opts(opts)
+      [:verbose, :host, :port, :boring].each do |option_name|
+        if rc_opts.has_key?(option_name) && !opts["#{option_name}_given".to_sym]
+          opts[option_name] = rc_opts[option_name]
+        end
+      end
+      opts
+    end
 
+    def rc_opts
+      unless @rc_opts
+        if File.readable?(RC_FILE)
+          info "reading options from ~/.ringleaderrc"
+          @rc_opts = parser.parse File.read(RC_FILE).strip.split(/\s+/)
+        else
+          @rc_opts = {}
+        end
       end
+      @rc_opts
     end
 
   end

data/lib/ringleader/config.rb

@@ -21,7 +21,7 @@ module Ringleader
       @apps = Hash[*configs.flatten]
     end
 
-    # Private: convert a YML hash to an array of name/OpenStruct pairs
+    # Internal: convert a YML hash to an array of name/OpenStruct pairs
     #
     # Does validation for each app config and raises an error if anything is
     # wrong. Sets default values for missing options, and assigns colors to each
@@ -61,7 +61,7 @@ module Ringleader
       end
     end
 
-    # Private: validate that the options have all of the required keys
+    # Internal: validate that the options have all of the required keys
     def validate(name, options)
       REQUIRED_KEYS.each do |key|
         unless options.has_key?(key)
@@ -70,7 +70,7 @@ module Ringleader
       end
     end
 
-    # Private: assign a color to each application configuration.
+    # Internal: assign a color to each application configuration.
     #
     # configs - the config data to modify
     # boring  - use boring standard terminal colors instead of a rainbow.

data/lib/ringleader/process.rb

@@ -55,21 +55,27 @@ module Ringleader
     def stop
       return unless @pid
 
+      children = child_pids @pid
+
       info "stopping #{@pid}"
+      debug "child pids: #{children.inspect}"
+
       @master.close unless @master.closed?
+
       debug "kill -#{config.kill_with} #{@pid}"
       ::Process.kill config.kill_with, -@pid
 
-      kill = after 7 do
-        if @running
-          warn "process #{@pid} did not shut down cleanly, killing it"
-          debug "kill -KILL #{@pid}"
-          ::Process.kill "KILL", -@pid
-        end
+      failsafe = after 7 do
+        warn "process #{@pid} did not shut down cleanly, killing it"
+        debug "kill -KILL #{@pid}"
+        ::Process.kill "KILL", -@pid
+        reap_orphans children
       end
 
       wait :running # wait for the exit callback
-      kill.cancel
+      failsafe.cancel
+      sleep 2 # give the children a chance to shut down
+      reap_orphans children
 
     rescue Errno::ESRCH, Errno::EPERM
       exited
@@ -83,8 +89,7 @@ module Ringleader
 
     # Internal: callback for when the process has exited.
     def exited
-      debug "pid #{@pid} has exited"
-      info "exited."
+      info "pid #{@pid} exited"
       @running = false
       @pid = nil
       @wait_for_port.terminate if @wait_for_port.alive?
@@ -92,7 +97,7 @@ module Ringleader
       signal :running, false
     end
 
-    # Private: start the application process and associated infrastructure
+    # Internal: start the application process and associated infrastructure
     #
     # Intended to be synchronous, as it blocks until the app has started (or
     # failed to start).
@@ -124,7 +129,7 @@ module Ringleader
 
       timer = after config.startup_timeout do
         warn "application startup took more than #{config.startup_timeout}"
-        stop!
+        async.stop
       end
 
       @running = wait :running
@@ -143,7 +148,7 @@ module Ringleader
       end
     end
 
-    # Private: check if the app is already running outside ringleader
+    # Internal: check if the app is already running outside ringleader
     def already_running?
       socket = TCPSocket.new config.host, config.app_port
       socket.close
@@ -152,7 +157,7 @@ module Ringleader
       false
     end
 
-    # Private: proxy output streams to the logger.
+    # Internal: proxy output streams to the logger.
     #
     # Fire and forget, runs in its own thread.
     def proxy_output(input)
@@ -163,7 +168,7 @@ module Ringleader
       end
     end
 
-    # Private: execute a command in a clean environment (bundler)
+    # Internal: execute a command in a clean environment (bundler)
     def in_clean_environment(&block)
       if Object.const_defined?(:Bundler)
         ::Bundler.with_clean_env(&block)
@@ -172,6 +177,37 @@ module Ringleader
       end
     end
 
+    # Internal: kill orphaned processes
+    def reap_orphans(child_pids)
+      child_pids.each do |pid|
+        next unless Sys::ProcTable.ps(pid)
+        error "child process #{pid} was orphaned, killing it"
+        begin
+          ::Process.kill "KILL", pid
+        rescue Errno::ESRCH, Errno::EPERM
+          debug "could not kill #{pid}"
+        end
+      end
+    end
+
+    # Internal: returns all child pids of the given parent
+    def child_pids(parent_pid)
+      proc_table = Sys::ProcTable.ps
+      children_of parent_pid, proc_table
+    end
+
+    # Internal: find child pids given a parent pid and a proc table
+    def children_of(parent_pid, proc_table)
+      [].tap do |pids|
+        proc_table.each do |proc_record|
+          if proc_record.ppid == parent_pid
+            pids << proc_record.pid
+            pids.concat children_of proc_record.pid, proc_table
+          end
+        end
+      end
+    end
+
   end
 
 end

data/lib/ringleader/socket_proxy.rb

@@ -16,8 +16,8 @@ module Ringleader
       debug "proxying to #{host}:#{port}"
       @socket = TCPSocket.new(host, port)
 
-      proxy! @socket, @upstream
-      proxy! @upstream, @socket
+      async.proxy @socket, @upstream
+      async.proxy @upstream, @socket
 
     rescue Errno::ECONNREFUSED
       error "could not proxy to #{host}:#{port}"

data/lib/ringleader/version.rb

@@ -1,3 +1,3 @@
 module Ringleader
-  VERSION = "1.1.2"
+  VERSION = "1.1.3"
 end

data/lib/ringleader/wait_for_exit.rb

@@ -4,12 +4,12 @@ module Ringleader
 
     def initialize(pid, app)
       @pid, @app = pid, app
-      wait!
+      async.wait
     end
 
     def wait
       ::Process.waitpid @pid
-      @app.exited!
+      @app.async.exited
       terminate
     end
   end

data/lib/ringleader/wait_for_port.rb

@@ -5,19 +5,19 @@ module Ringleader
 
     def initialize(host, port, app)
       @host, @port, @app = host, port, app
-      wait!
+      async.wait
     end
 
     def wait
       begin
-        socket = TCPSocket.new @host, @port
+        TCPSocket.new @host, @port
       rescue Errno::ECONNREFUSED
         sleep 0.5
         debug "#{@host}:#{@port} not open yet"
         retry
       end
       debug "#{@host}:#{@port} open"
-      @app.port_opened!
+      @app.async.port_opened
       terminate
     end
   end

data/ringleader.gemspec

@@ -16,12 +16,13 @@ Gem::Specification.new do |gem|
   gem.version       = Ringleader::VERSION
   gem.required_ruby_version = "> 1.9.3"
 
-  gem.add_dependency "celluloid", "~> 0.11.0"
-  gem.add_dependency "celluloid-io", "~> 0.11.0"
+  gem.add_dependency "celluloid", "~> 0.12.4"
+  gem.add_dependency "celluloid-io", "~> 0.12.0"
   gem.add_dependency "reel", "~> 0.1.0"
   gem.add_dependency "trollop", "~> 1.16.2"
   gem.add_dependency "rainbow", "~> 1.1.4"
   gem.add_dependency "color", "~> 1.4.1"
+  gem.add_dependency "sys-proctable", "~> 0.9.2"
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec", "~> 2.11.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ringleader
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-03 00:00:00.000000000 Z
+date: 2013-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.12.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.12.4
 - !ruby/object:Gem::Dependency
   name: celluloid-io
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: reel
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +107,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: sys-proctable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -190,6 +206,7 @@ files:
 - assets/underscore-min.js
 - bin/ringleader
 - dev_scripts/Procfile
+- dev_scripts/bad_parent.rb
 - dev_scripts/echo_server.rb
 - dev_scripts/many.yml
 - dev_scripts/signaling.rb
@@ -244,10 +261,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1091358799761404049
+      hash: -3588672138086956428
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Proxy TCP connections to an on-demand pool of configured applications