0.26.0

Add runit export format.

Gemfile

@@ -6,7 +6,7 @@ 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'

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    foreman (0.24.0)
+    foreman (0.26.0)
       term-ansicolor (~> 1.0.5)
       thor (>= 0.13.6)
 
@@ -15,7 +15,7 @@ GEM
     builder (3.0.0)
     crack (0.1.8)
     diff-lcs (1.1.2)
-    fakefs (0.2.1)
+    fakefs (0.3.2)
     hpricot (0.8.2)
     mime-types (1.16)
     mustache (0.11.2)
@@ -51,7 +51,7 @@ PLATFORMS
 
 DEPENDENCIES
   aws-s3
-  fakefs (~> 0.2.1)
+  fakefs (~> 0.3.2)
   foreman!
   parka
   rake

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 %>

lib/foreman/cli.rb

@@ -28,6 +28,7 @@ class Foreman::CLI < Thor
 
   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 +42,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
 

lib/foreman/engine.rb

@@ -28,6 +28,7 @@ class Foreman::Engine
 
   def start
     proctitle "ruby: foreman master"
+    termtitle "#{File.basename(@directory)} - foreman (#{processes.size} processes)"
 
     processes.each do |process|
       process.color = next_color
@@ -41,6 +42,7 @@ class Foreman::Engine
   end
 
   def execute(name)
+    error "no such process: #{name}" unless procfile[name]
     fork procfile[name]
 
     trap("TERM") { puts "SIGTERM received"; terminate_gracefully }
@@ -96,7 +98,7 @@ private ######################################################################
           end
         end
       end
-    rescue PTY::ChildExited, Interrupt, Errno::EIO
+    rescue PTY::ChildExited, Interrupt, Errno::EIO, Errno::ENOENT
       begin
         info "process exiting", process
       rescue Interrupt
@@ -158,6 +160,10 @@ private ######################################################################
     $0 = title
   end
 
+  def termtitle(title)
+    printf("\033]0;#{title}\007")
+  end
+
   def running_processes
     @running_processes ||= {}
   end
@@ -184,7 +190,7 @@ private ######################################################################
     return {} unless File.exists?(filename)
 
     File.read(filename).split("\n").inject({}) do |hash, line|
-      if line =~ /\A([A-Za-z_]+)=(.*)\z/
+      if line =~ /\A([A-Za-z_0-9]+)=(.*)\z/
         hash[$1] = $2
       end
       hash

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/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.processes.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,60 @@
+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.processes.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
+        
+        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
+        
+      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

@@ -27,6 +27,7 @@ class Foreman::Export::Upstart < Foreman::Export::Base
     process_template = export_template("upstart", "process.conf.erb", template_root)
 
     engine.processes.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/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("=")

lib/foreman/version.rb

@@ -1,5 +1,5 @@
 module Foreman
 
-  VERSION = "0.24.0"
+  VERSION = "0.26.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" "September 2011" "Foreman 0.23.0" "Foreman Manual"
+.TH "FOREMAN" "1" "November 2011" "Foreman 0.25.0" "Foreman Manual"
 .
 .SH "NAME"
 \fBforeman\fR \- manage Procfile\-based applications
@@ -132,7 +132,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

@@ -113,7 +113,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

spec/foreman/engine_spec.rb

@@ -48,6 +48,12 @@ describe "Foreman::Engine" do
       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

spec/foreman/export/bluepill_spec.rb

@@ -12,7 +12,7 @@ describe Foreman::Export::Bluepill do
   before(:each) { stub(bluepill).say }
 
   it "exports to the filesystem" do
-    bluepill.export("/tmp/init")
+    bluepill.export("/tmp/init", :concurrency => "alpha=2")
     
     File.read("/tmp/init/app.pill").should == example_export_file("bluepill/app.pill")
   end

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

spec/foreman/export/upstart_spec.rb

@@ -12,7 +12,7 @@ describe Foreman::Export::Upstart do
   before(:each) { stub(upstart).say }
 
   it "exports to the filesystem" do
-    upstart.export("/tmp/init")
+    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")

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|