0.36.1

Change default concurrency to 0 when concurrency is provided

.travis.yml

@@ -0,0 +1,14 @@
+script: bundle exec rake spec
+
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+
+notifications:
+  email: false
+  webhooks:
+    on_success: always
+    on_failure: always
+    urls:
+      - https://dx-helper.herokuapp.com/travis

Changelog

@@ -0,0 +1,11 @@
+0.26.1 12/05/2011 6160246da0fafe9cf8fde188d94bbc6babc667dc
+==========================================================
+
+Merge pull request #103 from csquared/load_env_from_irb   [David Dollar]
+refactor load_env to apply_environment   [Chris Continanza]
+rename load! to load_env!   [Chris Continanza]
+use ./.env as default   [Chris Continanza]
+load contents from env file   [Chris Continanza]
+refactor engine to expose env methods   [Chris Continanza]
+disable email notifications   [David Dollar]
+add travis config   [David Dollar]

Gemfile

@@ -6,10 +6,10 @@ group :development do
   gem 'parka'
   gem 'rake'
   gem 'ronn'
-  gem 'fakefs', '~> 0.2.1'
+  gem 'fakefs', '~> 0.3.2'
   gem 'rcov',   '~> 0.9.8'
   gem 'rr',     '~> 1.0.2'
-  gem 'rspec',  '~> 2.6.0'
+  gem 'rspec',  '~> 2.0'
   gem 'aws-s3'
   gem "rubyzip"
 end

Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    foreman (0.23.1)
-      term-ansicolor (~> 1.0.5)
+    foreman (0.36.1)
+      term-ansicolor (~> 1.0.7)
       thor (>= 0.13.6)
 
 GEM
@@ -14,8 +14,8 @@ GEM
       xml-simple
     builder (3.0.0)
     crack (0.1.8)
-    diff-lcs (1.1.2)
-    fakefs (0.2.1)
+    diff-lcs (1.1.3)
+    fakefs (0.3.2)
     hpricot (0.8.2)
     mime-types (1.16)
     mustache (0.11.2)
@@ -23,7 +23,7 @@ GEM
       crack
       rest-client
       thor
-    rake (0.9.2)
+    rake (0.9.2.2)
     rcov (0.9.8)
     rdiscount (1.6.5)
     rest-client (1.6.1)
@@ -33,16 +33,16 @@ GEM
       mustache (>= 0.7.0)
       rdiscount (>= 1.5.8)
     rr (1.0.2)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
+    rspec-mocks (2.8.0)
     rubyzip (0.9.4)
-    term-ansicolor (1.0.6)
+    term-ansicolor (1.0.7)
     thor (0.14.6)
     xml-simple (1.0.15)
 
@@ -51,12 +51,12 @@ PLATFORMS
 
 DEPENDENCIES
   aws-s3
-  fakefs (~> 0.2.1)
+  fakefs (~> 0.3.2)
   foreman!
   parka
   rake
   rcov (~> 0.9.8)
   ronn
   rr (~> 1.0.2)
-  rspec (~> 2.6.0)
+  rspec (~> 2.0)
   rubyzip

README.markdown

@@ -20,7 +20,8 @@ http://blog.daviddollar.org/2011/05/06/introducing-foreman.html
 
 ## Manual
 
