0.63.0

Does not pass tests

This reverts commit 17a8a316b8, reversing
changes made to 9e1d590734.

.travis.yml

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

Changelog.md

@@ -1,3 +1,31 @@
+## 0.62.0 (2013-03-08)
+
+* Merge pull request #334 from ged/reentrant_signal_handlers  [David Dollar]
+* Merge pull request #335 from ged/20_encoding_fix  [David Dollar]
+* Try to allow children to shut down gracefully  [Michael Granger]
+* Add deferred signal-handling (fixes #332).  [Michael Granger]
+* Fix spec encoding problem under Ruby 2.0.0.  [Michael Granger]
+* add ruby 2.0 to travis  [David Dollar]
+* Merge pull request #327 from patheticpat/master  [David Dollar]
+* Fixed a typo in cli options description  [Michael Kaiser]
+* handled by mingw now  [David Dollar]
+
+## 0.61.0 (2013-01-14)
+
+* 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]

Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    foreman (0.61.0)
+    foreman (0.63.0)
+      dotenv (>= 0.7)
       thor (>= 0.13.6)
 
 GEM
@@ -13,6 +14,7 @@ GEM
       xml-simple
     builder (3.0.0)
     diff-lcs (1.1.3)
+    dotenv (0.7.0)
     fakefs (0.3.2)
     hpricot (0.8.6)
     hpricot (0.8.6-java)

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 David Dollar
+
+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.

README.md

@@ -43,4 +43,6 @@ David Dollar
 
 ## License
 
-MIT
+Foreman is licensed under the MIT license.
+
+See LICENSE for the full license text.

bin/foreman-runner

@@ -34,7 +34,7 @@ shift $((OPTIND-1))
 
 if [ "$read_profile" = "1" ]; then
   if [ -f .profile ]; then
-    . .profile
+    . ./.profile
   fi
 fi
 

data/export/upstart/master.conf.erb

@@ -7,10 +7,6 @@ EOF
 
 end script
 
-start on (started network-interface
-          or started network-manager
-          or started networking)
+start on runlevel [2345]
 
-stop on (stopping network-interface
-         or stopping network-manager
-         or stopping networking)
+stop on runlevel [016]

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

@@ -18,9 +18,9 @@ Gem::Specification.new do |gem|
   gem.files << "man/foreman.1"
 
   gem.add_dependency 'thor', '>= 0.13.6'
+  gem.add_dependency 'dotenv', '>= 0.7'
 
   if ENV["PLATFORM"] == "java"
-    gem.add_dependency "posix-spawn", "~> 0.3.6"
     gem.platform = Gem::Platform.new("java")
   end
 

lib/foreman/cli.rb

@@ -23,7 +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 shudown gracefully before receiving a SIGKILL, defaults to 5."
+  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

@@ -1,7 +1,7 @@
 require "foreman"
-require "foreman/env"
 require "foreman/process"
 require "foreman/procfile"
+require "dotenv"
 require "tempfile"
 require "timeout"
 require "fileutils"
@@ -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
@@ -33,18 +37,22 @@ 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
-    # Make sure foreman is the process group leader.
-    Process.setpgrp unless Foreman.windows?
-
-    trap("TERM") { puts "SIGTERM received"; terminate_gracefully }
-    trap("INT")  { puts "SIGINT received";  terminate_gracefully }
-    trap("HUP")  { puts "SIGHUP received";  terminate_gracefully } if ::Signal.list.keys.include? 'HUP'
-
+    register_signal_handlers
     startup
     spawn_processes
     watch_for_output
@@ -53,6 +61,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
@@ -93,16 +169,14 @@ class Foreman::Engine
   # @param [String] filename  A .env file to load into the environment
   #
   def load_env(filename)
-    Foreman::Env.new(filename).entries do |name, value|
-      @env[name] = value
-    end
+    @env.update Dotenv::Environment.new(filename)
   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}"
@@ -113,7 +187,22 @@ class Foreman::Engine
       end
     else
       begin
-        Process.kill "-#{signal}", Process.getpgrp
+        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.pid
       rescue Errno::ESRCH, Errno::EPERM
       end
     end
@@ -277,8 +366,22 @@ 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|
+            next if reader == @selfpipe[:reader]
+
             if reader.eof?
               @readers.delete_if { |key, value| value == reader }
             else
@@ -305,13 +408,14 @@ 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(options[:timeout]) do
       watch_for_termination while @running.length > 0

lib/foreman/env.rb

