0.20.0

Blank line in Procfile breaks Foreman

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    foreman (0.16.0)
+    foreman (0.20.0)
       term-ansicolor (~> 1.0.5)
       thor (>= 0.13.6)
 
@@ -28,17 +28,15 @@ GEM
       mustache (>= 0.7.0)
       rdiscount (>= 1.5.8)
     rr (1.0.2)
-    rspec (2.0.1)
+    rspec (2.6.0)
-      rspec-core (~> 2.0.1)
+      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.0.1)
+      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.0.1)
+      rspec-mocks (~> 2.6.0)
-    rspec-core (2.0.1)
+    rspec-core (2.6.4)
-    rspec-expectations (2.0.1)
+    rspec-expectations (2.6.0)
-      diff-lcs (>= 1.1.2)
+      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.0.1)
+    rspec-mocks (2.6.0)
-      rspec-core (~> 2.0.1)
+    term-ansicolor (1.0.6)
-      rspec-expectations (~> 2.0.1)
-    term-ansicolor (1.0.5)
     thor (0.14.6)
 
 PLATFORMS
@@ -52,4 +50,4 @@ DEPENDENCIES
   rcov (~> 0.9.8)
   ronn
   rr (~> 1.0.2)
-  rspec (~> 2.0.0)
+  rspec (~> 2.6.0)

README.markdown

