capistrano-puma-a 2.0.0

data/lib/capistrano/tasks/nginx.rake

@@ -0,0 +1,25 @@
+namespace :load do
+  task :defaults do
+    # Nginx and puma configuration
+    set :nginx_config_name, -> { "#{fetch(:application)}_#{fetch(:stage)}" }
+    set :nginx_sites_available_path, -> { '/etc/nginx/sites-available' }
+    set :nginx_sites_enabled_path, -> { '/etc/nginx/sites-enabled' }
+    set :nginx_server_name, -> { "localhost #{fetch(:application)}.local" }
+    set :nginx_flags, -> { 'fail_timeout=0' }
+    set :nginx_http_flags, -> { fetch(:nginx_flags) }
+    set :nginx_socket_flags, -> { fetch(:nginx_flags) }
+    set :nginx_use_ssl, false
+  end
+end
+namespace :puma do
+  desc 'Setup nginx configuration'
+  task :nginx_config do
+    on roles(fetch(:puma_nginx, :web)) do |role|
+      puma_switch_user(role) do
+        template_puma('nginx_conf', "/tmp/nginx_#{fetch(:nginx_config_name)}", role)
+        sudo :mv, "/tmp/nginx_#{fetch(:nginx_config_name)} #{fetch(:nginx_sites_available_path)}/#{fetch(:nginx_config_name)}"
+        sudo :ln, '-fs', "#{fetch(:nginx_sites_available_path)}/#{fetch(:nginx_config_name)} #{fetch(:nginx_sites_enabled_path)}/#{fetch(:nginx_config_name)}"
+      end
+    end
+  end
+end

data/lib/capistrano/tasks/puma.rake

