0.60.0

foreman run can run things from the Procfile like heroku run.

.travis.yml

@@ -16,9 +16,7 @@ notifications:
       - http://dx-helper.herokuapp.com/travis
 
 rvm:
-  - 1.8.7
   - 1.9.2
   - 1.9.3
   - jruby
-  - rbx
   - ree

Changelog.md

@@ -1,3 +1,30 @@
+## 0.57.0 (2012-08-21)
+
+* fix startup checks for upstart exporter  [Aditya Sanghi]
+
+## 0.56.0 (2012-08-19)
+
+* read .profile, not .profile.d  [David Dollar]
+
+## 0.55.0 (2012-08-14)
+
+* use a forked process to exec a run with environment  [David Dollar]
+
+## 0.54.0 (2012-08-14)
+
+* use Foreman::Process to extract command running  [David Dollar]
+* changed to check env for bash  [brntbeer]
+
+## 0.53.0 (2012-07-24)
+
+* put app root in $HOME  [David Dollar]
+
+## 0.52.0 (2012-07-24)
+
+* wrap command in a runner that sources .profile.d scripts  [David Dollar]
+* fix upstart export specs  [David Dollar]
+* Make upstart export start/stop with network  [Daniel Farrell]
+
 ## 0.51.0 (2012-07-11)
 
 * dont try to colorize windows  [David Dollar]

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    foreman (0.52.0)
+    foreman (0.60.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.15.4)
+    thor (0.16.0)
     timecop (0.3.5)
     win32console (1.3.0-x86-mingw32)
     xml-simple (1.0.15)

bin/foreman-runner

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/sh
 #
 #/ Usage: foreman-runner [-d <dir>] [-p] <command> [<args>...]
 #/
@@ -16,12 +16,12 @@ usage() {
   exit
 }
 
-read_profiled=""
+read_profile=""
 
 while getopts ":hd:p" OPT; do
   case $OPT in
      d) cd "$OPTARG" ;;
-     p) read_profiled="1" ;;
+     p) read_profile="1" ;;
      h) usage ;;
     \?) error "invalid option: -$OPTARG" ;;
      :) error "option -$OPTARG requires an argument" ;;
@@ -32,13 +32,10 @@ shift $((OPTIND-1))
 
 [ -z "$1" ] && usage
 
