capistrano3-puma 3.1.1 → 5.2.0

data/lib/capistrano/puma/systemd.rb

@@ -0,0 +1,58 @@
+module Capistrano
+  class Puma::Systemd < Capistrano::Plugin
+    include PumaCommon
+
+    def register_hooks
+      after 'deploy:finished', 'puma:smart_restart'
+    end
+
+    def define_tasks
+      eval_rakefile File.expand_path('../../tasks/systemd.rake', __FILE__)
+    end
+
+    def set_defaults
+      set_if_empty :puma_systemctl_bin, '/bin/systemctl'
+      set_if_empty :puma_service_unit_name, -> { "puma_#{fetch(:application)}_#{fetch(:stage)}" }
+      set_if_empty :puma_enable_socket_service, -> { false }
+      set_if_empty :puma_systemctl_user, :system
+      set_if_empty :puma_enable_lingering, -> { fetch(:puma_systemctl_user) != :system }
+      set_if_empty :puma_lingering_user, -> { fetch(:user) }
+      set_if_empty :puma_phased_restart, -> { false }
+    end
+
+    def expanded_bundle_command
+      backend.capture(:echo, SSHKit.config.command_map[:bundle]).strip
+    end
+
+    def fetch_systemd_unit_path
+      if fetch(:puma_systemctl_user) == :system
+        "/etc/systemd/system/"
+      else
+        home_dir = backend.capture :pwd
+        File.join(home_dir, ".config", "systemd", "user")
+      end
+    end
+
+    def systemd_command(*args)
+      command = [fetch(:puma_systemctl_bin)]
+
+      unless fetch(:puma_systemctl_user) == :system
+        command << "--user"
+      end
+
+      command + args
+    end
+
+    def sudo_if_needed(*command)
+      if fetch(:puma_systemctl_user) == :system
+        backend.sudo command.map(&:to_s).join(" ")
+      else
+        backend.execute(*command)
+      end
+    end
+
+    def execute_systemd(*args)
+      sudo_if_needed(*systemd_command(*args))
+    end
+  end
+end

data/lib/capistrano/puma/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Capistrano
-  PUMAVERSION = '3.1.1'
+  PUMAVERSION = '5.2.0'
 end

data/lib/capistrano/puma.rb

@@ -1,5 +1,5 @@
 require 'capistrano/bundler'
-require "capistrano/plugin"
+require 'capistrano/plugin'
 
 module Capistrano
   module PumaCommon
@@ -28,8 +28,7 @@ module Capistrano
       end.join("\n")
     end
 
-
-    def template_puma(from, to, role)
+    def compiled_template_puma(from, role)
       @role = role
       file = [
           "lib/capistrano/templates/#{from}-#{role.hostname}-#{fetch(:stage)}.rb",
@@ -45,7 +44,50 @@ module Capistrano
           File.expand_path("../templates/#{from}.rb.erb", __FILE__)
       ].detect { |path| File.file?(path) }
       erb = File.read(file)
-      backend.upload! StringIO.new(ERB.new(erb, nil, '-').result(binding)), to
+      StringIO.new(ERB.new(erb, nil, '-').result(binding))
+    end
+
+    def template_puma(from, to, role)
+      backend.upload! compiled_template_puma(from, role), to
+    end
+
+    PumaBind = Struct.new(:full_address, :kind, :address) do
+      def unix?
+        kind == :unix
+      end
+
+      def ssl?
+        kind == :ssl
+      end
+
+      def tcp
+        kind == :tcp || ssl?
+      end
+
+      def local
+        if unix?
+          self
+        else
+          PumaBind.new(
+            localize_address(full_address),
+            kind,
+            localize_address(address)
+          )
+        end
+      end
+
+      private
+
+      def localize_address(address)
+        address.gsub(/0\.0\.0\.0(.+)/, "127.0.0.1\\1")
+      end
+    end
+
+    def puma_binds
+      Array(fetch(:puma_bind)).map do |m|
+        etype, address  = /(tcp|unix|ssl):\/{1,2}(.+)/.match(m).captures
+        PumaBind.new(m, etype.to_sym, address)
+      end
     end
   end
 
