0.49.0

Avoid crash by verifying the existence of SIGHUP before accessing it.

.travis.yml

@@ -1,8 +1,11 @@
 script: bundle exec rake spec
 
-rvm:
-  - 1.9.2
-  - 1.9.3
+matrix:
+  allow_failures:
+    - rvm: 1.8.7
+    - rvm: jruby
+    - rvm: rbx
+    - rvm: ree
 
 notifications:
   email: false
@@ -11,3 +14,11 @@ notifications:
     on_failure: always
     urls:
       - http://dx-helper.herokuapp.com/travis
+
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby
+  - rbx
+  - ree

Changelog.md

@@ -1,3 +1,20 @@
+## 0.48.0.pre1 (2012-06-11)
+
+* Massive refactoring for programmatic control and stability  [David Dollar]
+* Procfile commands with shell interpolations now work again  [David Dollar]
+* Stop trying to test on Ruby 1.8  [David Dollar]
+
+## 0.47.0 (2012-06-07)
+
+* Fix multi-word argument handling in `foreman run`.  [Daniel Brockman]
+* Make 'PORT=5000 foreman start' work  [Koen Van der Auwera]
+* Terminate gracefully upon SIGHUP  [Stefan Schüßler]
+* Set port from .env if specified  [Koen Van der Auwera]
+* Updated bluepill exporter to use environment variables from .env  [Aneeth]
+* Added launchd exporter  [Maxwell Swadling]
+* Quote and escape environment variables in upstart templates  [Matt Griffin]
+* Added list of ports to other languages to README  [elf Pavlik]
+
 ## 0.46.0 (2012-05-02)
 
 * Add Profile load/write/append API  [Michael Granger]

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    foreman (0.47.0)
+    foreman (0.49.0)
       thor (>= 0.13.6)
 
 GEM
@@ -39,7 +39,7 @@ GEM
       multi_json (~> 1.0.3)
       simplecov-html (~> 0.5.3)
     simplecov-html (0.5.3)
-    thor (0.14.6)
+    thor (0.15.4)
     timecop (0.3.5)
     win32console (1.3.0-x86-mingw32)
     xml-simple (1.0.15)

data/example/spawnee

@@ -9,6 +9,6 @@ sigterm() {
 #trap sigterm SIGTERM
 
 while true; do
-  echo "$NAME: ping"
+  echo "$NAME: ping $$"
   sleep 1
 done

lib/foreman.rb

@@ -12,6 +12,10 @@ module Foreman
     defined?(RUBY_PLATFORM) and RUBY_PLATFORM == "java"
   end
 
+  def self.ruby_18?
+    defined?(RUBY_VERSION) and RUBY_VERSION =~ /^1\.8\.\d+/
+  end
+
   def self.windows?
     defined?(RUBY_PLATFORM) and RUBY_PLATFORM =~ /(win|w)32$/
   end

lib/foreman/cli.rb

@@ -3,18 +3,23 @@ require "foreman/helpers"
 require "foreman/engine"
 require "foreman/engine/cli"
 require "foreman/export"
+require "foreman/version"
 require "shellwords"
+require "yaml"
 require "thor"
 
 class Foreman::CLI < Thor
 
   include Foreman::Helpers
 
+  map ["-v", "--version"] => :version
+
   class_option :procfile, :type => :string, :aliases => "-f", :desc => "Default: Procfile"
   class_option :root,     :type => :string, :aliases => "-d", :desc => "Default: Procfile directory"
 
   desc "start [PROCESS]", "Start the application (or a specific PROCESS)"
 
+  method_option :color,     :type => :boolean, :aliases => "-c", :desc => "Force color to be enabled"
   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"
@@ -79,15 +84,17 @@ class Foreman::CLI < Thor
     end
   end
 
+  desc "version", "Display Foreman gem version"
+
+  def version
+    puts Foreman::VERSION
+  end
+
   no_tasks do
     def engine
       @engine ||= begin
         engine_class = Foreman::Engine::CLI
-        engine = engine_class.new(
-          :formation => options[:formation],
-          :port      => options[:port],
-          :root      => options[:root]
-        )
+        engine = engine_class.new(options)
         engine
       end
     end
@@ -126,7 +133,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

@@ -24,7 +24,7 @@ class Foreman::Engine
   def initialize(options={})
     @options = options.dup
 
-    @options[:formation] ||= "all=1"
+    @options[:formation] ||= (options[:concurrency] || "all=1")
 
     @env       = {}
     @mutex     = Mutex.new
@@ -39,7 +39,7 @@ class Foreman::Engine
   def start
     trap("TERM") { puts "SIGTERM received"; terminate_gracefully }
     trap("INT")  { puts "SIGINT received";  terminate_gracefully }
-    trap("HUP")  { puts "SIGHUP received";  terminate_gracefully }
+    trap("HUP")  { puts "SIGHUP received";  terminate_gracefully } if ::Signal.list.keys.include? 'HUP'
 
     startup
     spawn_processes
@@ -99,13 +99,7 @@ class Foreman::Engine
   # @param [String] signal  The signal to send to each process
   #
   def killall(signal="SIGTERM")
-    @running.each do |pid, (process, index)|
-      system "sending #{signal} to #{name_for(pid)} at pid #{pid}"
-      begin
-        Process.kill(signal, -1 * pid)
-      rescue Errno::ESRCH, Errno::EPERM
-      end
-    end
+    Process.kill "-#{signal}", Process.pid
   end
 
   # Get the process formation
@@ -154,11 +148,28 @@ class Foreman::Engine
   #
   # @param [Foreman::Process] process   A +Process+ associated with this engine
   # @param [Fixnum]           instance  The instance of the process
-  # 
+  #
   # @returns [Fixnum] port  The port to use for this instance of this process
   #
-  def port_for(process, instance)
-    base_port + (@processes.index(process) * 100) + (instance - 1)
+  def port_for(process, instance, base=nil)
+    if base
+      base + (@processes.index(process.process) * 100) + (instance - 1)
+    else
+      base_port + (@processes.index(process) * 100) + (instance - 1)
+    end
+  end
+
+  # Get the base port for this foreman instance
+  #
+  # @returns [Fixnum] port  The base port
+  #
+  def base_port
+    (options[:port] || env["PORT"] || ENV["PORT"] || 5000).to_i
+  end
+
+  # deprecated
+  def environment
+    env
   end
 
 private
@@ -179,10 +190,6 @@ private
 
 ## Helpers ##########################################################
 
-  def base_port
-    (options[:port] || env["PORT"] || ENV["PORT"] || 5000).to_i
-  end
-
   def create_pipe
     IO.method(:pipe).arity.zero? ? IO.pipe : IO.pipe("BINARY")
   end
@@ -193,7 +200,7 @@ private
   end
 
   def parse_formation(formation)
-    pairs = @options[:formation].to_s.gsub(/\s/, "").split(",")
+    pairs = formation.to_s.gsub(/\s/, "").split(",")
 
     pairs.inject(Hash.new(0)) do |ax, pair|
       process, amount = pair.split("=")
@@ -253,7 +260,7 @@ private
         loop do
           (IO.select(@readers.values).first || []).each do |reader|
             data = reader.gets
-            output_with_mutex name_for(@readers.key(reader)), data
+            output_with_mutex name_for(@readers.invert[reader]), data
           end
         end
       rescue Exception => ex

lib/foreman/engine/cli.rb

@@ -24,11 +24,13 @@ class Foreman::Engine::CLI < Foreman::Engine
       :bright_white   => 37,
     }
 
