0.46.0

Add Procfile load/write/append API

Changelog.md

@@ -1,3 +1,30 @@
+## 0.45.0 (2012-04-26)
+
+* create and chown log dir in upstart export.  [Phil Hagelberg]
+* remove parka from dist files  [David Dollar]
+
+## 0.44.0 (2012-04-23)
+
+* make var output order repeatable in supervisord export [David Dollar]
+* make --procfile and --app-root influence each other in a more intuitive way  [David Dollar]
+* Look for .env and app_root in the same dir as the Procfile.  [Phil Hagelberg]
+
+## 0.43.0 (2012-04-20)
+
+* wrap supervisord env vars in quotes  [Raphael Randschau]
+
+## 0.42.0 (2012-04-18)
+
+* Move read_environment to a public class method.  [Phil Hagelberg]
+* Drop parka dependency  [Phil Hagelberg]
+* add group support for supervisord  [Raphael Randschau]
+* fix enviroment export  [Raphael Randschau]
+
+## 0.41.0 (2012-03-16)
+
+* replace term-ansicolor with built-in colorization  [David Dollar]
+* supervisord export template  [Raphael Randschau]
+
 ## 0.40.0 (2012-02-24)
 
 * support various quoting styles in .env  [David Dollar]

Gemfile

@@ -12,7 +12,6 @@ end
 
 group :development do
   gem 'aws-s3'
-  gem 'parka'
   gem 'rake'
   gem 'ronn'
   gem 'fakefs', '~> 0.3.2'

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    foreman (0.41.0)
+    foreman (0.45.0)
       thor (>= 0.13.6)
 
 GEM
@@ -12,7 +12,6 @@ GEM
       mime-types
       xml-simple
     builder (3.0.0)
-    crack (0.1.8)
     diff-lcs (1.1.3)
     fakefs (0.3.2)
     hpricot (0.8.6)
@@ -20,15 +19,9 @@ GEM
     mime-types (1.16)
     multi_json (1.0.4)
     mustache (0.11.2)
-    parka (0.6.2)
-      crack
-      rest-client
-      thor
     posix-spawn (0.3.6)
     rake (0.9.2.2)
     rdiscount (1.6.5)
-    rest-client (1.6.1)
-      mime-types (>= 1.16)
     ronn (0.7.3)
       hpricot (>= 0.8.2)
       mustache (>= 0.7.0)
@@ -59,7 +52,6 @@ DEPENDENCIES
   aws-s3
   fakefs (~> 0.3.2)
   foreman!
-  parka
   posix-spawn (~> 0.3.6)
   rake
   ronn

data/export/supervisord/app.conf.erb

@@ -1,12 +1,15 @@
 <%
+app_names = []
 engine.procfile.entries.each do |process|
   next if (conc = self.concurrency[process.name]) < 1
   1.upto(self.concurrency[process.name]) do |num|
     port = engine.port_for(process, num, self.port)
     name = if (conc > 1); "#{process.name}-#{num}" else process.name; end
