foreman 0.37.0-mingw32

data/README.md

@@ -0,0 +1,39 @@
+# Foreman
+
+Manage Procfile-based applications
+
+<table>
+  <tr>
+    <th>If you have...</th>
+    <th>Install with...</th>
+  </tr>
+  <tr>
+    <td>Ruby (MRI, JRuby, Windows)</td>
+    <td><pre>$ gem install foreman</pre></td>
+  </tr>
+  <tr>
+    <td>Mac OS X</td>
+    <td><a href="http://assets.foreman.io/foreman/foreman.pkg">foreman.pkg</a></td>
+  </tr>
+</table>
+
+## Getting Started
+
+* http://blog.daviddollar.org/2011/05/06/introducing-foreman.html
+
+## Documentation
+
+* [man page](http://ddollar.github.com/foreman)
+* [wiki](http://github.com/ddollar/foreman/wiki)
+
+## Authors
+
+#### Created and maintained by
+David Dollar
+
+#### Patches contributed by
+Adam Wiggins, Chris Continanza, Chris Lowder, Craig R Webster, Dan Farina, Dan Peterson, David Dollar, Fletcher Nichol, Gabriel Burt, Gamaliel Toro, Greg Reinacker, Hugues Le Gendre, Hunter Nield, Iain Hecker, Jay Zeschin, Keith Rarick, Khaja Minhajuddin, Lincoln Stoll, Marcos Muino Garcia, Mark McGranaghan, Matt Griffin, Matt Haynes, Matthijs Langenberg, Michael Dwan, Michael van Rooijen, Mike Javorski, Nathan Broadbent, Nathan L Smith, Nick Zadrozny, Phil Hagelberg, Ricardo Chimal, Jr, Thom May, Tom Ward, brainopia, clifff, jc00ke
+
+## License
+
+MIT

data/bin/foreman

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require "foreman/cli"
+
+Foreman::CLI.start

data/bin/runner

@@ -0,0 +1,36 @@
+#!/bin/sh
+#
+#/ Usage: runner [-d <dir>] <command>
+#/
+#/ Run a command with exec, optionally changing directory first
+
+set -e
+
+error() {
+  echo $@ >&2
+  exit 1
+}
+
+usage() {
+  cat $0 | grep '^#/' | cut -c4-
+  exit
+}
+
+while getopts ":hd:" OPT; do
+  case $OPT in
+     d) cd $OPTARG ;;
+     h) usage ;;
+    \?) error "invalid option: -$OPTARG" ;;
+     :) error "option -$OPTARG requires an argument" ;;
+  esac
+done
+
+shift $((OPTIND-1))
+
+command=$1
+
+if [ -z "$1" ]; then
+  usage
+fi
+
+exec $1

data/data/example/Procfile

@@ -0,0 +1,2 @@
+ticker: ruby ./ticker $PORT
+error:  ruby ./error

data/data/example/Procfile.without_colon

@@ -0,0 +1,2 @@
+ticker ./ticker $PORT
+error  ./error

data/data/example/error

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$stdout.sync = true
+
+puts "will error in 10s"
+sleep 5
+raise "Dying"

data/data/example/log/neverdie.log

