0.62.0

Add deferred signal-handling (fixes #332).

.travis.yml

@@ -18,4 +18,5 @@ notifications:
 rvm:
   - 1.9.2
   - 1.9.3
+  - 2.0.0
   - jruby

Changelog.md

@@ -1,3 +1,24 @@
+## 0.61.0 (2013-01-14)
+
+* 0.61.0  [David Dollar]
+* Fix bug in color definitons  [nseo]
+* Fix for high CPU load when processes close output  [Pavel Forkert]
+* Ensure foreman is the process group leader  [Christos Trochalakis]
+* Don't ignore blank lines in the output  [Matt Venables]
+* Add license to gemspec  [petedmarsh]
+* Since JRuby 1.9 doesn't require posix/spawn, only follow that path if JRuby is loaded and running in 1.8 mode.  [Adam Hutchison]
+* Remove explicit requirement on rubygems.  [Cyril Rohr]
+* Dont use shared_path variable before multistage has a chance at it  [Aditya Sanghi]
+* Strip Windows Line Endings  [Paul Morton]
+* Fix man page: --directory is actually --root.  [Evan Jones]
+* Add timeout switch to CLI  [Paulo Luis Franchini Casaretto]
+* Remove expectation of double quotes around environment variables from test comparisons  [Kevin McAllister]
+* Remove explicit wrapping of Shellwords.escape in double quotes  [Kevin McAllister]
+
+## 0.60.2 (2012-10-08)
+
+* Fix for nil value on io select loop, fixes #260  [Silvio Relli]
+
 ## 0.60.1 (2012-10-08)
 
 * sleep on select() to avoid spinning the cpu  [Silvio Relli]

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    foreman (0.60.2)
+    foreman (0.62.0)
       thor (>= 0.13.6)
 
 GEM

dist/mswin32.rake

@@ -1,16 +0,0 @@
-file pkg("foreman-#{version}-x86-mswin32.gem") => distribution_files do |t|
-  Bundler.with_clean_env do
-    sh "env PLATFORM=mswin32 gem build foreman.gemspec"
-  end
-  sh "mv foreman-#{version}-x86-mswin32.gem #{t.name}"
-end
-
-task "mswin32:build" => pkg("foreman-#{version}-x86-mswin32.gem")
-
-task "mswin32:clean" do
-  clean pkg("foreman-#{version}-x86-mswin32.gem")
-end
-
-task "mswin32:release" => "mswin32:build" do |t|
-  sh "gem push #{pkg("foreman-#{version}-x86-mswin32.gem")} || echo 'error'"
-end

foreman.gemspec

@@ -3,6 +3,7 @@ require "foreman/version"
 
 Gem::Specification.new do |gem|
   gem.name     = "foreman"
+  gem.license  = "MIT"
   gem.version  = Foreman::VERSION
 
   gem.author   = "David Dollar"

lib/foreman.rb

@@ -8,8 +8,8 @@ module Foreman
     File.expand_path("../../bin/foreman-runner", __FILE__)
   end
 
-  def self.jruby?
+  def self.jruby_18?
-    defined?(RUBY_PLATFORM) and RUBY_PLATFORM == "java"
+    defined?(RUBY_PLATFORM) and RUBY_PLATFORM == "java" and ruby_18?
   end
 
   def self.ruby_18?

lib/foreman/capistrano.rb

@@ -12,7 +12,7 @@ if defined?(Capistrano)
         set :foreman_procfile,    "Procfile"
         set :foreman_app,         application
         set :foreman_user,        user
-        set :foreman_log,         "#{shared_path}/log"
+        set :foreman_log,         'shared_path/log'
         set :foreman_concurrency, false
       DESC
       task :export, :roles => :app do

lib/foreman/cli.rb

@@ -23,6 +23,7 @@ class Foreman::CLI < Thor
   method_option :env,       :type => :string,  :aliases => "-e", :desc => "Specify an environment file to load, defaults to .env"
   method_option :formation, :type => :string,  :aliases => "-m", :banner => '"alpha=5,bar=3"'
   method_option :port,      :type => :numeric, :aliases => "-p"
+  method_option :timeout,   :type => :numeric, :aliases => "-t", :desc => "Specify the amount of time (in seconds) processes have to shutdown gracefully before receiving a SIGKILL, defaults to 5."
 
   class << self
     # Hackery. Take the run method away from Thor so that we can redefine it.

lib/foreman/engine.rb

@@ -9,6 +9,10 @@ require "thread"
 
 class Foreman::Engine
 
+  # The signals that the engine cares about.
+  #
+  HANDLED_SIGNALS = [ :TERM, :INT, :HUP ]
+
   attr_reader :env
   attr_reader :options
   attr_reader :processes
@@ -25,6 +29,7 @@ class Foreman::Engine
     @options = options.dup
 
     @options[:formation] ||= (options[:concurrency] || "all=1")
+    @options[:timeout] ||= 5
 
     @env       = {}
     @mutex     = Mutex.new
@@ -32,15 +37,25 @@ class Foreman::Engine
     @processes = []
     @running   = {}
     @readers   = {}
+
+    # Self-pipe for deferred signal-handling (ala djb: http://cr.yp.to/docs/selfpipe.html)
+    reader, writer       = create_pipe
+    reader.close_on_exec = true if reader.respond_to?(:close_on_exec)
+    writer.close_on_exec = true if writer.respond_to?(:close_on_exec)
+    @selfpipe            = { :reader => reader, :writer => writer }
+
+    # Set up a global signal queue
+    # http://blog.rubybestpractices.com/posts/ewong/016-Implementing-Signal-Handlers.html
+    Thread.main[:signal_queue] = []
   end
 
   # Start the processes registered to this +Engine+
   #
   def start
-    trap("TERM") { puts "SIGTERM received"; terminate_gracefully }
+    # Make sure foreman is the process group leader.
-    trap("INT")  { puts "SIGINT received";  terminate_gracefully }
+    Process.setpgrp unless Foreman.windows?
-    trap("HUP")  { puts "SIGHUP received";  terminate_gracefully } if ::Signal.list.keys.include? 'HUP'
 
+    register_signal_handlers
     startup
     spawn_processes
     watch_for_output
@@ -49,6 +64,74 @@ class Foreman::Engine
     shutdown
   end
 
+  # Set up deferred signal handlers
+  #
+  def register_signal_handlers
+    HANDLED_SIGNALS.each do |sig|
+      if ::Signal.list.include? sig.to_s
+        trap(sig) { Thread.main[:signal_queue] << sig ; notice_signal }
+      end
+    end
+  end
+
+  # Unregister deferred signal handlers
+  #
+  def restore_default_signal_handlers
+    HANDLED_SIGNALS.each do |sig|
+      trap(sig, :DEFAULT) if ::Signal.list.include? sig.to_s
+    end
+  end
+
+  # Wake the main thread up via the selfpipe when there's a signal
+  #
+  def notice_signal
+    @selfpipe[:writer].write_nonblock( '.' )
+  rescue Errno::EAGAIN
+    # Ignore writes that would block
+  rescue Errno::EINT
+    # Retry if another signal arrived while writing
+    retry
+  end
+
+  # Invoke the real handler for signal +sig+. This shouldn't be called directly
+  # by signal handlers, as it might invoke code which isn't re-entrant.
+  #
+  # @param [Symbol] sig  the name of the signal to be handled
+  #
+  def handle_signal(sig)
+    case sig
+    when :TERM
+      handle_term_signal
+    when :INT
+      handle_interrupt
+    when :HUP
+      handle_hangup
+    else
+      system "unhandled signal #{sig}"
+    end
+  end
+
+  # Handle a TERM signal
+  #
+  def handle_term_signal
+    puts "SIGTERM received"
+    terminate_gracefully
+  end
+
+  # Handle an INT signal
+  #
+  def handle_interrupt
+    puts "SIGINT received"
+    terminate_gracefully
+  end
+
+  # Handle a HUP signal
+  #
+  def handle_hangup
+    puts "SIGHUP received"
+    terminate_gracefully
+  end
+
   # Register a process to be run by this +Engine+
   #
   # @param [String] name     A name for this process
@@ -94,11 +177,11 @@ class Foreman::Engine
     end
   end
 
-  # Send a signal to all processesstarted by this +Engine+
+  # Send a signal to all processes started by this +Engine+
   #
   # @param [String] signal  The signal to send to each process
   #
-  def killall(signal="SIGTERM")
+  def kill_children(signal="SIGTERM")
     if Foreman.windows?
       @running.each do |pid, (process, index)|
         system "sending #{signal} to #{name_for(pid)} at pid #{pid}"
@@ -109,7 +192,22 @@ class Foreman::Engine
       end
     else
       begin
-        Process.kill "-#{signal}", Process.pid
+        Process.kill signal, *@running.keys unless @running.empty?
+      rescue Errno::ESRCH, Errno::EPERM
+      end
+    end
+  end
+
+  # Send a signal to the whole process group.
+  #
+  # @param [String] signal  The signal to send
+  #
+  def killall(signal="SIGTERM")
+    if Foreman.windows?
+      kill_children(signal)
+    else
+      begin
+        Process.kill "-#{signal}", Process.getpgrp
       rescue Errno::ESRCH, Errno::EPERM
       end
     end
@@ -273,10 +371,28 @@ private
     Thread.new do
       begin
         loop do
-          io = IO.select(@readers.values, nil, nil, 30)
+          io = IO.select([@selfpipe[:reader]] + @readers.values, nil, nil, 30)
+
+          begin
+            @selfpipe[:reader].read_nonblock(11)
+          rescue Errno::EAGAIN, Errno::EINTR => err
+            # ignore
+          end
+
+          # Look for any signals that arrived and handle them
+          while sig = Thread.main[:signal_queue].shift
+            self.handle_signal(sig)
+          end
+
           (io.nil? ? [] : io.first).each do |reader|
-            data = reader.gets
+            next if reader == @selfpipe[:reader]
-            output_with_mutex name_for(@readers.invert[reader]), data
+
+            if reader.eof?
+              @readers.delete_if { |key, value| value == reader }
+            else
+              data = reader.gets
+              output_with_mutex name_for(@readers.invert[reader]), data
+            end
           end
         end
       rescue Exception => ex
@@ -297,15 +413,16 @@ private
 
   def terminate_gracefully
     return if @terminating
+    restore_default_signal_handlers
     @terminating = true
     if Foreman.windows?
       system  "sending SIGKILL to all processes"
-      killall "SIGKILL"
+      kill_children "SIGKILL"
     else
       system  "sending SIGTERM to all processes"
-      killall "SIGTERM"
+      kill_children "SIGTERM"
     end
-    Timeout.timeout(5) do
+    Timeout.timeout(options[:timeout]) do
       watch_for_termination while @running.length > 0
     end
   rescue Timeout::Error

lib/foreman/engine/cli.rb

@@ -44,8 +44,8 @@ class Foreman::Engine::CLI < Foreman::Engine
 
   end
 
-  FOREMAN_COLORS = %w( cyan yellow green magenta red blue intense_cyan intense_yellow
+  FOREMAN_COLORS = %w( cyan yellow green magenta red blue bright_cyan bright_yellow
-                       intense_green intense_magenta intense_red, intense_blue )
+                       bright_green bright_magenta bright_red bright_blue )
 
   def startup
     @colors = map_colors
@@ -54,7 +54,7 @@ class Foreman::Engine::CLI < Foreman::Engine
   end
 
   def output(name, data)
-    data.to_s.chomp.split("\n").each do |message|
+    data.to_s.lines.map(&:chomp).each do |message|
       output  = ""
       output += $stdout.color(@colors[name.split(".").first].to_sym)
       output += "#{Time.now.strftime("%H:%M:%S")} #{pad_process_name(name)} | "
@@ -89,7 +89,7 @@ private
     @names.values.each_with_index do |name, index|
       colors[name] = FOREMAN_COLORS[index % FOREMAN_COLORS.length]
     end
-    colors["system"] = "intense_white"
+    colors["system"] = "bright_white"
     colors
   end
 

lib/foreman/env.rb

@@ -5,7 +5,7 @@ class Foreman::Env
   attr_reader :entries
 
   def initialize(filename)
-    @entries = File.read(filename).split("\n").inject({}) do |ax, line|
+    @entries = File.read(filename).gsub("\r\n","\n").split("\n").inject({}) do |ax, line|
       if line =~ /\A([A-Za-z_0-9]+)=(.*)\z/
         key = $1
         case val = $2

lib/foreman/export/base.rb

@@ -91,7 +91,7 @@ private ######################################################################
   end
 
   def shell_quote(value)
-    '"' + Shellwords.escape(value) + '"'
+    Shellwords.escape(value)
   end
 
   # deprecated

lib/foreman/process.rb

@@ -1,5 +1,4 @@
 require "foreman"
-require "rubygems"
 
 class Foreman::Process
 
@@ -53,7 +52,7 @@ class Foreman::Process
       Dir.chdir(cwd) do
         Process.spawn env, expanded_command(env), :out => output, :err => output
       end
-    elsif Foreman.jruby?
+    elsif Foreman.jruby_18?
       require "posix/spawn"
       wrapped_command = "#{Foreman.runner} -d '#{cwd}' -p -- #{command}"
       POSIX::Spawn.spawn env, wrapped_command, :out => output, :err => output

lib/foreman/procfile.rb

@@ -82,7 +82,7 @@ class Foreman::Procfile
 private
 
   def parse(filename)
-    File.read(filename).split("\n").map do |line|
+    File.read(filename).gsub("\r\n","\n").split("\n").map do |line|
       if line =~ /^([A-Za-z0-9_]+):\s*(.+)$/
         [$1, $2]
       end

lib/foreman/version.rb

@@ -1,5 +1,5 @@
 module Foreman
 
-  VERSION = "0.60.2"
+  VERSION = "0.62.0"
 
 end

man/foreman.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "FOREMAN" "1" "August 2012" "Foreman 0.60.1" "Foreman Manual"
+.TH "FOREMAN" "1" "January 2013" "Foreman 0.61.0" "Foreman Manual"
 .
 .SH "NAME"
 \fBforeman\fR \- manage Procfile\-based applications
@@ -90,7 +90,7 @@ Specify the user the application should be run as\. Defaults to the app name
 These options control all modes of foreman\'s operation\.
 .
 .TP
-\fB\-d\fR, \fB\-\-directory\fR
+\fB\-d\fR, \fB\-\-root\fR
 Specify an alternate application root\. This defaults to the directory containing the Procfile\.
 .
 .TP

man/foreman.1.ronn

@@ -84,7 +84,7 @@ The following options control how the application is run:
 
 These options control all modes of foreman's operation.
 
-  * `-d`, `--directory`:
+  * `-d`, `--root`:
     Specify an alternate application root. This defaults to the directory
     containing the Procfile.
 

spec/foreman/export/upstart_spec.rb

@@ -38,7 +38,7 @@ describe Foreman::Export::Upstart, :fakefs do
     engine.env['KEY'] = 'd"\|d'
     upstart.export
     "foobarfoo".should include "bar"
-    File.read("/tmp/init/app-alpha-1.conf").should =~ /KEY="d\\"\\\\\\\|d/
+    File.read("/tmp/init/app-alpha-1.conf").should =~ /KEY=d\\"\\\\\\\|d/
   end
 
   context "with a formation" do

spec/foreman/process_spec.rb

@@ -41,7 +41,7 @@ describe Foreman::Process do
 
     it "should output utf8 properly" do
       process = Foreman::Process.new(resource_path("bin/utf8"))
-      run(process).should == "\xFF\x03\n"
+      run(process).should == "\xFF\x03\n".force_encoding('binary')
     end
   end
 

spec/resources/export/supervisord/app-alpha-1.conf

@@ -8,7 +8,7 @@ stdout_logfile=/var/log/app/alpha-1.log
 stderr_logfile=/var/log/app/alpha-1.error.log
 user=app
 directory=/tmp/app
-environment=PORT="5000"
+environment=PORT=5000
 [program:app-bravo-1]
 command=./bravo
 autostart=true
@@ -18,7 +18,7 @@ stdout_logfile=/var/log/app/bravo-1.log
 stderr_logfile=/var/log/app/bravo-1.error.log
 user=app
 directory=/tmp/app
-environment=PORT="5100"
+environment=PORT=5100
 
 [group:app]
 programs=app-alpha-1,app-bravo-1

spec/resources/export/supervisord/app-alpha-2.conf

@@ -8,7 +8,7 @@ stdout_logfile=/var/log/app/alpha-1.log
 stderr_logfile=/var/log/app/alpha-1.error.log
 user=app
 directory=/tmp/app
-environment=PORT="5000"
+environment=PORT=5000
 [program:app-alpha-2]
 command=./alpha
 autostart=true
@@ -18,7 +18,7 @@ stdout_logfile=/var/log/app/alpha-2.log
 stderr_logfile=/var/log/app/alpha-2.error.log
 user=app
 directory=/tmp/app
-environment=PORT="5001"
+environment=PORT=5001
 
 [group:app]
 programs=app-alpha-1,app-alpha-2

spec/spec_helper.rb

@@ -1,5 +1,3 @@
-require "rubygems"
-
 require "simplecov"
 SimpleCov.start do
   add_filter "/spec/"