foreman 0.15.0 → 0.27.0

data/lib/foreman/procfile.rb

@@ -0,0 +1,37 @@
+require "foreman"
+
+# 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 :processes
+
+  def initialize(filename)
+    @processes = parse_procfile(filename)
+  end
+
+  def process_names
+    processes.map(&:name)
+  end
+
+  def [](name)
+    processes.detect { |process| process.name == name }
+  end
+
+private
+
+  def parse_procfile(filename)
+    File.read(filename).split("\n").map do |line|
+      if line =~ /^([A-Za-z0-9_]+):\s*(.+)$/
+        Foreman::Process.new($1, $2)
+      end
+    end.compact
+  end
+
+end

data/lib/foreman/utils.rb

@@ -3,7 +3,7 @@ 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|
         process, amount = pair.split("=")

data/lib/foreman/version.rb

@@ -1,5 +1,5 @@
 module Foreman
 
-  VERSION = "0.15.0"
+  VERSION = "0.27.0"
 
 end

data/lib/foreman.rb

@@ -4,5 +4,10 @@ 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
 end
 

data/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" "May 2011" "Foreman 0.13.0" "Foreman Manual"
+.TH "FOREMAN" "1" "November 2011" "Foreman 0.26.0" "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\-e\fR, \fB\-\-env\fR
+Specify an alternate environment file\. You can specify more than one file by using: \fB\-\-env file1,file2\fR\.
+.
+.TP
 \fB\-f\fR, \fB\-\-procfile\fR
 Specify an alternate location for the application\'s Procfile\. This file\'s containing directory will be assumed to be the root directory of the application\.
 .
@@ -75,9 +79,15 @@ Specify an alternate location for the application\'s Procfile\. This file\'s con
 foreman currently supports the following output formats:
 .
 .IP "\(bu" 4
+bluepill
+.
+.IP "\(bu" 4
 inittab
 .
 .IP "\(bu" 4
+runit
+.
+.IP "\(bu" 4
 upstart
 .
 .IP "" 0
@@ -125,7 +135,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
 .
@@ -137,6 +147,20 @@ $ foreman check
 .
 .IP "" 0
 .
+.SH "ENVIRONMENT"
+If a \fB\.env\fR file exists in the current directory, the default environment will be read from it\. This file should contain key/value pairs, separated by \fB=\fR, with one key/value pair per line\.
+.
+.IP "" 4
+.
+.nf
+
+FOO=bar
+BAZ=qux
+.
+.fi
+.
+.IP "" 0
+.
 .SH "DEFAULT OPTIONS"
 If a \fB\.foreman\fR file exists in the current directory, default options will be read from it\. This file should be in YAML format with the long option name as keys\. Example:
 .
@@ -144,7 +168,7 @@ If a \fB\.foreman\fR file exists in the current directory, default options will
 .
 .nf
 
-concurrency: alpha=0
+concurrency: alpha=0,bravo=1
 port: 15000
 .
 .fi

data/spec/foreman/cli_spec.rb

@@ -19,13 +19,22 @@ describe "Foreman::CLI" do
 
       it "runs successfully" do
         dont_allow(subject).error
-        mock.instance_of(Foreman::Engine).start({})
+        mock.instance_of(Foreman::Engine).start
         subject.start
       end
     end
   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

data/spec/foreman/engine_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 require "foreman/engine"
 
 describe "Foreman::Engine" do
-  subject { Foreman::Engine.new("Procfile") }
+  subject { Foreman::Engine.new("Procfile", {}) }
 
   describe "initialize" do
     describe "without an existing Procfile" do
@@ -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,28 +24,76 @@ 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(subject).fork(subject.procfile["alpha"])
+      mock(subject).fork(subject.procfile["bravo"])
       mock(subject).watch_for_termination
       subject.start
     end
 
     it "handles concurrency" do
       write_procfile