@@ -76,6 +118,7 @@ module Capistrano
       set_if_empty :puma_preload_app, false
       set_if_empty :puma_daemonize, false
       set_if_empty :puma_tag, ''
+      set_if_empty :puma_restart_command, 'bundle exec puma'
 
       # Chruby, Rbenv and RVM integration
       append :chruby_map_bins, 'puma', 'pumactl'
@@ -88,7 +131,6 @@ module Capistrano
 
     def register_hooks
       after 'deploy:check', 'puma:check'
-      after 'deploy:finished', 'puma:smart_restart'
     end
 
     def puma_workers
@@ -116,6 +158,8 @@ module Capistrano
 end
 
 require 'capistrano/puma/workers'
+require 'capistrano/puma/daemon'
+require 'capistrano/puma/systemd'
 require 'capistrano/puma/monit'
 require 'capistrano/puma/jungle'
 require 'capistrano/puma/nginx'

data/lib/capistrano/tasks/daemon.rake

@@ -0,0 +1,74 @@
+git_plugin = self
+
+namespace :puma do
+  desc 'Start puma'
+  task :start do
+    on roles(fetch(:puma_role)) do |role|
+      git_plugin.puma_switch_user(role) do
+        if test "[ -f #{fetch(:puma_pid)} ]" and test :kill, "-0 $( cat #{fetch(:puma_pid)} )"
+          info 'Puma is already running'
+        else
+          within current_path do
+            with rack_env: fetch(:puma_env) do
+              execute :puma, "-C #{fetch(:puma_conf)} --daemon"
+            end
+          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
+          git_plugin.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
+          git_plugin.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 :smart_restart do
+    if !fetch(:puma_preload_app) && fetch(:puma_workers, 0).to_i > 1
+      invoke 'puma:phased-restart'
+    else
+      invoke 'puma:restart'
+    end
+  end
+end

data/lib/capistrano/tasks/jungle.rake

@@ -39,7 +39,7 @@ namespace :puma do
     task :add do
       on roles(fetch(:puma_role)) do|role|
         begin
-          sudo "/etc/init.d/puma add '#{current_path}' #{fetch(:puma_user, role.user)}"
+          sudo "/etc/init.d/puma add '#{current_path}' #{fetch(:puma_user, role.user)} '#{fetch(:puma_conf)}'"
         rescue => error
           warn error
         end

data/lib/capistrano/tasks/nginx.rake

@@ -11,4 +11,12 @@ namespace :puma do
       end
     end
   end
+
+  desc 'Generate nginx configuration locally'
+  task :generate_nginx_config_locally do
+    fake_role = Struct.new(:hostname)
+    run_locally do
+      File.write('nginx.conf', git_plugin.compiled_template_puma("nginx_conf", fake_role.new("example.com")).string)
+    end
+  end
 end

data/lib/capistrano/tasks/puma.rake

@@ -8,75 +8,6 @@ namespace :puma do
     end
   end
 
-  desc 'Start puma'
-  task :start do
-    on roles(fetch(:puma_role)) do |role|
-      git_plugin.puma_switch_user(role) do
-        if test "[ -f #{fetch(:puma_conf)} ]"
-          info "using conf file #{fetch(:puma_conf)}"
-        else
-          invoke 'puma:config'
-        end
-
-        if test "[ -f #{fetch(:puma_pid)} ]" and test :kill, "-0 $( cat #{fetch(:puma_pid)} )"
-          info 'Already Puma is running'
-        else
-          within current_path do
-            with rack_env: fetch(:puma_env) do
-              execute :puma, "-C #{fetch(:puma_conf)} --daemon"
-            end
-          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
-          git_plugin.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
-          git_plugin.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
@@ -87,14 +18,4 @@ namespace :puma do
       end
     end
   end
-
-
-  task :smart_restart do
-    if !git_plugin.puma_preload_app? && git_plugin.puma_workers.to_i > 1
-      invoke 'puma:phased-restart'
-    else
-      invoke 'puma:restart'
-    end
-  end
-
 end

