Regenerated gemspec for version 0.4.7

README.markdown

@@ -0,0 +1,103 @@
+foreman(1) -- manage Procfile-based applications
+================================================
+
+## 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

README.rdoc

@@ -1,85 +0,0 @@
-= Foreman
-
-== Procfile
-
-    alpha ./bin/alpha
-    bravo ./bin/bravo some args
-    charlie ./bin/charlie -n 5
-
-== Development mode
-
-=== Running
-
-Log files will be output to standard out, colorized to aid in visual separation.
-
-    $ foreman start
-    [01:27:08] [alpha] started with pid 4393
-    [01:27:08] [bravo] started with pid 4394
-    [01:27:08] [charlie] started with pid 4395
-    [01:27:08] [bravo] initializing...
-    [01:27:08] [bravo] complete
-
-=== Using Screen
-
-Launch the processes in a screen session in indivudal windows
-
-    $ foreman screen
-
-== Single Process Execution
-
-    $ foreman execute alpha
-
-== Exporting to Upstart
-
-=== Export to upstart scripts
-
-    $ foreman export sampleapp
-
-    $ initctl list | grep sampleapp
-    sampleapp start/running
-    sampleapp-alpha (1) start/running, process 4204
-    sampleapp-bravo (1) start/running, process 4589
-    sampleapp-charlie (1) start/running, process 4597
-
-=== Change process concurrency levels
-
-    $ foreman scale sampleapp alpha 4
-    sampleapp-alpha (2) start/running, process 4164
-    sampleapp-alpha (3) start/running, process 4166
-    sampleapp-alpha (4) start/running, process 4168
-
-    $ initctl list | grep sampleapp
-    sampleapp start/running
-    sampleapp-alpha (4) start/running, process 4168
-    sampleapp-alpha (3) start/running, process 4166
-    sampleapp-alpha (2) start/running, process 4164
-    sampleapp-alpha (1) start/running, process 4204
-    sampleapp-bravo (1) start/running, process 4589
-    sampleapp-charlie (1) start/running, process 4597
-
-    $ foreman scale sampleapp alpha 1
-    sampleapp-alpha stop/waiting
-    sampleapp-alpha stop/waiting
-    sampleapp-alpha stop/waiting
-
-=== Good Upstart citizen
-
-All Upstart commands work as expected
-
-    $ start sampleapp
-    $ stop sampleapp
-    $ restart sampleapp
-
-=== Standardized Logging
-
-    /var/log/sampleapp/alpha.log
-    /var/log/sampleapp/bravo.log
-    /var/log/sampleapp/charlie.log
-
-== License
-
-MIT
-
-== Copyright
-
-(c) 2010 David Dollar

Rakefile

@@ -29,6 +29,9 @@ 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
 
 task :pages => :man do
@@ -61,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 %>
+  mkdir -p <%= log_root %>
-
+  chown -R <%= user %> <%= log_root %>
-  <% engine.processes.keys.sort.each do |process| %>
-    <% 1.upto(concurrency[process]).each do |num| %>
-      start <%=app%>-<%=process%>-<%=num%>
-    <% end %>
-  <% end %>
 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 "<%= 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,31 +5,33 @@
 
 Gem::Specification.new do |s|
   s.name = %q{foreman}
-  s.version = "0.4.2"
+  s.version = "0.4.7"
 
   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-29}
   s.default_executable = %q{foreman}
   s.description = %q{Process manager for applications with multiple components}
   s.email = %q{ddollar@gmail.com}
   s.executables = ["foreman"]
   s.extra_rdoc_files = [
-    "README.rdoc"
+    "README.markdown"
   ]
   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.2"
+  VERSION = "0.4.7"
 
   class AppDoesNotExist < Exception; end
 

lib/foreman/cli.rb

@@ -1,5 +1,4 @@
 require "foreman"
-require "foreman/configuration"
 require "foreman/engine"
 require "foreman/export"
 require "thor"
@@ -27,19 +26,23 @@ 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 :log,         :type => :string, :aliases => "-l"
+  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!
 
     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],
+      :user        => options[:user],
+      :log         => options[:log],
       :concurrency => options[:concurrency]
     )
   rescue Foreman::Export::Exception => ex

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

lib/foreman/export/inittab.rb

@@ -0,0 +1,31 @@
+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.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_root}/#{process.name}-#{num+1}.log 2>&1'"
+    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}"
@@ -25,25 +26,15 @@ class Foreman::Export::Upstart < Foreman::Export::Base
     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|
         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

@@ -3,8 +3,8 @@ foreman(1) -- manage Procfile-based applications
 
 ## SYNOPSIS
 
-`foreman` start [process]<br>
+`foreman start [process]`<br>
-`foreman` export <format> [location]
+`foreman export <format> [location]`
 
 ## DESCRIPTION
 
@@ -43,9 +43,16 @@ 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`.
+    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
 
@@ -56,6 +63,14 @@ These options control all modes of foreman's operation.
     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:

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