foreman 0.15.0 → 0.27.0

data/README.markdown

@@ -1,11 +1,49 @@
 # Foreman
 
-## Manual
+## Installation
+
+* Rubygems
+
+    gem install foreman
+
+* OSX
+
+    http://assets.foreman.io/foreman/foreman.pkg
+
+* Standalone Tarball
+
+    http://assets.foreman.io/foreman/foreman.tgz
+
+## Description
 
 http://blog.daviddollar.org/2011/05/06/introducing-foreman.html
 
+## Manual
+
 See the [man page](http://ddollar.github.com/foreman) for usage.
 
+## Authorship
+
+Created by David Dollar
+
+Patches contributed by:
+
+* Adam Wiggins
+* Dan Peterson
+* Hunter Nield
+* Jay Zeschin
+* Keith Rarick
+* Khaja Minhajuddin
+* Matt Haynes
+* Michael van Rooijen
+* Mike Javorski
+* Nathan L Smith
+* Nick Zadrozny
+* Ricardo Chimal, Jr
+* Thom May
+* clifff
+* Greg Reinacker
+
 ## License
 
 MIT

data/data/example/Procfile

@@ -1,2 +1,2 @@
-ticker: ./ticker $PORT
-error : ./error
+ticker: ruby ./ticker $PORT
+error:  ruby ./error

data/data/example/error

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+$stdout.sync = true
+
 puts "will error in 10s"
 sleep 5
 raise "Dying"

data/data/example/ticker

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

data/data/export/bluepill/master.pill.erb

@@ -0,0 +1,27 @@
+Bluepill.application("<%= app %>", :foreground => false, :log_file => "/var/log/bluepill.log") do |app|
+
+  app.uid = "<%= user %>"
+  app.gid = "<%= user %>"
+
+<% engine.processes.each do |process| %>
+<% 1.upto(concurrency[process.name]) do |num| %>
+<% port = engine.port_for(process, num, options[:port]) %>
+  app.process("<%= process.name %>-<%=num%>") do |process|
+    process.start_command = "<%= process.command.gsub("$PORT", port.to_s) %>"
+
+    process.working_dir = "<%= engine.directory %>"
+    process.daemonize = true
+    process.environment = {"PORT" => "<%= port %>"}
+    process.stop_signals = [:quit, 30.seconds, :term, 5.seconds, :kill]
+
+    process.stdout = process.stderr = "<%= log_root %>/<%= app %>-<%= process.name %>-<%=num%>.log"
+
+    process.monitor_children do |children|
+      children.stop_command "kill -QUIT {{PID}}"
+    end
+    
+    process.group = "<%= app %>-<%= process.name %>"
+  end
+<% end %>
+<% end %>
+end

data/data/export/runit/log_run.erb

@@ -0,0 +1,7 @@
+#!/bin/sh
+set -e
+
+LOG=<%= log_root %>/<%= process.name %>-<%= num %>
+
+test -d "$LOG" || mkdir -p m2750 "$LOG" && chown <%= user %> "$LOG"
+exec chpst -u <%= user %> svlogd "$LOG"

data/data/export/runit/run.erb

@@ -0,0 +1,3 @@
+#!/bin/sh
+cd <%= engine.directory %>
+exec chpst -u <%= user %> -e <%= process_env_directory %> <%= process.command %>

data/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 'export PORT=<%= port %>; <%= process.command %> >> <%= log_root %>/<%=process.name%>-<%=num%>.log 2>&1'
+exec su - <%= user %> -c 'cd <%= engine.directory %>; export PORT=<%= port %>;<% engine.environment.each_pair do |var,env| %> export <%= var.upcase %>=<%= env %>; <% end %> <%= process.command %> >> <%= log_root %>/<%=process.name%>-<%=num%>.log 2>&1'

data/lib/foreman/cli.rb

@@ -10,17 +10,17 @@ class Foreman::CLI < Thor
 
   desc "start [PROCESS]", "Start the application, or a specific process"
 
+  method_option :env,         :type => :string,  :aliases => "-e", :desc => "Specify an environment file to load, defaults to .env"
   method_option :port,        :type => :numeric, :aliases => "-p"
-  method_option :concurrency, :type => :string,  :aliases => "-c",
-    :banner => '"alpha=5,bar=3"'
+  method_option :concurrency, :type => :string,  :aliases => "-c", :banner => '"alpha=5,bar=3"'
 
   def start(process=nil)
     check_procfile!
 
     if process
-      engine.execute(process, options)
+      engine.execute(process)
     else
-      engine.start(options)
+      engine.start
     end
   end
 
@@ -28,8 +28,10 @@ class Foreman::CLI < Thor
 
   method_option :app,         :type => :string,  :aliases => "-a"
   method_option :log,         :type => :string,  :aliases => "-l"
+  method_option :env,         :type => :string,  :aliases => "-e", :desc => "Specify an environment file to load, defaults to .env"
   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"'
 
@@ -39,6 +41,8 @@ class Foreman::CLI < Thor
     formatter = case format
       when "inittab" then Foreman::Export::Inittab
       when "upstart" then Foreman::Export::Upstart
+      when "bluepill" then Foreman::Export::Bluepill
+      when "runit"    then Foreman::Export::Runit
       else error "Unknown export format: #{format}."
     end
 
@@ -51,9 +55,8 @@ class Foreman::CLI < Thor
   desc "check", "Validate your application's Procfile"
 
   def check
-    processes = engine.processes_in_order.map { |p| p.first }
-    error "no processes defined" unless processes.length > 0
-    display "valid procfile detected (#{processes.join(', ')})"
+    error "no processes defined" unless engine.processes.length > 0
+    display "valid procfile detected (#{engine.processes.map(&:name).join(', ')})"
   end
 
 private ######################################################################
@@ -63,7 +66,7 @@ private ######################################################################
   end
 
   def engine
-    @engine ||= Foreman::Engine.new(procfile)
+    @engine ||= Foreman::Engine.new(procfile, options)
   end
 
   def procfile
@@ -86,7 +89,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
 

data/lib/foreman/distribution.rb

@@ -0,0 +1,9 @@
+module Foreman
+  module Distribution
+    def self.files
+      Dir[File.expand_path("../../../{bin,data,lib}/**/*", __FILE__)].select do |file|
+        File.file?(file)
+      end
+    end
+  end
+end

data/lib/foreman/engine.rb

@@ -1,8 +1,10 @@
 require "foreman"
 require "foreman/process"
+require "foreman/procfile"
 require "foreman/utils"
 require "pty"
 require "tempfile"
+require "timeout"
 require "term/ansicolor"
 require "fileutils"
 
@@ -10,84 +12,73 @@ class Foreman::Engine
 
   attr_reader :procfile
   attr_reader :directory
+  attr_reader :options
 
   extend Term::ANSIColor
 
   COLORS = [ cyan, yellow, green, magenta, red ]
 
-  def initialize(procfile)
-    @procfile  = read_procfile(procfile)
+  def initialize(procfile, options={})
+    @procfile  = Foreman::Procfile.new(procfile)
     @directory = File.expand_path(File.dirname(procfile))
+    @options = options
+    @environment = read_environment_files(options[:env])
   end
 
-  def processes
-    @processes ||= begin
-      @order = []
-      procfile.split("\n").inject({}) do |hash, line|
-        next if line.strip == ""
-        name, command = line.split(/ *: +/, 2)
-        unless command
-          warn_deprecated_procfile!
-          name, command = line.split(/ +/, 2)
-        end
-        process = Foreman::Process.new(name, command)
-        process.color = next_color
-        @order << process.name
-        hash.update(process.name => process)
-      end
-    end
-  end
-
-  def process_order
-    processes
-    @order.uniq
+  def self.load_env!(env_file)
+    @environment = read_environment_files(env_file)
+    apply_environment!
   end
 
-  def processes_in_order
-    process_order.map do |name|
-      [name, processes[name]]
-    end
-  end
-
-  def start(options={})
+  def start
     proctitle "ruby: foreman master"
+    termtitle "#{File.basename(@directory)} - foreman (#{processes.size} processes)"
 
-    processes_in_order.each do |name, process|
-      fork process, options
+    processes.each do |process|
+      process.color = next_color
+      fork process
     end
 
-    trap("TERM") { puts "SIGTERM received"; kill_all("TERM") }
-    trap("INT")  { puts "SIGINT received";  kill_all("TERM")  }
+    trap("TERM") { puts "SIGTERM received"; terminate_gracefully }
+    trap("INT")  { puts "SIGINT received";  terminate_gracefully }
 
     watch_for_termination
   end
 
-  def execute(name, options={})
-    fork processes[name], options
+  def execute(name)
+    error "no such process: #{name}" unless process = procfile[name]
+    process.color = next_color
+    fork process
 
-    trap("TERM") { puts "SIGTERM received"; kill_all("TERM") }
-    trap("INT")  { puts "SIGINT received";  kill_all("TERM")  }
+    trap("TERM") { puts "SIGTERM received"; terminate_gracefully }
+    trap("INT")  { puts "SIGINT received";  terminate_gracefully }
 
     watch_for_termination
   end
 
+  def processes
+    procfile.processes
+  end
+
   def port_for(process, num, base_port=nil)
     base_port ||= 5000
-    offset = processes_in_order.map { |p| p.first }.index(process.name) * 100
+    offset = procfile.process_names.index(process.name) * 100
     base_port.to_i + offset + num - 1
   end
 
 private ######################################################################
 
-  def fork(process, options={})
-    concurrency = Foreman::Utils.parse_concurrency(options[:concurrency])
+  def fork(process)
+    concurrency = Foreman::Utils.parse_concurrency(@options[:concurrency])
 
     1.upto(concurrency[process.name]) do |num|
-      fork_individual(process, num, port_for(process, num, options[:port]))
+      fork_individual(process, num, port_for(process, num, @options[:port]))
     end
   end
 
   def fork_individual(process, num, port)
+    apply_environment!
+
     ENV["PORT"] = port.to_s
     ENV["PS"]   = "#{process.name}.#{num}"
 
@@ -101,18 +92,18 @@ private ######################################################################
 
   def run(process)
     proctitle "ruby: foreman #{process.name}"
+    trap("SIGINT", "IGNORE")
 
     begin
       Dir.chdir directory do
-        command = process.command
-
-        PTY.spawn("#{process.command} 2>&1") do |stdin, stdout, pid|
+        PTY.spawn(process.command) do |stdin, stdout, pid|
+          trap("SIGTERM") { Process.kill("SIGTERM", pid) }
           until stdin.eof?
             info stdin.gets, process
           end
         end
       end
-    rescue PTY::ChildExited, Interrupt
+    rescue PTY::ChildExited, Interrupt, Errno::EIO, Errno::ENOENT
       begin
         info "process exiting", process
       rescue Interrupt
@@ -120,14 +111,30 @@ private ######################################################################
     end
   end
 
-  def kill_all(signal="TERM")
-    info "terminating"
+  def kill_all(signal="SIGTERM")
     running_processes.each do |pid, process|
-      info "killing #{process.name} in pid #{pid}"
-      Process.kill(signal, pid)
+      Process.kill(signal, pid) rescue Errno::ESRCH
     end
   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
+
+  def watch_for_termination
+    pid, status = Process.wait2
+    process = running_processes.delete(pid)
+    info "process terminated", process
+    terminate_gracefully
+    kill_all
+  rescue Errno::ECHILD
+  end
+
   def info(message, process=nil)
     print process.color if process
     print "#{Time.now.strftime("%H:%M:%S")} #{pad_process_name(process)} | "
@@ -136,9 +143,14 @@ private ######################################################################
     puts
   end
 
+  def error(message)
+    puts "ERROR: #{message}"
+    exit 1
+  end
+
   def longest_process_name
     @longest_process_name ||= begin
-      longest = processes.keys.map { |name| name.length }.sort.last
+      longest = procfile.process_names.map { |name| name.length }.sort.last
       longest = 6 if longest < 6 # system
       longest
     end
@@ -149,27 +161,12 @@ private ######################################################################
     name.ljust(longest_process_name + 3) # add 3 for process number padding
   end
 
-  def print_info
-    info "currently running processes:"
-    running_processes.each do |pid, process|
-      info "pid #{pid}", process
-    end
-  end
-
   def proctitle(title)
     $0 = title
   end
 
-  def read_procfile(procfile)
-    File.read(procfile)
-  end
-
-  def watch_for_termination
-    pid, status = Process.wait2
-    process = running_processes.delete(pid)
-    info "process terminated", process
-    kill_all
-    Process.waitall
+  def termtitle(title)
+    printf("\033]0;#{title}\007")
   end
 
   def running_processes
@@ -182,12 +179,37 @@ private ######################################################################
     @current_color >= COLORS.length ? "" : COLORS[@current_color]
   end
 
-  def warn_deprecated_procfile!
-    return if @already_warned_deprecated
-    @already_warned_deprecated = true
-    puts "!!! This format of Procfile is deprecated, and will not work starting in v0.12"
-    puts "!!! Use a colon to separate the process name from the command"
-    puts "!!! e.g.   web: thin start"
+  module Env
+    attr_reader :environment
+
+    def read_environment_files(filenames)
+      environment = {}
+
+      (filenames || "").split(",").map(&:strip).each do |filename|
+        error "No such file: #{filename}" unless File.exists?(filename)
+        environment.merge!(read_environment(filename))
+      end
+
+      environment.merge!(read_environment(".env")) unless filenames
+      environment
+    end
+
+    def read_environment(filename)
+      return {} unless File.exists?(filename)
+
+      File.read(filename).split("\n").inject({}) do |hash, line|
+        if line =~ /\A([A-Za-z_0-9]+)=(.*)\z/
+          hash[$1] = $2
+        end
+        hash
+      end
+    end
+
+    def apply_environment!
+      @environment.each { |k,v| ENV[k] = v }
+    end
   end
 
+  include Env
+  extend  Env
 end

data/lib/foreman/export/base.rb

@@ -23,8 +23,14 @@ private ######################################################################
     puts "[foreman export] %s" % message
   end
 
-  def export_template(name)
-    File.read(File.expand_path("../../../../data/export/#{name}", __FILE__))
+  def 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.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)