data/lib/capistrano/tasks/systemd.rake

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+git_plugin = self
+
+namespace :puma do
+  namespace :systemd do
+    desc 'Config Puma systemd service'
+    task :config do
+      on roles(fetch(:puma_role)) do |role|
+
+        upload_compiled_template = lambda do |template_name, unit_filename|
+          git_plugin.template_puma template_name, "#{fetch(:tmp_dir)}/#{unit_filename}", role
+          systemd_path = fetch(:puma_systemd_conf_dir, git_plugin.fetch_systemd_unit_path)
+          if fetch(:puma_systemctl_user) == :system
+            sudo "mv #{fetch(:tmp_dir)}/#{unit_filename} #{systemd_path}"
+          else
+            execute :mkdir, "-p", systemd_path
+            execute :mv, "#{fetch(:tmp_dir)}/#{unit_filename}", "#{systemd_path}"
+          end
+        end
+
+        upload_compiled_template.call("puma.service", "#{fetch(:puma_service_unit_name)}.service")
+
+        if fetch(:puma_enable_socket_service)
+          upload_compiled_template.call("puma.socket", "#{fetch(:puma_service_unit_name)}.socket")
+        end
+
+        # Reload systemd
+        git_plugin.execute_systemd("daemon-reload")
+      end
+    end
+
+    desc 'Generate service configuration locally'
+    task :generate_config_locally do
+      fake_role = Struct.new(:hostname)
+      run_locally do
+        File.write('puma.service', git_plugin.compiled_template_puma("puma.service", fake_role.new("example.com")).string)
+        if fetch(:puma_enable_socket_service)
+          File.write('puma.socket', git_plugin.compiled_template_puma("puma.socket", fake_role.new("example.com")).string)
+        end
+      end
+    end
+
+    desc 'Enable Puma systemd service'
+    task :enable do
+      on roles(fetch(:puma_role)) do
+        git_plugin.execute_systemd("enable", fetch(:puma_service_unit_name))
+        git_plugin.execute_systemd("enable", fetch(:puma_service_unit_name) + ".socket") if fetch(:puma_enable_socket_service)
+
+        if fetch(:puma_systemctl_user) != :system && fetch(:puma_enable_lingering)
+          execute :loginctl, "enable-linger", fetch(:puma_lingering_user)
+        end
+      end
+    end
+
+    desc 'Disable Puma systemd service'
+    task :disable do
+      on roles(fetch(:puma_role)) do
+        git_plugin.execute_systemd("disable", fetch(:puma_service_unit_name))
+        git_plugin.execute_systemd("disable", fetch(:puma_service_unit_name) + ".socket") if fetch(:puma_enable_socket_service)
+      end
+    end
+
+    desc 'Stop Puma socket via systemd'
+    task :stop_socket do
+      on roles(fetch(:puma_role)) do
+        git_plugin.execute_systemd("stop", fetch(:puma_service_unit_name) + ".socket")
+      end
+    end
+
+    desc 'Restart Puma socket via systemd'
+    task :restart_socket do
+      on roles(fetch(:puma_role)) do
+        git_plugin.execute_systemd("restart", fetch(:puma_service_unit_name) + ".socket")
+      end
+    end
+  end
+
+  desc 'Start Puma service via systemd'
+  task :start do
+    on roles(fetch(:puma_role)) do
+      git_plugin.execute_systemd("start", fetch(:puma_service_unit_name))
+    end
+  end
+
+  desc 'Stop Puma service via systemd'
+  task :stop do
+    on roles(fetch(:puma_role)) do
+      git_plugin.execute_systemd("stop", fetch(:puma_service_unit_name))
+    end
+  end
+
+  desc 'Restarts or reloads Puma service via systemd'
+  task :smart_restart do
+    if fetch(:puma_phased_restart)
+      invoke 'puma:reload'
+    else
+      invoke 'puma:restart'
+    end
+  end
+
+  desc 'Restart Puma service via systemd'
+  task :restart do
+    on roles(fetch(:puma_role)) do
+      git_plugin.execute_systemd("restart", fetch(:puma_service_unit_name))
+    end
+  end
+
+  desc 'Reload Puma service via systemd'
+  task :reload do
+    on roles(fetch(:puma_role)) do
+      service_ok = if fetch(:puma_systemctl_user) == :system
+        execute("#{fetch(:puma_systemctl_bin)} status #{fetch(:puma_service_unit_name)} > /dev/null", raise_on_non_zero_exit: false)
+      else
+        execute("#{fetch(:puma_systemctl_bin)} --user status #{fetch(:puma_service_unit_name)} > /dev/null", raise_on_non_zero_exit: false)
+      end
+      cmd = 'reload'
+      if !service_ok
+        cmd = 'restart'
+      end
+      if fetch(:puma_systemctl_user) == :system
+        sudo "#{fetch(:puma_systemctl_bin)} #{cmd} #{fetch(:puma_service_unit_name)}"
+      else
+        execute "#{fetch(:puma_systemctl_bin)}", "--user", cmd, fetch(:puma_service_unit_name)
+      end
+    end
+  end
+
+  desc 'Get Puma service status via systemd'
+  task :status do
+    on roles(fetch(:puma_role)) do
+      git_plugin.execute_systemd("status", fetch(:puma_service_unit_name))
+      git_plugin.execute_systemd("status", fetch(:puma_service_unit_name) + ".socket") if fetch(:puma_enable_socket_service)
+    end
+  end
+end