@@ -12,17 +12,18 @@ http://blog.daviddollar.org/2011/05/06/introducing-foreman.html
 
 See the [man page](http://ddollar.github.com/foreman) for usage.
 
-## Author
+## Authorship
 
-David Dollar
+Created by David Dollar
 
-## Contributors
+Patches contributed by:
 
-Adam Wiggins
+* Adam Wiggins
-clifff
+* clifff
-Dan Peterson
+* Dan Peterson
-Keith Rarick
+* Jay Zeschin
-Ricardo Chimal, Jr
+* Keith Rarick
+* Ricardo Chimal, Jr
 
 ## License
 

Rakefile

@@ -13,7 +13,7 @@ task :default => :spec
 task :release => :man
 
 desc "Run all specs"
-Rspec::Core::RakeTask.new(:spec) do |t|
+RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = 'spec/**/*_spec.rb'
 end
 
@@ -22,7 +22,7 @@ task :rcov => "rcov:build" do
   %x{ open coverage/index.html }
 end
 
-Rspec::Core::RakeTask.new("rcov:build") do |t|
+RSpec::Core::RakeTask.new("rcov:build") do |t|
   t.pattern = 'spec/**/*_spec.rb'
   t.rcov = true
   t.rcov_opts = [ "--exclude", ".bundle", "--exclude", "spec" ]

bin/foreman-runner

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+exec ARGV.join(" ")

data/example/ticker

@@ -1,5 +1,11 @@
 #!/usr/bin/env ruby
 
+%w( SIGINT SIGTERM SIGHUP ).each do |signal|
+  trap(signal) do
+    puts "received #{signal} but i'm ignoring it!"
+  end
+end
+
 while true
   puts "tick: #{ARGV.inspect} -- FOO:#{ENV["FOO"]}"
   sleep 1

data/export/upstart/process.conf.erb

@@ -2,5 +2,4 @@ start on starting <%= app %>-<%= process.name %>
 stop on stopping <%= app %>-<%= process.name %>
 respawn
 
-chdir <%= engine.directory %>
+exec su - <%= user %> -c 'cd <%= engine.directory %>; export PORT=<%= port %>; <%= process.command %> >> <%= log_root %>/<%=process.name%>-<%=num%>.log 2>&1'
-exec su <%= user %> -c 'export PORT=<%= port %>; <%= process.command %> >> <%= log_root %>/<%=process.name%>-<%=num%>.log 2>&1'

foreman.gemspec

@@ -25,5 +25,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'fakefs', '~> 0.2.1'
   gem.add_development_dependency 'rcov',   '~> 0.9.8'
   gem.add_development_dependency 'rr',     '~> 1.0.2'
-  gem.add_development_dependency 'rspec',  '~> 2.0.0'
+  gem.add_development_dependency 'rspec',  '~> 2.6.0'
 end

lib/foreman/cli.rb

@@ -30,6 +30,7 @@ class Foreman::CLI < Thor
   method_option :log,         :type => :string,  :aliases => "-l"
   method_option :port,        :type => :numeric, :aliases => "-p"
   method_option :user,        :type => :string,  :aliases => "-u"
+  method_option :template,    :type => :string,  :aliases => "-t"
   method_option :concurrency, :type => :string,  :aliases => "-c",
     :banner => '"alpha=5,bar=3"'
 
@@ -86,7 +87,7 @@ private ######################################################################
   def options
     original_options = super
     return original_options unless File.exists?(".foreman")
-    defaults = YAML::load_file(".foreman")
+    defaults = YAML::load_file(".foreman") || {}
     Thor::CoreExt::HashWithIndifferentAccess.new(defaults.merge(original_options))
   end
 

lib/foreman/engine.rb

@@ -3,6 +3,7 @@ require "foreman/process"
 require "foreman/utils"
 require "pty"
 require "tempfile"
+require "timeout"
 require "term/ansicolor"
 require "fileutils"
 
@@ -24,7 +25,7 @@ class Foreman::Engine
     @processes ||= begin
       @order = []
       procfile.split("\n").inject({}) do |hash, line|
-        next if line.strip == ""
+        next hash if line.strip == ""
         name, command = line.split(/ *: +/, 2)
         unless command
           warn_deprecated_procfile!
@@ -58,8 +59,8 @@ class Foreman::Engine
       fork process, options, environment
     end
 
-    trap("TERM") { puts "SIGTERM received"; kill_all("TERM") }
+    trap("TERM") { puts "SIGTERM received"; terminate_gracefully }
-    trap("INT")  { puts "SIGINT received";  kill_all("TERM")  }
+    trap("INT")  { puts "SIGINT received";  terminate_gracefully }
 
     watch_for_termination
   end
@@ -69,8 +70,8 @@ class Foreman::Engine
 
     fork processes[name], options, environment
 
-    trap("TERM") { puts "SIGTERM received"; kill_all("TERM") }
+    trap("TERM") { puts "SIGTERM received"; terminate_gracefully }
-    trap("INT")  { puts "SIGINT received";  kill_all("TERM")  }
+    trap("INT")  { puts "SIGINT received";  terminate_gracefully }
 
     watch_for_termination
   end
@@ -107,18 +108,18 @@ private ######################################################################
 
   def run(process)
     proctitle "ruby: foreman #{process.name}"
+    trap("SIGINT", "IGNORE")
 
     begin
       Dir.chdir directory do
-        command = process.command
+        PTY.spawn(runner, process.command) do |stdin, stdout, pid|
-
+          trap("SIGTERM") { Process.kill("SIGTERM", pid) }
-        PTY.spawn("#{process.command} 2>&1") do |stdin, stdout, pid|
           until stdin.eof?
             info stdin.gets, process
           end
         end
       end
-    rescue PTY::ChildExited, Interrupt
+    rescue PTY::ChildExited, Interrupt, Errno::EIO
       begin
         info "process exiting", process
       rescue Interrupt
@@ -126,11 +127,9 @@ private ######################################################################
     end
   end
 
-  def kill_all(signal="TERM")
+  def kill_all(signal="SIGTERM")
-    info "terminating"
     running_processes.each do |pid, process|
-      info "killing #{process.name} in pid #{pid}"
+      Process.kill(signal, pid) rescue Errno::ESRCH
-      Process.kill(signal, pid)
     end
   end
 
@@ -179,8 +178,9 @@ private ######################################################################
     pid, status = Process.wait2
     process = running_processes.delete(pid)
     info "process terminated", process
+    terminate_gracefully
     kill_all
-    Process.waitall
+  rescue Errno::ECHILD
   end
 
   def running_processes
@@ -217,4 +217,17 @@ private ######################################################################
     environment
   end
 
+  def runner
+    File.expand_path("../../../bin/foreman-runner", __FILE__)
+  end
+
+  def terminate_gracefully
+    info "sending SIGTERM to all processes"
+    kill_all "SIGTERM"
+    Timeout.timeout(3) { Process.waitall }
+  rescue Timeout::Error
+    info "sending SIGKILL to all processes"
+    kill_all "SIGKILL"
+  end
+
 end

lib/foreman/export/base.rb

@@ -23,8 +23,14 @@ private ######################################################################
     puts "[foreman export] %s" % message
   end
 
-  def export_template(name)
+  def export_template(exporter, file, template_root)
-    File.read(File.expand_path("../../../../data/export/#{name}", __FILE__))
+    if template_root && File.exist?(file_path = File.join(template_root, file))
+      File.read(file_path)
+    elsif File.exist?(file_path = File.join("~/.foreman/templates", file))
+      File.read(file_path)
+    else
+      File.read(File.expand_path("../../../../data/export/#{exporter}/#{file}", __FILE__))
+    end
   end
 
   def write_file(filename, contents)

lib/foreman/export/upstart.rb

@@ -11,6 +11,7 @@ class Foreman::Export::Upstart < Foreman::Export::Base
     app = options[:app] || File.basename(engine.directory)
     user = options[:user] || app
     log_root = options[:log] || "/var/log/#{app}"
+    template_root = options[:template]
 
     Dir["#{location}/#{app}*.conf"].each do |file|
       say "cleaning up: #{file}"
@@ -19,14 +20,14 @@ class Foreman::Export::Upstart < Foreman::Export::Base
 
     concurrency = Foreman::Utils.parse_concurrency(options[:concurrency])
 
-    master_template = export_template("upstart/master.conf.erb")
+    master_template = export_template("upstart", "master.conf.erb", template_root)
     master_config   = ERB.new(master_template).result(binding)
     write_file "#{location}/#{app}.conf", master_config
 
-    process_template = export_template("upstart/process.conf.erb")
+    process_template = export_template("upstart", "process.conf.erb", template_root)
 
     engine.processes.values.each do |process|
-      process_master_template = export_template("upstart/process_master.conf.erb")
+      process_master_template = export_template("upstart", "process_master.conf.erb", template_root)
       process_master_config   = ERB.new(process_master_template).result(binding)
       write_file "#{location}/#{app}-#{process.name}.conf", process_master_config
 

lib/foreman/version.rb

@@ -1,5 +1,5 @@
 module Foreman
 
-  VERSION = "0.16.0"
+  VERSION = "0.20.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" "May 2011" "Foreman 0.15.0" "Foreman Manual"
+.TH "FOREMAN" "1" "August 2011" "Foreman 0.19.0" "Foreman Manual"
 .
 .SH "NAME"
 \fBforeman\fR \- manage Procfile\-based applications
@@ -69,7 +69,7 @@ These options control all modes of foreman\'s operation\.
 .
 .TP
 \fB\-e\fR, \fB\-\-env\fR
-Specify a file containing the environment that should be set up for each child process\. The file should be key/value pairs separated by \fB=\fR, with one key/value pair per line\.
+Specify an alternate environment file\.
 .
 .TP
 \fB\-f\fR, \fB\-\-procfile\fR
@@ -141,6 +141,20 @@ $ foreman check
 .
 .IP "" 0
 .
+.SH "ENVIRONMENT"
+If a \fB\.env\fR file exists in the current directory, the default environment will be read from it\. This file should contain key/value pairs, separated by \fB=\fR, with one key/value pair per line\.
+.
+.IP "" 4
+.
+.nf
+
+FOO=bar
+BAZ=qux
+.
+.fi
+.
+.IP "" 0
+.
 .SH "DEFAULT OPTIONS"
 If a \fB\.foreman\fR file exists in the current directory, default options will be read from it\. This file should be in YAML format with the long option name as keys\. Example:
 .

man/foreman.1.ronn

@@ -67,9 +67,7 @@ The following options control how the application is run:
 These options control all modes of foreman's operation.
 
   * `-e`, `--env`:
-    Specify a file containing the environment that should be set up for each
+    Specify an alternate environment file.
-    child process. The file should be key/value pairs separated by `=`, with
-    one key/value pair per line.
 
   * `-f`, `--procfile`:
     Specify an alternate location for the application's Procfile. This file's
@@ -116,6 +114,15 @@ You can validate your Procfile format using the `check` command
 
     $ foreman check
 
+## ENVIRONMENT
+
+If a `.env` file exists in the current directory, the default environment will
+be read from it. This file should contain key/value pairs, separated by `=`, with
+one key/value pair per line.
+
+    FOO=bar
+    BAZ=qux
+
 ## DEFAULT OPTIONS
 
 If a `.foreman` file exists in the current directory, default options will

spec/foreman/export/upstart_spec.rb

@@ -1,9 +1,11 @@
 require "spec_helper"
 require "foreman/engine"
 require "foreman/export/upstart"
+require "tmpdir"
 
 describe Foreman::Export::Upstart do
-  let(:engine) { Foreman::Engine.new(write_procfile) }
+  let(:procfile) { FileUtils.mkdir_p("/tmp/app"); write_procfile("/tmp/app/Procfile") }
+  let(:engine) { Foreman::Engine.new(procfile) }
   let(:upstart) { Foreman::Export::Upstart.new(engine) }
 
   before(:each) { load_export_templates_into_fakefs("upstart") }
@@ -12,11 +14,42 @@ describe Foreman::Export::Upstart do
   it "exports to the filesystem" do
     upstart.export("/tmp/init")
 
-    File.read("/tmp/init/foreman.conf").should         == example_export_file("upstart/foreman.conf")
+    File.read("/tmp/init/app.conf").should         == example_export_file("upstart/app.conf")
-    File.read("/tmp/init/foreman-alpha.conf").should   == example_export_file("upstart/foreman-alpha.conf")
+    File.read("/tmp/init/app-alpha.conf").should   == example_export_file("upstart/app-alpha.conf")
-    File.read("/tmp/init/foreman-alpha-1.conf").should == example_export_file("upstart/foreman-alpha-1.conf")
+    File.read("/tmp/init/app-alpha-1.conf").should == example_export_file("upstart/app-alpha-1.conf")
-    File.read("/tmp/init/foreman-alpha-2.conf").should == example_export_file("upstart/foreman-alpha-2.conf")
+    File.read("/tmp/init/app-alpha-2.conf").should == example_export_file("upstart/app-alpha-2.conf")
-    File.read("/tmp/init/foreman-bravo.conf").should   == example_export_file("upstart/foreman.bravo.conf")
+    File.read("/tmp/init/app-bravo.conf").should   == example_export_file("upstart/app-bravo.conf")
-    File.read("/tmp/init/foreman-bravo-1.conf").should == example_export_file("upstart/foreman-bravo-1.conf")
+    File.read("/tmp/init/app-bravo-1.conf").should == example_export_file("upstart/app-bravo-1.conf")
   end
+
+  context "with alternate templates" do
+    let(:template_root) { "/tmp/alternate" }
+
+    before do
+      FileUtils.mkdir_p template_root
+      File.open("#{template_root}/master.conf.erb", "w") { |f| f.puts "alternate_template" }
+    end
+
+    it "can export with alternate template files" do
+      upstart.export("/tmp/init", :template => template_root)
+
+      File.read("/tmp/init/app.conf").should == "alternate_template\n"
+    end
+  end
+
+  context "with alternate templates from home dir" do
+    let(:default_template_root) {File.expand_path("~/.foreman/templates")}
+
+    before do
+      FileUtils.mkdir_p default_template_root
+      File.open("#{default_template_root}/master.conf.erb", "w") { |f| f.puts "default_alternate_template" }
+    end
+
+    it "can export with alternate template files" do
+      upstart.export("/tmp/init")
+
+      File.read("/tmp/init/app.conf").should == "default_alternate_template\n"
+    end
+  end
+
 end

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

@@ -0,0 +1,5 @@
+start on starting app-alpha
+stop on stopping app-alpha
+respawn
+
+exec su - app -c 'cd /tmp/app; export PORT=5000; ./alpha >> /var/log/app/alpha-1.log 2>&1'

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

@@ -0,0 +1,5 @@
+start on starting app-alpha
+stop on stopping app-alpha
+respawn
+
+exec su - app -c 'cd /tmp/app; export PORT=5001; ./alpha >> /var/log/app/alpha-2.log 2>&1'

spec/resources/export/upstart/app-alpha.conf

@@ -0,0 +1,2 @@
+start on starting app
+stop on stopping app

spec/resources/export/upstart/app-bravo-1.conf

@@ -0,0 +1,5 @@
+start on starting app-bravo
+stop on stopping app-bravo
+respawn
+
+exec su - app -c 'cd /tmp/app; export PORT=5100; ./bravo >> /var/log/app/bravo-1.log 2>&1'

spec/resources/export/upstart/app-bravo.conf

@@ -0,0 +1,2 @@
+start on starting app
+stop on stopping app

spec/resources/export/upstart/app.conf

@@ -0,0 +1,8 @@
+pre-start script
+
+bash << "EOF"
+  mkdir -p /var/log/app
+  chown -R app /var/log/app
+EOF
+
+end script

spec/resources/export/upstart/foreman-alpha-1.conf

@@ -1,6 +0,0 @@
-start on starting foreman-alpha
-stop on stopping foreman-alpha
-respawn
-
-chdir /Users/david/Code/foreman
-exec su foreman -c 'export PORT=5000; ./alpha >> /var/log/foreman/alpha-1.log 2>&1'

spec/resources/export/upstart/foreman-alpha-2.conf

@@ -1,6 +0,0 @@
-start on starting foreman-alpha
-stop on stopping foreman-alpha
-respawn
-
-chdir /Users/david/Code/foreman
-exec su foreman -c 'export PORT=5001; ./alpha >> /var/log/foreman/alpha-2.log 2>&1'

spec/resources/export/upstart/foreman-alpha.conf

@@ -1,2 +0,0 @@
-start on starting foreman
-stop on stopping foreman

spec/resources/export/upstart/foreman-bravo-1.conf

@@ -1,6 +0,0 @@
-start on starting foreman-bravo
-stop on stopping foreman-bravo
-respawn
-
-chdir /Users/david/Code/foreman
-exec su foreman -c 'export PORT=5100; ./bravo >> /var/log/foreman/bravo-1.log 2>&1'

spec/resources/export/upstart/foreman.bravo.conf

@@ -1,2 +0,0 @@
-start on starting foreman
-stop on stopping foreman

spec/resources/export/upstart/foreman.conf

@@ -1,8 +0,0 @@
-pre-start script
-
-bash << "EOF"
-  mkdir -p /var/log/foreman
-  chown -R foreman /var/log/foreman
-EOF
-
-end script

spec/spec_helper.rb

@@ -27,6 +27,7 @@ end
 def write_procfile(procfile="Procfile")
   File.open(procfile, "w") do |file|
     file.puts "alpha: ./alpha"
+    file.puts "\n"
     file.puts "bravo: ./bravo"
   end
   File.expand_path(procfile)
@@ -52,7 +53,7 @@ def example_export_file(filename)
   data
 end
 
-Rspec.configure do |config|
+RSpec.configure do |config|
   config.color_enabled = true
   config.include FakeFS::SpecHelpers
   config.mock_with :rr