overman 0.0.1 → 0.87.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d480b8870bea6ea71782fc5161f05d07dd615025653f6dfa84a2697c3efec9d
-  data.tar.gz: '09b2e9d46aeec0a4094474e8ca09f434345764b603e3c47ab8a83c99758862fc'
+  metadata.gz: 16dff0543ec0529199820c87e2bb1aa9df5ddfe0d2287c8993a4f223d72a6c85
+  data.tar.gz: f586a1017a45d1d8e517af84157441e1f28e910e35a15f069cfd69de8e8bc31b
 SHA512:
-  metadata.gz: b86b65cd4c20dd2469bef0f643bc4842943aa9d3db6d1425d5c985aa07707af6962f0e268d4cd8526acc976b2d85466ecd28bc80e5c6dea42355d219101b228f
-  data.tar.gz: 067c74e38e42349c41c2ec234761e011630683bbeeb89e59265e9475f2a257e4da984ff58fd551511daaf34f46452ed3b26b640ad769b8ab369d4e086c7e4135
+  metadata.gz: 1f88e4b71f8936627deea9c573f83c8071778738b769bc490127d14527adafb80202901b2b47ae09fe62d05d6c8a3933ee458215e03c020022b067fc09f91932
+  data.tar.gz: 20c42a00a35ace143e4234c4b80958c6981a010987373c48748a1df522fd2e643ffd811eed231c20b5305829173fc2379e622f4c759f9c3c9a4595b79c6ce2a8

data/README.md