data/lib/capistrano/templates/nginx_conf.erb

@@ -1,12 +1,11 @@
 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)};"
+  @backends = puma_binds.map do |bind|
+     if bind.unix?
+       "server unix:#{bind.address} #{fetch(:nginx_socket_flags)};"
+     else
+       "server #{bind.local.address} #{fetch(:nginx_http_flags)};"
+     end
   end
-end
 %><% @backends.each do |server| %>
   <%= server %><% end %>
 }
@@ -20,8 +19,11 @@ server {
 
 server {
 <% if fetch(:nginx_use_ssl) -%>
-  listen 443;
-  ssl on;
+  <% if fetch(:nginx_use_http2) -%>
+  listen 443 ssl http2;
+  <% else -%>
+  listen 443 ssl;
+  <% end -%>
 <% if fetch(:nginx_ssl_certificate) -%>
   ssl_certificate <%= fetch(:nginx_ssl_certificate) %>;
 <% else -%>
@@ -46,7 +48,9 @@ server {
   error_page 503 @503;
 
   location @puma_<%= fetch(:nginx_config_name) %> {
+    proxy_http_version 1.1;
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header X-Forwarded-Proto $scheme;
     proxy_set_header Host $host;
     proxy_redirect off;
     proxy_set_header Upgrade $http_upgrade;
@@ -54,7 +58,11 @@ server {
 <% if fetch(:nginx_use_ssl) -%>
     proxy_set_header X-Forwarded-Proto https;
 <% else -%>
+  <% if fetch(:nginx_downstream_uses_ssl) -%>
+    proxy_set_header X-Forwarded-Proto https;
+  <% else -%>
     proxy_set_header X-Forwarded-Proto http;
+  <% end -%>
 <% end -%>
     proxy_pass http://puma_<%= fetch(:nginx_config_name) %>;
     # limit_req zone=one;

data/lib/capistrano/templates/puma.rb.erb

@@ -28,6 +28,8 @@ worker_timeout <%= fetch(:puma_worker_timeout).to_i %>
 daemonize
 <% end %>
 
+restart_command '<%= fetch(:puma_restart_command) %>'
+
 <% if puma_preload_app? %>
 preload_app!
 <% else %>

data/lib/capistrano/templates/puma.service.erb

@@ -0,0 +1,28 @@
+[Unit]
+Description=Puma HTTP Server for <%= "#{fetch(:application)} (#{fetch(:stage)})" %>
+After=network.target
+<%= "Requires=#{fetch(:puma_service_unit_name)}.socket" if fetch(:puma_enable_socket_service) %>
+
+[Service]
+Type=simple
+<%="User=#{puma_user(@role)}" if fetch(:puma_systemctl_user) == :system %>
+WorkingDirectory=<%= current_path %>
+# Support older bundler versions where file descriptors weren't kept
+# See https://github.com/rubygems/rubygems/issues/3254
+ExecStart=<%= expanded_bundle_command %> exec --keep-file-descriptors puma -C <%= fetch(:puma_conf) %>
+ExecReload=/bin/kill -USR1 $MAINPID
+StandardOutput=append:<%= fetch(:puma_access_log) %>
+StandardError=append:<%= fetch(:puma_error_log) %>
+<%="EnvironmentFile=#{fetch(:puma_service_unit_env_file)}" if fetch(:puma_service_unit_env_file) %>
+
+<% fetch(:puma_service_unit_env_vars, []).each do |environment_variable| %>
+<%="Environment=#{environment_variable}" %>
+<% end %>
+
+Restart=always
+RestartSec=1
+
+SyslogIdentifier=puma
+
+[Install]
+WantedBy=<%=(fetch(:puma_systemctl_user) == :system) ? "multi-user.target" : "default.target"%>

data/lib/capistrano/templates/puma.socket.erb

@@ -0,0 +1,22 @@
+[Unit]
+Description=Puma HTTP Server Accept Sockets for <%= "#{fetch(:application)} (#{fetch(:stage)})" %>
+
+[Socket]
+<% puma_binds.each do |bind| -%>
+<%= "ListenStream=#{bind.local.address}" %>
+<% end -%>
+
+# Don't let systemd accept the request, wait for Puma to do that.
+# Systemd will start the puma service upon first request if it wasn't started.
+#
+# You might also want to set your Nginx upstream to have a fail_timeout large enough to accomodate your app's
+# startup time.
+Accept=no
+<%= "NoDelay=true" if fetch(:puma_systemctl_user) == :system %>
+ReusePort=true
+Backlog=1024
+
+SyslogIdentifier=puma_socket
+
+[Install]
+WantedBy=sockets.target

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano3-puma
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 5.2.0
 platform: ruby
 authors:
 - Abdelkader Boudih
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-07-04 00:00:00.000000000 Z
+date: 2021-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -42,16 +42,22 @@ dependencies:
   name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '6.0'
 description: Puma integration for Capistrano 3
 email:
 - Terminale@gmail.com
@@ -59,6 +65,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/stale.yml"
 - ".gitignore"
 - CHANGELOG.md
 - CONTRIBUTORS.md
@@ -68,20 +75,26 @@ files:
 - Rakefile
 - capistrano3-puma.gemspec
 - lib/capistrano/puma.rb
+- lib/capistrano/puma/daemon.rb
 - lib/capistrano/puma/jungle.rb
 - lib/capistrano/puma/monit.rb
 - lib/capistrano/puma/nginx.rb
+- lib/capistrano/puma/systemd.rb
 - lib/capistrano/puma/version.rb
 - lib/capistrano/puma/workers.rb
+- lib/capistrano/tasks/daemon.rake
 - lib/capistrano/tasks/jungle.rake
 - lib/capistrano/tasks/monit.rake
 - lib/capistrano/tasks/nginx.rake
 - lib/capistrano/tasks/puma.rake
+- lib/capistrano/tasks/systemd.rake
 - lib/capistrano/tasks/workers.rake
 - lib/capistrano/templates/nginx_conf.erb
 - lib/capistrano/templates/puma-deb.erb
 - lib/capistrano/templates/puma-rpm.erb
 - lib/capistrano/templates/puma.rb.erb
+- lib/capistrano/templates/puma.service.erb
+- lib/capistrano/templates/puma.socket.erb
 - lib/capistrano/templates/puma_monit.conf.erb
 - lib/capistrano/templates/run-puma.erb
 - lib/capistrano3-puma.rb
@@ -107,9 +120,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Puma integration for Capistrano
 test_files: []