@@ -0,0 +1,4 @@
+tick
+tick
+./never_die:6:in `sleep': Interrupt
+	from ./never_die:6

data/data/example/ticker

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+$stdout.sync = true
+
+%w( SIGINT SIGTERM ).each do |signal|
+  trap(signal) do
+    puts "received #{signal} but i'm ignoring it!"
+  end
+end
+
+while true
+  puts "tick: #{ARGV.inspect} -- FOO:#{ENV["FOO"]}"
+  sleep 1
+end

data/data/export/bluepill/master.pill.erb

@@ -0,0 +1,27 @@
+Bluepill.application("<%= app %>", :foreground => false, :log_file => "/var/log/bluepill.log") do |app|
+
+  app.uid = "<%= user %>"
+  app.gid = "<%= user %>"
+
+<% engine.procfile.entries.each do |process| %>
+<% 1.upto(concurrency[process.name]) do |num| %>
+<% port = engine.port_for(process, num, self.port) %>
+  app.process("<%= process.name %>-<%=num%>") do |process|
+    process.start_command = "<%= process.command.gsub("$PORT", port.to_s) %>"
+
+    process.working_dir = "<%= engine.directory %>"
+    process.daemonize = true
+    process.environment = {"PORT" => "<%= port %>"}
+    process.stop_signals = [:quit, 30.seconds, :term, 5.seconds, :kill]
+
+    process.stdout = process.stderr = "<%= log_root %>/<%= app %>-<%= process.name %>-<%=num%>.log"
+
+    process.monitor_children do |children|
+      children.stop_command "kill -QUIT {{PID}}"
+    end
+
+    process.group = "<%= app %>-<%= process.name %>"
+  end
+<% end %>
+<% end %>
+end

data/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/data/export/runit/run.erb

@@ -0,0 +1,3 @@
+#!/bin/sh
+cd <%= engine.directory %>
+exec chpst -u <%= user %> -e <%= process_env_directory %> <%= process.command %>

data/data/export/upstart/master.conf.erb

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

data/data/export/upstart/process.conf.erb

@@ -0,0 +1,5 @@
+start on starting <%= app %>-<%= process.name %>
+stop on stopping <%= app %>-<%= process.name %>
+respawn
+
+exec su - <%= user %> -c 'cd <%= engine.directory %>; export PORT=<%= port %>;<% engine.environment.each_pair do |var,env| %> export <%= var.upcase %>=<%= env %>; <% end %> <%= process.command %> >> <%= log_root %>/<%=process.name%>-<%=num%>.log 2>&1'

data/data/export/upstart/process_master.conf.erb

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

data/lib/foreman.rb

@@ -0,0 +1,25 @@
+require "foreman/version"
+
+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)
+  end
+
+  def self.runner
+    File.expand_path("../../bin/runner", __FILE__)
+  end
+
+  def self.jruby?
+    defined?(RUBY_PLATFORM) and RUBY_PLATFORM == "java"
+  end
+
+  def self.windows?
+    defined?(RUBY_PLATFORM) and RUBY_PLATFORM =~ /(win|w)32$/
+  end
+
+end

data/lib/foreman/cli.rb

@@ -0,0 +1,98 @@
+require "foreman"
+require "foreman/helpers"
+require "foreman/engine"
+require "foreman/export"
+require "thor"
+require "yaml"
+
+class Foreman::CLI < Thor
+  include Foreman::Helpers
+
+  class_option :procfile, :type => :string, :aliases => "-f", :desc => "Default: Procfile"
+
+  desc "start", "Start the application"
+
+  class_option :procfile, :type => :string, :aliases => "-f", :desc => "Default: Procfile"
+  class_option :app_root, :type => :string, :aliases => "-d", :desc => "Default: Procfile directory"
+
+  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 :concurrency, :type => :string,  :aliases => "-c", :banner => '"alpha=5,bar=3"'
+
+  class << self
+    # Hackery. Take the run method away from Thor so that we can redefine it.
+    def is_thor_reserved_word?(word, type)
+      return false if word == 'run'
+      super
+    end
+  end
+
+  def start
+    check_procfile!
+    engine.start
+  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 :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"
+  method_option :concurrency, :type => :string,  :aliases => "-c", :banner => '"alpha=5,bar=3"'
+
+  def export(format, location=nil)
+    check_procfile!
+    formatter = Foreman::Export.formatter(format)
+    formatter.new(location, engine, options).export
+  rescue Foreman::Export::Exception => ex
+    error ex.message
+  end
+
+  desc "check", "Validate your application's Procfile"
+
+  def check
+    error "no processes defined" unless engine.procfile.entries.length > 0
+    puts "valid procfile detected (#{engine.procfile.process_names.join(', ')})"
+  end
+
+  desc "run COMMAND", "Run a command using your application's environment"
+
+  def run(*args)
+    engine.apply_environment!
+    begin
+      exec args.join(" ")
+    rescue Errno::EACCES
+      error "not executable: #{args.first}"
+    rescue Errno::ENOENT
+      error "command not found: #{args.first}"
+    end
+  end
+
+private ######################################################################
+
+  def check_procfile!
+    error("#{procfile} does not exist.") unless File.exist?(procfile)
+  end
+
+  def engine
+    @engine ||= Foreman::Engine.new(procfile, options)
+  end
+
+  def procfile
+    options[:procfile] || "Procfile"
+  end
+
+  def error(message)
+    puts "ERROR: #{message}"
+    exit 1
+  end
+
+  def options
+    original_options = super
+    return original_options unless File.exists?(".foreman")
+    defaults = YAML::load_file(".foreman") || {}
+    Thor::CoreExt::HashWithIndifferentAccess.new(defaults.merge(original_options))
+  end
+end

data/lib/foreman/distribution.rb

@@ -0,0 +1,9 @@
+module Foreman
+  module Distribution
+    def self.files
+      Dir[File.expand_path("../../../{bin,data,lib}/**/*", __FILE__)].select do |file|
+        File.file?(file)
+      end
+    end
+  end
+end

data/lib/foreman/engine.rb

@@ -0,0 +1,234 @@
+require "foreman"
+require "foreman/process"
+require "foreman/procfile"
+require "foreman/utils"
+require "tempfile"
+require "timeout"
+require "term/ansicolor"
+require "fileutils"
+require "thread"
+
+class Foreman::Engine
+
+  attr_reader :procfile
+  attr_reader :directory
+  attr_reader :options
+
+  extend Term::ANSIColor
+
+  COLORS = [ cyan, yellow, green, magenta, red, blue,
+             intense_cyan, intense_yellow, intense_green, intense_magenta,
+             intense_red, intense_blue ]
+
+  def initialize(procfile, options={})
+    @procfile  = Foreman::Procfile.new(procfile)
+    @directory = options[:app_root] || File.expand_path(File.dirname(procfile))
+    @options = options
+    @environment = read_environment_files(options[:env])
+    @output_mutex = Mutex.new
+  end
+
+  def self.load_env!(env_file)
+    @environment = read_environment_files(env_file)
+    apply_environment!
+  end
+
+  def start
+    proctitle "ruby: foreman master"
+    termtitle "#{File.basename(@directory)} - foreman"
+
+    trap("TERM") { puts "SIGTERM received"; terminate_gracefully }
+    trap("INT")  { puts "SIGINT received";  terminate_gracefully }
+
+    assign_colors
+    spawn_processes
+    watch_for_output
+    watch_for_termination
+  end
+
+  def port_for(process, num, base_port=nil)
+    base_port ||= 5000
+    offset = procfile.process_names.index(process.name) * 100
+    base_port.to_i + offset + num - 1
+  end
+
+private ######################################################################
+
+  def spawn_processes
+    concurrency = Foreman::Utils.parse_concurrency(@options[:concurrency])
+
+    procfile.entries.each do |entry|
+      reader, writer = IO.pipe
+      entry.spawn(concurrency[entry.name], writer, @directory, @environment, port_for(entry, 1, base_port)).each do |process|
+        running_processes[process.pid] = process
+        readers[process] = reader
+      end
+    end
+  end
+
+  def base_port
+    options[:port] || 5000
+  end
+
+  def kill_all(signal="SIGTERM")
+    running_processes.each do |pid, process|
+      info "sending #{signal} to pid #{pid}"
+      process.kill signal
+    end
+  end
+
+  def terminate_gracefully
+    return if @terminating
+    @terminating = true
+    info "sending SIGTERM to all processes"
+    kill_all "SIGTERM"
+    Timeout.timeout(5) do
+      while running_processes.length > 0
+        pid, status = Process.wait2
+        process = running_processes.delete(pid)
+        info "process terminated", process.name
+      end
+    end
+  rescue Timeout::Error
+    info "sending SIGKILL to all processes"
+    kill_all "SIGKILL"
+  end
+
+  def watch_for_output
+    Thread.new do
+      require "win32console" if Foreman.windows?
+      begin
+        loop do
+          rs, ws = IO.select(readers.values, [], [], 1)
+          (rs || []).each do |r|
+            data = r.gets
+            next unless data
+            ps, message = data.split(",", 2)
+            color = colors[ps.split(".").first]
+            info message, ps, color
+          end
+        end
+      rescue Exception => ex
+        puts ex.message
+        puts ex.backtrace
+      end
+    end
+  end
+
+  def watch_for_termination
+    pid, status = Process.wait2
+    process = running_processes.delete(pid)
+    info "process terminated", process.name
+    terminate_gracefully
+  rescue Errno::ECHILD
+  end
+
+  def info(message, name="system", color=Term::ANSIColor.white)
+    output  = ""
+    output += color
+    output += "#{Time.now.strftime("%H:%M:%S")} #{pad_process_name(name)} | "
+    output += Term::ANSIColor.reset
+    output += message.chomp
+    puts output
+  end
+
+  def print(message=nil)
+    @output_mutex.synchronize do
+      $stdout.print message
+    end
+  end
+
+  def puts(message=nil)
+    @output_mutex.synchronize do
+      $stdout.puts message
+    end
+  end
+
+  def longest_process_name
+    @longest_process_name ||= begin
+      longest = procfile.process_names.map { |name| name.length }.sort.last
+      longest = 6 if longest < 6 # system
+      longest
+    end
+  end
+
+  def pad_process_name(name="system")
+    name.to_s.ljust(longest_process_name + 3) # add 3 for process number padding
+  end
+
+  def proctitle(title)
+    $0 = title
+  end
+
+  def termtitle(title)
+    printf("\033]0;#{title}\007") unless Foreman.windows?
+  end
+
+  def running_processes
+    @running_processes ||= {}
+  end
+
+  def readers
+    @readers ||= {}
+  end
+
+  def colors
+    @colors ||= {}
+  end
+
+  def assign_colors
+    procfile.entries.each do |entry|
+      colors[entry.name] = next_color
+    end
+  end
+
+  def process_by_reader(reader)
+    readers.invert[reader]
+  end
+
+  def next_color
+    @current_color ||= -1
+    @current_color  +=  1
+    @current_color = 0 if COLORS.length < @current_color
+    COLORS[@current_color]
+  end
+
+  module Env
+    attr_reader :environment
+
+    def read_environment_files(filenames)
+      environment = {}
+
+      (filenames || "").split(",").map(&:strip).each do |filename|
+        error "No such file: #{filename}" unless File.exists?(filename)
+        environment.merge!(read_environment(filename))
+      end
+
+      environment.merge!(read_environment(".env")) unless filenames
+      environment
+    end
+
+    def read_environment(filename)
+      return {} unless File.exists?(filename)
+
+      File.read(filename).split("\n").inject({}) do |hash, line|
+        if line =~ /\A([A-Za-z_0-9]+)=(.*)\z/
+          hash[$1] = $2
+        end
+        hash
+      end
+    end
+
+    def apply_environment!
+      @environment.each { |k,v| ENV[k] = v }
+    end
+
+    def error(message)
+      puts "ERROR: #{message}"
+      exit 1
+    end
+  end
+
+  include Env
+  extend  Env
+end