Regenerated gemspec for version 0.7.0

README.markdown

@@ -1,103 +1,4 @@
-foreman(1) -- manage Procfile-based applications
-================================================
+Foreman
+=======
 
-## SYNOPSIS
-
-`foreman start [process]`<br>
-`foreman export <var>format</var> [location]`
-
-## DESCRIPTION
-
-**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.
-
-## RUNNING
-
-`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.
-
-If a parameter is passed, foreman will run one instance of the specified
-application type.
-
-The following options control how the application is run:
-
-  * `-s`, `--screen`:
-    Run the application as a series of screen windows rather than interleaved
-    in stdout.
-
-## EXPORTING
-
-`foreman export` is used to export your application to another process
-management format.
-
-An location to export can be passed as an argument. This argument may be
-either required or optional depending on the export format.
-
-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.
-
-  * `-l`, `--log`:
-    Specify the directory to place process logs in.
-
-  * `-c`, `--concurrency`:
-    Specify the number of each process type to run. The value passed in
-    should be in the format `process=num,process=num`
-
-  * `-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`
-    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:
-
-    $ foreman start
-
-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
-
-## COPYRIGHT
-
-Foreman is Copyright (C) 2010 David Dollar <http://daviddollar.org>
-
-
-[SYNOPSIS]: #SYNOPSIS "SYNOPSIS"
-[DESCRIPTION]: #DESCRIPTION "DESCRIPTION"
-[RUNNING]: #RUNNING "RUNNING"
-[EXPORTING]: #EXPORTING "EXPORTING"
-[OPTIONS]: #OPTIONS "OPTIONS"
-[PROCFILE]: #PROCFILE "PROCFILE"
-[EXAMPLES]: #EXAMPLES "EXAMPLES"
-[COPYRIGHT]: #COPYRIGHT "COPYRIGHT"
-
-
-[foreman(1)]: foreman.1.html
+See the [man page](http://ddollar.github.com/foreman) for usage.

Rakefile

@@ -29,7 +29,6 @@ task :man do
   ENV['RONN_MANUAL']  = "Foreman Manual"
   ENV['RONN_ORGANIZATION'] = "Foreman #{Foreman::VERSION}"
   sh "ronn -w -s toc -r5 --markdown man/*.ronn"
-  sh "cp man/foreman.1.markdown README.markdown"
   sh "git add README.markdown"
   sh "git commit -m 'update readme' || echo 'nothing to commit'"
 end

export/upstart/master.conf.erb

@@ -1,8 +1,8 @@
 pre-start script
 
 bash << "EOF"
-  mkdir -p <%= log_root %>/<%= app %>
-  chown -R <%= user %> <%= log_root %>/<%= app %>
+  mkdir -p <%= log_root %>
+  chown -R <%= user %> <%= log_root %>
 EOF
 
 end script

export/upstart/process.conf.erb

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

foreman.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{foreman}
-  s.version = "0.4.6"
+  s.version = "0.7.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-29}
+  s.date = %q{2010-07-19}
   s.default_executable = %q{foreman}
   s.description = %q{Process manager for applications with multiple components}
   s.email = %q{ddollar@gmail.com}
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
      "lib/foreman/export/inittab.rb",
      "lib/foreman/export/upstart.rb",
      "lib/foreman/process.rb",
+     "lib/foreman/utils.rb",
      "spec/foreman/cli_spec.rb",
      "spec/foreman/engine_spec.rb",
      "spec/foreman/export/upstart_spec.rb",
@@ -39,7 +40,6 @@ Gem::Specification.new do |s|
      "spec/foreman_spec.rb",
      "spec/spec_helper.rb"
   ]
-  s.has_rdoc = false
   s.homepage = %q{http://github.com/ddollar/foreman}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]

lib/foreman.rb

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

lib/foreman/cli.rb

@@ -5,31 +5,32 @@ 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"
 
-  method_option :screen,   :type => :boolean, :aliases => "-s"
+  method_option :concurrency, :type => :string,  :aliases => "-c",
+    :banner => '"alpha=5,bar=3"'
 
   def start(process=nil)
     check_procfile!
-    
+
     if process
-      engine.execute(process)
-    elsif options[:screen]
-      engine.screen
+      engine.execute(process, options)
     else
-      engine.start
+      engine.start(options)
     end
   end
 
   desc "export FORMAT LOCATION", "Export the application to another process management format"
 
-  method_option :app,         :type => :string, :aliases => "-a"
-  method_option :log,         :type => :string, :aliases => "-l"
-  method_option :user,        :type => :string, :aliases => "-u"
-  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)
     check_procfile!
 
@@ -39,12 +40,8 @@ class Foreman::CLI < Thor
       else error "Unknown export format: #{format}."
     end
 
-    formatter.new(engine).export(location,
-      :name        => options[:app],
-      :user        => options[:user],
-      :log         => options[:log],
-      :concurrency => options[:concurrency]
-    )
+    formatter.new(engine).export(location, options)
+
   rescue Foreman::Export::Exception => ex
     error ex.message
   end

lib/foreman/engine.rb

@@ -1,8 +1,10 @@
 require "foreman"
 require "foreman/process"
+require "foreman/utils"
 require "pty"
 require "tempfile"
 require "term/ansicolor"
+require "fileutils"
 
 class Foreman::Engine
 
@@ -11,28 +13,42 @@ class Foreman::Engine
 
   extend Term::ANSIColor
 
-  COLORS = [ cyan, yellow, green, magenta, on_blue ]
+  COLORS = [ cyan, yellow, green, magenta, red ]
 
   def initialize(procfile)
     @procfile  = read_procfile(procfile)
     @directory = File.expand_path(File.dirname(procfile))
   end
 
-  def processes
+  def processes(concurrency=nil)
     @processes ||= begin
+      concurrency = Foreman::Utils.parse_concurrency(concurrency)
+
       procfile.split("\n").inject({}) do |hash, line|
         next if line.strip == ""
-        process = Foreman::Process.new(*line.split(" ", 2))
-        process.color = next_color
-        hash.update(process.name => process)
+        name, command = line.split(" ", 2)
+
+        if concurrency[name] > 1 then
+          1.upto(concurrency[name]) do |num|
+            process = Foreman::Process.new("#{name}.#{num}", command)
+            process.color = next_color
+            hash[process.name] = process
+          end
+        else
+          process = Foreman::Process.new(name, command)
+          process.color = next_color
+          hash[process.name] = process
+        end
+
+        hash
       end
     end
   end
 
-  def start
+  def start(options={})
     proctitle "ruby: foreman master"
 
-    processes.each do |name, process|
+    processes(options[:concurrency]).each do |name, process|
       fork process
     end
 
@@ -42,21 +58,17 @@ class Foreman::Engine
     watch_for_termination
   end
 
-  def screen
-    tempfile = Tempfile.new("foreman")
-    tempfile.puts "sessionname foreman"
-    processes.each do |name, process|
-      tempfile.puts "screen -t #{name} #{process.command}"
+  def execute(name, options={})
+    processes(options[:concurrency]).values.select do |process|
+      process.name =~ /\A#{name}\.?\d*\Z/
+    end.each do |process|
+      fork process
     end
-    tempfile.close
 
-    system "screen -c #{tempfile.path}"
+    trap("TERM") { kill_and_exit("TERM") }
+    trap("INT")  { kill_and_exit("INT")  }
 
-    tempfile.delete
-  end
-
-  def execute(name)
-    run(processes[name], false)
+    watch_for_termination
   end
 
 private ######################################################################

lib/foreman/export/base.rb

@@ -1,4 +1,5 @@
 require "foreman/export"
+require "foreman/utils"
 
 class Foreman::Export::Base
 
@@ -26,14 +27,10 @@ private ######################################################################
     File.read(File.expand_path("../../../../export/#{name}", __FILE__))
   end
 
-  def parse_concurrency(concurrency)
-    @concurrency ||= begin
-      pairs = concurrency.to_s.gsub(/\s/, "").split(",")
-      pairs.inject(Hash.new(1)) do |hash, pair|
-        process, amount = pair.split("=")
-        hash.update(process => amount.to_i)        
-      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)

lib/foreman/export/inittab.rb

@@ -5,25 +5,30 @@ 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"
-
-    log_dir = "#{log_root}/#{app}"
+    log_root = options[:log] || "/var/log/#{app}"
 
     concurrency = parse_concurrency(options[:concurrency])
 
     inittab = []
     inittab << "# ----- foreman #{app} processes -----"
-    engine.processes.values.each_with_index do |process, num|
-      id = app.slice(0, 2).upcase + sprintf("%02d", num+1)
-      inittab << "#{id}:4:respawn:/bin/su - #{user} -c '#{process.command} >> #{log_dir}/#{process.name}-#{num+1}.log 2>&1'"
+
+    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_dir)
-      FileUtils.chown(user, nil, log_dir)
+      FileUtils.mkdir_p(log_root)
+      FileUtils.chown(user, nil, log_root)
       write_file(fname, inittab)
     else
       puts inittab

lib/foreman/export/upstart.rb

@@ -10,7 +10,7 @@ class Foreman::Export::Upstart < Foreman::Export::Base
 
     app = options[:app] || File.basename(engine.directory)
     user = options[:user] || app
-    log_root = options[:log] || "/var/log"
+    log_root = options[:log] || "/var/log/#{app}"
 
     Dir["#{location}/#{app}*.conf"].each do |file|
       say "cleaning up: #{file}"
@@ -31,6 +31,7 @@ class Foreman::Export::Upstart < Foreman::Export::Base
       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

lib/foreman/utils.rb

@@ -0,0 +1,15 @@
+require "foreman"
+
+class Foreman::Utils
+
+  def self.parse_concurrency(concurrency)
+    @concurrency ||= begin
+      pairs = concurrency.to_s.gsub(/\s/, "").split(",")
+      pairs.inject(Hash.new(1)) do |hash, pair|
+        process, amount = pair.split("=")
+        hash.update(process => amount.to_i)        
+      end
+    end
+  end
+
+end

man/foreman.1.ronn

@@ -25,9 +25,9 @@ application type.
 
 The following options control how the application is run:
 
-  * `-s`, `--screen`:
-    Run the application as a series of screen windows rather than interleaved
-    in stdout.
+  * `-c`, `--concurrency`:
+    Specify the number of each process type to run. The value passed in
+    should be in the format `process=num,process=num`
 
 ## EXPORTING
 
@@ -43,13 +43,17 @@ The following options control how the application is run:
     Use this name rather than the application's root directory name as the
     name of the application when exporting.
 
-  * `-l`, `--log`:
-    Specify the directory to place process logs in.
-
   * `-c`, `--concurrency`:
     Specify the number of each process type to run. The value passed in
     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
@@ -58,11 +62,39 @@ The following options control how the application is run:
 
 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.
 
+## EXPORT FORMATS
+
+foreman currently supports the following output formats:
+
+  * inittab
+
+  * upstart
+
+## INITTAB EXPORT
+
+Will export a chunk of inittab-compatible configuration:
+
+    # ----- foreman example processes -----
+    EX01:4:respawn:/bin/su - example -c 'PORT=5000 bundle exec thin start >> /var/log/web-1.log 2>&1'
+    EX02:4:respawn:/bin/su - example -c 'PORT=5100 bundle exec rake jobs:work >> /var/log/job-1.log 2>&1'
+    # ----- end foreman example processes -----
+
+## UPSTART EXPORT
+
+Will create a series of upstart scripts in the location you specify. Scripts
+will be structured to make the following commands valid:
+
+  `start appname`
+
+  `stop appname-processname`
+
+  `restart appname-processname-3`
+
 ## PROCFILE
 
 A Procfile should contain both a name for the process and the command used

spec/foreman/cli_spec.rb

@@ -19,7 +19,7 @@ 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
@@ -51,10 +51,7 @@ describe "Foreman::CLI" do
 
         it "runs successfully" do
           dont_allow(subject).error
-          mock.instance_of(Foreman::Export::Upstart).export("/tmp/foo", {
-            :concurrency => nil,
-            :name => nil
-          })
+          mock.instance_of(Foreman::Export::Upstart).export("/tmp/foo", {})
           subject.export("upstart", "/tmp/foo")
         end
       end

spec/foreman/engine_spec.rb

@@ -10,7 +10,7 @@ describe "Foreman::Engine" do
         lambda { subject }.should raise_error
       end
     end
-    
+
     describe "with a Procfile" do
       it "reads the processes" do
         write_procfile
@@ -19,7 +19,7 @@ describe "Foreman::Engine" do
       end
     end
   end
-  
+
   describe "start" do
     it "forks the processes" do
       write_procfile
@@ -33,7 +33,8 @@ describe "Foreman::Engine" do
   describe "execute" do
     it "runs the processes" do
       write_procfile
-      mock(subject).run(subject.processes["alpha"], false)
+      mock(subject).fork(subject.processes["alpha"])
+      mock(subject).watch_for_termination
       subject.execute("alpha")
     end
   end