-    environment = (engine.environment.each_pair { |var,env| "#{var.upcase}=#{env}" }.to_a << "PORT=#{port}")
+    environment = (engine.environment.keys.sort.map{ |var| %{#{var.upcase}="#{engine.environment[var]}"} } + [%{PORT="#{port}"}])
+    app_name = "#{app}-#{name}"
+    app_names << app_name
 %>
-[program:<%= app %>-<%= name %>]
+[program:<%= app_name %>]
 command=<%= process.command %>
 autostart=true
 autorestart=true
@@ -19,3 +22,6 @@ environment=<%= environment.join(',') %><%
   end
 end
 %>
+
+[group:<%= app %>]
+programs=<%= app_names.join(',') %>

dist/gem.rake

@@ -10,5 +10,5 @@ task "gem:clean" do
 end
 
 task "gem:release" => "gem:build" do |t|
-  sh "parka push -f #{pkg("foreman-#{version}.gem")}"
+  sh "gem push #{pkg("foreman-#{version}.gem")} || echo 'error'"
 end

dist/jruby.rake

@@ -12,5 +12,5 @@ task "jruby:clean" do
 end
 
 task "jruby:release" => "jruby:build" do |t|
-  sh "parka push -f #{pkg("foreman-#{version}-jruby.gem")}"
+  sh "gem push #{pkg("foreman-#{version}-jruby.gem")} || echo 'error'"
 end

dist/mingw32.rake

@@ -12,5 +12,5 @@ task "mingw32:clean" do
 end
 
 task "mingw32:release" => "mingw32:build" do |t|
-  sh "parka push -f #{pkg("foreman-#{version}-mingw32.gem")}"
+  sh "gem push #{pkg("foreman-#{version}-mingw32.gem")} || echo 'error'"
 end

lib/foreman/cli.rb

@@ -83,7 +83,11 @@ private ######################################################################
   end
 
   def procfile
-    options[:procfile] || "Procfile"
+    case
+      when options[:procfile] then options[:procfile]
+      when options[:app_root] then File.expand_path(File.join(options[:app_root], "Procfile"))
+      else "Procfile"
+    end
   end
 
   def error(message)

lib/foreman/engine.rb

@@ -21,11 +21,13 @@ class Foreman::Engine
   Foreman::Color.enable($stdout)
 
   def initialize(procfile, options={})
-    @procfile  = Foreman::Procfile.new(procfile)
+    @procfile  = Foreman::Procfile.new(procfile) if File.exists?(procfile)
     @directory = options[:app_root] || File.expand_path(File.dirname(procfile))
     @options = options.dup
-    @environment = read_environment_files(options[:env])
     @output_mutex = Mutex.new
+
+    @options[:env] ||= default_env
+    @environment = read_environment_files(@options[:env])
   end
 
   def start
@@ -51,6 +53,22 @@ class Foreman::Engine
     environment.each { |k,v| ENV[k] = v }
   end
 
+  def self.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
+
 private ######################################################################
 
   def spawn_processes
@@ -195,26 +213,15 @@ private ######################################################################
 
     (filenames || "").split(",").map(&:strip).each do |filename|
       error "No such file: #{filename}" unless File.exists?(filename)
-      environment.merge!(read_environment(filename))
+      environment.merge!(Foreman::Engine.read_environment(filename))
     end
 
-    environment.merge!(read_environment(".env")) unless filenames
     environment
   end
 
-  def read_environment(filename)
+  def default_env
-    return {} unless File.exists?(filename)
+    env = File.join(directory, ".env")
-
+    File.exists?(env) ? env : ""
-    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/export/upstart.rb

@@ -36,6 +36,8 @@ class Foreman::Export::Upstart < Foreman::Export::Base
         write_file "#{location}/#{app}-#{process.name}-#{num}.conf", process_config
       end
     end
-  end
 
+    FileUtils.mkdir_p(log_root) rescue error "could not create #{log_root}"
+    FileUtils.chown(user, nil, log_root) rescue error "could not chown #{log_root} to #{user}"
+  end
 end

lib/foreman/procfile.rb

@@ -13,8 +13,9 @@ class Foreman::Procfile
 
   attr_reader :entries
 
-  def initialize(filename)
+  def initialize(filename=nil)
-    @entries = parse_procfile(filename)
+    @entries = []
+    load(filename) if filename
   end
 
   def [](name)
@@ -25,12 +26,31 @@ class Foreman::Procfile
     entries.map(&:name)
   end
 
-private
+  def load(filename)
+    entries.clear
+    parse_procfile(filename)
+  end
+
+  def write(filename)
+    File.open(filename, 'w') do |io|
+      entries.each do |ent|
+        io.puts(ent)
+      end
+    end
+  end
+
+  def <<(entry)
+    entries << Foreman::ProcfileEntry.new(*entry)
+    self
+  end
+
+
+protected
 
   def parse_procfile(filename)
     File.read(filename).split("\n").map do |line|
       if line =~ /^([A-Za-z0-9_]+):\s*(.+)$/
-        Foreman::ProcfileEntry.new($1, $2)
+        self << [ $1, $2 ]
       end
     end.compact
   end

lib/foreman/procfile_entry.rb

@@ -19,4 +19,8 @@ class Foreman::ProcfileEntry
     end
   end
 
+  def to_s
+    "#{name}: #{command}"
+  end
+
 end

lib/foreman/version.rb

@@ -1,5 +1,5 @@
 module Foreman
 
-  VERSION = "0.41.0"
+  VERSION = "0.46.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" "February 2012" "Foreman 0.39.0" "Foreman Manual"
+.TH "FOREMAN" "1" "April 2012" "Foreman 0.45.0" "Foreman Manual"
 .
 .SH "NAME"
 \fBforeman\fR \- manage Procfile\-based applications
@@ -35,6 +35,14 @@ The following options control how the application is run:
 Specify the number of each process type to run\. The value passed in should be in the format \fBprocess=num,process=num\fR
 .
 .TP
+\fB\-e\fR, \fB\-\-env\fR
+Specify one or more \.env files to load
+.
+.TP
+\fB\-f\fR, \fB\-\-procfile\fR
+Specify an alternate Procfile to load, implies \fB\-d\fR at the Procfile root\.
+.
+.TP
 \fB\-p\fR, \fB\-\-port\fR
 Specify which port to use as the base for this application\. Should be a multiple of 1000\.
 .

man/foreman.1.ronn

@@ -30,6 +30,12 @@ The following options control how the application is run:
     Specify the number of each process type to run. The value passed in
     should be in the format `process=num,process=num`
 
+  * `-e`, `--env`:
+    Specify one or more .env files to load
+
+  * `-f`, `--procfile`:
+    Specify an alternate Procfile to load, implies `-d` at the Procfile root.
+
   * `-p`, `--port`:
     Specify which port to use as the base for this application. Should be
     a multiple of 1000.

spec/foreman/cli_spec.rb

@@ -34,6 +34,15 @@ describe "Foreman::CLI", :fakefs do
         subject.start("alpha")
       end
     end
+
+    describe "with an alternate root" do
+      it "reads the Procfile from that root" do
+        write_procfile "/some/app/Procfile"
+        mock(Foreman::Procfile).new("/some/app/Procfile")
+        mock.instance_of(Foreman::Engine).start
+        foreman %{ start -d /some/app }
+      end
+    end
   end
 
   describe "export" do

spec/foreman/engine_spec.rb

@@ -12,12 +12,6 @@ describe "Foreman::Engine", :fakefs do
   end
 
   describe "initialize" do
-    describe "without an existing Procfile" do
-      it "raises an error" do
-        lambda { subject }.should raise_error
-      end
-    end
-
     describe "with a Procfile" do
       before { write_procfile }
 
@@ -49,6 +43,14 @@ describe "Foreman::Engine", :fakefs do
     end
   end
 
+  describe "directories" do
+    it "has the directory default relative to the Procfile" do
+      write_procfile "/some/app/Procfile"
+      engine = Foreman::Engine.new("/some/app/Procfile")
+      engine.directory.should == "/some/app"
+    end
+  end
+
   describe "environment" do
     before(:each) do
       write_procfile
@@ -97,6 +99,15 @@ describe "Foreman::Engine", :fakefs do
       engine.environment.should == {"FOO"=>"qoo"}
       engine.start
     end
+
+    it "should be loaded relative to the Procfile" do
+      FileUtils.mkdir_p "/some/app"
+      File.open("/some/app/.env", "w") { |f| f.puts("FOO=qoo") }
+      write_procfile "/some/app/Procfile"
+      engine = Foreman::Engine.new("/some/app/Procfile")
+      engine.environment.should == {"FOO"=>"qoo"}
+      engine.start
+    end
   end
 
   describe "utf8" do

spec/foreman/export/supervisord_spec.rb

@@ -15,12 +15,11 @@ describe Foreman::Export::Supervisord, :fakefs do
   it "exports to the filesystem" do
     supervisord.export
 
-    File.read("/tmp/init/app.conf").should         == example_export_file("supervisord/app.conf")
+    File.read("/tmp/init/app.conf").should == example_export_file("supervisord/app.conf")
   end
 
   it "cleans up if exporting into an existing dir" do
     mock(FileUtils).rm("/tmp/init/app.conf")
-
     supervisord.export
     supervisord.export
   end
@@ -30,8 +29,7 @@ describe Foreman::Export::Supervisord, :fakefs do
 
     it "exports to the filesystem with concurrency" do
       supervisord.export
-      
+      File.read("/tmp/init/app.conf").should == example_export_file("supervisord/app-alpha-2.conf")
-      File.read("/tmp/init/app.conf").should            == example_export_file("supervisord/app-alpha-2.conf")
     end
   end
 
@@ -46,7 +44,6 @@ describe Foreman::Export::Supervisord, :fakefs do
 
     it "can export with alternate template files" do
       supervisord.export
-      
       File.read("/tmp/init/app.conf").should == "alternate_template\n"
     end
   end
@@ -67,9 +64,22 @@ describe Foreman::Export::Supervisord, :fakefs do
 
     it "can export with alternate template files" do
       supervisord.export
-
       File.read("/tmp/init/app.conf").should == "default_alternate_template\n"
     end
   end
 
+  context "environment export" do
+    it "correctly translates environment when exporting" do
+      File.open("/tmp/supervisord_env", "w") { |f| f.puts("QUEUE=fastqueue,slowqueue\nVERBOSE=1") }
+
+      engine = Foreman::Engine.new(procfile,:env => "/tmp/supervisord_env")
+      supervisor = Foreman::Export::Supervisord.new("/tmp/init", engine, options)
+      stub(supervisor).say
+
+      supervisor.export
+
+      File.read("/tmp/init/app.conf").should == example_export_file("supervisord/app-env-with-comma.conf")
+    end
+  end
+
 end

spec/foreman/procfile_entry_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'foreman/procfile_entry'
+require 'pathname'
+require 'tmpdir'
+
+describe Foreman::ProcfileEntry do
+  subject { described_class.new('alpha', './alpha') }
+
+  it "stringifies as a Procfile line" do
+    subject.to_s.should == 'alpha: ./alpha'
+  end
+
+end

spec/foreman/procfile_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'foreman/procfile'
+require 'pathname'
+require 'tmpdir'
+
+describe Foreman::Procfile do
+  subject { described_class.new }
+
+  let(:testdir) { Pathname(Dir.tmpdir) }
+  let(:procfile) { testdir + 'Procfile' }
+
+  it "can have a process appended to it" do
+    subject << ['alpha', './alpha']
+    subject['alpha'].should be_a(Foreman::ProcfileEntry)
+  end
+
+  it "can write itself out to a file" do
+    subject << ['alpha', './alpha']
+    subject.write(procfile)
+    procfile.read.should == "alpha: ./alpha\n"
+  end
+
+  it "can re-read entries from a file" do
+    procfile.open('w') { |io| io.puts "gamma: ./radiation", "theta: ./rate" }
+    subject << ['alpha', './alpha']
+    subject.load(procfile)
+    subject.process_names.should have(2).members
+    subject.process_names.should include('gamma', 'theta')
+  end
+
+end

spec/resources/export/supervisord/app-alpha-2.conf

@@ -8,7 +8,7 @@ stdout_logfile=/var/log/app/alpha-1-out.log
 stderr_logfile=/var/log/app/alpha-1-err.log
 user=app
 directory=/tmp/app
-environment=PORT=5000
+environment=PORT="5000"
 [program:app-alpha-2]
 command=./alpha
 autostart=true
@@ -18,4 +18,7 @@ stdout_logfile=/var/log/app/alpha-2-out.log
 stderr_logfile=/var/log/app/alpha-2-err.log
 user=app
 directory=/tmp/app
-environment=PORT=5001
+environment=PORT="5001"
+
+[group:app]
+programs=app-alpha-1,app-alpha-2

spec/resources/export/supervisord/app-env-with-comma.conf

@@ -0,0 +1,24 @@
+
+[program:app-alpha]
+command=./alpha
+autostart=true
+autorestart=true
+stopsignal=QUIT
+stdout_logfile=/var/log/app/alpha-1-out.log
+stderr_logfile=/var/log/app/alpha-1-err.log
+user=app
+directory=/tmp/app
+environment=QUEUE="fastqueue,slowqueue",VERBOSE="1",PORT="5000"
+[program:app-bravo]
+command=./bravo
+autostart=true
+autorestart=true
+stopsignal=QUIT
+stdout_logfile=/var/log/app/bravo-1-out.log
+stderr_logfile=/var/log/app/bravo-1-err.log
+user=app
+directory=/tmp/app
+environment=QUEUE="fastqueue,slowqueue",VERBOSE="1",PORT="5100"
+
+[group:app]
+programs=app-alpha,app-bravo

spec/resources/export/supervisord/app-env.conf

@@ -0,0 +1,21 @@
+
+[program:app-alpha]
+command=./alpha
+autostart=true
+autorestart=true
+stopsignal=QUIT
+stdout_logfile=/var/log/app/alpha-1-out.log
+stderr_logfile=/var/log/app/alpha-1-err.log
+user=app
+directory=/tmp/app
+environment=FOO="bar",PORT="5000"
+[program:app-bravo]
+command=./bravo
+autostart=true
+autorestart=true
+stopsignal=QUIT
+stdout_logfile=/var/log/app/bravo-1-out.log
+stderr_logfile=/var/log/app/bravo-1-err.log
+user=app
+directory=/tmp/app
+environment=FOO="bar",PORT="5100"

spec/resources/export/supervisord/app.conf

@@ -8,7 +8,7 @@ stdout_logfile=/var/log/app/alpha-1-out.log
 stderr_logfile=/var/log/app/alpha-1-err.log
 user=app
 directory=/tmp/app
-environment=PORT=5000
+environment=PORT="5000"
 [program:app-bravo]
 command=./bravo
 autostart=true
@@ -18,4 +18,7 @@ stdout_logfile=/var/log/app/bravo-1-out.log
 stderr_logfile=/var/log/app/bravo-1-err.log
 user=app
 directory=/tmp/app
-environment=PORT=5100
+environment=PORT="5100"
+
+[group:app]
+programs=app-alpha,app-bravo