-    def self.enable(io)
+    def self.enable(io, force=false)
       io.extend(self)
+      @@color_force = force
     end
 
     def color?
+      return true if @@color_force
       return false unless self.respond_to?(:isatty)
       self.isatty && ENV["TERM"]
     end
@@ -51,14 +53,17 @@ class Foreman::Engine::CLI < Foreman::Engine
 
   def output(name, data)
     data.to_s.chomp.split("\n").each do |message|
-      Color.enable($stdout) unless $stdout.respond_to?(:color?)
+      Color.enable($stdout, options[:color]) unless $stdout.respond_to?(:color?)
       output  = ""
       output += $stdout.color(@colors[name.split(".").first].to_sym)
       output += "#{Time.now.strftime("%H:%M:%S")} #{pad_process_name(name)} | "
       output += $stdout.color(:reset)
       output += message
       $stdout.puts output
+      $stdout.flush
     end
+  rescue Errno::EPIPE
+    terminate_gracefully
   end
 
   def shutdown

lib/foreman/export.rb

@@ -1,5 +1,6 @@
 require "foreman"
 require "foreman/helpers"
+require "pathname"
 
 module Foreman::Export
   extend Foreman::Helpers
@@ -31,4 +32,3 @@ require "foreman/export/bluepill"
 require "foreman/export/runit"
 require "foreman/export/supervisord"
 require "foreman/export/launchd"
-

lib/foreman/export/base.rb

@@ -1,4 +1,6 @@
 require "foreman/export"
+require "ostruct"
+require "pathname"
 require "shellwords"
 
 class Foreman::Export::Base
@@ -8,11 +10,37 @@ class Foreman::Export::Base
   attr_reader :options
   attr_reader :formation
 
+  # deprecated
+  attr_reader :port
+
   def initialize(location, engine, options={})
     @location  = location
     @engine    = engine
     @options   = options.dup
     @formation = engine.formation
+
+    # deprecated
+    def port
+      Foreman::Export::Base.warn_deprecation!
+      engine.base_port
+    end
+
+    # deprecated
+    def template
+      Foreman::Export::Base.warn_deprecation!
+      options[:template]
+    end
+
+    # deprecated
+    def @engine.procfile
+      Foreman::Export::Base.warn_deprecation!
+      @processes.map do |process|
+        OpenStruct.new(
+          :name => @names[process],
+          :process => process
+        )
+      end
+    end
   end
 
   def export
@@ -36,6 +64,18 @@ class Foreman::Export::Base
 
 private ######################################################################
 
