0.40.0

Provide a useful error if `foreman check` fails to find a Procfile

.gitignore

@@ -1,4 +1,5 @@
 /.bundle
+/.rbenv-version
 /coverage
 /example/log/*
 /man/*.html

Changelog.md

@@ -1,3 +1,31 @@
+## 0.39.0 (2012-02-07)
+
+* rename bin/runner to bin/foreman-runner  [David Dollar]
+* fix tgz release  [David Dollar]
+* bundle update hpricot  [John Firebaugh]
+* touch up .pkg release tasks  [David Dollar]
+
+## 0.38.0 (2012-02-02)
+
+* bring back single process starting  [David Dollar]
+* more attempts at getting ci working with jruby  [David Dollar]
+* ignore .rbenv-version  [David Dollar]
+* force to binary encoding if supported  [David Dollar]
+
+## 0.37.2 (2012-01-29)
+
+* handle directories with spaces in runner  [David Dollar]
+* update docs  [David Dollar]
+
+## 0.37.1 (2012-01-29)
+
+* use binary pipes to better handle UTF-8 data  [David Dollar]
+* set up example procfile with UTF-8 item  [David Dollar]
+* remove autotest  [David Dollar]
+* fix up authors generation  [David Dollar]
+* fix up packaging after moving tasks  [David Dollar]
+* fix up changelog tasks  [David Dollar]
+
 ## 0.37.0 (2012-01-29)
 
 * put an entire line of output inside a single mutex so we don't cross the streams  [David Dollar]

Gemfile

@@ -11,14 +11,12 @@ platform :jruby do
 end
 
 group :development do
+  gem 'aws-s3'
   gem 'parka'
   gem 'rake'
   gem 'ronn'
   gem 'fakefs', '~> 0.3.2'
   gem 'rr',     '~> 1.0.2'
   gem 'rspec',  '~> 2.0'
-  gem 'ZenTest'
-  gem 'aws-s3'
-  gem "rubyzip"
   gem "simplecov", :require => false
 end

Gemfile.lock

@@ -1,14 +1,13 @@
 PATH
   remote: .
   specs:
-    foreman (0.37.1)
+    foreman (0.40.0)
       term-ansicolor (~> 1.0.7)
       thor (>= 0.13.6)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    ZenTest (4.6.2)
     aws-s3 (0.6.2)
       builder
       mime-types
@@ -17,8 +16,8 @@ GEM
     crack (0.1.8)
     diff-lcs (1.1.3)
     fakefs (0.3.2)
-    hpricot (0.8.2)
-    hpricot (0.8.2-java)
+    hpricot (0.8.6)
+    hpricot (0.8.6-java)
     mime-types (1.16)
     multi_json (1.0.4)
     mustache (0.11.2)
@@ -44,7 +43,6 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
-    rubyzip (0.9.4)
     simplecov (0.5.4)
       multi_json (~> 1.0.3)
       simplecov-html (~> 0.5.3)
@@ -60,7 +58,6 @@ PLATFORMS
   x86-mingw32
 
 DEPENDENCIES
-  ZenTest
   aws-s3
   fakefs (~> 0.3.2)
   foreman!
@@ -70,6 +67,5 @@ DEPENDENCIES
   ronn
   rr (~> 1.0.2)
   rspec (~> 2.0)
-  rubyzip
   simplecov
   win32console (~> 1.3.0)

README.md

@@ -33,7 +33,7 @@ Manage Procfile-based applications
 David Dollar
 
 #### Patches contributed by
-Adam Wiggins, Chris Continanza, Chris Lowder, Craig R Webster, Dan Farina, Dan Peterson, David Dollar, Fletcher Nichol, Florian Apolloner, Gabriel Burt, Gamaliel Toro, Greg Reinacker, Hugues Le Gendre, Hunter Nield, Iain Hecker, Jay Zeschin, Keith Rarick, Khaja Minhajuddin, Lincoln Stoll, Marcos Muino Garcia, Mark McGranaghan, Matt Griffin, Matt Haynes, Matthijs Langenberg, Michael Dwan, Michael van Rooijen, Mike Javorski, Nathan Broadbent, Nathan L Smith, Nick Zadrozny, Phil Hagelberg, Ricardo Chimal, Jr, Thom May, Tom Ward, brainopia, clifff, jc00ke
+Adam Wiggins, Chris Continanza, Chris Lowder, Craig R Webster, Dan Farina, Dan Peterson, David Dollar, Fletcher Nichol, Florian Apolloner, Gabriel Burt, Gamaliel Toro, Greg Reinacker, Hugues Le Gendre, Hunter Nield, Iain Hecker, Jay Zeschin, John Firebaugh, Keith Rarick, Khaja Minhajuddin, Lincoln Stoll, Marcos Muino Garcia, Mark McGranaghan, Matt Griffin, Matt Haynes, Matthijs Langenberg, Michael Dwan, Michael van Rooijen, Mike Javorski, Nathan Broadbent, Nathan L Smith, Nick Zadrozny, Phil Hagelberg, Ricardo Chimal, Jr, Thom May, Tom Ward, brainopia, clifff, jc00ke
 
 ## License
 

Rakefile

@@ -1,6 +1,8 @@
 $:.unshift File.expand_path("../lib", __FILE__)
 require "foreman"
 
+require "bundler/setup"
+
 Dir[File.expand_path("../tasks/*.rake", __FILE__)].each do |task|
   load task
 end

bin/foreman-runner

@@ -1,6 +1,6 @@
 #!/bin/sh
 #
-#/ Usage: runner [-d <dir>] <command>
+#/ Usage: foreman-runner [-d <dir>] <command>
 #/
 #/ Run a command with exec, optionally changing directory first
 
@@ -18,7 +18,7 @@ usage() {
 
 while getopts ":hd:" OPT; do
   case $OPT in
-     d) cd $OPTARG ;;
+     d) cd "$OPTARG" ;;
      h) usage ;;
     \?) error "invalid option: -$OPTARG" ;;
      :) error "option -$OPTARG requires an argument" ;;

dist/deb.rake

@@ -4,7 +4,7 @@ file pkg("/apt-#{version}/foreman-#{version}.deb") => distribution_files("deb")
       assemble_distribution
       assemble_gems
       assemble resource("deb/foreman"), "bin/foreman", 0755
-      File.chmod 0755, "bin/runner"
+      File.chmod 0755, "bin/foreman-runner"
     end
 
     assemble resource("deb/control"), "control"

dist/jruby.rake

@@ -1,5 +1,7 @@
 file pkg("foreman-#{version}-jruby.gem") => distribution_files do |t|
-  sh "env PLATFORM=java gem build foreman.gemspec"
+  Bundler.with_clean_env do
+    sh "env PLATFORM=java gem build foreman.gemspec"
+  end
   sh "mv foreman-#{version}-java.gem #{t.name}"
 end
 

dist/mingw32.rake

@@ -1,5 +1,7 @@
 file pkg("foreman-#{version}-mingw32.gem") => distribution_files do |t|
-  sh "env PLATFORM=mingw32 gem build foreman.gemspec"
+  Bundler.with_clean_env do
+    sh "env PLATFORM=mingw32 gem build foreman.gemspec"
+  end
   sh "mv foreman-#{version}-mingw32.gem #{t.name}"
 end
 

dist/pkg.rake

@@ -13,7 +13,7 @@ file pkg("foreman-#{version}.pkg") => distribution_files do |t|
 
     mkdir_p "pkg"
     mkdir_p "pkg/Resources"
-    mkdir_p "pkg/foreman-#{version}.pkg"
+    mkdir_p "pkg/foreman.pkg"
 
     dist = File.read(resource("pkg/Distribution.erb"))
     dist = ERB.new(dist).result(binding)
@@ -21,20 +21,21 @@ file pkg("foreman-#{version}.pkg") => distribution_files do |t|
 
     dist = File.read(resource("pkg/PackageInfo.erb"))
     dist = ERB.new(dist).result(binding)
-    File.open("pkg/foreman-#{version}.pkg/PackageInfo", "w") { |f| f.puts dist }
+    File.open("pkg/foreman.pkg/PackageInfo", "w") { |f| f.puts dist }
 
-    mkdir_p "pkg/foreman-#{version}.pkg/Scripts"
-    cp resource("pkg/postinstall"), "pkg/foreman-#{version}.pkg/Scripts/postinstall"
-    chmod 0755, "pkg/foreman-#{version}.pkg/Scripts/postinstall"
+    mkdir_p "pkg/foreman.pkg/Scripts"
+    cp resource("pkg/postinstall"), "pkg/foreman.pkg/Scripts/postinstall"
+    chmod 0755, "pkg/foreman.pkg/Scripts/postinstall"
 
-    sh %{ mkbom -s foreman pkg/foreman-#{version}.pkg/Bom }
+    sh %{ mkbom -s foreman pkg/foreman.pkg/Bom }
 
     Dir.chdir("foreman") do
-      sh %{ pax -wz -x cpio . > ../pkg/foreman-#{version}.pkg/Payload }
+      sh %{ pax -wz -x cpio . > ../pkg/foreman.pkg/Payload }
     end
 
     sh %{ pkgutil --flatten pkg foreman-#{version}.pkg }
 
+    FileUtils.mkdir_p(File.dirname(t.name))
     cp_r "foreman-#{version}.pkg", t.name
   end
 end

dist/resources/pkg/Distribution.erb

@@ -10,14 +10,14 @@
   ]]></script>
   <choices-outline>
     <line choice="git"/>
-    <line choice="foreman-<%= version %>"/>
+    <line choice="foreman"/>
   </choices-outline>
   <choice id="git" title="git" start_selected="false" start_enabled="false" selected="needs_git()" enabled="needs_git()">
     <pkg-ref id="git.pkg" />
   </choice>
-  <choice id="foreman-<%= version %>" title="foreman">
+  <choice id="foreman" title="foreman">
     <pkg-ref id="io.foreman.installer"/>
   </choice>
-  <pkg-ref id="io.foreman.installer" installKBytes="<%= kbytes %>" version="<%= version %>" auth="Root">#foreman-<%= version %>.pkg</pkg-ref>
+  <pkg-ref id="io.foreman.installer" installKBytes="<%= kbytes %>" version="<%= version %>" auth="Root">#foreman.pkg</pkg-ref>
 </installer-script>
 

dist/resources/pkg/PackageInfo.erb

@@ -4,4 +4,3 @@
     <postinstall file="./postinstall"/>
   </scripts>
 </pkg-info>
-

dist/tgz.rake

@@ -3,7 +3,7 @@ file pkg("foreman-#{version}.tgz") => distribution_files do |t|
     mkchdir("foreman") do
       assemble_distribution
       assemble_gems
-      rm_rf "bin"
+      rm_f "bin/foreman"
       assemble resource("tgz/foreman"), "foreman", 0755
     end
 

lib/foreman.rb

@@ -4,14 +4,8 @@ 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__)
+    File.expand_path("../../bin/foreman-runner", __FILE__)
   end
 
   def self.jruby?

lib/foreman/cli.rb

@@ -10,7 +10,7 @@ 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"
@@ -27,8 +27,9 @@ class Foreman::CLI < Thor
     end
   end
 
-  def start
+  def start(process=nil)
     check_procfile!
+    engine.options[:concurrency] = "#{process}=1" if process
     engine.start
   end
 
@@ -53,6 +54,7 @@ class Foreman::CLI < Thor
   desc "check", "Validate your application's Procfile"
 
   def check
+    check_procfile!
     error "no processes defined" unless engine.procfile.entries.length > 0
     puts "valid procfile detected (#{engine.procfile.process_names.join(', ')})"
   end

lib/foreman/engine.rb

@@ -10,6 +10,7 @@ require "thread"
 
 class Foreman::Engine
 
+  attr_reader :environment
   attr_reader :procfile
   attr_reader :directory
   attr_reader :options
@@ -23,16 +24,11 @@ class Foreman::Engine
   def initialize(procfile, options={})
     @procfile  = Foreman::Procfile.new(procfile)
     @directory = options[:app_root] || File.expand_path(File.dirname(procfile))
-    @options = options
+    @options = options.dup
     @environment = read_environment_files(options[:env])
     @output_mutex = Mutex.new
   end
 
-  def self.load_env!(env_file)
-    @environment = read_environment_files(env_file)
-    apply_environment!
-  end
-
   def start
     proctitle "ruby: foreman master"
     termtitle "#{File.basename(@directory)} - foreman"
@@ -52,6 +48,10 @@ class Foreman::Engine
     base_port.to_i + offset + num - 1
   end
 
+  def apply_environment!
+    environment.each { |k,v| ENV[k] = v }
+  end
+
 private ######################################################################
 
   def spawn_processes
@@ -99,6 +99,7 @@ private ######################################################################
     (rs || []).each do |r|
       data = r.gets
       next unless data
+      data.force_encoding("BINARY") if data.respond_to?(:force_encoding)
       ps, message = data.split(",", 2)
       color = colors[ps.split(".").first]
       info message, ps, color
@@ -197,42 +198,31 @@ private ######################################################################
     COLORS[@current_color]
   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
+    (filenames || "").split(",").map(&:strip).each do |filename|
+      error "No such file: #{filename}" unless File.exists?(filename)
+      environment.merge!(read_environment(filename))
     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
-
-    def error(message)
-      puts "ERROR: #{message}"
-      exit 1
-    end
+    environment.merge!(read_environment(".env")) unless filenames
+    environment
   end
 
-  include Env
-  extend  Env
+  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/
+        key, val = [$1, $2]
+        case val
+          when /\A'(.*)'\z/ then hash[key] = $1
+          when /\A"(.*)"\z/ then hash[key] = $1.gsub(/\\(.)/, '\1')
+          else hash[key] = val
+        end
+      end
+      hash
+    end
+  end
 end

lib/foreman/version.rb

@@ -1,5 +1,5 @@
 module Foreman
 
-  VERSION = "0.37.1"
+  VERSION = "0.40.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" "January 2012" "Foreman 0.37.0" "Foreman Manual"
+.TH "FOREMAN" "1" "February 2012" "Foreman 0.39.0" "Foreman Manual"
 .
 .SH "NAME"
 \fBforeman\fR \- manage Procfile\-based applications
@@ -10,10 +10,13 @@
 \fBforeman start [process]\fR
 .
 .br
+\fBforeman run <command>\fR
+.
+.br
 \fBforeman export <format> [location]\fR
 .
 .SH "DESCRIPTION"
-\fBForeman\fR is a manager for Procfile\-based applications\. Its aim is to abstract away the details of the Procfile format, and allow you to either run your application directly or export it to some other process management format\.
+Foreman is a manager for Procfile\-based applications\. Its aim is to abstract away the details of the Procfile format, and allow you to either run your application directly or export it to some other process management format\.
 .
 .SH "RUNNING"
 \fBforeman start\fR is used to run your application directly from the command line\.
@@ -35,6 +38,9 @@ Specify the number of each process type to run\. The value passed in should be i
 \fB\-p\fR, \fB\-\-port\fR
 Specify which port to use as the base for this application\. Should be a multiple of 1000\.
 .
+.P
+\fBforeman run\fR is used to run one\-off commands using the same environment as your defined processes\.
+.
 .SH "EXPORTING"
 \fBforeman export\fR is used to export your application to another process management format\.
 .
@@ -61,10 +67,14 @@ Specify the directory to place process logs in\.
 Specify which port to use as the base for this application\. Should be a multiple of 1000\.
 .
 .TP
+\fB\-t\fR, \fB\-\-template\fR
+Specify an alternate template to use for creating export files\. See \fIhttps://github\.com/ddollar/foreman/tree/master/data/export\fR for examples\.
+.
+.TP
 \fB\-u\fR, \fB\-\-user\fR
 Specify the user the application should be run as\. Defaults to the app name
 .
-.SH "OPTIONS"
+.SH "GLOBAL OPTIONS"
 These options control all modes of foreman\'s operation\.
 .
 .TP

man/foreman.1.ronn

@@ -4,11 +4,12 @@ foreman(1) -- manage Procfile-based applications
 ## SYNOPSIS
 
 `foreman start [process]`<br>
+`foreman run <command>`<br>
 `foreman export <format> [location]`
 
 ## DESCRIPTION
 
-**Foreman** is a manager for Procfile-based applications. Its aim is to
+Foreman is a manager for Procfile-based applications. Its aim is to
 abstract away the details of the Procfile format, and allow you to either run
 your application directly or export it to some other process management
 format.
@@ -33,6 +34,9 @@ The following options control how the application is run:
     Specify which port to use as the base for this application. Should be
     a multiple of 1000.
 
+`foreman run` is used to run one-off commands using the same environment
+as your defined processes.
+
 ## EXPORTING
 
 `foreman export` is used to export your application to another process
@@ -58,11 +62,15 @@ The following options control how the application is run:
     Specify which port to use as the base for this application. Should be
     a multiple of 1000.
 
+  * `-t`, `--template`:
+    Specify an alternate template to use for creating export files.
+    See <https://github.com/ddollar/foreman/tree/master/data/export> for examples.
+
   * `-u`, `--user`:
     Specify the user the application should be run as. Defaults to the
     app name
 
-## OPTIONS
+## GLOBAL OPTIONS
 
 These options control all modes of foreman's operation.
 

spec/foreman/cli_spec.rb

@@ -3,6 +3,8 @@ require "foreman/cli"
 
 describe "Foreman::CLI", :fakefs do
   subject { Foreman::CLI.new }
+  let(:engine) { subject.send(:engine) }
+  let(:entries) { engine.procfile.entries.inject({}) { |h,e| h.update(e.name => e) } }
 
   describe "start" do
     describe "with a non-existent Procfile" do
@@ -22,6 +24,15 @@ describe "Foreman::CLI", :fakefs do
         mock.instance_of(Foreman::Engine).start
         subject.start
       end
+
+      it "can run a single process" do
+        dont_allow(subject).error
+        stub(engine).watch_for_output
+        stub(engine).watch_for_termination
+        mock(entries["alpha"]).spawn(1, is_a(IO), engine.directory, {}, 5000) { [] }
+        mock(entries["bravo"]).spawn(0, is_a(IO), engine.directory, {}, 5100) { [] }
+        subject.start("alpha")
+      end
     end
   end
 
@@ -109,6 +120,14 @@ describe "Foreman::CLI", :fakefs do
         end
       end
     end
+
+    describe "without a Procfile" do
+      it "displays an error" do
+        mock_error(subject, "Procfile does not exist.") do
+          subject.check
+        end
+      end
+    end
   end
 
   describe "run" do

spec/foreman/engine_spec.rb

@@ -4,6 +4,13 @@ require "foreman/engine"
 describe "Foreman::Engine", :fakefs do
   subject { Foreman::Engine.new("Procfile", {}) }
 
+  before do
+    any_instance_of(Foreman::Engine) do |engine|
+      stub(engine).proctitle
+      stub(engine).termtitle
+    end
+  end
+
   describe "initialize" do
     describe "without an existing Procfile" do
       it "raises an error" do
@@ -46,14 +53,16 @@ describe "Foreman::Engine", :fakefs do
     before(:each) do
       write_procfile
       stub(Process).fork
+      any_instance_of(Foreman::Engine) do |engine|
+        stub(engine).info
+        stub(engine).spawn_processes
+        stub(engine).watch_for_termination
+      end
     end
 
     it "should read if specified" 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.start
     end
@@ -62,13 +71,21 @@ describe "Foreman::Engine", :fakefs do
       File.open("/tmp/env1", "w") { |f| f.puts("FOO=bar") }
       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.start
     end
 
+    it "should handle quoted values" do
+      File.open("/tmp/env", "w") do |f|
+        f.puts 'FOO=bar'
+        f.puts 'BAZ="qux"'
+        f.puts "FRED='barney'"
+        f.puts 'OTHER="escaped\"quote"'
+      end
+      engine = Foreman::Engine.new("Procfile", :env => "/tmp/env")
+      engine.environment.should == { "FOO" => "bar", "BAZ" => "qux", "FRED" => "barney", "OTHER" => 'escaped"quote' }
+    end
+
     it "should fail if specified and doesnt exist" do
       mock.instance_of(Foreman::Engine).error("No such file: /tmp/env")
       engine = Foreman::Engine.new("Procfile", :env => "/tmp/env")
@@ -77,8 +94,6 @@ describe "Foreman::Engine", :fakefs do
     it "should read .env if none specified" do
       File.open(".env", "w") { |f| f.puts("FOO=qoo") }
       engine = Foreman::Engine.new("Procfile")
-      mock(engine).spawn_processes
-      mock(engine).watch_for_termination
       engine.environment.should == {"FOO"=>"qoo"}
       engine.start
     end
@@ -95,7 +110,7 @@ describe "Foreman::Engine", :fakefs do
       stub(subject).watch_for_output
       stub(subject).watch_for_termination
       subject.start
-      sleep 1
+      Process.waitall
       mock(subject).info(/started with pid \d+/, "utf8.1", anything)
       mock(subject).info("\xff\x03\n", "utf8.1", anything)
       subject.send(:poll_readers)

spec/foreman_spec.rb

@@ -8,24 +8,6 @@ describe Foreman do
     it { should be_a String }
   end
 
-  describe "::load_env!(env_file)", :fakefs do
-    after do
-      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
-
   describe "runner" do
     it "should exist" do
       File.exists?(Foreman.runner).should == true