foreman 0.31.0 → 0.50.0

data/lib/foreman/export/inittab.rb

@@ -2,36 +2,31 @@ require "foreman/export"
 
 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/#{app}"
-
-    concurrency = Foreman::Utils.parse_concurrency(options[:concurrency])
+  def export
+    error("Must specify a location") unless location
 
     inittab = []
     inittab << "# ----- foreman #{app} processes -----"
 
-    engine.procfile.entries.inject(1) do |index, process|
-      1.upto(concurrency[process.name]) do |num|
+    index = 1
+    engine.each_process do |name, process|
+      1.upto(engine.formation[name]) do |num|
         id = app.slice(0, 2).upcase + sprintf("%02d", index)
-        port = engine.port_for(process, num, options[:port])
-        inittab << "#{id}:4:respawn:/bin/su - #{user} -c 'PORT=#{port} #{process.command} >> #{log_root}/#{process.name}-#{num}.log 2>&1'"
+        port = engine.port_for(process, num)
+        inittab << "#{id}:4:respawn:/bin/su - #{user} -c 'PORT=#{port} #{process.command} >> #{log}/#{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) rescue error "could not create #{log_root}"
-      FileUtils.chown(user, nil, log_root) rescue error "could not chown #{log_root} to #{user}"
-      write_file(fname, inittab)
-    else
+    if location == "-"
       puts inittab
+    else
+      say "writing: #{location}"
+      File.open(location, "w") { |file| file.puts inittab }
     end
   end
 

data/lib/foreman/export/launchd.rb

@@ -0,0 +1,15 @@
+require "erb"
+require "foreman/export"
+
+class Foreman::Export::Launchd < Foreman::Export::Base
+
+  def export
+    super
+    engine.each_process do |name, process|
+      1.upto(engine.formation[name]) do |num|
+        write_template "launchd/launchd.plist.erb", "#{app}-#{name}-#{num}.plist", binding
+      end
+    end
+  end
+
+end

data/lib/foreman/export/runit.rb

@@ -2,59 +2,33 @@ 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])
+  ENV_VARIABLE_REGEX = /([a-zA-Z_]+[a-zA-Z0-9_]*)=(\S+)/
 
-    run_template = export_template('runit', 'run.erb', template_root)
-    log_run_template = export_template('runit', 'log_run.erb', template_root)
+  def export
+    super
 
-    engine.procfile.entries.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"
+    engine.each_process do |name, process|
+      1.upto(engine.formation[name]) do |num|
+        process_directory = "#{app}-#{name}-#{num}"
 
         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
+        create_directory "#{process_directory}/env"
+        create_directory "#{process_directory}/log"
 
-        port = engine.port_for(process, num, options[:port])
-        environment_variables = {'PORT' => port}.
-            merge(engine.environment).
-            merge(inline_variables(process.command))
+        write_template "runit/run.erb", "#{process_directory}/run", binding
+        chmod 0755, "#{process_directory}/run"
 
-        environment_variables.each_pair do |var, env|
-          write_file "#{process_env_directory}/#{var.upcase}", env
+        port = engine.port_for(process, num)
+        engine.env.merge("PORT" => port.to_s).each do |key, value|
+          write_file "#{process_directory}/env/#{key}", value
         end
 
-        log_run = ERB.new(log_run_template).result(binding)
-        write_file "#{process_log_directory}/run", log_run
-
+        write_template "runit/log/run.erb", "#{process_directory}/log/run", binding
+        chmod 0755, "#{process_directory}/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

data/lib/foreman/export/supervisord.rb

@@ -0,0 +1,16 @@
+require "erb"
+require "foreman/export"
+
+class Foreman::Export::Supervisord < Foreman::Export::Base
+
+  def export
+    super
+
+    Dir["#{location}/#{app}*.conf"].each do |file|
+      clean file
+    end
+
+    write_template "supervisord/app.conf.erb", "#{app}.conf", binding
+  end
+
+end

data/lib/foreman/export/upstart.rb

@@ -3,41 +3,23 @@ require "foreman/export"
 
 class Foreman::Export::Upstart < Foreman::Export::Base
 
-  def export(location, options={})
-    error("Must specify a location") unless location
-
-    FileUtils.mkdir_p location
-
-    app = options[:app] || File.basename(engine.directory)
-    user = options[:user] || app
-    log_root = options[:log] || "/var/log/#{app}"
-    template_root = options[:template]
+  def export
+    super
 
     Dir["#{location}/#{app}*.conf"].each do |file|
-      say "cleaning up: #{file}"
-      FileUtils.rm(file)
+      clean file
     end
 