+  def self.warn_deprecation!
+    @@deprecation_warned ||= false
+    return if @@deprecation_warned
+    puts "WARNING: Using deprecated exporter interface. Please update your exporter"
+    puts "the interface shown in the upstart exporter:"
+    puts
+    puts "https://github.com/ddollar/foreman/blob/master/lib/foreman/export/upstart.rb"
+    puts "https://github.com/ddollar/foreman/blob/master/data/export/upstart/process.conf.erb"
+    puts
+    @@deprecation_warned = true
+  end
+
   def error(message)
     raise Foreman::Export::Exception.new(message)
   end
@@ -54,13 +94,28 @@ private ######################################################################
     '"' + Shellwords.escape(value) + '"'
   end
 
-  def export_template(name)
-    name_without_first = name.split("/")[1..-1].join("/")
-    matchers = []
-    matchers << File.join(options[:template], name_without_first) if options[:template]
-    matchers << File.expand_path("~/.foreman/templates/#{name}")
-    matchers << File.expand_path("../../../../data/export/#{name}", __FILE__)
-    File.read(matchers.detect { |m| File.exists?(m) })
+  # deprecated
+  def old_export_template(exporter, file, template_root)
+    if template_root && File.exist?(file_path = File.join(template_root, file))
+      File.read(file_path)
+    elsif File.exist?(file_path = File.expand_path(File.join("~/.foreman/templates", file)))
+      File.read(file_path)
+    else
+      File.read(File.expand_path("../../../../data/export/#{exporter}/#{file}", __FILE__))
+    end
+  end
+
+  def export_template(name, file=nil, template_root=nil)
+    if file && template_root
+      old_export_template name, file, template_root
+    else
+      name_without_first = name.split("/")[1..-1].join("/")
+      matchers = []
+      matchers << File.join(options[:template], name_without_first) if options[:template]
+      matchers << File.expand_path("~/.foreman/templates/#{name}")
+      matchers << File.expand_path("../../../../data/export/#{name}", __FILE__)
+      File.read(matchers.detect { |m| File.exists?(m) })
+    end
   end
 
   def write_template(name, target, binding)
@@ -81,7 +136,9 @@ private ######################################################################
   def write_file(filename, contents)
     say "writing: #{filename}"
 
-    File.open(File.join(location, filename), "w") do |file|
+    filename = File.join(location, filename) unless Pathname.new(filename).absolute?
+
+    File.open(filename, "w") do |file|
       file.puts contents
     end
   end

lib/foreman/process.rb

@@ -36,16 +36,25 @@ class Foreman::Process
 
     if Foreman.windows?
       Dir.chdir(cwd) do
-        Process.spawn env, command, :out => output, :err => output, :new_pgroup => true
+        Process.spawn env, command, :out => output, :err => output
       end
     elsif Foreman.jruby?
       Dir.chdir(cwd) do
         require "posix/spawn"
-        POSIX::Spawn.spawn env, command, :out => output, :err => output, :pgroup => 0
+        POSIX::Spawn.spawn env, command, :out => output, :err => output
+      end
+    elsif Foreman.ruby_18?
+      Dir.chdir(cwd) do
+        fork do
+          $stdout.reopen output
+          $stderr.reopen output
+          env.each { |k,v| ENV[k] = v }
+          exec command
+        end
       end
     else
       Dir.chdir(cwd) do
-        Process.spawn env, command, :out => output, :err => output, :pgroup => 0
+        Process.spawn env, command, :out => output, :err => output
       end
     end
   end
@@ -55,7 +64,7 @@ class Foreman::Process
   # @param [String] signal  The signal to send
   #
   def kill(signal)
-    pid && Process.kill(signal, -1 * pid)
+    pid && Process.kill("-#{signal}", pid)
   rescue Errno::ESRCH
     false
   end

lib/foreman/version.rb

@@ -1,5 +1,5 @@
 module Foreman
 
-  VERSION = "0.47.0"
+  VERSION = "0.49.0"
 
 end

spec/foreman/cli_spec.rb

@@ -74,4 +74,14 @@ describe "Foreman::CLI", :fakefs do
     end
   end
 
+  describe "version" do
+    it "displays gem version" do
+      foreman("version").chomp.should == Foreman::VERSION
+    end
+
+    it "displays gem version on shortcut command" do
+      foreman("-v").chomp.should == Foreman::VERSION
+    end
+  end
+
 end

spec/spec_helper.rb

@@ -54,7 +54,6 @@ def fork_and_capture(&blk)
   Process.wait pid
   buffer = ""
   until rd.eof?
-    p [:foo]
     buffer += rd.gets
   end
 end

tasks/release.rake

@@ -35,7 +35,7 @@ def newer_release
   tags = %x{ git tag --contains v#{latest_release} }.split("\n").sort_by do |tag|
     Gem::Version.new(tag[1..-1])
   end
-  tags.reject { |tag| Gem::Version.new(tag[1..-1]).prerelease? }[1]
+  tags[1]
 end
 
 desc "Generate a Changelog"