-See the [man page](http://ddollar.github.com/foreman) for usage.
+* [man page](http://ddollar.github.com/foreman)
+* [wiki](http://github.com/ddollar/foreman/wiki)
 
 ## Authorship
 

Rakefile

@@ -166,3 +166,22 @@ end
 Dir[File.expand_path("../dist/**/*.rake", __FILE__)].each do |rake|
   import rake
 end
+
+task :changelog do
+  timestamp = Time.now.utc.strftime('%m/%d/%Y')
+  sha = `git log | head -1`.split(' ').last
+  changelog = ["#{version} #{timestamp} #{sha}"]
+  changelog << ('=' * changelog[0].length)
+  changelog << ''
+
+  last_sha = `cat Changelog | head -1`.split(' ').last
+  shortlog = `git log #{last_sha}..HEAD --pretty=format:'%s   [%an]'`
+  changelog << shortlog.split("\n")
+  changelog.concat ['', '', '']
+
+  old_changelog = File.read('Changelog')
+  File.open('Changelog', 'w') do |file|
+    file.write(changelog.join("\n"))
+    file.write(old_changelog)
+  end
+end

bin/runner

@@ -0,0 +1,2 @@
+#!/bin/sh
+exec $1 2>&1

data/example/Procfile

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

data/export/bluepill/master.pill.erb

@@ -3,7 +3,7 @@ Bluepill.application("<%= app %>", :foreground => false, :log_file => "/var/log/
   app.uid = "<%= user %>"
   app.gid = "<%= user %>"
 
-<% engine.processes.values.each do |process| %>
+<% engine.procfile.entries.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|
@@ -19,9 +19,9 @@ Bluepill.application("<%= app %>", :foreground => false, :log_file => "/var/log/
     process.monitor_children do |children|
       children.stop_command "kill -QUIT {{PID}}"
     end
-    
+
     process.group = "<%= app %>-<%= process.name %>"
   end
 <% end %>
 <% end %>
-end
+end

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/export/runit/run.erb

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

foreman.gemspec

@@ -16,6 +16,6 @@ Gem::Specification.new do |gem|
   gem.files = Dir["**/*"].select { |d| d =~ %r{^(README|bin/|data/|ext/|lib/|spec/|test/)} }
   gem.files << "man/foreman.1"
 
-  gem.add_dependency 'term-ansicolor', '~> 1.0.5'
+  gem.add_dependency 'term-ansicolor', '~> 1.0.7'
   gem.add_dependency 'thor',           '>= 0.13.6'
 end

lib/foreman.rb

@@ -4,5 +4,15 @@ module Foreman
 
   class AppDoesNotExist < Exception; end
 
+  # load contents of env_file into ENV
+  def self.load_env!(env_file = './.env')
+    require 'foreman/engine'
+    Foreman::Engine.load_env!(env_file)
+  end
+
+  def self.runner
+    File.expand_path("../../bin/runner", __FILE__)
+  end
+
 end
 

lib/foreman/cli.rb

@@ -6,28 +6,33 @@ require "yaml"
 
 class Foreman::CLI < Thor
 
-  class_option :procfile, :type => :string, :aliases => "-f", :desc => "Default: Procfile"
+  desc "start", "Start the application"
 
-  desc "start [PROCESS]", "Start the application, or a specific process"
+  class_option :procfile, :type => :string, :aliases => "-f", :desc => "Default: Procfile"
+  class_option :app_root, :type => :string, :aliases => "-d", :desc => "Default: Procfile directory"
 
   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"'
 
-  def start(process=nil)
-    check_procfile!
-
-    if process
-      engine.execute(process)
-    else
-      engine.start
+  class << self
+    # Hackery. Take the run method away from Thor so that we can redefine it.
+    def is_thor_reserved_word?(word, type)
+      return false if word == 'run'
+      super
     end
   end
 
+  def start
+    check_procfile!
+    engine.start
+  end
+
   desc "export FORMAT LOCATION", "Export the application to another process management format"
 
   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"
@@ -41,6 +46,7 @@ class Foreman::CLI < Thor
       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
 
@@ -53,9 +59,21 @@ 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.procfile.entries.length > 0
+    display "valid procfile detected (#{engine.procfile.process_names.join(', ')})"
+  end
+
+  desc "run COMMAND", "Run a command using your application's environment"
+
+  def run(*args)
+    engine.apply_environment!
+    begin
+      exec args.join(" ")
+    rescue Errno::EACCES
+      error "not executable: #{args.first}"
+    rescue Errno::ENOENT
+      error "command not found: #{args.first}"
+    end
   end
 
 private ######################################################################
@@ -91,5 +109,4 @@ private ######################################################################
     defaults = YAML::load_file(".foreman") || {}
     Thor::CoreExt::HashWithIndifferentAccess.new(defaults.merge(original_options))
   end
-
 end

lib/foreman/engine.rb

@@ -1,145 +1,137 @@
 require "foreman"
 require "foreman/process"
+require "foreman/procfile"
 require "foreman/utils"
 require "pty"
 require "tempfile"
 require "timeout"
 require "term/ansicolor"
 require "fileutils"
+require "thread"
 
 class Foreman::Engine
 
   attr_reader :procfile
   attr_reader :directory
-  attr_reader :environment
   attr_reader :options
 
   extend Term::ANSIColor
 
-  COLORS = [ cyan, yellow, green, magenta, red ]
+  COLORS = [ cyan, yellow, green, magenta, red, blue,
+             intense_cyan, intense_yellow, intense_green, intense_magenta,
+             intense_red, intense_blue ]
 
   def initialize(procfile, options={})
-    @procfile  = read_procfile(procfile)
-    @directory = File.expand_path(File.dirname(procfile))
+    @procfile  = Foreman::Procfile.new(procfile)
+    @directory = options[:app_root] || File.expand_path(File.dirname(procfile))
     @options = options
     @environment = read_environment_files(options[:env])
+    @output_mutex = Mutex.new
   end
 
-  def processes
-    @processes ||= begin
-      @order = []
-      procfile.split("\n").inject({}) do |hash, line|
-        next hash if line.strip == ""
-        name, command = line.split(/\s*:\s+/, 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
-  end
-
-  def processes_in_order
-    process_order.map do |name|
-      [name, processes[name]]
-    end
+  def self.load_env!(env_file)
+    @environment = read_environment_files(env_file)
+    apply_environment!
   end
 
   def start
     proctitle "ruby: foreman master"
-
-    processes_in_order.each do |name, process|
-      fork process
-    end
-
-    trap("TERM") { puts "SIGTERM received"; terminate_gracefully }
-    trap("INT")  { puts "SIGINT received";  terminate_gracefully }
-
-    watch_for_termination
-  end
-
-  def execute(name)
-
-    fork processes[name]
+    termtitle "#{File.basename(@directory)} - foreman"
 
     trap("TERM") { puts "SIGTERM received"; terminate_gracefully }
     trap("INT")  { puts "SIGINT received";  terminate_gracefully }
 
+    assign_colors
+    spawn_processes
+    watch_for_output
     watch_for_termination
   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)
+  def spawn_processes
     concurrency = Foreman::Utils.parse_concurrency(@options[:concurrency])
 
-    1.upto(concurrency[process.name]) do |num|
-      fork_individual(process, num, port_for(process, num, @options[:port]))
+    procfile.entries.each do |entry|
+      reader, writer = IO.pipe
+      entry.spawn(concurrency[entry.name], writer, @directory, @environment, port_for(entry, 1, base_port)).each do |process|
+        running_processes[process.pid] = process
+        readers[process] = reader
+      end
     end
   end
 
-  def fork_individual(process, num, port)
-    @environment.each { |k,v| ENV[k] = v }
-
-    ENV["PORT"] = port.to_s
-    ENV["PS"]   = "#{process.name}.#{num}"
-
-    pid = Process.fork do
-      run(process)
-    end
-
-    info "started with pid #{pid}", process
-    running_processes[pid] = process
-  end
-
-  def run(process)
-    proctitle "ruby: foreman #{process.name}"
-    trap("SIGINT", "IGNORE")
-
-    begin
-      Dir.chdir directory do
-        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, Errno::EIO
-      begin
-        info "process exiting", process
-      rescue Interrupt
-      end
-    end
+  def base_port
+    options[:port] || 5000
   end
 
   def kill_all(signal="SIGTERM")
     running_processes.each do |pid, process|
+      info "sending #{signal} to pid #{pid}"
       Process.kill(signal, pid) rescue Errno::ESRCH
     end
   end
 
-  def info(message, process=nil)
-    print process.color if process
-    print "#{Time.now.strftime("%H:%M:%S")} #{pad_process_name(process)} | "
+  def terminate_gracefully
+    info "sending SIGTERM to all processes"
+    kill_all "SIGTERM"
+    Timeout.timeout(5) { Process.waitall }
+  rescue Timeout::Error
+    info "sending SIGKILL to all processes"
+    kill_all "SIGKILL"
+  end
+
+  def watch_for_output
+    Thread.new do
+      begin
+        loop do
+          rs, ws = IO.select(readers.values, [], [], 1)
+          (rs || []).each do |r|
+            ps, message = r.gets.split(",", 2)
+            color = colors[ps.split(".").first]
+            info message, ps, color
+          end
+        end
+      rescue Exception => ex
+        puts ex.message
+        puts ex.backtrace
+      end
+    end
+  end
+
+  def watch_for_termination
+    pid, status = Process.wait2
+    process = running_processes.delete(pid)
+    info "process terminated", process.name
+    terminate_gracefully
+    kill_all
+  rescue Errno::ECHILD
+  end
+
+  def info(message, name="system", color=Term::ANSIColor.white)
+    print color
+    print "#{Time.now.strftime("%H:%M:%S")} #{pad_process_name(name)} | "
     print Term::ANSIColor.reset
     print message.chomp
-    puts
+    puts ""
+  end
+
+  def print(message=nil)
+    @output_mutex.synchronize do
+      $stdout.print message
+    end
+  end
+
+  def puts(message=nil)
+    @output_mutex.synchronize do
+      $stdout.puts message
+    end
   end
 
   def error(message)
@@ -149,89 +141,84 @@ private ######################################################################
 
   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
   end
 
-  def pad_process_name(process)
-    name = process ? "#{ENV["PS"]}" : "system"
-    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
+  def pad_process_name(name="system")
+    name.to_s.ljust(longest_process_name + 3) # add 3 for process number padding
   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
-    terminate_gracefully
-    kill_all
-  rescue Errno::ECHILD
+  def termtitle(title)
+    printf("\033]0;#{title}\007")
   end
 
   def running_processes
     @running_processes ||= {}
   end
 
+  def readers
+    @readers ||= {}
+  end
+
+  def colors
+    @colors ||= {}
+  end
+
+  def assign_colors
+    procfile.entries.each do |entry|
+      colors[entry.name] = next_color
+    end
+  end
+
+  def process_by_reader(reader)
+    readers.invert[reader]
+  end
+
   def next_color
     @current_color ||= -1
     @current_color  +=  1
-    @current_color >= COLORS.length ? "" : COLORS[@current_color]
+    @current_color = 0 if COLORS.length < @current_color
+    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"
-  end
+  module Env
+    attr_reader :environment
 
-  def read_environment_files(filenames)
-    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_]+)=(.*)\z/
-        hash[$1] = $2
+      (filenames || "").split(",").map(&:strip).each do |filename|
+        error "No such file: #{filename}" unless File.exists?(filename)
+        environment.merge!(read_environment(filename))
       end
-      hash
+
+      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
 
-  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
-
+  include Env
+  extend  Env
 end

lib/foreman/export.rb

@@ -8,3 +8,4 @@ require "foreman/export/base"
 require "foreman/export/inittab"
 require "foreman/export/upstart"
 require "foreman/export/bluepill"
+require "foreman/export/runit"

lib/foreman/export/base.rb

@@ -26,7 +26,7 @@ private ######################################################################
   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))
+    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__))