-    concurrency = Foreman::Utils.parse_concurrency(options[:concurrency])
-
-    master_template = export_template("upstart", "master.conf.erb", template_root)
-    master_config   = ERB.new(master_template).result(binding)
-    write_file "#{location}/#{app}.conf", master_config
+    write_template "upstart/master.conf.erb", "#{app}.conf", binding
 
-    process_template = export_template("upstart", "process.conf.erb", template_root)
+    engine.each_process do |name, process|
+      next if engine.formation[name] < 1
+      write_template "upstart/process_master.conf.erb", "#{app}-#{name}.conf", binding
 
-    engine.procfile.entries.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
-
-      1.upto(concurrency[process.name]) do |num|
-        port = engine.port_for(process, num, options[:port])
-        process_config = ERB.new(process_template).result(binding)
-        write_file "#{location}/#{app}-#{process.name}-#{num}.conf", process_config
+      1.upto(engine.formation[name]) do |num|
+        port = engine.port_for(process, num)
+        write_template "upstart/process.conf.erb", "#{app}-#{name}-#{num}.conf", binding
       end
     end
   end
-
 end

data/lib/foreman/export.rb

@@ -1,7 +1,28 @@
 require "foreman"
+require "foreman/helpers"
+require "pathname"
 
 module Foreman::Export
+  extend Foreman::Helpers
+
   class Exception < ::Exception; end
+
+  def self.formatter(format)
+    begin
+      require "foreman/export/#{ format.tr('-', '_') }"
+      classy_format = classify(format)
+      formatter     = constantize("Foreman::Export::#{ classy_format }")
+    rescue NameError => ex
+      error "Unknown export format: #{format} (no class Foreman::Export::#{ classy_format })."
+    rescue LoadError => ex
+      error "Unknown export format: #{format} (unable to load file 'foreman/export/#{ format.tr('-', '_') }')."
+    end
+  end
+
+  def self.error(message)
+    raise Foreman::Export::Exception.new(message)
+  end
+
 end
 
 require "foreman/export/base"
@@ -9,3 +30,5 @@ require "foreman/export/inittab"
 require "foreman/export/upstart"
 require "foreman/export/bluepill"
 require "foreman/export/runit"
+require "foreman/export/supervisord"
+require "foreman/export/launchd"

data/lib/foreman/helpers.rb

@@ -0,0 +1,45 @@
+module Foreman::Helpers
+  # Copied whole sale from, https://github.com/defunkt/resque/
+
+  # Given a word with dashes, returns a camel cased version of it.
+  #
+  # classify('job-name') # => 'JobName'
+  def classify(dashed_word)
+    dashed_word.split('-').each { |part| part[0] = part[0].chr.upcase }.join
+  end  # Tries to find a constant with the name specified in the argument string:
+
+  #
+  # constantize("Module") # => Module
+  # constantize("Test::Unit") # => Test::Unit
+  #
+  # The name is assumed to be the one of a top-level constant, no matter
+  # whether it starts with "::" or not. No lexical context is taken into
+  # account:
+  #
+  # C = 'outside'
+  # module M
+  #   C = 'inside'
+  #   C # => 'inside'
+  #   constantize("C") # => 'outside', same as ::C
+  # end
+  #
+  # NameError is raised when the constant is unknown.
+  def constantize(camel_cased_word)
+    camel_cased_word = camel_cased_word.to_s
+
+    names = camel_cased_word.split('::')
+    names.shift if names.empty? || names.first.empty?
+
+    constant = Object
+    names.each do |name|
+      args = Module.method(:const_get).arity != 1 ? [false] : []
+
+      if constant.const_defined?(name, *args)
+        constant = constant.const_get(name)
+      else
+        constant = constant.const_missing(name)
+      end
+    end
+    constant
+  end
+end

data/lib/foreman/process.rb

@@ -1,68 +1,102 @@
 require "foreman"
+require "rubygems"
 
 class Foreman::Process
 
-  attr_reader :entry
-  attr_reader :num
-  attr_reader :pid
-  attr_reader :port
+  attr_reader :command
+  attr_reader :env
 
-  def initialize(entry, num, port)
-    @entry = entry
-    @num = num
-    @port = port
-  end
+  # Create a Process
+  #
+  # @param [String] command  The command to run
+  # @param [Hash]   options
+  #
+  # @option options [String] :cwd (./)  Change to this working directory before executing the process
+  # @option options [Hash]   :env ({})  Environment variables to set for this process
+  #
+  def initialize(command, options={})
+    @command = command
+    @options = options.dup
 
-  def run(pipe, basedir, environment)
-    Dir.chdir(basedir) do
-      with_environment(environment.merge("PORT" => port.to_s)) do
-        run_process entry.command, pipe
-      end
-    end
+    @options[:env] ||= {}
   end
 