-      mock(subject).fork_individual(subject.processes["alpha"], 1, 5000)
-      mock(subject).fork_individual(subject.processes["alpha"], 2, 5001)
-      mock(subject).fork_individual(subject.processes["bravo"], 1, 5100)
-      mock(subject).watch_for_termination
-      subject.start(:concurrency => "alpha=2")
+      engine = Foreman::Engine.new("Procfile",:concurrency => "alpha=2")
+      mock(engine).fork_individual(engine.procfile["alpha"], 1, 5000)
+      mock(engine).fork_individual(engine.procfile["alpha"], 2, 5001)
+      mock(engine).fork_individual(engine.procfile["bravo"], 1, 5100)
+      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).fork(subject.procfile["alpha"])
       mock(subject).watch_for_termination
       subject.execute("alpha")
     end
+
+    it "shows an error running a process that doesnt exist" do
+      write_procfile
+      mock(subject).puts("ERROR: no such process: foo")
+      lambda { subject.execute("foo") }.should raise_error(SystemExit)
+    end
+  end
+
+  describe "environment" do
+    before(:each) do
+      write_procfile
+      stub(Process).fork
+    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).watch_for_termination
+      engine.environment.should == {"FOO"=>"baz"}
+      engine.execute("alpha")
+    end
+
+    it "should read more than one if specified" 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).watch_for_termination
+      engine.environment.should == { "FOO"=>"bar", "BAZ"=>"qux" }
+      engine.execute("alpha")
+    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")
+    end
+
+    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).watch_for_termination
+      mock(engine).fork_individual(anything, anything, anything)
+      engine.environment.should == {"FOO"=>"qoo"}
+      engine.execute("bravo")
+    end
   end
 end

data/spec/foreman/export/bluepill_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+require "foreman/engine"
+require "foreman/export/bluepill"
+require "tmpdir"
+
+describe Foreman::Export::Bluepill do
+  let(:procfile) { FileUtils.mkdir_p("/tmp/app"); write_procfile("/tmp/app/Procfile") }
+  let(:engine) { Foreman::Engine.new(procfile) }
+  let(:bluepill) { Foreman::Export::Bluepill.new(engine) }
+
+  before(:each) { load_export_templates_into_fakefs("bluepill") }
+  before(:each) { stub(bluepill).say }
+
+  it "exports to the filesystem" do
+    bluepill.export("/tmp/init", :concurrency => "alpha=2")
+    
+    File.read("/tmp/init/app.pill").should == example_export_file("bluepill/app.pill")
+  end
+
+end

data/spec/foreman/export/runit_spec.rb

@@ -0,0 +1,35 @@
+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 }
+  
+  it "exports to the filesystem" do
+    FileUtils.mkdir_p('/tmp/init')
+    runit.export('/tmp/init', :concurrency => 'alpha=2')
+    
+    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

data/spec/foreman/export/upstart_spec.rb

@@ -1,21 +1,55 @@
 require "spec_helper"
+require "foreman/engine"
 require "foreman/export/upstart"
+require "tmpdir"
 
 describe Foreman::Export::Upstart do
-  let(:engine) { Foreman::Engine.new(write_procfile) }
+  let(:procfile) { FileUtils.mkdir_p("/tmp/app"); write_procfile("/tmp/app/Procfile") }
+  let(:engine) { Foreman::Engine.new(procfile) }
   let(:upstart) { Foreman::Export::Upstart.new(engine) }
 
   before(:each) { load_export_templates_into_fakefs("upstart") }
   before(:each) { stub(upstart).say }
 
   it "exports to the filesystem" do