lib/foreman/export/bluepill.rb

@@ -23,7 +23,6 @@ class Foreman::Export::Bluepill < Foreman::Export::Base
     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

lib/foreman/export/inittab.rb

@@ -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.procfile.entries.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])

lib/foreman/export/runit.rb

@@ -0,0 +1,61 @@
+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.procfile.entries.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
+        FileUtils.chmod 0755, "#{process_directory}/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
+        FileUtils.chmod 0755, "#{process_log_directory}/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

lib/foreman/export/upstart.rb

@@ -26,7 +26,8 @@ class Foreman::Export::Upstart < Foreman::Export::Base
 
     process_template = export_template("upstart", "process.conf.erb", template_root)
 
-    engine.processes.values.each do |process|
+    engine.procfile.entries.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

lib/foreman/process.rb

@@ -2,13 +2,69 @@ require "foreman"
 
 class Foreman::Process
 
-  attr_reader :name
-  attr_reader :command
-  attr_accessor :color
+  attr_reader :entry
+  attr_reader :num
+  attr_reader :pid
+  attr_reader :port
 
-  def initialize(name, command)
-    @name    = name
-    @command = command
+  def initialize(entry, num, port)
+    @entry = entry
+    @num = num
+    @port = port
+  end
+
+  def run(pipe, basedir, environment)
+    Dir.chdir(basedir) do
+      with_environment(environment.merge("PORT" => port.to_s)) do
+        run_process entry.command, pipe
+      end
+    end
+  end
+
+  def name
+    "%s.%s" % [ entry.name, num ]
+  end
+
+private
+
+  def fork_with_io(command)
+    reader, writer = IO.pipe
+    pid = fork do
+      trap("INT", "IGNORE")
+      writer.sync = true
+      $stdout.reopen writer
+      $stderr.reopen writer
+      reader.close
+      exec Foreman.runner, replace_command_env(command)
+    end
+    [ reader, pid ]
+  end
+
+  def run_process(command, pipe)
+    io, @pid = fork_with_io(command)
+    output pipe, "started with pid %d" % @pid
+    Thread.new do
+      until io.eof?
+        output pipe, io.gets
+      end
+    end
+  end
+
+  def output(pipe, message)
+    pipe.puts "%s,%s" % [ name, message ]
+  end
+
+  def replace_command_env(command)
+    command.gsub(/\$(\w+)/) { |e| ENV[e[1..-1]] }
+  end
+
+  def with_environment(environment)
+    old_env = ENV.each_pair.inject({}) { |h,(k,v)| h.update(k => v) }
+    environment.each { |k,v| ENV[k] = v }
+    ret = yield
+    ENV.clear
+    old_env.each { |k,v| ENV[k] = v}
+    ret
   end
 
 end