-  def name
-    "%s.%s" % [ entry.name, num ]
-  end
+  # Run a +Process+
+  #
+  # @param [Hash] options
+  #
+  # @option options :env    ({})       Environment variables to set for this execution
+  # @option options :output ($stdout)  The output stream
+  #
+  # @returns [Fixnum] pid  The +pid+ of the process
+  #
+  def run(options={})
+    env    = options[:env] ? @options[:env].merge(options[:env]) : @options[:env]
+    output = options[:output] || $stdout
 
-private
-
-  def fork_with_io(command)
-    reader, writer = IO.pipe
-    pid = fork do
-      trap("INT", "IGNORE")
-      $stdout.reopen writer
-      reader.close
-      exec Foreman.runner, replace_command_env(command)
+    if Foreman.windows?
+      Dir.chdir(cwd) do
+        expanded_command = command.dup
+        env.each do |key, val|
+          expanded_command.gsub!("$#{key}", val)
+        end
+        Process.spawn env, expanded_command, :out => output, :err => output
+      end
+    elsif Foreman.jruby?
+      Dir.chdir(cwd) do
+        require "posix/spawn"
+        POSIX::Spawn.spawn env, command, :out => output, :err => output
+      end
+    elsif Foreman.ruby_18?
+      Dir.chdir(cwd) do
+        fork do
+          $stdout.reopen output
+          $stderr.reopen output
+          env.each { |k,v| ENV[k] = v }
+          exec command
+        end
+      end
+    else
+      Dir.chdir(cwd) do
+        Process.spawn env, command, :out => output, :err => output
+      end
     end
-    [ reader, pid ]
   end
 
-  def run_process(command, pipe)
-    io, @pid = fork_with_io(command)
-    output pipe, "started with pid %d" % @pid
-    Thread.new do
-      until io.eof?
-        output pipe, io.gets
-      end
+  # Send a signal to this +Process+
+  #
+  # @param [String] signal  The signal to send
+  #
+  def kill(signal)
+    if Foreman.windows?
+      pid && Process.kill(signal, pid)
+    else
+      pid && Process.kill("-#{signal}", pid)
     end
+  rescue Errno::ESRCH
+    false
   end
 
-  def output(pipe, message)
-    pipe.puts "%s,%s" % [ name, message ]
+  # Test whether or not this +Process+ is still running
+  #
+  # @returns [Boolean]
+  #
+  def alive?
+    kill(0)
   end
 
-  def replace_command_env(command)
-    command.gsub(/\$(\w+)/) { |e| ENV[e[1..-1]] }
+  # Test whether or not this +Process+ has terminated
+  #
+  # @returns [Boolean]
+  #
+  def dead?
+    !alive?
   end
 
-  def with_environment(environment)
-    old_env = ENV.each_pair.inject({}) { |h,(k,v)| h.update(k => v) }
-    environment.each { |k,v| ENV[k] = v }
-    ret = yield
-    ENV.clear
-    old_env.each { |k,v| ENV[k] = v}
-    ret
+private
+
+  def cwd
+    @options[:cwd] || "."
   end
 
 end

data/lib/foreman/procfile.rb

@@ -1,36 +1,90 @@
 require "foreman"
-require "foreman/procfile_entry"
 
-# A valid Procfile entry is captured by this regex.
-# All other lines are ignored.
+# Reads and writes Procfiles
+#
+# A valid Procfile entry is captured by this regex:
 #
-# /^([A-Za-z0-9_]+):\s*(.+)$/
+#   /^([A-Za-z0-9_]+):\s*(.+)$/
 #
-# $1 = name
-# $2 = command
+# All other lines are ignored.
 #
 class Foreman::Procfile
 
-  attr_reader :entries
+  # Initialize a Procfile
+  #
+  # @param [String] filename (nil)  An optional filename to read from
+  #
+  def initialize(filename=nil)
+    @entries = []
+    load(filename) if filename
+  end
 
-  def initialize(filename)
-    @entries = parse_procfile(filename)
+  # Yield each +Procfile+ entry in order
+  #
+  def entries(&blk)
+    @entries.each do |(name, command)|
+      yield name, command
+    end
   end
 
+  # Retrieve a +Procfile+ command by name
+  #
+  # @param [String] name  The name of the Procfile entry to retrieve
+  #
   def [](name)