-if [ "$read_profiled" == "1" ]; then
+if [ "$read_profile" = "1" ]; then
-  shopt -s nullglob
+  if [ -f .profile ]; then
-  for script in .profile.d/*; do
+    . .profile
-    echo "sourcing $script"
+  fi
-    source $script
-  done
-  shopt -u nullglob
 fi
 
 exec "$@"

data/export/launchd/launchd.plist.erb

@@ -4,14 +4,25 @@
 <dict>
     <key>Label</key>
     <string><%= "#{app}-#{name}-#{num}" %></string>
+    <key>EnvironmentVariables</key>
+    <dict>
+    <%- engine.env.merge("PORT" => port).each_pair do |var,env| -%>
+        <key><%= var.upcase %></key>
+        <string><%= env %></string>
+    <%- end -%>
+    </dict>
     <key>ProgramArguments</key>
     <array>
-        <string><%= process.command %></string>
+    <%- command_args.each do |command| -%>
+        <string><%= command %></string>
+    <%- end -%>
     </array>
     <key>KeepAlive</key>
     <true/>
     <key>RunAtLoad</key>
     <true/>
+    <key>StandardOutPath</key>
+    <string><%= log %>/<%= app %>-<%= name %>-<%=num%>.log</string>
     <key>StandardErrorPath</key>
     <string><%= log %>/<%= app %>-<%= name %>-<%=num%>.log</string>
     <key>UserName</key>

data/export/upstart/master.conf.erb

@@ -7,5 +7,10 @@ EOF
 
 end script
 
-start on started network
+start on (started network-interface
-stop on stopping network
+          or started network-manager
+          or started networking)
+
+stop on (stopping network-interface
+         or stopping network-manager
+         or stopping networking)

lib/foreman/capistrano.rb

@@ -0,0 +1,54 @@
+if defined?(Capistrano)
+  Capistrano::Configuration.instance(:must_exist).load do
+
+    namespace :foreman do
+      desc <<-DESC
+        Export the Procfile to upstart.  Will use sudo if available.
+
+        You can override any of these defaults by setting the variables shown below.
+
+        set :foreman_format,      "upstart"
+        set :foreman_location,    "/etc/init"
+        set :foreman_procfile,    "Procfile"
+        set :foreman_app,         application
+        set :foreman_user,        user
+        set :foreman_log,         "#{shared_path}/log"
+        set :foreman_concurrency, false
+      DESC
+      task :export, :roles => :app do
+        bundle_cmd          = fetch(:bundle_cmd, "bundle")
+        foreman_format      = fetch(:foreman_format, "upstart")
+        foreman_location    = fetch(:foreman_location, "/etc/init")
+        foreman_procfile    = fetch(:foreman_procfile, "Procfile")
+        foreman_app         = fetch(:foreman_app, application)
+        foreman_user        = fetch(:foreman_user, user)
+        foreman_log         = fetch(:foreman_log, "#{shared_path}/log")
+        foreman_concurrency = fetch(:foreman_concurrency, false)
+
+        args = ["#{foreman_format} #{foreman_location}"]
+        args << "-f #{foreman_procfile}"
+        args << "-a #{foreman_app}"
+        args << "-u #{foreman_user}"
+        args << "-l #{foreman_log}"
+        args << "-c #{foreman_concurrency}" if foreman_concurrency
+        run "cd #{release_path} && #{sudo} #{bundle_cmd} exec foreman export #{args.join(' ')}"
+      end
+
+      desc "Start the application services"
+      task :start, :roles => :app do
+        run "#{sudo} start #{application}"
+      end
+
+      desc "Stop the application services"
+      task :stop, :roles => :app do
+        run "#{sudo} stop #{application}"
+      end
+
+      desc "Restart the application services"
+      task :restart, :roles => :app do
+        run "#{sudo} start #{application} || #{sudo} restart #{application}"
+      end
+
+    end
+  end
+end

lib/foreman/cli.rb

@@ -75,13 +75,27 @@ class Foreman::CLI < Thor
 
   def run(*args)
     load_environment!
-    begin
+
-      exec engine.env, args.shelljoin
+    if File.exist?(procfile)
-    rescue Errno::EACCES
+      engine.load_procfile(procfile)
-      error "not executable: #{args.first}"
-    rescue Errno::ENOENT
-      error "command not found: #{args.first}"
     end
+
+    pid = fork do
+      begin
+        engine.env.each { |k,v| ENV[k] = v }
+        if args.size == 1 && process = engine.process(args.first)
+          process.exec(:env => engine.env)
+        else
+          exec args.shelljoin
+        end
+      rescue Errno::EACCES
+        error "not executable: #{args.first}"
+      rescue Errno::ENOENT
+        error "command not found: #{args.first}"
+      end
+    end
+    Process.wait(pid)
+    exit $?.exitstatus
   end
 
   desc "version", "Display Foreman gem version"
@@ -125,7 +139,7 @@ private ######################################################################
   def procfile
     case
       when options[:procfile] then options[:procfile]
-      when options[:root]     then File.expand_path(File.join(options[:app_root], "Procfile"))
+      when options[:root]     then File.expand_path(File.join(options[:root], "Procfile"))
       else "Procfile"
     end
   end

lib/foreman/engine.rb

@@ -256,7 +256,9 @@ private
       1.upto(formation[@names[process]]) do |n|
         reader, writer = create_pipe
         begin
-          pid = process.run(:output => writer, :env => { "PORT" => port_for(process, n).to_s })
+          pid = process.run(:output => writer, :env => {
+            "PORT" => port_for(process, n).to_s
+          })
           writer.puts "started with pid #{pid}"
         rescue Errno::ENOENT
           writer.puts "unknown command: #{process.command}"

lib/foreman/env.rb

@@ -9,8 +9,10 @@ class Foreman::Env
       if line =~ /\A([A-Za-z_0-9]+)=(.*)\z/
         key = $1
         case val = $2
+          # Remove single quotes
           when /\A'(.*)'\z/ then ax[key] = $1
-          when /\A"(.*)"\z/ then ax[key] = $1.gsub(/\\(.)/, '\1')
+          # Remove double quotes and unescape string preserving newline characters
+          when /\A"(.*)"\z/ then ax[key] = $1.gsub('\n', "\n").gsub(/\\(.)/, '\1')
           else ax[key] = val
         end
       end

lib/foreman/export/base.rb

@@ -119,7 +119,7 @@ private ######################################################################
   end
 
   def write_template(name, target, binding)
-    compiled = ERB.new(export_template(name)).result(binding)
+    compiled = ERB.new(export_template(name), nil, '-').result(binding)
     write_file target, compiled
   end
 

lib/foreman/export/inittab.rb

@@ -13,7 +13,16 @@ class Foreman::Export::Inittab < Foreman::Export::Base
       1.upto(engine.formation[name]) do |num|
         id = app.slice(0, 2).upcase + sprintf("%02d", index)
         port = engine.port_for(process, num)
-        inittab << "#{id}:4:respawn:/bin/su - #{user} -c 'PORT=#{port} #{process.command} >> #{log}/#{name}-#{num}.log 2>&1'"
+
+        commands = []
+        commands << "cd #{engine.root}"
+        commands << "export PORT=#{port}"
+        engine.env.each_pair do |var, env|
+          commands << "export #{var.upcase}=#{shell_quote(env)}"
+        end
+        commands << "#{process.command} >> #{log}/#{name}-#{num}.log 2>&1"
+
+        inittab << "#{id}:4:respawn:/bin/su - #{user} -c '#{commands.join(";")}'"
         index += 1
       end
     end

lib/foreman/export/launchd.rb

@@ -7,6 +7,8 @@ class Foreman::Export::Launchd < Foreman::Export::Base
     super
     engine.each_process do |name, process|
       1.upto(engine.formation[name]) do |num|
+        port = engine.port_for(process, num)
+        command_args = process.command.split(" ")
         write_template "launchd/launchd.plist.erb", "#{app}-#{name}-#{num}.plist", binding
       end
     end

lib/foreman/process.rb

@@ -21,6 +21,21 @@ class Foreman::Process
     @options[:env] ||= {}
   end
 
+  # Get environment-expanded command for a +Process+
+  #
+  # @param [Hash] custom_env ({}) Environment variables to merge with defaults
+  #
+  # @return [String]  The expanded command
+  #
+  def expanded_command(custom_env={})
+    env = @options[:env].merge(custom_env)
+    expanded_command = command.dup
+    env.each do |key, val|
+      expanded_command.gsub!("$#{key}", val)
+    end
+    expanded_command
+  end
+
   # Run a +Process+
   #
   # @param [Hash] options
@@ -31,16 +46,12 @@ class Foreman::Process
   # @returns [Fixnum] pid  The +pid+ of the process
   #
   def run(options={})
-    env    = options[:env] ? @options[:env].merge(options[:env]) : @options[:env]
+    env    = @options[:env].merge(options[:env] || {})
     output = options[:output] || $stdout
 
     if Foreman.windows?
       Dir.chdir(cwd) do
-        expanded_command = command.dup
+        Process.spawn env, expanded_command(env), :out => output, :err => output
-        env.each do |key, val|
-          expanded_command.gsub!("$#{key}", val)
-        end
-        Process.spawn env, expanded_command, :out => output, :err => output
       end
     elsif Foreman.jruby?
       require "posix/spawn"
@@ -52,7 +63,7 @@ class Foreman::Process
         $stderr.reopen output
         env.each { |k,v| ENV[k] = v }
         wrapped_command = "#{Foreman.runner} -d '#{cwd}' -p -- #{command}"
-        exec wrapped_command
+        Kernel.exec wrapped_command
       end
     else
       wrapped_command = "#{Foreman.runner} -d '#{cwd}' -p -- #{command}"
@@ -60,6 +71,20 @@ class Foreman::Process
     end
   end
 
+  # Exec a +Process+
+  #
+  # @param [Hash] options
+  #
+  # @option options :env ({}) Environment variables to set for this execution
+  #
+  # @return Does not return
+  def exec(options={})
+    env = @options[:env].merge(options[:env] || {})
+    env.each { |k, v| ENV[k] = v }
+    Dir.chdir(cwd)
+    Kernel.exec expanded_command(env)
+  end
+
   # Send a signal to this +Process+
   #
   # @param [String] signal  The signal to send
@@ -90,8 +115,10 @@ class Foreman::Process
     !alive?
   end
 
-private
+  # Returns the working directory for this +Process+
-
+  #
+  # @returns [String]
+  #
   def cwd
     File.expand_path(@options[:cwd] || ".")
   end

lib/foreman/version.rb

@@ -1,5 +1,5 @@
 module Foreman
 
-  VERSION = "0.52.0"
+  VERSION = "0.60.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" "July 2012" "Foreman 0.51.0" "Foreman Manual"
+.TH "FOREMAN" "1" "July 2012" "Foreman 0.57.0" "Foreman Manual"
 .
 .SH "NAME"
 \fBforeman\fR \- manage Procfile\-based applications

spec/foreman/cli_spec.rb

@@ -72,6 +72,15 @@ describe "Foreman::CLI", :fakefs do
     it "includes the environment" do
       forked_foreman("run #{resource_path("bin/env FOO")} -e #{resource_path(".env")}").should == "bar\n"
     end
+
+    it "can run a command from the Procfile" do
+      forked_foreman("run -f #{resource_path("Procfile")} test").should == "testing\n"
+    end
+
+    it "exits with the same exit code as the command" do
+      fork_and_get_exitstatus("run echo 1").should == 0
+      fork_and_get_exitstatus("run date 'invalid_date'").should == 1
+    end
   end
 
   describe "version" do

spec/foreman/engine_spec.rb

@@ -90,6 +90,14 @@ describe "Foreman::Engine", :fakefs do
       subject.env["OTHER"].should == 'escaped"quote'
     end
 
+    it "should handle multiline strings" do
+      File.open("/tmp/env", "w") do |f|
+        f.puts 'FOO="bar\nbaz"'
+      end
+      subject.load_env "/tmp/env"
+      subject.env["FOO"].should == "bar\nbaz"
+    end
+
     it "should fail if specified and doesnt exist" do
       lambda { subject.load_env "/tmp/env" }.should raise_error(Errno::ENOENT)
     end

spec/foreman/export/launchd_spec.rb

@@ -18,4 +18,14 @@ describe Foreman::Export::Launchd, :fakefs do
     File.read("/tmp/init/app-bravo-1.plist").should == example_export_file("launchd/launchd-b.default")
   end
 
+  context "with multiple command arguments" do
+    let(:procfile) { FileUtils.mkdir_p("/tmp/app"); write_procfile("/tmp/app/Procfile", "charlie") }
+
+    it "splits each command argument" do
+      launchd.export
+      File.read("/tmp/init/app-alpha-1.plist").should == example_export_file("launchd/launchd-c.default")
+    end
+
+  end
+
 end

spec/resources/export/inittab/inittab.concurrency

@@ -1,4 +1,4 @@
 # ----- foreman app processes -----
-AP01:4:respawn:/bin/su - app -c 'PORT=5000 ./alpha >> /var/log/app/alpha-1.log 2>&1'
+AP01:4:respawn:/bin/su - app -c 'cd /tmp/app;export PORT=5000;./alpha >> /var/log/app/alpha-1.log 2>&1'
-AP02:4:respawn:/bin/su - app -c 'PORT=5001 ./alpha >> /var/log/app/alpha-2.log 2>&1'
+AP02:4:respawn:/bin/su - app -c 'cd /tmp/app;export PORT=5001;./alpha >> /var/log/app/alpha-2.log 2>&1'
 # ----- end foreman app processes -----

spec/resources/export/inittab/inittab.default

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

spec/resources/export/launchd/launchd-a.default

@@ -4,6 +4,11 @@
 <dict>
     <key>Label</key>
     <string>app-alpha-1</string>
+    <key>EnvironmentVariables</key>
+    <dict>
+        <key>PORT</key>
+        <string>5000</string>
+    </dict>
     <key>ProgramArguments</key>
     <array>
         <string>./alpha</string>
@@ -12,6 +17,8 @@
     <true/>
     <key>RunAtLoad</key>
     <true/>
+    <key>StandardOutPath</key>
+    <string>/var/log/app/app-alpha-1.log</string>
     <key>StandardErrorPath</key>
     <string>/var/log/app/app-alpha-1.log</string>
     <key>UserName</key>

spec/resources/export/launchd/launchd-b.default

@@ -4,6 +4,11 @@
 <dict>
     <key>Label</key>
     <string>app-bravo-1</string>
+    <key>EnvironmentVariables</key>
+    <dict>
+        <key>PORT</key>
+        <string>5100</string>
+    </dict>
     <key>ProgramArguments</key>
     <array>
         <string>./bravo</string>
@@ -12,6 +17,8 @@
     <true/>
     <key>RunAtLoad</key>
     <true/>
+    <key>StandardOutPath</key>
+    <string>/var/log/app/app-bravo-1.log</string>
     <key>StandardErrorPath</key>
     <string>/var/log/app/app-bravo-1.log</string>
     <key>UserName</key>

spec/resources/export/launchd/launchd-c.default

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>Label</key>
+    <string>app-alpha-1</string>
+    <key>EnvironmentVariables</key>
+    <dict>
+        <key>PORT</key>
+        <string>5000</string>
+    </dict>
+    <key>ProgramArguments</key>
+    <array>
+        <string>./alpha</string>
+        <string>charlie</string>
+    </array>
+    <key>KeepAlive</key>
+    <true/>
+    <key>RunAtLoad</key>
+    <true/>
+    <key>StandardOutPath</key>
+    <string>/var/log/app/app-alpha-1.log</string>
+    <key>StandardErrorPath</key>
+    <string>/var/log/app/app-alpha-1.log</string>
+    <key>UserName</key>
+    <string>app</string>
+    <key>WorkingDirectory</key>
+    <string>/tmp/app</string>
+</dict>
+</plist>

spec/resources/export/upstart/app.conf

@@ -7,5 +7,10 @@ EOF
 
 end script
 
-start on started network
+start on (started network-interface
-stop on stopping network
+          or started network-manager
+          or started networking)
+
+stop on (stopping network-interface
+         or stopping network-manager
+         or stopping networking)

spec/spec_helper.rb

@@ -58,6 +58,12 @@ def fork_and_capture(&blk)
   end
 end
 
+def fork_and_get_exitstatus(args)
+  pid = Process.spawn("bundle exec bin/foreman #{args}", :out => "/dev/null", :err => "/dev/null")
+  Process.wait(pid)
+  $?.exitstatus
+end
+
 def mock_exit(&block)
   block.should raise_error(SystemExit)
 end