@@ -0,0 +1,197 @@
+namespace :load do
+  task :defaults do
+    set :puma_default_hooks, -> { true }
+    set :puma_role, :app
+    set :puma_env, -> { fetch(:rack_env, fetch(:rails_env, fetch(:stage))) }
+    # Configure "min" to be the minimum number of threads to use to answer
+    # requests and "max" the maximum.
+    set :puma_threads, [0, 16]
+    set :puma_workers, 0
+    set :puma_rackup, -> { File.join(current_path, 'config.ru') }
+    set :puma_state, -> { File.join(shared_path, 'tmp', 'pids', 'puma.state') }
+    set :puma_pid, -> { File.join(shared_path, 'tmp', 'pids', 'puma.pid') }
+    set :puma_bind, -> { File.join("unix://#{shared_path}", 'tmp', 'sockets', 'puma.sock') }
+    set :puma_default_control_app, -> { File.join("unix://#{shared_path}", 'tmp', 'sockets', 'pumactl.sock') }
+    set :puma_conf, -> { File.join(shared_path, 'puma.rb') }
+    set :puma_access_log, -> { File.join(shared_path, 'log', 'puma_access.log') }
+    set :puma_error_log, -> { File.join(shared_path, 'log', 'puma_error.log') }
+    set :puma_init_active_record, false
+    set :puma_preload_app, false
+
+    # Chruby, Rbenv and RVM integration
+    append :chruby_map_bins, 'puma', 'pumactl'
+    append :rbenv_map_bins, 'puma', 'pumactl'
+    append :rvm_map_bins, 'puma', 'pumactl'
+
+    # Bundler integration
+    append :bundle_bins, 'puma', 'pumactl'
+  end
+end
+
+namespace :deploy do
+  before :starting, :check_puma_hooks do
+    invoke 'puma:add_default_hooks' if fetch(:puma_default_hooks)
+  end
+end
+
+namespace :puma do
+
+  desc 'Setup Puma config file'
+  task :config do
+    on roles(fetch(:puma_role)) do |role|
+      template_puma 'puma', fetch(:puma_conf), role
+    end
+  end
+
+  desc 'Start puma'
+  task :start do
+    on roles (fetch(:puma_role)) do |role|
+      puma_switch_user(role) do
+        if test "[ -f #{fetch(:puma_conf)} ]"
+          info "using conf file #{fetch(:puma_conf)}"
+        else
+          invoke 'puma:config'
+        end
+        within current_path do
+          with rack_env: fetch(:puma_env) do
+            execute :puma, "-C #{fetch(:puma_conf)} --daemon"
+          end
+        end
+      end
+    end
+  end
+
+  %w[halt stop status].map do |command|
+    desc "#{command} puma"
+    task command do
+      on roles (fetch(:puma_role)) do |role|
+        within current_path do
+          puma_switch_user(role) do
+            with rack_env: fetch(:puma_env) do
+              if test "[ -f #{fetch(:puma_pid)} ]"
+                if test :kill, "-0 $( cat #{fetch(:puma_pid)} )"
+                  execute :pumactl, "-S #{fetch(:puma_state)} -F #{fetch(:puma_conf)} #{command}"
+                else
+                  # delete invalid pid file , process is not running.
+                  execute :rm, fetch(:puma_pid)
+                end
+              else
+                #pid file not found, so puma is probably not running or it using another pidfile
+                warn 'Puma not running'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  %w[phased-restart restart].map do |command|
+    desc "#{command} puma"
+    task command do
+      on roles (fetch(:puma_role)) do |role|
+        within current_path do
+          puma_switch_user(role) do
+            with rack_env: fetch(:puma_env) do
+              if test "[ -f #{fetch(:puma_pid)} ]" and test :kill, "-0 $( cat #{fetch(:puma_pid)} )"
+                # NOTE pid exist but state file is nonsense, so ignore that case
+                execute :pumactl, "-S #{fetch(:puma_state)} -F #{fetch(:puma_conf)} #{command}"
+              else
+                # Puma is not running or state file is not present : Run it
+                invoke 'puma:start'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  task :check do
+    on roles (fetch(:puma_role)) do |role|
+      #Create puma.rb for new deployments
+      unless  test "[ -f #{fetch(:puma_conf)} ]"
+        warn 'puma.rb NOT FOUND!'
+        #TODO DRY
+        template_puma 'puma', fetch(:puma_conf), role
+        info 'puma.rb generated'
+      end
+    end
+  end
+
+
+  task :smart_restart do
+    if !puma_preload_app? && puma_workers.to_i > 1
+      invoke 'puma:phased-restart'
+    else
+      invoke 'puma:restart'
+    end
+  end
+
+  def puma_switch_user(role, &block)
+    user = puma_user(role)
+    if user == role.user
+      block.call
+    else
+      as user do
+        block.call
+      end
+    end
+  end
+
+  def puma_user(role)
+    properties = role.properties
+    properties.fetch(:puma_user) ||               # local property for puma only
+    fetch(:puma_user) ||
+    properties.fetch(:run_as) || # global property across multiple capistrano gems
+    role.user
+  end
+
+  def puma_workers
+    fetch(:puma_workers, 0)
+  end
+
+  def puma_preload_app?
+    fetch(:puma_preload_app)
+  end
+
+  def puma_bind
+    Array(fetch(:puma_bind)).collect do |bind|
+      "bind '#{bind}'"
+    end.join("\n")
+  end
+
+  def puma_plugins
+    Array(fetch(:puma_plugins)).collect do |bind|
+      "plugin '#{bind}'"
+    end.join("\n")
+  end
+
+  def template_puma(from, to, role)
+    [
+        "lib/capistrano/templates/#{from}-#{role.hostname}-#{fetch(:stage)}.rb",
+        "lib/capistrano/templates/#{from}-#{role.hostname}.rb",
+        "lib/capistrano/templates/#{from}-#{fetch(:stage)}.rb",
+        "lib/capistrano/templates/#{from}.rb.erb",
+        "lib/capistrano/templates/#{from}.rb",
+        "lib/capistrano/templates/#{from}.erb",
+        "config/deploy/templates/#{from}.rb.erb",
+        "config/deploy/templates/#{from}.rb",
+        "config/deploy/templates/#{from}.erb",
+        File.expand_path("../../templates/#{from}.rb.erb", __FILE__),
+        File.expand_path("../../templates/#{from}.erb", __FILE__)
+    ].each do |path|
+      if File.file?(path)
+        erb = File.read(path)
+        upload! StringIO.new(ERB.new(erb, nil, '-').result(binding)), to
+        break
+      end
+    end
+  end
+
+  task :add_default_hooks do
+    after 'deploy:check', 'puma:check'
+    after 'deploy:finished', 'puma:smart_restart'
+  end
+
+end