-    entries.detect { |entry| entry.name == name }
+    @entries.detect { |n,c| name == n }.last
+  end
+
+  # Create a +Procfile+ entry
+  #
+  # @param [String] name     The name of the +Procfile+ entry to create
+  # @param [String] command  The command of the +Procfile+ entry to create
+  #
+  def []=(name, command)
+    delete name
+    @entries << [name, command]
+  end
+
+  # Remove a +Procfile+ entry
+  #
+  # @param [String] name  The name of the +Procfile+ entry to remove
+  #
+  def delete(name)
+    @entries.reject! { |n,c| name == n }
+  end
+
+  # Load a Procfile from a file
+  #
+  # @param [String] filename  The filename of the +Procfile+ to load
+  #
+  def load(filename)
+    @entries.replace parse(filename)
+  end
+
+  # Save a Procfile to a file
+  #
+  # @param [String] filename  Save the +Procfile+ to this file
+  #
+  def save(filename)
+    File.open(filename, 'w') do |file|
+      file.puts self.to_s
+    end
   end
 
-  def process_names
-    entries.map(&:name)
+  # Get the +Procfile+ as a +String+
+  #
+  def to_s
+    @entries.map do |name, command|
+      [ name, command ].join(": ")
+    end.join("\n")
   end
 
 private
 
-  def parse_procfile(filename)
+  def parse(filename)
     File.read(filename).split("\n").map do |line|
       if line =~ /^([A-Za-z0-9_]+):\s*(.+)$/
-        Foreman::ProcfileEntry.new($1, $2)
+        [$1, $2]
       end
     end.compact
   end

data/lib/foreman/version.rb

@@ -1,5 +1,5 @@
 module Foreman
 
-  VERSION = "0.31.0"
+  VERSION = "0.50.0"
 
 end

data/lib/foreman.rb

@@ -4,15 +4,20 @@ 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)
+  def self.runner
+    File.expand_path("../../bin/foreman-runner", __FILE__)
   end
 
-  def self.runner
-    File.expand_path("../../bin/runner", __FILE__)
+  def self.jruby?
+    defined?(RUBY_PLATFORM) and RUBY_PLATFORM == "java"
   end
 
-end
+  def self.ruby_18?
+    defined?(RUBY_VERSION) and RUBY_VERSION =~ /^1\.8\.\d+/
+  end
 
+  def self.windows?
+    defined?(RUBY_PLATFORM) and RUBY_PLATFORM =~ /(win|w)32$/
+  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" "November 2011" "Foreman 0.26.0" "Foreman Manual"
+.TH "FOREMAN" "1" "July 2012" "Foreman 0.50.0" "Foreman Manual"
 .
 .SH "NAME"
 \fBforeman\fR \- manage Procfile\-based applications
@@ -10,10 +10,13 @@
 \fBforeman start [process]\fR
 .
 .br
+\fBforeman run <command>\fR
+.
+.br
 \fBforeman export <format> [location]\fR
 .
 .SH "DESCRIPTION"
-\fBForeman\fR 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\.
+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\.
 .
 .SH "RUNNING"
 \fBforeman start\fR is used to run your application directly from the command line\.
@@ -32,9 +35,24 @@ The following options control how the application is run:
 Specify the number of each process type to run\. The value passed in should be in the format \fBprocess=num,process=num\fR
 .
 .TP
+\fB\-e\fR, \fB\-\-env\fR
+Specify one or more \.env files to load
+.
+.TP
+\fB\-f\fR, \fB\-\-procfile\fR
+Specify an alternate Procfile to load, implies \fB\-d\fR at the Procfile root\.
+.
+.TP
 \fB\-p\fR, \fB\-\-port\fR
 Specify which port to use as the base for this application\. Should be a multiple of 1000\.
 .
+.TP
+\fB\-t\fR, \fB\-\-tmux\fR
+Runs the processes in a tmux session\. Creates one window for each process and an extra window containing the output of each window (requires gawk)\.
+.
+.P
+\fBforeman run\fR is used to run one\-off commands using the same environment as your defined processes\.
+.
 .SH "EXPORTING"
 \fBforeman export\fR is used to export your application to another process management format\.
 .
@@ -61,13 +79,21 @@ Specify the directory to place process logs in\.
 Specify which port to use as the base for this application\. Should be a multiple of 1000\.
 .
 .TP
+\fB\-t\fR, \fB\-\-template\fR
+Specify an alternate template to use for creating export files\. See \fIhttps://github\.com/ddollar/foreman/tree/master/data/export\fR for examples\.
+.
+.TP
 \fB\-u\fR, \fB\-\-user\fR
 Specify the user the application should be run as\. Defaults to the app name
 .
-.SH "OPTIONS"
+.SH "GLOBAL OPTIONS"
 These options control all modes of foreman\'s operation\.
 .
 .TP
+\fB\-d\fR, \fB\-\-directory\fR
+Specify an alternate application root\. This defaults to the directory containing the Procfile\.
+.
+.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\.
 .