lib/foreman/procfile.rb

@@ -0,0 +1,38 @@
+require "foreman"
+require "foreman/procfile_entry"
+
+# A valid Procfile entry is captured by this regex.
+# All other lines are ignored.
+#
+# /^([A-Za-z0-9_]+):\s*(.+)$/
+#
+# $1 = name
+# $2 = command
+#
+class Foreman::Procfile
+
+  attr_reader :entries
+
+  def initialize(filename)
+    @entries = parse_procfile(filename)
+  end
+
+  def [](name)
+    entries.detect { |entry| entry.name == name }
+  end
+
+  def process_names
+    entries.map(&:name)
+  end
+
+private
+
+  def parse_procfile(filename)
+    File.read(filename).split("\n").map do |line|
+      if line =~ /^([A-Za-z0-9_]+):\s*(.+)$/
+        Foreman::ProcfileEntry.new($1, $2)
+      end
+    end.compact
+  end
+
+end

lib/foreman/procfile_entry.rb

@@ -0,0 +1,22 @@
+require "foreman"
+
+class Foreman::ProcfileEntry
+
+  attr_reader :name
+  attr_reader :command
+  attr_accessor :color
+
+  def initialize(name, command)
+    @name = name
+    @command = command
+  end
+
+  def spawn(num, pipe, basedir, environment, base_port)
+    (1..num).to_a.map do |n|
+      process = Foreman::Process.new(self, n, base_port + (n-1))
+      process.run(pipe, basedir, environment)
+      process
+    end
+  end
+
+end

lib/foreman/utils.rb

@@ -3,9 +3,12 @@ require "foreman"
 class Foreman::Utils
 
   def self.parse_concurrency(concurrency)
-    @concurrency ||= begin
+    begin
       pairs = concurrency.to_s.gsub(/\s/, "").split(",")
-      pairs.inject(Hash.new(1)) do |hash, pair|
+      
+      default = concurrency.nil? ? 1 : 0
+      
+      pairs.inject(Hash.new(default)) do |hash, pair|
         process, amount = pair.split("=")
         hash.update(process => amount.to_i)        
       end

lib/foreman/version.rb

@@ -1,5 +1,5 @@
 module Foreman
 