data/lib/capistrano/tasks/workers.rake

@@ -0,0 +1,38 @@
+namespace :puma do
+  namespace :workers do
+    desc 'Add a worker'
+    task :count do
+      on roles (fetch(:puma_role)) do |role|
+        puma_switch_user(role) do
+        #TODO
+        # cleanup
+        # add host name/ip
+        workers_count = capture("ps ax | grep -c 'puma: cluster worker: `cat  #{fetch(:puma_pid)}`'").to_i - 1
+        log  "Workers count : #{workers_count}"
+        end
+      end
+    end
+
+    # TODO
+    # Add/remove workers to specific host/s
+    # Define  # of workers to add/remove
+    # Refactor
+    desc 'Worker++'
+    task :more do
+      on roles (fetch(:puma_role)) do |role|
+        puma_switch_user(role) do
+          execute(:kill, "-TTIN `cat  #{fetch(:puma_pid)}`")
+        end
+      end
+    end
+
+    desc 'Worker--'
+    task :less do
+      on roles (fetch(:puma_role)) do |role|
+        puma_switch_user(role) do
+          execute(:kill, "-TTOU `cat  #{fetch(:puma_pid)}`")
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/templates/nginx_conf.erb

@@ -0,0 +1,82 @@
+upstream puma_<%= fetch(:nginx_config_name) %> { <%
+  @backends = [fetch(:puma_bind)].flatten.map do |m|
+  etype, address  = /(tcp|unix|ssl):\/{1,2}(.+)/.match(m).captures
+  if etype == 'unix'
+    "server #{etype}:#{address} #{fetch(:nginx_socket_flags)};"
+  else
+    "server #{address.gsub(/0\.0\.0\.0(.+)/, "127.0.0.1\\1")} #{fetch(:nginx_http_flags)};"
+  end
+end
+%><% @backends.each do |server| %>
+  <%= server %><% end %>
+}
+<% if fetch(:nginx_use_ssl) -%>
+server {
+  listen 80;
+  server_name <%= fetch(:nginx_server_name) %>;
+  rewrite ^(.*) https://$host$1 permanent;
+}
+<% end -%>
+
+server {
+<% if fetch(:nginx_use_ssl) -%>
+  listen 443;
+  ssl on;
+  ssl_certificate /etc/ssl/certs/<%= fetch(:nginx_config_name) %>.crt;
+  ssl_certificate_key /etc/ssl/private/<%= fetch(:nginx_config_name) %>.key;
+<% else -%>
+  listen 80;
+<% end -%>
+  server_name <%= fetch(:nginx_server_name) %>;
+  root <%= current_path %>/public;
+  try_files $uri/index.html $uri @puma_<%= fetch(:nginx_config_name) %>;
+
+  client_max_body_size 4G;
+  keepalive_timeout 10;
+
+  error_page 500 502 504 /500.html;
+  error_page 503 @503;
+
+  location @puma_<%= fetch(:nginx_config_name) %> {
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header Host $http_host;
+    proxy_redirect off;
+<% if fetch(:nginx_use_ssl) -%>
+    proxy_set_header X-Forwarded-Proto https;
+<% end -%>
+    proxy_pass http://puma_<%= fetch(:nginx_config_name) %>;
+    # limit_req zone=one;
+    access_log <%= shared_path %>/log/nginx.access.log;
+    error_log <%= shared_path %>/log/nginx.error.log;
+  }
+
+  location ^~ /assets/ {
+    gzip_static on;
+    expires max;
+    add_header Cache-Control public;
+  }
+
+  location = /50x.html {
+    root html;
+  }
+
+  location = /404.html {
+    root html;
+  }
+
+  location @503 {
+    error_page 405 = /system/maintenance.html;
+    if (-f $document_root/system/maintenance.html) {
+      rewrite ^(.*)$ /system/maintenance.html break;
+    }
+    rewrite ^(.*)$ /503.html break;
+  }
+
+  if ($request_method !~ ^(GET|HEAD|PUT|PATCH|POST|DELETE|OPTIONS)$ ){
+    return 405;
+  }
+
+  if (-f $document_root/system/maintenance.html) {
+    return 503;
+  }
+}

