Regenerated gemspec for version 0.5.0

README.markdown

@@ -15,7 +15,7 @@ format.
 
 ## RUNNING
 
-`foreman start` is used to run your application directly from the command line. 
+`foreman start` is used to run your application directly from the command line.
 
 If no additional parameters are passed, foreman will run one instance of each
 type of process defined in your Procfile.
@@ -42,20 +42,39 @@ The following options control how the application is run:
   * `-a`, `--app`:
     Use this name rather than the application's root directory name as the
     name of the application when exporting.
-    
+
   * `-c`, `--concurrency`:
     Specify the number of each process type to run. The value passed in
-    should be in the format `process=num,process=num`.
+    should be in the format `process=num,process=num`
+
+  * `-l`, `--log`:
+    Specify the directory to place process logs in.
+
+  * `-p`, `--port`:
+    Specify which port to use as the base for this application. Should be
+    a multiple of 1000.
+
+  * `-u`, `--user`:
+    Specify the user the application should be run as. Defaults to the
+    app name
 
 ## OPTIONS
 
 These options control all modes of foreman's operation.
 
-  * `-p`, `--procfile`
+  * `-f`, `--procfile`
     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.
 
+## PROCFILE
+
+A Procfile should contain both a name for the process and the command used
+to run it.
+
+    web  bundle exec thin start
+    job  bundle exec rake jobs:work
+
 ## EXAMPLES
 
 Start one instance of each process type, interleave the output on stdout:
@@ -65,7 +84,7 @@ Start one instance of each process type, interleave the output on stdout:
 Export the application in upstart format:
 
     $ foreman export upstart /etc/init
-    
+
 Run one process type from the application defined in a specific Procfile:
 
     $ foreman start alpha -p ~/app/Procfile
@@ -80,6 +99,7 @@ Foreman is Copyright (C) 2010 David Dollar <http://daviddollar.org>
 [RUNNING]: #RUNNING "RUNNING"
 [EXPORTING]: #EXPORTING "EXPORTING"
 [OPTIONS]: #OPTIONS "OPTIONS"
+[PROCFILE]: #PROCFILE "PROCFILE"
 [EXAMPLES]: #EXAMPLES "EXAMPLES"
 [COPYRIGHT]: #COPYRIGHT "COPYRIGHT"
 

Rakefile

@@ -64,7 +64,7 @@ begin
     s.platform = Gem::Platform::RUBY
     s.has_rdoc = false
 
-    s.files = %w(Rakefile README.md) + Dir["{bin,lib,spec}/**/*"]
+    s.files = %w(Rakefile README.md) + Dir["{bin,export,lib,spec}/**/*"]
     s.require_path = "lib"
 
     # #s.bindir             = "bin"

export/upstart/master.conf.erb

@@ -1,13 +1,8 @@
 pre-start script
 
 bash << "EOF"
-  mkdir -p /var/log/<%= app %>
-
-  <% engine.processes.keys.sort.each do |process| %>
-    <% 1.upto(concurrency[process]).each do |num| %>
-      start <%=app%>-<%=process%>-<%=num%>
-    <% end %>
-  <% end %>
+  mkdir -p <%= log_root %>
+  chown -R <%= user %> <%= log_root %>
 EOF
 
 end script

export/upstart/process.conf.erb

@@ -1,5 +1,6 @@
-stop on stopping <%= app %>
+start on starting <%= app %>-<%= process.name %>
+stop on stopping <%= app %>-<%= process.name %>
 respawn
 
 chdir <%= engine.directory %>
-exec <%= process.command %> >> /var/log/<%=app%>/<%=process.name%>-<%=num%>.log 2>&1
+exec su <%= user %> -c "PORT=<%= port %> <%= process.command %> >> <%= log_root %>/<%=process.name%>-<%=num%>.log 2>&1"

export/upstart/process_master.conf.erb

@@ -0,0 +1,2 @@
+start on starting <%= app %>
+stop on stopping <%= app %>

foreman.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{foreman}
-  s.version = "0.4.3"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Dollar"]
-  s.date = %q{2010-06-23}
+  s.date = %q{2010-06-30}
   s.default_executable = %q{foreman}
   s.description = %q{Process manager for applications with multiple components}
   s.email = %q{ddollar@gmail.com}