-  VERSION = "0.23.1"
+  VERSION = "0.36.1"
 
 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" "September 2011" "Foreman 0.23.0" "Foreman Manual"
+.TH "FOREMAN" "1" "January 2012" "Foreman 0.33.1" "Foreman Manual"
 .
 .SH "NAME"
 \fBforeman\fR \- manage Procfile\-based applications
@@ -68,6 +68,10 @@ 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
+Specify an alternate application root\. This defaults to the directory containing the Procfile\.
+.
+.TP
 \fB\-e\fR, \fB\-\-env\fR
 Specify an alternate environment file\. You can specify more than one file by using: \fB\-\-env file1,file2\fR\.
 .
@@ -85,6 +89,9 @@ bluepill
 inittab
 .
 .IP "\(bu" 4
+runit
+.
+.IP "\(bu" 4
 upstart
 .
 .IP "" 0
@@ -132,7 +139,7 @@ job: bundle exec rake jobs:work
 .IP "" 0
 .
 .P
-You can validate your Procfile format using the \fBcheck\fR command
+A process name may contain letters, numbers amd the underscore character\. You can validate your Procfile format using the \fBcheck\fR command:
 .
 .IP "" 4
 .

man/foreman.1.ronn

@@ -66,6 +66,10 @@ The following options control how the application is run:
 
 These options control all modes of foreman's operation.
 
+  * `-d`, `--directory`:
+    Specify an alternate application root. This defaults to the directory
+    containing the Procfile.
+
   * `-e`, `--env`:
     Specify an alternate environment file. You can specify more than one
     file by using: `--env file1,file2`.
@@ -83,6 +87,8 @@ foreman currently supports the following output formats:
 
   * inittab
 
+  * runit
+
   * upstart
 
 ## INITTAB EXPORT
@@ -113,7 +119,8 @@ to run it.
     web: bundle exec thin start
     job: bundle exec rake jobs:work
 
-You can validate your Procfile format using the `check` command
+A process name may contain letters, numbers amd the underscore character.
+You can validate your Procfile format using the `check` command:
 
     $ foreman check
 

spec/foreman/cli_spec.rb

@@ -26,6 +26,15 @@ describe "Foreman::CLI" do
   end
 
   describe "export" do
+    describe "options" do
+      it "respects --env" do
+        write_procfile
+        write_env("envfile")
+        mock.instance_of(Foreman::Export::Upstart).export("/upstart", { "env" => "envfile" })
+        foreman %{ export upstart /upstart --env envfile }
+      end
+    end
+
     describe "with a non-existent Procfile" do
       it "prints an error" do
         mock_error(subject, "Procfile does not exist.") do
@@ -80,5 +89,54 @@ describe "Foreman::CLI" do
       end
     end
   end
+  
+  describe "run" do
+    describe "with a valid Procfile" do
+      before { write_procfile }
+
+      describe "and a command" do
+        let(:command) { ["ls", "-l"] }
+        
+        before(:each) do
+          stub(subject).exec
+        end
+        
+        it "should load the environment file" do
+          write_env
+          preserving_env do
+            subject.run *command
+            ENV["FOO"].should == "bar"
+          end
+          
+          ENV["FOO"].should be_nil
+        end
+        
+        it "should runute the command as a string" do
+          mock(subject).exec(command.join(" "))
+          subject.run *command
+        end
+      end
+      
+      describe "and a non-existent command" do
+        let(:command) { "iuhtngrglhulhdfg" }
+        
+        it "should print an error" do
+          mock_error(subject, "command not found: #{command}") do
+            subject.run command
+          end
+        end
+      end
+      
+      describe "and a non-executable command" do
+        let(:command) { __FILE__ }
+        
+        it "should print an error" do
+          mock_error(subject, "not executable: #{command}") do
+            subject.run command
+          end
+        end
+      end
+    end
+  end
 
 end

spec/foreman/engine_spec.rb

@@ -15,21 +15,8 @@ describe "Foreman::Engine" do
       before { write_procfile }
 
       it "reads the processes" do
-        subject.processes["alpha"].command.should == "./alpha"
-        subject.processes["bravo"].command.should == "./bravo"
-      end
-    end
-
-    describe "with a deprecated Procfile" do
-      before do
-        File.open("Procfile", "w") do |file|
-          file.puts "name command"
-        end
-      end
-
-      it "should print a deprecation warning" do
-        mock(subject).warn_deprecated_procfile!
-        subject.processes.length.should == 1
+        subject.procfile["alpha"].command.should == "./alpha"
+        subject.procfile["bravo"].command.should == "./bravo"
       end
     end
   end
@@ -37,8 +24,9 @@ describe "Foreman::Engine" do
   describe "start" do
     it "forks the processes" do
       write_procfile
-      mock(subject).fork(subject.processes["alpha"])
-      mock(subject).fork(subject.processes["bravo"])
+      mock.instance_of(Foreman::Process).run_process("./alpha", is_a(IO))
+      mock.instance_of(Foreman::Process).run_process("./bravo", is_a(IO))
+      mock(subject).watch_for_output
       mock(subject).watch_for_termination
       subject.start
     end