data/lib/capistrano/templates/puma-deb.erb

@@ -0,0 +1,336 @@
+#! /bin/sh
+### BEGIN INIT INFO
+# Provides: puma
+# Required-Start: $remote_fs $syslog
+# Required-Stop: $remote_fs $syslog
+# Default-Start: 2 3 4 5
+# Default-Stop: 0 1 6
+# Short-Description: Example initscript
+# Description: This file should be used to construct scripts to be
+# placed in /etc/init.d.
+### END INIT INFO
+
+# Author: Darío Javier Cravero <'dario@exordo.com'>
+# Modified by: Abdelkader Boudih <'terminale@gmail.com'>
+#
+# Do NOT "set -e"
+
+# PATH should only include /usr/* if it runs after the mountnfs.sh script
+PATH=/usr/local/bin:/usr/local/sbin/:/sbin:/usr/sbin:/bin:/usr/bin
+DESC="Puma rack web server"
+NAME=puma
+DAEMON=$NAME
+SCRIPTNAME=/etc/init.d/$NAME
+CONFIG=<%=fetch(:puma_jungle_conf)%>
+JUNGLE=`cat $CONFIG`
+RUNPUMA=<%=fetch(:puma_run_path)%>
+
+# Load the VERBOSE setting and other rcS variables
+. /lib/init/vars.sh
+
+# Define LSB log_* functions.
+# Depend on lsb-base (>= 3.0-6) to ensure that this file is present.
+. /lib/lsb/init-functions
+
+#
+# Function that starts the jungle
+#
+do_start() {
+  log_daemon_msg "=> Running the jungle..."
+  for i in $JUNGLE; do
+    dir=`echo $i | cut -d , -f 1`
+    user=`echo $i | cut -d , -f 2`
+    config_file=`echo $i | cut -d , -f 3`
+    if [ "$config_file" = "" ]; then
+      config_file="$dir/config/puma.rb"
+    fi
+    log_file=`echo $i | cut -d , -f 4`
+    if [ "$log_file" = "" ]; then
+      log_file="$dir/log/puma.log"
+    fi
+    do_start_one $dir $user $config_file $log_file
+  done
+}
+
+do_start_one() {
+  PIDFILE=$1/tmp/pids/puma.pid
+  if [ -e $PIDFILE ]; then
+    PID=`cat $PIDFILE`
+    # If the puma isn't running, run it, otherwise restart it.
+    if [ "`ps -A -o pid= | grep -c $PID`" -eq 0 ]; then
+      do_start_one_do $1 $2
+    else
+      do_restart_one $1 $2
+    fi
+  else
+    do_start_one_do $1 $2
+  fi
+}
+
+do_start_one_do() {
+  log_daemon_msg "--> Woke up puma $1"
+  log_daemon_msg "user $2"
+  log_daemon_msg "log to $4"
+  log_daemon_msg "start-stop-daemon --verbose --start --chdir $1 --chuid $2 --background --exec $RUNPUMA $1 "
+  start-stop-daemon --verbose --start --chdir $1 --chuid $2 --background --exec $RUNPUMA -- $1
+}
+
+#
+# Function that stops the jungle
+#
+do_stop() {
+  log_daemon_msg "=> Putting all the beasts to bed..."
+  for i in $JUNGLE; do
+    dir=`echo $i | cut -d , -f 1`
+    user=`echo $i | cut -d , -f 2`
+    do_stop_one $dir $user
+  done
+}
+#
+# Function that stops the daemon/service
+#
+do_stop_one() {
+  log_daemon_msg "--> Stopping $1"
+  PIDFILE=$1/tmp/pids/puma.pid
+  STATEFILE=$1/tmp/pids/puma.state
+  if [ -e $PIDFILE ]; then
+    PID=`cat $PIDFILE`
+    if [ "`ps -A -o pid= | grep -c $PID`" -eq 0 ]; then
+      log_daemon_msg "---> Puma $1 isn't running."
+    else
+      log_daemon_msg "---> About to kill PID `cat $PIDFILE`"
+      su - $2 -c "pumactl --state $STATEFILE stop"
+      # Many daemons don't delete their pidfiles when they exit.
+      rm -f $PIDFILE $STATEFILE
+    fi
+  else
+    log_daemon_msg "---> No puma here..."
+  fi
+  return 0
+}
+
+#
+# Function that restarts the jungle
+#
+do_restart() {
+  for i in $JUNGLE; do
+    dir=`echo $i | cut -d , -f 1`
+    user=`echo $i | cut -d , -f 2`
+    do_restart_one $dir $user
+  done
+}
+
+#
+# Function that sends a SIGUSR2 to the daemon/service
+#
+do_restart_one() {
+  PIDFILE=$1/tmp/pids/puma.pid
+  i=`grep $1 $CONFIG`
+  dir=`echo $i | cut -d , -f 1`
+
+  if [ -e $PIDFILE ]; then
+    log_daemon_msg "--> About to restart puma $1"
+    su - $2 -c "pumactl --state $dir/tmp/pids/puma.state restart"
+    # kill -s USR2 `cat $PIDFILE`
+    # TODO Check if process exist
+  else
+    log_daemon_msg "--> Your puma was never playing... Let's get it out there first"
+    user=`echo $i | cut -d , -f 2`
+    config_file=`echo $i | cut -d , -f 3`
+    if [ "$config_file" = "" ]; then
+      config_file="$dir/config/puma.rb"
+      do_start_one $dir $user $config_file
+    fi
+    log_file=`echo $i | cut -d , -f 4`
+    if [ "$log_file" = "" ]; then
+      log_file="$dir/log/puma.log"
+    fi
+    do_start_one $dir $user $config_file $log_file
+  fi
+  return 0
+}
+
+#
+# Function that statuss the jungle
+#
+do_status() {
+  for i in $JUNGLE; do
+    dir=`echo $i | cut -d , -f 1`
+    user=`echo $i | cut -d , -f 2`
+    do_status_one $dir $user
+  done
+}
+
+#
+# Function that sends a SIGUSR2 to the daemon/service
+#
+do_status_one() {
+  PIDFILE=$1/tmp/pids/puma.pid
+  i=`grep $1 $CONFIG`
+  dir=`echo $i | cut -d , -f 1`
+
+  if [ -e $PIDFILE ]; then
+    log_daemon_msg "--> About to status puma $1"
+
+    su - $2 -c "pumactl --state $dir/tmp/pids/puma.state stats "
+
+  else
+    log_daemon_msg "--> $1 isn't there :(..."
+  fi
+  return 0
+}
+
+do_add() {
+  str=""
+  # App's directory
+  if [ -d "$1" ]; then
+    if [ "`grep -c "^$1" $CONFIG`" -eq 0 ]; then
+      str=$1
+    else
+      echo "The app is already being managed. Remove it if you want to update its config."
+      exit 0
+    fi
+  else
+    echo "The directory $1 doesn't exist."
+    exit 1
+  fi
+  # User to run it as
+  if [ "`grep -c "^$2:" /etc/passwd`" -eq 0 ]; then
+    echo "The user $2 doesn't exist."
+    exit 1
+  else
+    str="$str,$2"
+  fi
+  # Config file
+  if [ "$3" != "" ]; then
+    if [ -e $3 ]; then
+      str="$str,$3"
+    else
+      echo "The config file $3 doesn't exist."
+      exit 1
+    fi
+  fi
+  # Log file
+  if [ "$4" != "" ]; then
+    str="$str,$4"
+  fi
+
+  # Add it to the jungle
+  echo $str >> $CONFIG
+  log_daemon_msg "Added a Puma to the jungle: $str. You still have to start it though."
+}
+
+do_remove() {
+  if [ "`grep -c "^$1" $CONFIG`" -eq 0 ]; then
+    echo "There's no app $1 to remove."
+  else
+    # Stop it first.
+    do_stop_one $1
+    # Remove it from the config.
+    sed -i "\\:^$1:d" $CONFIG
+    log_daemon_msg "Removed a Puma from the jungle: $1."
+  fi
+}
+
+case "$1" in
+  start)
+    [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
+    if [ "$#" -eq 1 ]; then
+      do_start
+    else
+      i=`grep $2 $CONFIG`
+      dir=`echo $i | cut -d , -f 1`
+      user=`echo $i | cut -d , -f 2`
+      config_file=`echo $i | cut -d , -f 3`
+      if [ "$config_file" = "" ]; then
+        config_file="$dir/config/puma.rb"
+
+        do_start_one $dir $user $config_file
+      fi
+      case "$?" in
+        0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+        2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+      esac
+    fi
+  ;;
+  stop)
+    [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
+    if [ "$#" -eq 1 ]; then
+      do_stop
+    else
+      i=`grep $2 $CONFIG`
+      dir=`echo $i | cut -d , -f 1`
+      do_stop_one $dir
+    fi
+    case "$?" in
+      0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+      2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+    esac
+  ;;
+  status)
+    # TODO Implement.
+    log_daemon_msg "Status $DESC" "$NAME"
+    if [ "$#" -eq 1 ]; then
+      do_status
+    else
+      i=`grep $2 $CONFIG`
+      dir=`echo $i | cut -d , -f 1`
+      do_status_one $dir
+    fi
+    case "$?" in
+      0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+      2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+    esac
+  ;;
+  restart)
+    log_daemon_msg "Restarting $DESC" "$NAME"
+    if [ "$#" -eq 1 ]; then
+      do_restart
+    else
+      i=`grep $2 $CONFIG`
+      dir=`echo $i | cut -d , -f 1`
+      do_restart_one $dir
+    fi
+    case "$?" in
+      0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+      2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+    esac
+  ;;
+  add)
+    if [ "$#" -lt 3 ]; then
+      echo "Please, specifiy the app's directory and the user that will run it at least."
+      echo " Usage: $SCRIPTNAME add /path/to/app user /path/to/app/config/puma.rb /path/to/app/config/log/puma.log"
+      echo " config and log are optionals."
+      exit 1
+    else
+      do_add $2 $3 $4 $5
+    fi
+    case "$?" in
+      0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+      2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+    esac
+  ;;
+  remove)
+    if [ "$#" -lt 2 ]; then
+      echo "Please, specifiy the app's directory to remove."
+      exit 1
+    else
+      do_remove $2
+    fi
+    case "$?" in
+      0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+      2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+    esac
+  ;;
+  *)
+    echo "Usage:" >&2
+    echo " Run the jungle: $SCRIPTNAME {start|stop|status|restart}" >&2
+    echo " Add a Puma: $SCRIPTNAME add /path/to/app user /path/to/app/config/puma.rb /path/to/app/config/log/puma.log"
+    echo " config and log are optionals."
+    echo " Remove a Puma: $SCRIPTNAME remove /path/to/app"
+    echo " On a Puma: $SCRIPTNAME {start|stop|status|restart} PUMA-NAME" >&2
+    exit 3
+  ;;
+esac
+:
+