@@ -1,29 +0,0 @@
-require "foreman"
-
-class Foreman::Env
-
-  attr_reader :entries
-
-  def initialize(filename)
-    @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
-          # Remove single quotes
-          when /\A'(.*)'\z/ then ax[key] = $1
-          # Remove double quotes and unescape string preserving newline characters
-          when /\A"(.*)"\z/ then ax[key] = $1.gsub('\n', "\n").gsub(/\\(.)/, '\1')
-          else ax[key] = val
-        end
-      end
-      ax
-    end
-  end
-
-  def entries
-    @entries.each do |key, value|
-      yield key, value
-    end
-  end
-
-end

lib/foreman/export/upstart.rb

@@ -6,7 +6,7 @@ class Foreman::Export::Upstart < Foreman::Export::Base
   def export
     super
 
-    Dir["#{location}/#{app}*.conf"].each do |file|
+    (Dir["#{location}/#{app}-*.conf"] << "#{location}/#{app}.conf").each do |file|
       clean file
     end
 

lib/foreman/procfile.rb

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

lib/foreman/version.rb

@@ -1,5 +1,5 @@
 module Foreman
 
-  VERSION = "0.61.0"
+  VERSION = "0.63.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" "October 2012" "" ""
+.TH "FOREMAN" "1" "January 2013" "Foreman 0.61.0" "Foreman Manual"
 .
 .SH "NAME"
 \fBforeman\fR \- manage Procfile\-based applications
@@ -46,10 +46,6 @@ Specify an alternate Procfile to load, implies \fB\-d\fR at the Procfile root\.
 \fB\-p\fR, \fB\-\-port\fR
 Specify which port to use as the base for this application\. Should be a multiple of 1000\.
 .
-.TP
-\fB\-t\fR, \fB\-\-tmux\fR
-Runs the processes in a tmux session\. Creates one window for each process and an extra window containing the output of each window (requires gawk)\.
-.
 .P
 \fBforeman run\fR is used to run one\-off commands using the same environment as your defined processes\.
 .
@@ -234,7 +230,7 @@ Run one process type from the application defined in a specific Procfile:
 .
 .nf
 
-$ foreman start alpha \-p ~/myapp/Procfile
+$ foreman start alpha \-f ~/myapp/Procfile
 .
 .fi
 .

man/foreman.1.ronn

@@ -40,10 +40,6 @@ The following options control how the application is run:
     Specify which port to use as the base for this application. Should be
     a multiple of 1000.
 
-  * `-t`, `--tmux`:
-    Runs the processes in a tmux session. Creates one window for each process
-    and an extra window containing the output of each window (requires gawk).
-
 `foreman run` is used to run one-off commands using the same environment
 as your defined processes.
 

spec/foreman/cli_spec.rb

@@ -50,7 +50,7 @@ describe "Foreman::CLI", :fakefs do
   describe "check" do
     it "with a valid Procfile displays the jobs" do
       write_procfile
-      foreman("check").should == "valid procfile detected (alpha, bravo)\n"
+      foreman("check").should == "valid procfile detected (alpha, bravo, foo_bar, foo-bar)\n"
     end
 
     it "with a blank Procfile displays an error" do

spec/foreman/export/upstart_spec.rb

@@ -29,11 +29,27 @@ describe Foreman::Export::Upstart, :fakefs do
     mock(FileUtils).rm("/tmp/init/app-alpha-1.conf")
     mock(FileUtils).rm("/tmp/init/app-bravo.conf")
     mock(FileUtils).rm("/tmp/init/app-bravo-1.conf")
+    mock(FileUtils).rm("/tmp/init/app-foo-bar.conf")
+    mock(FileUtils).rm("/tmp/init/app-foo-bar-1.conf")
+    mock(FileUtils).rm("/tmp/init/app-foo_bar.conf")
+    mock(FileUtils).rm("/tmp/init/app-foo_bar-1.conf")
 
     upstart.export
     upstart.export
   end
 
+  it "does not delete exported files for similarly named applications" do
+    FileUtils.mkdir_p "/tmp/init"
+
+    ["app2", "app2-alpha", "app2-alpha-1"].each do |name|
+      path = "/tmp/init/#{name}.conf"
+      FileUtils.touch(path)
+      dont_allow(FileUtils).rm(path)
+    end
+
+    upstart.export
+  end
+
   it "quotes and escapes environment variables" do
     engine.env['KEY'] = 'd"\|d'
     upstart.export

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/foreman/procfile_spec.rb

@@ -16,8 +16,10 @@ describe Foreman::Procfile, :fakefs do
   it "loads a passed-in Procfile" do
     write_procfile
     procfile = Foreman::Procfile.new("Procfile")