@@ -46,25 +34,15 @@ describe "Foreman::Engine" do
     it "handles concurrency" do
       write_procfile
       engine = Foreman::Engine.new("Procfile",:concurrency => "alpha=2")
-      mock(engine).fork_individual(engine.processes["alpha"], 1, 5000)
-      mock(engine).fork_individual(engine.processes["alpha"], 2, 5001)
-      mock(engine).fork_individual(engine.processes["bravo"], 1, 5100)
+      mock.instance_of(Foreman::Process).run_process("./alpha", is_a(IO)).twice
+      mock.instance_of(Foreman::Process).run_process("./bravo", is_a(IO)).never
+      mock(engine).watch_for_output
       mock(engine).watch_for_termination
       engine.start
     end
   end
 
-  describe "execute" do
-    it "runs the processes" do
-      write_procfile
-      mock(subject).fork(subject.processes["alpha"])
-      mock(subject).watch_for_termination
-      subject.execute("alpha")
-    end
-  end
-
   describe "environment" do
-
     before(:each) do
       write_procfile
       stub(Process).fork
@@ -74,9 +52,10 @@ describe "Foreman::Engine" do
       File.open("/tmp/env", "w") { |f| f.puts("FOO=baz") }
       engine = Foreman::Engine.new("Procfile", :env => "/tmp/env")
       stub(engine).info
+      mock(engine).spawn_processes
       mock(engine).watch_for_termination
       engine.environment.should == {"FOO"=>"baz"}
-      engine.execute("alpha")
+      engine.start
     end
 
     it "should read more than one if specified" do
@@ -84,9 +63,10 @@ describe "Foreman::Engine" do
       File.open("/tmp/env2", "w") { |f| f.puts("BAZ=qux") }
       engine = Foreman::Engine.new("Procfile", :env => "/tmp/env1,/tmp/env2")
       stub(engine).info
+      mock(engine).spawn_processes
       mock(engine).watch_for_termination
       engine.environment.should == { "FOO"=>"bar", "BAZ"=>"qux" }
-      engine.execute("alpha")
+      engine.start
     end
 
     it "should fail if specified and doesnt exist" do
@@ -97,11 +77,10 @@ describe "Foreman::Engine" do
     it "should read .env if none specified" do
       File.open(".env", "w") { |f| f.puts("FOO=qoo") }
       engine = Foreman::Engine.new("Procfile")
-      stub(engine).info
+      mock(engine).spawn_processes
       mock(engine).watch_for_termination
-      mock(engine).fork_individual(anything, anything, anything)
       engine.environment.should == {"FOO"=>"qoo"}
-      engine.execute("bravo")
+      engine.start
     end
   end
 end

spec/foreman/export/bluepill_spec.rb

@@ -13,8 +13,12 @@ describe Foreman::Export::Bluepill do
 
   it "exports to the filesystem" do
     bluepill.export("/tmp/init")
-    
-    File.read("/tmp/init/app.pill").should == example_export_file("bluepill/app.pill")
+    normalize_space(File.read("/tmp/init/app.pill")).should == normalize_space(example_export_file("bluepill/app.pill"))
   end
 
+  it "exports to the filesystem with concurrency" do
+    bluepill.export("/tmp/init", :concurrency => "alpha=2")
+    
+    normalize_space(File.read("/tmp/init/app.pill")).should == normalize_space(example_export_file("bluepill/app-concurrency.pill"))
+  end
 end

spec/foreman/export/runit_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+require "foreman/engine"
+require "foreman/export/runit"
+require "tmpdir"
+
+describe Foreman::Export::Runit do
+  let(:procfile) { FileUtils.mkdir_p("/tmp/app"); write_procfile("/tmp/app/Procfile", 'bar=baz') }
+  let(:engine) { Foreman::Engine.new(procfile) }
+  let(:runit) { Foreman::Export::Runit.new(engine) }
+  
+  before(:each) { load_export_templates_into_fakefs("runit") }
+  before(:each) { stub(runit).say }
+  before(:each) { stub(FakeFS::FileUtils).chmod }
+  
+  it "exports to the filesystem" do
+    FileUtils.mkdir_p('/tmp/init')
+    runit.export('/tmp/init', :concurrency => "alpha=2,bravo=1")
+    
+    File.read("/tmp/init/app-alpha-1/run").should == example_export_file('runit/app-alpha-1-run')
+    File.read("/tmp/init/app-alpha-1/log/run").should == 
+        example_export_file('runit/app-alpha-1-log-run')
+    File.read("/tmp/init/app-alpha-1/env/PORT").should == "5000\n"
+    File.read("/tmp/init/app-alpha-1/env/BAR").should == "baz\n"
+    
+    File.read("/tmp/init/app-alpha-2/run").should == example_export_file('runit/app-alpha-2-run')
+    File.read("/tmp/init/app-alpha-2/log/run").should == 
+        example_export_file('runit/app-alpha-2-log-run')
+    File.read("/tmp/init/app-alpha-2/env/PORT").should == "5001\n"
+    File.read("/tmp/init/app-alpha-2/env/BAR").should == "baz\n"
+    
+    File.read("/tmp/init/app-bravo-1/run").should == example_export_file('runit/app-bravo-1-run')
+    File.read("/tmp/init/app-bravo-1/log/run").should == 
+        example_export_file('runit/app-bravo-1-log-run')
+    File.read("/tmp/init/app-bravo-1/env/PORT").should == "5100\n"
+  end
+end