@@ -20,16 +20,18 @@ Gem::Specification.new do |s|
   s.files = [
     "Rakefile",
      "bin/foreman",
+     "export/upstart/master.conf.erb",
+     "export/upstart/process.conf.erb",
+     "export/upstart/process_master.conf.erb",
      "lib/foreman.rb",
      "lib/foreman/cli.rb",
-     "lib/foreman/configuration.rb",
      "lib/foreman/engine.rb",
      "lib/foreman/export.rb",
      "lib/foreman/export/base.rb",
+     "lib/foreman/export/inittab.rb",
      "lib/foreman/export/upstart.rb",
      "lib/foreman/process.rb",
      "spec/foreman/cli_spec.rb",
-     "spec/foreman/configuration_spec.rb",
      "spec/foreman/engine_spec.rb",
      "spec/foreman/export/upstart_spec.rb",
      "spec/foreman/export_spec.rb",
@@ -45,7 +47,6 @@ Gem::Specification.new do |s|
   s.summary = %q{Process manager for applications with multiple components}
   s.test_files = [
     "spec/foreman/cli_spec.rb",
-     "spec/foreman/configuration_spec.rb",
      "spec/foreman/engine_spec.rb",
      "spec/foreman/export/upstart_spec.rb",
      "spec/foreman/export_spec.rb",

lib/foreman.rb

@@ -1,6 +1,6 @@
 module Foreman
 
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 
   class AppDoesNotExist < Exception; end
 

lib/foreman/cli.rb

@@ -1,12 +1,11 @@
 require "foreman"
-require "foreman/configuration"
 require "foreman/engine"
 require "foreman/export"
 require "thor"
 
 class Foreman::CLI < Thor
 
-  class_option :procfile, :type => :string, :aliases => "-p", :desc => "Default: ./Procfile"
+  class_option :procfile, :type => :string, :aliases => "-f", :desc => "Default: ./Procfile"
 
   desc "start [PROCESS]", "Start the application, or a specific process"
 
@@ -14,7 +13,7 @@ class Foreman::CLI < Thor
 
   def start(process=nil)
     check_procfile!
-    
+
     if process
       engine.execute(process)
     elsif options[:screen]
@@ -26,8 +25,11 @@ class Foreman::CLI < Thor
 
   desc "export FORMAT LOCATION", "Export the application to another process management format"
 
-  method_option :app,         :type => :string, :aliases => "-a"
-  method_option :concurrency, :type => :string, :aliases => "-c",
+  method_option :app,         :type => :string,  :aliases => "-a"
+  method_option :log,         :type => :string,  :aliases => "-l"
+  method_option :port,        :type => :numeric, :aliases => "-p"
+  method_option :user,        :type => :string,  :aliases => "-u"
+  method_option :concurrency, :type => :string,  :aliases => "-c",
     :banner => '"alpha=5,bar=3"'
 
   def export(format, location=nil)
@@ -35,13 +37,12 @@ class Foreman::CLI < Thor
 
     formatter = case format
       when "upstart" then Foreman::Export::Upstart
+      when "inittab" then Foreman::Export::Inittab
       else error "Unknown export format: #{format}."
     end
 
-    formatter.new(engine).export(location,
-      :name        => options[:app],
-      :concurrency => options[:concurrency]
-    )
+    formatter.new(engine).export(location, options)
+
   rescue Foreman::Export::Exception => ex
     error ex.message
   end

lib/foreman/configuration.rb

@@ -1,55 +0,0 @@
-require "foreman"
-
-class Foreman::Configuration
-
-  attr_reader :app
-  attr_reader :processes
-
-  def initialize(app)
-    @app = app
-    @processes = {}
-    read_initial_config
-  end
-
-  def scale(process, amount)
-    old_amount = processes[process].to_i
-    processes[process] = amount.to_i
-    amount = amount.to_i
-
-    if (old_amount < amount)
-      ((old_amount + 1) .. amount).each { |num| system "start #{app}-#{process} NUM=#{num}" }
-    elsif (amount < old_amount)
-      ((amount + 1) .. old_amount).each { |num| system "stop #{app}-#{process} NUM=#{num}" }
-    end
-
-    write
-  end
-
-  def write
-    write_file "/etc/foreman/#{app}.conf", <<-UPSTART_CONFIG
-#{app}_processes="#{processes.keys.sort.join(' ')}"
-#{processes.keys.sort.map { |k| "#{app}_#{k}=\"#{processes[k]}\"" }.join("\n")}
-    UPSTART_CONFIG
-  end
-
-private ######################################################################
-
-  def read_initial_config
-    config = File.read("/etc/foreman/#{app}.conf").split("\n").inject({}) do |accum, line|
-      key, value = line.match(/^(.+?)\s*=\s*"(.+?)"\s*$/).captures
-      #accum.update(parts(1) => parts(2))
-      accum.update(key => value)
-    end
-    config["#{app}_processes"].split(" ").each do |process|
-      processes[process] = config["#{app}_#{process}"].to_i
-    end
-  rescue Errno::ENOENT
-  end
-
-  def write_file(filename, contents)
-    File.open(filename, "w") do |file|
-      file.puts contents
-    end
-  end
-
-end

lib/foreman/export.rb

@@ -5,3 +5,4 @@ module Foreman::Export
 end
 
 require "foreman/export/upstart"
+require "foreman/export/inittab"

lib/foreman/export/base.rb

@@ -1,4 +1,3 @@
-require "foreman/configuration"
 require "foreman/export"
 
 class Foreman::Export::Base
@@ -37,6 +36,12 @@ private ######################################################################
     end
   end
 
+  def port_for(base_port, app, num)
+    base_port ||= 5000
+    offset = engine.processes.keys.sort.index(app) * 100
+    base_port.to_i + offset + num - 1
+  end
+
   def write_file(filename, contents)
     say "writing: #{filename}"
 

lib/foreman/export/inittab.rb

@@ -0,0 +1,38 @@
+require "foreman/export/base"
+
+class Foreman::Export::Inittab < Foreman::Export::Base
+
+  def export(fname=nil, options={})
+    app = options[:app] || File.basename(engine.directory)
+    user = options[:user] || app
+    log_root = options[:log] || "/var/log"
+
+    concurrency = parse_concurrency(options[:concurrency])
+
+    inittab = []
+    inittab << "# ----- foreman #{app} processes -----"
+
+    engine.processes.values.inject(1) do |index, process|
+      1.upto(concurrency[process.name]) do |num|
+        id = app.slice(0, 2).upcase + sprintf("%02d", index)
+        port = port_for(options[:port], process.name, num)
+        inittab << "#{id}:4:respawn:/bin/su - #{user} -c 'PORT=#{port} #{process.command} >> #{log_root}/#{process.name}-#{num}.log 2>&1'"
+        index += 1
+      end
+      index
+    end
+
+    inittab << "# ----- end foreman #{app} processes -----"
+
+    inittab = inittab.join("\n") + "\n"
+
+    if fname
+      FileUtils.mkdir_p(log_root)
+      FileUtils.chown(user, nil, log_root)
+      write_file(fname, inittab)
+    else
+      puts inittab
+    end
+  end
+
+end

lib/foreman/export/upstart.rb

@@ -1,5 +1,4 @@
 require "erb"
-require "foreman/configuration"
 require "foreman/export/base"
 
 class Foreman::Export::Upstart < Foreman::Export::Base
@@ -10,6 +9,8 @@ class Foreman::Export::Upstart < Foreman::Export::Base
     FileUtils.mkdir_p location
 
     app = options[:app] || File.basename(engine.directory)
+    user = options[:user] || app
+    log_root = options[:log] || "/var/log/#{app}"
 
     Dir["#{location}/#{app}*.conf"].each do |file|
       say "cleaning up: #{file}"
@@ -23,27 +24,18 @@ class Foreman::Export::Upstart < Foreman::Export::Base
     write_file "#{location}/#{app}.conf", master_config
 
     process_template = export_template("upstart/process.conf.erb")
-    
+
     engine.processes.values.each do |process|
+      process_master_template = export_template("upstart/process_master.conf.erb")
+      process_master_config   = ERB.new(process_master_template).result(binding)
+      write_file "#{location}/#{app}-#{process.name}.conf", process_master_config
+
       1.upto(concurrency[process.name]) do |num|
+        port = port_for(options[:port], process.name, num)
         process_config = ERB.new(process_template).result(binding)
         write_file "#{location}/#{app}-#{process.name}-#{num}.conf", process_config
       end
     end
-
-    return
-    write_file "#{location}/#{app}.conf", <<-UPSTART_MASTER
-    UPSTART_MASTER
-
-    engine.processes.each do |process|
-      write_file process_conf, <<-UPSTART_CHILD
-      UPSTART_CHILD
-    end
-
-    engine.processes.each do |name, process|
-      config.processes[name] ||= 1
-    end
-    config.write
   end
 
 end

man/foreman.1.ronn

@@ -15,7 +15,7 @@ format.
 
 ## RUNNING
 
-`foreman start` is used to run your application directly from the command line. 
+`foreman start` is used to run your application directly from the command line.
 
 If no additional parameters are passed, foreman will run one instance of each
 type of process defined in your Procfile.
@@ -42,20 +42,39 @@ The following options control how the application is run:
   * `-a`, `--app`:
     Use this name rather than the application's root directory name as the
     name of the application when exporting.
-    
+
   * `-c`, `--concurrency`:
     Specify the number of each process type to run. The value passed in
-    should be in the format `process=num,process=num`.
+    should be in the format `process=num,process=num`
+
+  * `-l`, `--log`:
+    Specify the directory to place process logs in.
+
+  * `-p`, `--port`:
+    Specify which port to use as the base for this application. Should be
+    a multiple of 1000.
+
+  * `-u`, `--user`:
+    Specify the user the application should be run as. Defaults to the
+    app name
 
 ## OPTIONS
 
 These options control all modes of foreman's operation.
 
-  * `-p`, `--procfile`
+  * `-f`, `--procfile`
     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.
 
+## PROCFILE
+
+A Procfile should contain both a name for the process and the command used
+to run it.
+
+    web  bundle exec thin start
+    job  bundle exec rake jobs:work
+
 ## EXAMPLES
 
 Start one instance of each process type, interleave the output on stdout:
@@ -65,7 +84,7 @@ Start one instance of each process type, interleave the output on stdout:
 Export the application in upstart format:
 
     $ foreman export upstart /etc/init
-    
+
 Run one process type from the application defined in a specific Procfile:
 
     $ foreman start alpha -p ~/app/Procfile

spec/foreman/configuration_spec.rb

@@ -1,49 +0,0 @@
-require "spec_helper"
-require "foreman/configuration"
-
-describe "Foreman::Configuration" do
-  subject { Foreman::Configuration.new("testapp") }
-
-  describe "initialize" do
-    describe "without an existing config" do
-      it "has no processes" do
-        subject.processes.length.should == 0
-      end
-    end
-
-    describe "with an existing config" do
-      it "has processes" do
-        write_foreman_config("testapp")
-        subject.processes["alpha"].should == 1
-        subject.processes["bravo"].should == 2
-      end
-    end
-  end
-
-  describe "scale" do
-    before(:each) { write_foreman_config("testapp") }
-
-    it "can scale up" do
-      mock(subject).system("start testapp-alpha NUM=2")
-      mock(subject).system("start testapp-alpha NUM=3")
-      subject.scale("alpha", 3)
-    end
-
-    it "can scale down" do
-      mock(subject).system("stop testapp-bravo NUM=2")
-      subject.scale("bravo", 1)
-    end
-  end
-  
-  describe "wite" do
-    it "can write a configuration file" do
-      subject.scale("charlie", 3)
-      subject.scale("delta", 4)
-      File.read("/etc/foreman/testapp.conf").should == <<-FOREMAN_CONFIG
-testapp_processes="charlie delta"
-testapp_charlie="3"
-testapp_delta="4"
-      FOREMAN_CONFIG
-    end
-  end
-end