@@ -0,0 +1,52 @@
+# Overman (`ddollar/foreman` fork)
+
+[![CI](https://github.com/spinels/overman/actions/workflows/ci.yml/badge.svg)](https://github.com/spinels/overman/actions/workflows/ci.yml)
+
+Manage Procfile-based applications
+
+## Installation
+
+    $ gem install overman
+
+Ruby users should take care *not* to install overman in their project's `Gemfile`. See this [wiki article](https://github.com/ddollar/foreman/wiki/Don't-Bundle-Foreman) for more details.
+
+## Getting Started
+
+* http://blog.daviddollar.org/2011/05/06/introducing-foreman.html
+
+## Supported Ruby versions
+
+See [ci.yml](.github/workflows/ci.yml) for a list of Ruby versions against which Foreman is tested.
+
+## Documentation
+
+* [man page](http://ddollar.github.io/foreman/)
+* [wiki](https://github.com/ddollar/foreman/wiki)
+* [changelog](https://github.com/ddollar/foreman/blob/master/Changelog.md)
+
+## Ports
+
+* [forego](https://github.com/ddollar/forego) - Go
+* [node-foreman](https://github.com/strongloop/node-foreman) - Node.js
+* [gaffer](https://github.com/jingweno/gaffer) - Java/JVM
+* [goreman](https://github.com/mattn/goreman) - Go
+* [honcho](https://github.com/nickstenning/honcho) - python
+* [proclet](https://github.com/kazeburo/Proclet) - Perl
+* [shoreman](https://github.com/chrismytton/shoreman) - shell
+* [crank](https://github.com/arktisklada/crank) - Crystal
+* [houseman](https://github.com/fujimura/houseman) - Haskell
+* [spm](https://github.com/bytegust/spm) - Go
+
+## Authors
+
+#### Created and maintained by
+David Dollar
+
+#### Patches contributed by
+[Contributor List](https://github.com/ddollar/foreman/contributors)
+
+## License
+
+Foreman is licensed under the MIT license.
+
+See LICENSE for the full license text.

data/bin/foreman-runner

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

data/bin/overman

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

data/data/example/Procfile

@@ -0,0 +1,4 @@
+ticker:  ruby ./ticker $PORT
+error:   ruby ./error
+utf8:    ruby ./utf8
+spawner: ./spawner

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/spawnee

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+NAME="$1"
+
+sigterm() {
+  echo "$NAME: got sigterm"
+}
+
+#trap sigterm SIGTERM
+
+while true; do
+  echo "$NAME: ping $$"
+  sleep 1
+done

data/data/example/spawner

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+./spawnee A &
+./spawnee B &
+./spawnee C &
+
+wait

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/example/utf8

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# encoding: BINARY
+
+$stdout.sync = true
+
+while true
+  puts "\u65e5\u672c\u8a9e\u6587\u5b57\u5217"
+  puts "\u0915\u0932\u094d\u0907\u0928\u0643\u0637\u0628\u041a\u0430\u043b\u0438\u043d\u0430"
+  puts "\xff\x03"
+  sleep 1
+end

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

@@ -0,0 +1,28 @@
+Bluepill.application("<%= app %>", :foreground => false, :log_file => "/var/log/bluepill.log") do |app|
+
+  app.uid = "<%= user %>"
+  app.gid = "<%= user %>"
+
+<% engine.each_process do |name, process| %>
+<% 1.upto(engine.formation[name]) do |num| %>
+  <% port = engine.port_for(process, num) %>
+  app.process("<%= name %>-<%= num %>") do |process|
+    process.start_command = %Q{<%= process.command %>}
+
+    process.working_dir = "<%= engine.root %>"
+    process.daemonize = true
+    process.environment = <%= engine.env.merge("PORT" => port.to_s).inspect %>
+    process.stop_signals = [:quit, 30.seconds, :term, 5.seconds, :kill]
+    process.stop_grace_time = 45.seconds
+
+    process.stdout = process.stderr = "<%= log %>/<%= app %>-<%= name %>-<%= num %>.log"
+
+    process.monitor_children do |children|
+      children.stop_command "kill {{PID}}"
+    end
+
+    process.group = "<%= app %>-<%= name %>"
+  end
+<% end %>
+<% end %>
+end

data/data/export/daemon/master.conf.erb

@@ -0,0 +1,14 @@
+pre-start script
+
+bash << "EOF"
+mkdir -p <%= log %>
+chown -R <%= user %> <%= log %>
+mkdir -p <%= run %>
+chown -R <%= user %> <%= run %>
+EOF
+
+end script
+
+start on runlevel [2345]
+
+stop on runlevel [016]

data/data/export/daemon/process.conf.erb

@@ -0,0 +1,8 @@
+start on starting <%= app %>-<%= name.gsub('_', '-') %>
+stop on stopping <%= app %>-<%= name.gsub('_', '-') %>
+respawn
+
+env PORT=<%= port %><% engine.env.each_pair do |var, env| %>
+env <%= var %>=<%= env %><% end %>
+
+exec start-stop-daemon --start --chuid <%= user %> --chdir <%= engine.root %> --make-pidfile --pidfile <%= run %>/<%= app %>-<%= name %>-<%= num %>.pid --exec <%= executable %><%= arguments %> >> <%= log %>/<%= app %>-<%= name %>-<%= num %>.log 2>&1

data/data/export/daemon/process_master.conf.erb

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

data/data/export/launchd/launchd.plist.erb

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>Label</key>
+    <string><%= "#{app}-#{name}-#{num}" %></string>
+    <key>EnvironmentVariables</key>
+    <dict>
+    <%- engine.env.merge("PORT" => port).each_pair do |var,env| -%>
+        <key><%= var %></key>
+        <string><%= env %></string>
+    <%- end -%>
+    </dict>
+    <key>ProgramArguments</key>
+    <array>
+    <%- command_args.each do |command| -%>
+        <string><%= command %></string>
+    <%- end -%>
+    </array>
+    <key>KeepAlive</key>
+    <true/>
+    <key>RunAtLoad</key>
+    <true/>
+    <key>StandardOutPath</key>
+    <string><%= log %>/<%= app %>-<%= name %>-<%=num%>.log</string>
+    <key>StandardErrorPath</key>
+    <string><%= log %>/<%= app %>-<%= name %>-<%=num%>.log</string>
+    <key>UserName</key>
+    <string><%= user %></string>
+    <key>WorkingDirectory</key>
+    <string><%= engine.root %></string>
+</dict>
+</plist>

data/data/export/runit/log/run.erb

@@ -0,0 +1,7 @@
+#!/bin/sh
+set -e
+
+LOG=<%= log %>/<%= name %>-<%= num %>
+
+test -d "$LOG" || mkdir -p -m 2750 "$LOG" && chown <%= user %> "$LOG"
+exec chpst -u <%= user %> svlogd "$LOG"

data/data/export/runit/run.erb

@@ -0,0 +1,4 @@
+#!/bin/sh
+cd <%= engine.root %>
+exec 2>&1
+exec chpst -u <%= user %> -e <%= File.join(location, "#{process_directory}/env")  %> <%= process.command %>

data/data/export/supervisord/app.conf.erb

@@ -0,0 +1,31 @@
+<%
+app_names = []
+engine.each_process do |name, process|
+  1.upto(engine.formation[name]) do |num|
+    port = engine.port_for(process, num)
+    full_name = "#{app}-#{name}-#{num}"
+    environment = engine.env.merge("PORT" => port.to_s).map do |key, value|
+    	value = shell_quote(value)
+    	value = value.gsub('\=', '=')
+    	value = value.gsub('\&', '&')
+    	value = value.gsub('\?', '?')
+      "#{key}=\"#{value}\""
+    end
+    app_names << full_name
+-%>
+[program:<%= full_name %>]
+command=<%= process.command %>
+autostart=true
+autorestart=true
+stdout_logfile=<%= log %>/<%= name %>-<%= num %>.log
+stderr_logfile=<%= log %>/<%= name %>-<%= num %>.error.log
+user=<%= user %>
+directory=<%= engine.root %>
+environment=<%= environment.join(',') %>
+
+<%
+  end
+end
+-%>
+[group:<%= app %>]
+programs=<%= app_names.join(',') %>

data/data/export/systemd/master.target.erb

@@ -0,0 +1,5 @@
+[Unit]
+Wants=<%= service_names.join(' ') %>
+
+[Install]
+WantedBy=multi-user.target

data/data/export/systemd/process.service.erb

@@ -0,0 +1,21 @@
+[Unit]
+PartOf=<%= app %>.target
+StopWhenUnneeded=yes
+
+[Service]
+User=<%= user %>
+WorkingDirectory=<%= engine.root %>
+Environment=PORT=<%= port %>
+Environment=PS=<%= process_name %>
+<% engine.env.each_pair do |var,env| -%>
+Environment="<%= var %>=<%= env %>"
+<% end -%>
+ExecStart=/bin/bash -lc 'exec -a "<%= app %>-<%= process_name %>" <%= process.command %>'
+Restart=always
+RestartSec=14s
+StandardInput=null
+StandardOutput=syslog
+StandardError=syslog
+SyslogIdentifier=%n
+KillMode=mixed
+TimeoutStopSec=<%= engine.options[:timeout] %>

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

@@ -0,0 +1,2 @@
+start on runlevel [2345]
+stop on runlevel [!2345]

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

@@ -0,0 +1,15 @@
+start on starting <%= app %>-<%= name %>
+stop on stopping <%= app %>-<%= name %>
+respawn
+
+env PORT=<%= port %>
+<% engine.env.each do |name,value| -%>
+<% next if name.upcase == "PORT" -%>
+env <%= name %>='<%= value.gsub(/'/, "'\"'\"'") %>'
+<% end -%>
+
+setuid <%= user %>
+
+chdir <%= engine.root %>
+
+exec <%= process.command %>

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

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

data/lib/foreman/cli.rb

@@ -0,0 +1,162 @@
+require "foreman"
+require "foreman/helpers"
+require "foreman/engine"
+require "foreman/engine/cli"
+require "foreman/export"
+require "foreman/version"
+require "shellwords"
+require "yaml"
+require "foreman/vendor/thor/lib/thor"
+
+class Foreman::CLI < Foreman::Thor
+
+  include Foreman::Helpers
+
+  map ["-v", "--version"] => :version
+
+  class_option :procfile, :type => :string, :aliases => "-f", :desc => "Default: Procfile"
+  class_option :root,     :type => :string, :aliases => "-d", :desc => "Default: Procfile directory"
+
+  desc "start [PROCESS]", "Start the application (or a specific PROCESS)"
+
+  method_option :color,     :type => :boolean, :aliases => "-c", :desc => "Force color to be enabled"
+  method_option :env,       :type => :string,  :aliases => "-e", :desc => "Specify an environment file to load, defaults to .env"
+  method_option :formation, :type => :string,  :aliases => "-m", :banner => '"alpha=5,bar=3"', :desc => 'Specify what processes will run and how many. Default: "all=1"'
+  method_option :port,      :type => :numeric, :aliases => "-p"
+  method_option :timeout,   :type => :numeric, :aliases => "-t", :desc => "Specify the amount of time (in seconds) processes have to shutdown gracefully before receiving a SIGKILL, defaults to 5."
+  method_option :timestamp, :type => :boolean, :default => true, :desc => "Include timestamp in output"
+
+  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(process=nil)
+    check_procfile!
+    load_environment!
+    engine.load_procfile(procfile)
+    engine.options[:formation] = "#{process}=1" if process
+    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 :run,         :type => :string,  :aliases => "-r", :desc => "Specify the pid file directory, defaults to /var/run/<application>"
+  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 :formation, :type => :string,  :aliases => "-m", :banner => '"alpha=5,bar=3"', :desc => 'Specify what processes will run and how many. Default: "all=1"'
+  method_option :timeout,     :type => :numeric, :aliases => "-t", :desc => "Specify the amount of time (in seconds) processes have to shutdown gracefully before receiving a SIGKILL, defaults to 5."
+
+  def export(format, location=nil)
+    check_procfile!
+    load_environment!
+    engine.load_procfile(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
+    check_procfile!
+    engine.load_procfile(procfile)
+    error "no processes defined" unless engine.processes.length > 0
+    puts "valid procfile detected (#{engine.process_names.join(', ')})"
+  end
+
+  desc "run COMMAND [ARGS...]", "Run a command using your application's environment"
+
+  method_option :env, :type => :string, :aliases => "-e", :desc => "Specify an environment file to load, defaults to .env"
+  stop_on_unknown_option! :run
+
+  def run(*args)
+    load_environment!
+
+    if File.file?(procfile)
+      engine.load_procfile(procfile)
+    end
+
+    pid = fork do
+      begin
+        engine.env.each { |k,v| ENV[k] = v }
+        if args.size == 1 && process = engine.process(args.first)
+          process.exec(:env => engine.env)
+        else
+          exec args.shelljoin
+        end
+      rescue Errno::EACCES
+        error "not executable: #{args.first}"
+      rescue Errno::ENOENT
+        error "command not found: #{args.first}"
+      end
+    end
+    trap("INT") do
+      Process.kill(:INT, pid)
+    end
+    Process.wait(pid)
+    exit $?.exitstatus || 0
+  rescue Interrupt
+  end
+
+  desc "version", "Display Foreman gem version"
+
+  def version
+    puts Foreman::VERSION
+  end
+
+  no_tasks do
+    def engine
+      @engine ||= begin
+        engine_class = Foreman::Engine::CLI
+        engine = engine_class.new(options)
+        engine
+      end
+    end
+  end
+
+private ######################################################################
+
+  def error(message)
+    puts "ERROR: #{message}"
+    exit 1
+  end
+
+  def check_procfile!
+    error("#{procfile} does not exist.") unless File.file?(procfile)
+  end
+
+  def load_environment!
+    if options[:env]
+      options[:env].split(",").each do |file|
+        engine.load_env file
+      end
+    else
+      default_env = File.join(engine.root, ".env")
+      engine.load_env default_env if File.file?(default_env)
+    end
+  end
+
+  def procfile
+    case
+      when options[:procfile] then options[:procfile]
+      when options[:root]     then File.expand_path(File.join(options[:root], "Procfile"))
+      else "Procfile"
+    end
+  end
+
+  def options
+    original_options = super
+    return original_options unless File.file?(".foreman")
+    defaults = ::YAML::load_file(".foreman") || {}
+    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/cli.rb

@@ -0,0 +1,105 @@
+require "foreman/engine"
+
+class Foreman::Engine::CLI < Foreman::Engine
+
+  module Color
+
+    ANSI = {
+      :reset          => 0,
+      :black          => 30,
+      :red            => 31,
+      :green          => 32,
+      :yellow         => 33,
+      :blue           => 34,
+      :magenta        => 35,
+      :cyan           => 36,
+      :white          => 37,
+      :bright_black   => 30,
+      :bright_red     => 31,
+      :bright_green   => 32,
+      :bright_yellow  => 33,
+      :bright_blue    => 34,
+      :bright_magenta => 35,
+      :bright_cyan    => 36,
+      :bright_white   => 37,
+    }
+
+    def self.enable(io, force=false)
+      io.extend(self)
+      @@color_force = force
+    end
+
+    def color?
+      return true if @@color_force
+      return false if Foreman.windows?
+      return false unless self.respond_to?(:isatty)
+      self.isatty && ENV["TERM"]
+    end
+
+    def color(name)
+      return "" unless color?
+      return "" unless ansi = ANSI[name.to_sym]
+      "\e[#{ansi}m"
+    end
+
+  end
+
+  FOREMAN_COLORS = %w( cyan yellow green magenta red blue bright_cyan bright_yellow
+                       bright_green bright_magenta bright_red bright_blue )
+
+  def startup
+    @colors = map_colors
+    proctitle "foreman: master" unless Foreman.windows?
+    Color.enable($stdout, options[:color])
+  end
+
+  def output(name, data)
+    data.to_s.lines.map(&:chomp).each do |message|
+      output  = ""
+      output += $stdout.color(@colors[name.split(".").first].to_sym)
+      output += "#{Time.now.strftime("%H:%M:%S")} " if options[:timestamp]
+      output += "#{pad_process_name(name)} | "
+      output += $stdout.color(:reset)
+      output += message
+      $stdout.puts output
+      $stdout.flush
+    end
+  rescue Errno::EPIPE
+    terminate_gracefully
+  end
+
+  def shutdown
+  end
+
+private
+
+  def name_padding
+    @name_padding ||= begin
+      index_padding = @names.values.map { |n| formation[n] }.max.to_s.length + 1
+      name_padding  = @names.values.map { |n| n.length + index_padding }.sort.last
+      [ 6, name_padding ].max
+    end
+  end
+
+  def pad_process_name(name)
+    name.ljust(name_padding, " ")
+  end
+
+  def map_colors
+    colors = Hash.new("white")
+    @names.values.each_with_index do |name, index|
+      colors[name] = FOREMAN_COLORS[index % FOREMAN_COLORS.length]
+    end
+    colors["system"] = "bright_white"
+    colors
+  end
+
+  def proctitle(title)
+    $0 = title
+  end
+
+  def termtitle(title)
+    printf("\033]0;#{title}\007") unless Foreman.windows?
+  end
+
+end