-    procfile["alpha"].should == "./alpha"
-    procfile["bravo"].should == "./bravo"
+    procfile["alpha"].should   == "./alpha"
+    procfile["bravo"].should   == "./bravo"
+    procfile["foo-bar"].should == "./foo-bar"
+    procfile["foo_bar"].should == "./foo_bar"
   end
 
   it "can have a process appended to it" do

spec/resources/export/bluepill/app.pill

@@ -42,5 +42,40 @@ Bluepill.application("app", :foreground => false, :log_file => "/var/log/bluepil
     process.group = "app-bravo"
   end
 
+  app.process("foo_bar-1") do |process|
+    process.start_command = "./foo_bar"
 
+    process.working_dir = "/tmp/app"
+    process.daemonize = true
+    process.environment = {"PORT"=>"5200"}
+    process.stop_signals = [:quit, 30.seconds, :term, 5.seconds, :kill]
+    process.stop_grace_time = 45.seconds
+
+    process.stdout = process.stderr = "/var/log/app/app-foo_bar-1.log"
+
+    process.monitor_children do |children|
+      children.stop_command "kill {{PID}}"
+    end
+
+    process.group = "app-foo_bar"
+  end
+
+  app.process("foo-bar-1") do |process|
+    process.start_command = "./foo-bar"
+
+    process.working_dir = "/tmp/app"
+    process.daemonize = true
+    process.environment = {"PORT"=>"5300"}
+    process.stop_signals = [:quit, 30.seconds, :term, 5.seconds, :kill]
+    process.stop_grace_time = 45.seconds
+
+    process.stdout = process.stderr = "/var/log/app/app-foo-bar-1.log"
+
+    process.monitor_children do |children|
+
+    children.stop_command "kill {{PID}}"
+    end
+
+    process.group = "app-foo-bar"
+  end
 end

spec/resources/export/inittab/inittab.default

@@ -1,4 +1,6 @@
 # ----- foreman app processes -----
 AP01:4:respawn:/bin/su - app -c 'cd /tmp/app;export PORT=5000;./alpha >> /var/log/app/alpha-1.log 2>&1'
 AP02:4:respawn:/bin/su - app -c 'cd /tmp/app;export PORT=5100;./bravo >> /var/log/app/bravo-1.log 2>&1'
+AP03:4:respawn:/bin/su - app -c 'cd /tmp/app;export PORT=5200;./foo_bar >> /var/log/app/foo_bar-1.log 2>&1'
+AP04:4:respawn:/bin/su - app -c 'cd /tmp/app;export PORT=5300;./foo-bar >> /var/log/app/foo-bar-1.log 2>&1'
 # ----- end foreman app processes -----

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

@@ -19,6 +19,26 @@ stderr_logfile=/var/log/app/bravo-1.error.log
 user=app
 directory=/tmp/app
 environment=PORT=5100
+[program:app-foo_bar-1]
+command=./foo_bar
+autostart=true
+autorestart=true
+stopsignal=QUIT
+stdout_logfile=/var/log/app/foo_bar-1.log
+stderr_logfile=/var/log/app/foo_bar-1.error.log
+user=app
+directory=/tmp/app
+environment=PORT=5200
+[program:app-foo-bar-1]
+command=./foo-bar
+autostart=true
+autorestart=true
+stopsignal=QUIT
+stdout_logfile=/var/log/app/foo-bar-1.log
+stderr_logfile=/var/log/app/foo-bar-1.error.log
+user=app
+directory=/tmp/app
+environment=PORT=5300
 
 [group:app]
-programs=app-alpha-1,app-bravo-1
+programs=app-alpha-1,app-bravo-1,app-foo_bar-1,app-foo-bar-1

spec/resources/export/upstart/app.conf

@@ -7,10 +7,6 @@ EOF
 
 end script
 
-start on (started network-interface
-          or started network-manager
-          or started networking)
+start on runlevel [2345]
 
-stop on (stopping network-interface
-         or stopping network-manager
-         or stopping networking)
+stop on runlevel [016]

spec/spec_helper.rb

@@ -79,6 +79,8 @@ def write_procfile(procfile="Procfile", alpha_env="")
     file.puts "alpha: ./alpha" + " #{alpha_env}".rstrip
     file.puts "\n"
     file.puts "bravo:\t./bravo"
+    file.puts "foo_bar:\t./foo_bar"
+    file.puts "foo-bar:\t./foo-bar"
   end
   File.expand_path(procfile)
 end