-    upstart.export("/tmp/init")
-
-    File.read("/tmp/init/foreman.conf").should         == example_export_file("upstart/foreman.conf")
-    File.read("/tmp/init/foreman-alpha.conf").should   == example_export_file("upstart/foreman-alpha.conf")
-    File.read("/tmp/init/foreman-alpha-1.conf").should == example_export_file("upstart/foreman-alpha-1.conf")
-    File.read("/tmp/init/foreman-alpha-2.conf").should == example_export_file("upstart/foreman-alpha-2.conf")
-    File.read("/tmp/init/foreman-bravo.conf").should   == example_export_file("upstart/foreman.bravo.conf")
-    File.read("/tmp/init/foreman-bravo-1.conf").should == example_export_file("upstart/foreman-bravo-1.conf")
+    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.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
+
+  context "with alternate templates" do
+    let(:template_root) { "/tmp/alternate" }
+
+    before do
+      FileUtils.mkdir_p template_root
+      File.open("#{template_root}/master.conf.erb", "w") { |f| f.puts "alternate_template" }
+    end
+
+    it "can export with alternate template files" do
+      upstart.export("/tmp/init", :template => template_root)
+
+      File.read("/tmp/init/app.conf").should == "alternate_template\n"
+    end
   end
+
+  context "with alternate templates from home dir" do
+    let(:default_template_root) {File.expand_path("~/.foreman/templates")}
+
+    before do
+      FileUtils.mkdir_p default_template_root
+      File.open("#{default_template_root}/master.conf.erb", "w") { |f| f.puts "default_alternate_template" }
+    end
+
+    it "can export with alternate template files" do
+      upstart.export("/tmp/init")
+
+      File.read("/tmp/init/app.conf").should == "default_alternate_template\n"
+    end
+  end
+
 end

data/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

data/spec/resources/export/bluepill/app.pill

@@ -0,0 +1,65 @@
+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
+
+
+
+
+  app.process("bravo-1") do |process|
+    process.start_command = "./bravo"
+
+    process.working_dir = "/tmp/app"
+    process.daemonize = true
+    process.environment = {"PORT" => "5100"}
+    process.stop_signals = [:quit, 30.seconds, :term, 5.seconds, :kill]
+
+    process.stdout = process.stderr = "/var/log/app/app-bravo-1.log"
+
+    process.monitor_children do |children|
+      children.stop_command "kill -QUIT {{PID}}"
+    end
+    
+    process.group = "app-bravo"
+  end
+
+
+end

data/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"

data/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

data/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"

data/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

data/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"

data/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

data/spec/resources/export/upstart/app-alpha-1.conf

@@ -0,0 +1,5 @@
+start on starting app-alpha
+stop on stopping app-alpha
+respawn
+
+exec su - app -c 'cd /tmp/app; export PORT=5000; ./alpha >> /var/log/app/alpha-1.log 2>&1'

data/spec/resources/export/upstart/app-alpha-2.conf

@@ -0,0 +1,5 @@
+start on starting app-alpha
+stop on stopping app-alpha
+respawn
+
+exec su - app -c 'cd /tmp/app; export PORT=5001; ./alpha >> /var/log/app/alpha-2.log 2>&1'

data/spec/resources/export/upstart/app-alpha.conf

@@ -0,0 +1,2 @@
+start on starting app
+stop on stopping app

data/spec/resources/export/upstart/app-bravo-1.conf

@@ -0,0 +1,5 @@
+start on starting app-bravo
+stop on stopping app-bravo
+respawn
+
+exec su - app -c 'cd /tmp/app; export PORT=5100; ./bravo >> /var/log/app/bravo-1.log 2>&1'

data/spec/resources/export/upstart/app-bravo.conf

@@ -0,0 +1,2 @@
+start on starting app
+stop on stopping app

data/spec/resources/export/upstart/app.conf

@@ -0,0 +1,8 @@
+pre-start script
+
+bash << "EOF"
+  mkdir -p /var/log/app
+  chown -R app /var/log/app
+EOF
+
+end script

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ require "rspec"
 require "fakefs/safe"
 require "fakefs/spec_helpers"
 
-$:.unshift "lib"
+$:.unshift File.expand_path("../../lib", __FILE__)
 
 def mock_error(subject, message)
   mock_exit do
@@ -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,14 +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 "bravo: ./bravo"
+    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|
@@ -52,7 +63,7 @@ def example_export_file(filename)
   data
 end
 
-Rspec.configure do |config|
+RSpec.configure do |config|
   config.color_enabled = true
   config.include FakeFS::SpecHelpers
   config.mock_with :rr