data/lib/foreman/export/bluepill.rb

@@ -0,0 +1,28 @@
+require "erb"
+require "foreman/export"
+
+class Foreman::Export::Bluepill < Foreman::Export::Base
+
+  def export(location, options={})
+    error("Must specify a location") unless location
+
+    FileUtils.mkdir_p location
+
+    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}.pill"].each do |file|
+      say "cleaning up: #{file}"
+      FileUtils.rm(file)
+    end
+
+    concurrency = Foreman::Utils.parse_concurrency(options[:concurrency])
+
+    master_template = export_template("bluepill", "master.pill.erb", template_root)
+    master_config   = ERB.new(master_template).result(binding)
+    write_file "#{location}/#{app}.pill", master_config
+  end
+
+end

data/lib/foreman/export/inittab.rb

@@ -1,4 +1,4 @@
-require "foreman/export/base"
+require "foreman/export"
 
 class Foreman::Export::Inittab < Foreman::Export::Base
 
@@ -12,7 +12,7 @@ class Foreman::Export::Inittab < Foreman::Export::Base
     inittab = []
     inittab << "# ----- foreman #{app} processes -----"
 
-    engine.processes.values.inject(1) do |index, process|
+    engine.processes.inject(1) do |index, process|
       1.upto(concurrency[process.name]) do |num|
         id = app.slice(0, 2).upcase + sprintf("%02d", index)
         port = engine.port_for(process, num, options[:port])