spec/foreman/export/upstart_spec.rb

@@ -17,11 +17,20 @@ describe Foreman::Export::Upstart do
     File.read("/tmp/init/app.conf").should         == example_export_file("upstart/app.conf")
     File.read("/tmp/init/app-alpha.conf").should   == example_export_file("upstart/app-alpha.conf")
     File.read("/tmp/init/app-alpha-1.conf").should == example_export_file("upstart/app-alpha-1.conf")
-    File.read("/tmp/init/app-alpha-2.conf").should == example_export_file("upstart/app-alpha-2.conf")
     File.read("/tmp/init/app-bravo.conf").should   == example_export_file("upstart/app-bravo.conf")
     File.read("/tmp/init/app-bravo-1.conf").should == example_export_file("upstart/app-bravo-1.conf")
   end
 
+  it "exports to the filesystem with concurrency" do
+    upstart.export("/tmp/init", :concurrency => "alpha=2")
+
+    File.read("/tmp/init/app.conf").should         == example_export_file("upstart/app.conf")
+    File.read("/tmp/init/app-alpha.conf").should   == example_export_file("upstart/app-alpha.conf")
+    File.read("/tmp/init/app-alpha-1.conf").should == example_export_file("upstart/app-alpha-1.conf")
+    File.read("/tmp/init/app-alpha-2.conf").should == example_export_file("upstart/app-alpha-2.conf")
+    File.exists?("/tmp/init/app-bravo-1.conf").should == false
+  end
+
   context "with alternate templates" do
     let(:template_root) { "/tmp/alternate" }
 
@@ -38,13 +47,19 @@ describe Foreman::Export::Upstart do
   end
 
   context "with alternate templates from home dir" do
-    let(:default_template_root) {File.expand_path("~/.foreman/templates")}
+    let(:default_template_root) {File.expand_path("#{ENV['HOME']}/.foreman/templates")}
 
     before do
+      ENV['_FOREMAN_SPEC_HOME'] = ENV['HOME']
+      ENV['HOME'] = "/home/appuser"
       FileUtils.mkdir_p default_template_root
       File.open("#{default_template_root}/master.conf.erb", "w") { |f| f.puts "default_alternate_template" }
     end
 
+    after do
+      ENV['HOME'] = ENV.delete('_FOREMAN_SPEC_HOME')
+    end
+
     it "can export with alternate template files" do
       upstart.export("/tmp/init")
 

spec/foreman_spec.rb

@@ -8,4 +8,26 @@ describe Foreman do
     it { should be_a String }
   end
 
+  describe "::load_env!(env_file)" do
+    before do
+      FakeFS.activate!
+    end
+
+    after do
+      FakeFS.deactivate!
+      ENV['FOO'] = nil
+    end
+
+    it "should load env_file into ENV" do
+      File.open("/tmp/env1", "w") { |f| f.puts("FOO=bar") }
+      Foreman.load_env!("/tmp/env1")
+      ENV['FOO'].should == 'bar'
+    end 
+
+    it "should assume env_file in ./.env" do
+      File.open("./.env", "w") { |f| f.puts("FOO=bar") }
+      Foreman.load_env!
+      ENV['FOO'].should == 'bar'
+    end
+  end
 end

spec/helper_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe "spec helpers" do
+  describe "#preserving_env" do
+    after { ENV.delete "FOO" }
+    
+    it "should remove added environment vars" do
+      preserving_env { ENV["FOO"] = "baz" }
+      ENV["FOO"].should == nil
+    end
+    
+    it "should reset modified environment vars" do
+      ENV["FOO"] = "bar"
+      preserving_env { ENV["FOO"] = "baz"}
+      ENV["FOO"].should == "bar"
+    end
+  end
+end

spec/resources/export/bluepill/app-concurrency.pill

@@ -0,0 +1,47 @@
+Bluepill.application("app", :foreground => false, :log_file => "/var/log/bluepill.log") do |app|
+
+  app.uid = "app"
+  app.gid = "app"
+
+
+
+
+  app.process("alpha-1") do |process|
+    process.start_command = "./alpha"
+
+    process.working_dir = "/tmp/app"
+    process.daemonize = true
+    process.environment = {"PORT" => "5000"}
+    process.stop_signals = [:quit, 30.seconds, :term, 5.seconds, :kill]
+
+    process.stdout = process.stderr = "/var/log/app/app-alpha-1.log"
+
+    process.monitor_children do |children|
+      children.stop_command "kill -QUIT {{PID}}"
+    end
+    
+    process.group = "app-alpha"
+  end
+
+
+  app.process("alpha-2") do |process|
+    process.start_command = "./alpha"
+
+    process.working_dir = "/tmp/app"
+    process.daemonize = true
+    process.environment = {"PORT" => "5001"}
+    process.stop_signals = [:quit, 30.seconds, :term, 5.seconds, :kill]
+
+    process.stdout = process.stderr = "/var/log/app/app-alpha-2.log"
+
+    process.monitor_children do |children|
+      children.stop_command "kill -QUIT {{PID}}"
+    end
+    
+    process.group = "app-alpha"
+  end
+
+
+
+
+end