data/lib/foreman/export/runit.rb

@@ -0,0 +1,60 @@
+require "erb"
+require "foreman/export"
+
+class Foreman::Export::Runit < Foreman::Export::Base
+  ENV_VARIABLE_REGEX = /([a-zA-Z_]+[a-zA-Z0-9_]*)=(\S+)/
+  
+  def export(location, options={})
+    error("Must specify a location") unless location
+    
+    app = options[:app] || File.basename(engine.directory)
+    user = options[:user] || app
+    log_root = options[:log] || "/var/log/#{app}"
+    template_root = options[:template]
+    
+    concurrency = Foreman::Utils.parse_concurrency(options[:concurrency])
+    
+    run_template = export_template('runit', 'run.erb', template_root)
+    log_run_template = export_template('runit', 'log_run.erb', template_root)
+
+    engine.processes.each do |process|
+      1.upto(concurrency[process.name]) do |num|
+        process_directory     = "#{location}/#{app}-#{process.name}-#{num}"
+        process_env_directory = "#{process_directory}/env"
+        process_log_directory = "#{process_directory}/log"
+        
+        create_directory process_directory
+        create_directory process_env_directory
+        create_directory process_log_directory
+        
+        run = ERB.new(run_template).result(binding)
+        write_file "#{process_directory}/run", run
+        
+        port = engine.port_for(process, num, options[:port])
+        environment_variables = {'PORT' => port}.
+            merge(engine.environment).
+            merge(inline_variables(process.command))
+            
+        environment_variables.each_pair do |var, env|
+          write_file "#{process_env_directory}/#{var.upcase}", env
+        end
+        
+        log_run = ERB.new(log_run_template).result(binding)
+        write_file "#{process_log_directory}/run", log_run
+        
+      end
+    end
+    
+  end
+  
+  private
+  def create_directory(location)
+    say "creating: #{location}"
+    FileUtils.mkdir(location)
+  end
+  
+  def inline_variables(command)
+    variable_name_regex = 
+    Hash[*command.scan(ENV_VARIABLE_REGEX).flatten]
+  end
+end

data/lib/foreman/export/upstart.rb

@@ -1,5 +1,5 @@
 require "erb"
-require "foreman/export/base"
+require "foreman/export"
 
 class Foreman::Export::Upstart < Foreman::Export::Base
 
@@ -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,15 @@ 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")
+    engine.processes.each do |process|
+      next if (conc = concurrency[process.name]) < 1
+      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
 

data/lib/foreman/export.rb

@@ -4,5 +4,8 @@ module Foreman::Export
   class Exception < ::Exception; end
 end
 
+require "foreman/export/base"
 require "foreman/export/inittab"
 require "foreman/export/upstart"
+require "foreman/export/bluepill"
+require "foreman/export/runit"