spec/resources/export/bluepill/app.pill

@@ -19,31 +19,10 @@ Bluepill.application("app", :foreground => false, :log_file => "/var/log/bluepil
     process.monitor_children do |children|
       children.stop_command "kill -QUIT {{PID}}"
     end
-    
+
     process.group = "app-alpha"
   end
 
-
-  app.process("alpha-2") do |process|
-    process.start_command = "./alpha"
-
-    process.working_dir = "/tmp/app"
-    process.daemonize = true
-    process.environment = {"PORT" => "5001"}
-    process.stop_signals = [:quit, 30.seconds, :term, 5.seconds, :kill]
-
-    process.stdout = process.stderr = "/var/log/app/app-alpha-2.log"
-
-    process.monitor_children do |children|
-      children.stop_command "kill -QUIT {{PID}}"
-    end
-    
-    process.group = "app-alpha"
-  end
-
-
-
-
   app.process("bravo-1") do |process|
     process.start_command = "./bravo"
 
@@ -57,7 +36,7 @@ Bluepill.application("app", :foreground => false, :log_file => "/var/log/bluepil
     process.monitor_children do |children|
       children.stop_command "kill -QUIT {{PID}}"
     end
-    
+
     process.group = "app-bravo"
   end
 

spec/resources/export/runit/app-alpha-1-log-run

@@ -0,0 +1,7 @@
+#!/bin/sh
+set -e
+
+LOG=/var/log/app/alpha-1
+
+test -d "$LOG" || mkdir -p m2750 "$LOG" && chown app "$LOG"
+exec chpst -u app svlogd "$LOG"

spec/resources/export/runit/app-alpha-1-run

@@ -0,0 +1,3 @@
+#!/bin/sh
+cd /tmp/app
+exec chpst -u app -e /tmp/init/app-alpha-1/env ./alpha bar=baz

spec/resources/export/runit/app-alpha-2-log-run

@@ -0,0 +1,7 @@
+#!/bin/sh
+set -e
+
+LOG=/var/log/app/alpha-2
+
+test -d "$LOG" || mkdir -p m2750 "$LOG" && chown app "$LOG"
+exec chpst -u app svlogd "$LOG"

spec/resources/export/runit/app-alpha-2-run

@@ -0,0 +1,3 @@
+#!/bin/sh
+cd /tmp/app
+exec chpst -u app -e /tmp/init/app-alpha-2/env ./alpha bar=baz

spec/resources/export/runit/app-bravo-1-log-run

@@ -0,0 +1,7 @@
+#!/bin/sh
+set -e
+
+LOG=/var/log/app/bravo-1
+
+test -d "$LOG" || mkdir -p m2750 "$LOG" && chown app "$LOG"
+exec chpst -u app svlogd "$LOG"

spec/resources/export/runit/app-bravo-1-run

@@ -0,0 +1,3 @@
+#!/bin/sh
+cd /tmp/app
+exec chpst -u app -e /tmp/init/app-bravo-1/env ./bravo

spec/spec_helper.rb

@@ -12,6 +12,10 @@ def mock_error(subject, message)
   end
 end
 
+def foreman(args)
+  Foreman::CLI.start(args.split(" "))
+end
+
 def mock_exit(&block)
   block.should raise_error(SystemExit)
 end
@@ -24,15 +28,21 @@ def write_foreman_config(app)
   end
 end
 
-def write_procfile(procfile="Procfile")
+def write_procfile(procfile="Procfile", alpha_env="")
   File.open(procfile, "w") do |file|
-    file.puts "alpha: ./alpha"
+    file.puts "alpha: ./alpha" + " #{alpha_env}".rstrip
     file.puts "\n"
     file.puts "bravo:\t./bravo"
   end
   File.expand_path(procfile)
 end
 
+def write_env(env=".env")
+  File.open(env, "w") do |file|
+    file.puts "FOO=bar"
+  end
+end
+
 def load_export_templates_into_fakefs(type)
   FakeFS.deactivate!
   files = Dir[File.expand_path("../../data/export/#{type}/**", __FILE__)].inject({}) do |hash, file|
@@ -53,8 +63,23 @@ def example_export_file(filename)
   data
 end
 
+def preserving_env
+  old_env = ENV.to_hash
+  begin
+    yield
+  ensure
+    ENV.clear
+    ENV.update(old_env)
+  end
+end
+
+def normalize_space(s)
+  s.gsub(/\n[\n\s]*/, "\n")
+end
+  
 RSpec.configure do |config|
   config.color_enabled = true
+  config.order = 'rand'
   config.include FakeFS::SpecHelpers
   config.mock_with :rr
 end