capistrano-sidekiq 1.0.0 → 2.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 32880c1c6b9be519c9495ac2c5d96339b1349c0d
-  data.tar.gz: e4957a5475c6b66ca3834c7ebfce013d944df4a1
+SHA256:
+  metadata.gz: 91c3f4102ef3615f03a48a556d88c44ab661d261b9a3de0c1ac64c8bfcbe8b8e
+  data.tar.gz: cad9284e68f38ef297e68e243ae3c986d1952e09113ecbd859336447a878ac6b
 SHA512:
-  metadata.gz: '0229b5c4bdcc2504750737b61c8cc1960ff5f1e45f1d0ef19e61a38678862530ef0f1ae563bbc16d93e3be1a23ee0e0ae86c8d348de93c37f52d1b4ed6907883'
-  data.tar.gz: 651c4e097370eb64cf1a5a695982783522a8804a3a1282552e75a56e36b2fc43e89d59493e77b320abf46a4ca28053d67de8bc951b409371faa97d8ed7785bc4
+  metadata.gz: ce5c062014f43fbc0412fb1fdbb2624f3c4782bc63bb81b016c653cea4ad35bcbc7b6a9c62cc7e8d05b79a41c4eb77b3cbd9a49f6d68ea7748ebc60152587952
+  data.tar.gz: 6060d3d29376741acb8ceef5371fedaa6cf9473a05fd66f84fb348eca61ce5154f39ab402de3f4a44aefd6d3c220022382414541d98c050706039b9f3e24cf89

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 .idea
+*.iml

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.6.5

data/CHANGELOG.md

@@ -1,11 +1,27 @@
 # Changelog
 
+## 1.0.3
+- Add upstart support
+- Fix monit service name
+
+## 1.0.2
+- Fix deployment flow hooks
+
+## 1.0.1
+- Add deploy failure handling @phillbaker
+- Support custom monit filename @zocoi
+- Systemd Integration @baierjan
+- Fix regression in sidekiq_roles variable
+- Fixed pidfile accounting per process @jsantos
+- Rubocop corrections for main task @jsantos
+
 ## 1.0.0
 
 - Prepend underscore before service name index @Tensho
 - Convert CHANGELOG to Markdown @Tensho
 - Drop support for capistrano 2.0 @Tensho
 - *BREAKING CHANGE* If people used custom monit template, they should adjust it to use pid_files variable instead of processes_pids. @Tensho
+- *BREAKING CHANGE* `:sidekiq_role` has been renamed to its plural form, `:sidekiq_roles`
 
 ## 0.20.0
 
@@ -17,21 +33,21 @@
 - `sidekiq:stop` task perpertually callable @Tensho
 
 ## 0.5.4
- 
+
  - Add support for custom count of processes per host in monit task @okoriko
- 
+
 ## 0.5.3
- 
+
  - Custom count of processes per each host
- 
+
 ## 0.5.0
- 
+
  - Multiple processes @mrsimo
- 
+
 ## 0.3.9
- 
+
  - Restore daemon flag from Monit template
- 
+
 ## 0.3.8
 
 - Update monit template: use su instead of sudo / permit all Sidekiq options @bensie
@@ -43,59 +59,59 @@
 - Run Sidekiq as daemon from Monit @dpaluy
 
 ## 0.3.5
- 
+
 - Added `:sidekiq_tag` for capistrano 2 @OscarBarrett
- 
+
 ## 0.3.4
- 
+
 - Fix bug in `sidekiq:start` for capistrano 2 task
- 
+
 ## 0.3.3
- 
+
 - `sidekiq:restart` after `deploy:restart` added to default hooks
- 
+
 ## 0.3.2
- 
+
 - `:sidekiq_queue` accept an array
- 
+
 ## 0.3.1
- 
+
 - Fix logs @rottman
 - Add concurrency option support @ungsophy
- 
+
 ## 0.3.0
- 
+
 - Fix monit task @andreygerasimchuk
- 
+
 ## 0.2.9
- 
+
 - Check if current directory exist @alexdunae
- 
+
 ## 0.2.8
- 
+
 - Added `:sidekiq_queue` & `:sidekiq_config`
- 
+
 ## 0.2.7
- 
+
 - Signal usage @penso
- 
+
 ## 0.2.6
- 
+
 - `sidekiq:start` check if sidekiq is running
- 
+
 ## 0.2.5
- 
+
 - Bug fixes
- 
+
 ## 0.2.4
- 
+
 - Fast deploy with `:sidekiq_run_in_background`
- 
+
 ## 0.2.3
- 
+
 - Added monit tasks (alpha)
- 
+
 ## 0.2.0
- 
+
 - Added `sidekiq:rolling_restart` @jlecour
- 
+

data/README.md

@@ -1,5 +1,4 @@
 [![Gem Version](https://badge.fury.io/rb/capistrano-sidekiq.svg)](http://badge.fury.io/rb/capistrano-sidekiq)
-[![Dependency Status](https://gemnasium.com/seuros/capistrano-sidekiq.svg)](https://gemnasium.com/seuros/capistrano-sidekiq)
 
 # Capistrano::Sidekiq
 
@@ -7,12 +6,6 @@ Sidekiq integration for Capistrano
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-    gem 'capistrano-sidekiq', github: 'seuros/capistrano-sidekiq'
-
-or:
-
     gem 'capistrano-sidekiq', group: :development
 
 And then execute:
@@ -22,29 +15,28 @@ And then execute:
 
 ## Usage
 ```ruby
-# Capfile
-require 'capistrano/sidekiq'
-require 'capistrano/sidekiq/monit' #to require monit tasks # Only for capistrano3
+    # Capfile
+
+    require 'capistrano/sidekiq'
+    install_plugin Capistrano::Sidekiq  # Default sidekiq tasks
+    # Then select your service manager
+    install_plugin Capistrano::Sidekiq::Systemd 
+    # or  
+    install_plugin Capistrano::Sidekiq::Upstart  # tests needed
+    # or  
+    install_plugin Capistrano::Sidekiq::Monit  # tests needed
 ```
 
 
 Configurable options, shown here with defaults:
 
 ```ruby
+:sidekiq_roles => :app
 :sidekiq_default_hooks => true
 :sidekiq_pid => File.join(shared_path, 'tmp', 'pids', 'sidekiq.pid') # ensure this path exists in production before deploying.
 :sidekiq_env => fetch(:rack_env, fetch(:rails_env, fetch(:stage)))
 :sidekiq_log => File.join(shared_path, 'log', 'sidekiq.log')
-:sidekiq_options => nil
-:sidekiq_require => nil
-:sidekiq_tag => nil
-:sidekiq_config => nil # if you have a config/sidekiq.yml, do not forget to set this. 
-:sidekiq_queue => nil
-:sidekiq_timeout => 10
-:sidekiq_roles => :app
-:sidekiq_processes => 1
-:sidekiq_options_per_process => nil
-:sidekiq_concurrency => nil
+
 # sidekiq monit
 :sidekiq_monit_templates_path => 'config/deploy/templates'
 :sidekiq_monit_conf_dir => '/etc/monit/conf.d'
@@ -52,42 +44,27 @@ Configurable options, shown here with defaults:
 :monit_bin => '/usr/bin/monit'
 :sidekiq_monit_default_hooks => true
 :sidekiq_monit_group => nil
-:sidekiq_service_name => "sidekiq_#{fetch(:application)}_#{fetch(:sidekiq_env)}" + (index ? "_#{index}" : '') 
+:sidekiq_service_name => "sidekiq_#{fetch(:application)}" 
 
-:sidekiq_cmd => "#{fetch(:bundle_cmd, "bundle")} exec sidekiq" # Only for capistrano2.5
-:sidekiqctl_cmd => "#{fetch(:bundle_cmd, "bundle")} exec sidekiqctl" # Only for capistrano2.5
 :sidekiq_user => nil #user to run sidekiq as
 ```
 
+## Known issues with Capistrano 3
+
 There is a known bug that prevents sidekiq from starting when pty is true on Capistrano 3.
 ```ruby
 set :pty,  false
 ```
 
-## Multiple processes
-
-You can configure sidekiq to start with multiple processes. Just set the proper amount in `sidekiq_processes`.
-
-You can also customize the configuration for every process. If you want to do that, just set
-`sidekiq_options_per_process` with an array of the configuration options that you want in string format.
-This example should boot the first process with the queue `high` and the second one with the queues `default`
-and `low`:
+## Bundler
 
+If you'd like to prepend `bundle exec` to your sidekiq and sidekiqctl calls, modify the SSHKit command maps
+in your deploy.rb file:
 ```ruby
-set :sidekiq_options_per_process, ["--queue high", "--queue default --queue low"]
+SSHKit.config.command_map[:sidekiq] = "bundle exec sidekiq"
+SSHKit.config.command_map[:sidekiqctl] = "bundle exec sidekiqctl"
 ```
 
-## Different number of processes per role
-
-You can configure how many processes you want to run on each host next way:
-
-```ruby
-set :sidekiq_roles, [:sidekiq_small, :sidekiq_big]
-set :sidekiq_small_processes, 1
-set :sidekiq_big_processes, 4
-server 'example-small.com', roles: [:sidekiq_small]
-server 'example-big.com', roles: [:sidekiq_big]
-```
 
 ## Customizing the monit sidekiq templates
 

data/capistrano-sidekiq.gemspec

@@ -18,5 +18,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'capistrano', '>= 3.9.0'
-  spec.add_dependency 'sidekiq', '>= 3.4'
+  spec.add_dependency 'capistrano-bundler'
+  spec.add_dependency 'sidekiq', '>= 6.0'
 end

data/lib/capistrano/sidekiq.rb

@@ -1 +1,29 @@
-load File.expand_path('../tasks/sidekiq.rake', __FILE__)
+require 'capistrano/bundler'
+require "capistrano/plugin"
+
+module Capistrano
+  class Sidekiq < Capistrano::Plugin
+    def define_tasks
+      eval_rakefile File.expand_path('../tasks/sidekiq.rake', __FILE__)
+    end
+
+    def set_defaults
+      set_if_empty :sidekiq_default_hooks, true
+
+      set_if_empty :sidekiq_env, -> { fetch(:rack_env, fetch(:rails_env, fetch(:rake_env, fetch(:stage)))) }
+      set_if_empty :sidekiq_roles, fetch(:sidekiq_role, :app)
+      set_if_empty :sidekiq_log, -> { File.join(shared_path, 'log', 'sidekiq.log') }
+      # Rbenv, Chruby, and RVM integration
+      append :rbenv_map_bins, 'sidekiq', 'sidekiqctl'
+      append :rvm_map_bins, 'sidekiq', 'sidekiqctl'
+      append :chruby_map_bins, 'sidekiq', 'sidekiqctl'
+      # Bundler integration
+      append :bundle_bins, 'sidekiq', 'sidekiqctl'
+    end
+
+  end
+end
+
+require_relative 'sidekiq/systemd'
+require_relative 'sidekiq/upstart'
+require_relative 'sidekiq/monit'

data/lib/capistrano/sidekiq/monit.rb

@@ -1 +1,17 @@
-load File.expand_path('../../tasks/monit.rake', __FILE__)
+module Capistrano
+  class Sidekiq::Monit < Capistrano::Plugin
+    def set_defaults
+      set_if_empty :monit_bin, '/usr/bin/monit'
+      set_if_empty :sidekiq_monit_conf_dir, '/etc/monit/conf.d'
+      set_if_empty :sidekiq_monit_conf_file, -> { "#{sidekiq_service_name}.conf" }
+      set_if_empty :sidekiq_monit_use_sudo, true
+      set_if_empty :sidekiq_monit_default_hooks, true
+      set_if_empty :sidekiq_monit_templates_path, 'config/deploy/templates'
+      set_if_empty :sidekiq_monit_group, nil
+    end
+
+    def define_tasks
+      eval_rakefile File.expand_path('../../tasks/monit.rake', __FILE__)
+    end
+  end
+end

data/lib/capistrano/sidekiq/systemd.rb

@@ -0,0 +1,12 @@
+module Capistrano
+  class Sidekiq::Systemd < Capistrano::Plugin
+    def set_defaults
+      set_if_empty :sidekiq_service_unit_name, 'sidekiq'
+      set_if_empty :sidekiq_service_unit_user, :user # :system
+    end
+
+    def define_tasks
+      eval_rakefile File.expand_path('../../tasks/systemd.rake', __FILE__)
+    end
+  end
+end

data/lib/capistrano/sidekiq/upstart.rb

@@ -0,0 +1,11 @@
+module Capistrano
+  class Sidekiq::Upstart < Capistrano::Plugin
+    def set_defaults
+      set_if_empty :sidekiq_service_unit_name, 'sidekiq'
+    end
+
+    def define_tasks
+      eval_rakefile File.expand_path('../../tasks/upstart.rake', __FILE__)
+    end
+  end
+end

data/lib/capistrano/sidekiq/version.rb

@@ -1,3 +1,3 @@
 module Capistrano
-  SidekiqVERSION = '1.0.0'
+  SidekiqVERSION = '2.0.0.beta2'
 end

data/lib/capistrano/tasks/monit.rake

@@ -1,6 +1,7 @@
 namespace :load do
   task :defaults do
     set :sidekiq_monit_conf_dir, '/etc/monit/conf.d'
+    set :sidekiq_monit_conf_file, -> { "#{sidekiq_service_name}.conf" }
     set :sidekiq_monit_use_sudo, true
     set :monit_bin, '/usr/bin/monit'
     set :sidekiq_monit_default_hooks, true
@@ -31,7 +32,7 @@ namespace :sidekiq do
         @role = role
         upload_sidekiq_template 'sidekiq_monit', "#{fetch(:tmp_dir)}/monit.conf", @role
 
-        mv_command = "mv #{fetch(:tmp_dir)}/monit.conf #{fetch(:sidekiq_monit_conf_dir)}/#{sidekiq_service_name}.conf"
+        mv_command = "mv #{fetch(:tmp_dir)}/monit.conf #{fetch(:sidekiq_monit_conf_dir)}/#{fetch(:sidekiq_monit_conf_file)}"
         sudo_if_needed mv_command
 
         sudo_if_needed "#{fetch(:monit_bin)} reload"

data/lib/capistrano/tasks/sidekiq.rake

@@ -1,219 +1,20 @@
-namespace :load do
-  task :defaults do
-    set :sidekiq_default_hooks, true
-
-    set :sidekiq_pid, -> { File.join(shared_path, 'tmp', 'pids', 'sidekiq.pid') }
-    set :sidekiq_env, -> { fetch(:rack_env, fetch(:rails_env, fetch(:stage))) }
-    set :sidekiq_log, -> { File.join(shared_path, 'log', 'sidekiq.log') }
-    set :sidekiq_timeout, 10
-    set :sidekiq_roles, :app
-    set :sidekiq_processes, 1
-    set :sidekiq_options_per_process, nil
-    set :sidekiq_user, nil
-    # Rbenv, Chruby, and RVM integration
-    set :rbenv_map_bins, fetch(:rbenv_map_bins).to_a.concat(%w(sidekiq sidekiqctl))
-    set :rvm_map_bins, fetch(:rvm_map_bins).to_a.concat(%w(sidekiq sidekiqctl))
-    set :chruby_map_bins, fetch(:chruby_map_bins).to_a.concat(%w{ sidekiq sidekiqctl })
-    # Bundler integration
-    set :bundle_bins, fetch(:bundle_bins).to_a.concat(%w(sidekiq sidekiqctl))
-  end
-end
-
 namespace :deploy do
   before :starting, :check_sidekiq_hooks do
     invoke 'sidekiq:add_default_hooks' if fetch(:sidekiq_default_hooks)
   end
-  after :publishing, :restart_sidekiq do
-    invoke 'sidekiq:restart' if fetch(:sidekiq_default_hooks)
-  end
 end
 
 namespace :sidekiq do
   task :add_default_hooks do
-    after 'deploy:starting',  'sidekiq:quiet'
-    after 'deploy:updated',   'sidekiq:stop'
-    after 'deploy:reverted',  'sidekiq:stop'
+    after 'deploy:starting', 'sidekiq:quiet'
+    after 'deploy:updated', 'sidekiq:stop'
     after 'deploy:published', 'sidekiq:start'
-  end
-
-  desc 'Quiet sidekiq (stop fetching new tasks from Redis)'
-  task :quiet do
-    on roles fetch(:sidekiq_roles) do |role|
-      switch_user(role) do
-        if test("[ -d #{release_path} ]")
-          each_process_with_index(reverse: true) do |pid_file, idx|
-            if pid_file_exists?(pid_file) && process_exists?(pid_file)
-              quiet_sidekiq(pid_file)
-            end
-          end
-        end
-      end
-    end
-  end
-
-  desc 'Stop sidekiq (graceful shutdown within timeout, put unfinished tasks back to Redis)'
-  task :stop do
-    on roles fetch(:sidekiq_roles) do |role|
-      switch_user(role) do
-        if test("[ -d #{release_path} ]")
-          each_process_with_index(reverse: true) do |pid_file, idx|
-            if pid_file_exists?(pid_file) && process_exists?(pid_file)
-              stop_sidekiq(pid_file)
-            end
-          end
-        end
-      end
-    end
-  end
-
-  desc 'Start sidekiq'
-  task :start do
-    on roles fetch(:sidekiq_roles) do |role|
-      switch_user(role) do
-        each_process_with_index do |pid_file, idx|
-          unless pid_file_exists?(pid_file) && process_exists?(pid_file)
-            start_sidekiq(pid_file, idx)
-          end
-        end
-      end
-    end
+    after 'deploy:failed', 'sidekiq:restart'
   end
 
   desc 'Restart sidekiq'
   task :restart do
     invoke! 'sidekiq:stop'
-    invoke 'sidekiq:start'
-  end
-
-  desc 'Rolling-restart sidekiq'
-  task :rolling_restart do
-    on roles fetch(:sidekiq_roles) do |role|
-      switch_user(role) do
-        each_process_with_index(true) do |pid_file, idx|
-          if pid_file_exists?(pid_file) && process_exists?(pid_file)
-            stop_sidekiq(pid_file)
-          end
-          start_sidekiq(pid_file, idx)
-        end
-      end
-    end
-  end
-
-  desc 'Delete any pid file not in use'
-  task :cleanup do
-    on roles fetch(:sidekiq_roles) do |role|
-      switch_user(role) do
-        each_process_with_index do |pid_file, idx|
-          unless process_exists?(pid_file)
-            if pid_file_exists?(pid_file)
-              execute "rm #{pid_file}"
-            end
-          end
-        end
-      end
-    end
-  end
-
-  # TODO: Don't start if all processes are off, raise warning.
-  desc 'Respawn missing sidekiq processes'
-  task :respawn do
-    invoke 'sidekiq:cleanup'
-    on roles fetch(:sidekiq_roles) do |role|
-      switch_user(role) do
-        each_process_with_index do |pid_file, idx|
-          unless pid_file_exists?(pid_file)
-            start_sidekiq(pid_file, idx)
-          end
-        end
-      end
-    end
-  end
-
-  def each_process_with_index(reverse: false)
-    _pid_files = pid_files
-    _pid_files.reverse! if reverse
-    _pid_files.each_with_index do |pid_file, idx|
-      within release_path do
-        yield(pid_file, idx)
-      end
-    end
-  end
-
-  def pid_files
-    sidekiq_roles = Array(fetch(:sidekiq_roles))
-    sidekiq_roles.select! { |role| host.roles.include?(role) }
-    sidekiq_roles.flat_map do |role|
-      processes = fetch(:"#{ role }_processes") || fetch(:sidekiq_processes)
-      Array.new(processes) { |idx| fetch(:sidekiq_pid).gsub(/\.pid$/, "-#{idx}.pid") }
-    end
-  end
-
-  def pid_file_exists?(pid_file)
-    test(*("[ -f #{pid_file} ]").split(' '))
-  end
-
-  def process_exists?(pid_file)
-    test(*("kill -0 $( cat #{pid_file} )").split(' '))
-  end
-
-  def quiet_sidekiq(pid_file)
-    begin
-      execute :sidekiqctl, 'quiet', "#{pid_file}"
-    rescue SSHKit::Command::Failed
-      # If gems are not installed (first deploy) and sidekiq_default_hooks is active
-      warn 'sidekiqctl not found (ignore if this is the first deploy)'
-    end
-  end
-
-  def stop_sidekiq(pid_file)
-    execute :sidekiqctl, 'stop', "#{pid_file}", fetch(:sidekiq_timeout)
-  end
-
-  def start_sidekiq(pid_file, idx = 0)
-    args = []
-    args.push "--index #{idx}"
-    args.push "--pidfile #{pid_file}"
-    args.push "--environment #{fetch(:sidekiq_env)}"
-    args.push "--logfile #{fetch(:sidekiq_log)}" if fetch(:sidekiq_log)
-    args.push "--require #{fetch(:sidekiq_require)}" if fetch(:sidekiq_require)
-    args.push "--tag #{fetch(:sidekiq_tag)}" if fetch(:sidekiq_tag)
-    Array(fetch(:sidekiq_queue)).each do |queue|
-      args.push "--queue #{queue}"
-    end
-    args.push "--config #{fetch(:sidekiq_config)}" if fetch(:sidekiq_config)
-    args.push "--concurrency #{fetch(:sidekiq_concurrency)}" if fetch(:sidekiq_concurrency)
-    if process_options = fetch(:sidekiq_options_per_process)
-      args.push process_options[idx]
-    end
-    # use sidekiq_options for special options
-    args.push fetch(:sidekiq_options) if fetch(:sidekiq_options)
-
-    if defined?(JRUBY_VERSION)
-      args.push '>/dev/null 2>&1 &'
-      warn 'Since JRuby doesn\'t support Process.daemon, Sidekiq will not be running as a daemon.'
-    else
-      args.push '--daemon'
-    end
-
-    execute :sidekiq, args.compact.join(' ')
-  end
-
-  def switch_user(role, &block)
-    su_user = sidekiq_user(role)
-    if su_user == role.user
-      block.call
-    else
-      as su_user do
-        block.call
-      end
-    end
-  end
-
-  def sidekiq_user(role)
-    properties = role.properties
-    properties.fetch(:sidekiq_user) || # local property for sidekiq only
-    fetch(:sidekiq_user) ||
-    properties.fetch(:run_as) || # global property across multiple capistrano gems
-    role.user
+    invoke! 'sidekiq:start'
   end
 end

data/lib/capistrano/tasks/systemd.rake

@@ -0,0 +1,134 @@
+git_plugin = self
+
+namespace :sidekiq do
+  desc 'Quiet sidekiq (stop fetching new tasks from Redis)'
+  task :quiet do
+    on roles fetch(:sidekiq_roles) do |role|
+      git_plugin.switch_user(role) do
+        if fetch(:sidekiq_service_unit_user) == :system
+          execute :sudo, :systemctl, "reload", fetch(:sidekiq_service_unit_name), raise_on_non_zero_exit: false
+        else
+          execute :systemctl, "--user", "reload", fetch(:sidekiq_service_unit_name), raise_on_non_zero_exit: false
+        end
+      end
+    end
+  end
+
+  desc 'Stop sidekiq (graceful shutdown within timeout, put unfinished tasks back to Redis)'
+  task :stop do
+    on roles fetch(:sidekiq_roles) do |role|
+      git_plugin.switch_user(role) do
+        if fetch(:sidekiq_service_unit_user) == :system
+          execute :sudo, :systemctl, "stop", fetch(:sidekiq_service_unit_name)
+        else
+          execute :systemctl, "--user", "stop", fetch(:sidekiq_service_unit_name)
+        end
+      end
+    end
+  end
+
+  desc 'Start sidekiq'
+  task :start do
+    on roles fetch(:sidekiq_roles) do |role|
+      git_plugin.switch_user(role) do
+        if fetch(:sidekiq_service_unit_user) == :system
+          execute :sudo, :systemctl, 'start', fetch(:sidekiq_service_unit_name)
+        else
+          execute :systemctl, '--user', 'start', fetch(:sidekiq_service_unit_name)
+        end
+      end
+    end
+  end
+
+  desc 'Install systemd sidekiq service'
+  task :install do
+    on roles fetch(:sidekiq_roles) do |role|
+      git_plugin.switch_user(role) do
+        git_plugin.create_systemd_template
+        if fetch(:sidekiq_service_unit_user) == :system
+          execute :sudo, :systemctl, "enable", fetch(:sidekiq_service_unit_name)
+        else
+          execute :systemctl, "--user", "enable", fetch(:sidekiq_service_unit_name)
+        end
+      end
+    end
+  end
+
+  desc 'UnInstall systemd sidekiq service'
+  task :uninstall do
+    on roles fetch(:sidekiq_roles) do |role|
+      git_plugin.switch_user(role) do
+        if fetch(:sidekiq_service_unit_user) == :system
+          execute :sudo, :systemctl, "disable", fetch(:sidekiq_service_unit_name)
+        else
+          execute :systemctl, "--user", "disable", fetch(:sidekiq_service_unit_name)
+        end
+        execute :rm, '-f', File.join(fetch(:service_unit_path, fetch_systemd_unit_path), fetch(:sidekiq_service_unit_name))
+      end
+    end
+  end
+
+  desc 'Generate service_locally'
+  task :generate_service_locally do
+    run_locally do
+      File.write('sidekiq', git_plugin.compiled_template)
+    end
+  end
+
+  def fetch_systemd_unit_path
+    if fetch(:sidekiq_service_unit_user) == :system
+      # if the path is not standard `set :service_unit_path`
+      "/etc/systemd/system/"
+    else
+      home_dir = backend.capture :pwd
+      File.join(home_dir, ".config", "systemd", "user")
+    end
+  end
+
+  def compiled_template
+    search_paths = [
+      File.expand_path(
+          File.join(*%w[.. .. .. generators capistrano sidekiq systemd templates sidekiq.service.capistrano.erb]),
+          __FILE__
+      ),
+    ]
+    template_path = search_paths.detect { |path| File.file?(path) }
+    template = File.read(template_path)
+    ERB.new(template).result(binding)
+  end
+
+  def create_systemd_template
+    ctemplate = compiled_template
+    systemd_path = fetch(:service_unit_path, fetch_systemd_unit_path)
+
+    if fetch(:sidekiq_service_unit_user) == :user
+      backend.execute :mkdir, "-p", systemd_path
+    end
+    backend.upload!(
+        StringIO.new(ctemplate),
+        "/tmp/#{fetch :sidekiq_service_unit_name}.service"
+    )
+    if fetch(:sidekiq_service_unit_user) == :system
+      backend.execute :sudo, :mv, "/tmp/#{fetch :sidekiq_service_unit_name}.service", "#{systemd_path}/#{fetch :sidekiq_service_unit_name}.service"
+      backend.execute :sudo, :systemctl, "daemon-reload"
+    else
+      backend.execute :sudo, :mv, "/tmp/#{fetch :sidekiq_service_unit_name}.service", "#{systemd_path}/#{fetch :sidekiq_service_unit_name}.service"
+      backend.execute :systemctl, "--user", "daemon-reload"
+    end
+  end
+
+  def switch_user(role)
+    su_user = sidekiq_user
+    if su_user != role.user
+      yield
+    else
+      as su_user do
+        yield
+      end
+    end
+  end
+
+  def sidekiq_user
+    fetch(:sidekiq_user, fetch(:run_as))
+  end
+end

data/lib/capistrano/tasks/upstart.rake

@@ -0,0 +1,47 @@
+namespace :sidekiq do
+  desc 'Quiet sidekiq (stop fetching new tasks from Redis)'
+  task :quiet do
+    on roles fetch(:sidekiq_roles) do |role|
+      git_plugin.switch_user(role) do
+        sudo :service, fetch(:sidekiq_service_unit_name), :reload
+      end
+    end
+  end
+
+  desc 'Stop sidekiq (graceful shutdown within timeout, put unfinished tasks back to Redis)'
+  task :stop do
+    on roles fetch(:sidekiq_roles) do |role|
+      git_plugin.switch_user(role) do
+        sudo :service, fetch(:sidekiq_service_unit_name), :stop
+      end
+    end
+  end
+
+  desc 'Start sidekiq'
+  task :start do
+    on roles fetch(:sidekiq_roles) do |role|
+      git_plugin.switch_user(role) do
+        sudo :service, fetch(:sidekiq_service_unit_name), :start
+      end
+    end
+  end
+
+  def switch_user(role)
+    su_user = sidekiq_user(role)
+    if su_user == role.user
+      yield
+    else
+      as su_user do
+        yield
+      end
+    end
+  end
+
+  def sidekiq_user(role)
+    properties = role.properties
+    properties.fetch(:sidekiq_user) || # local property for sidekiq only
+        fetch(:sidekiq_user) ||
+        properties.fetch(:run_as) || # global property across multiple capistrano gems
+        role.user
+  end
+end

data/lib/generators/capistrano/sidekiq/monit/templates/sidekiq_monit.conf.erb

@@ -5,6 +5,6 @@ check process <%= sidekiq_service_name(idx) %>
   start program = "/bin/su - <%= sidekiq_user(@role) %> -c 'cd <%= current_path %> && <%= SSHKit.config.command_map[:sidekiq] %> <%= sidekiq_config %> --index <%= idx %> --pidfile <%= pid_file %> --environment <%= fetch(:sidekiq_env) %> <%= sidekiq_concurrency %> <%= sidekiq_logfile %> <%= sidekiq_require %> <%= sidekiq_queues %> <%= sidekiq_options_per_process[idx] %> -d'" with timeout 30 seconds
 
   stop program = "/bin/su - <%= sidekiq_user(@role) %> -c 'cd <%= current_path %> && <%= SSHKit.config.command_map[:sidekiqctl] %> stop <%= pid_file %>'" with timeout <%= fetch(:sidekiq_timeout).to_i + 10  %> seconds
-  group <%= fetch(:sidekiq_monit_group, fetch(:application)) %>-sidekiq
+  group <%= fetch(:sidekiq_monit_group) || fetch(:application) %>-sidekiq
 
 <% end %>

data/lib/generators/capistrano/sidekiq/systemd/templates/sidekiq.service.capistrano.erb

@@ -0,0 +1,24 @@
+[Unit]
+Description=sidekiq for <%= "#{fetch(:application)} (#{fetch(:stage)})" %>
+After=syslog.target network.target
+
+[Service]
+Type=simple
+WorkingDirectory=<%= File.join(fetch(:deploy_to), 'current') %>
+ExecStart=<%= SSHKit.config.command_map[:bundler] %> exec sidekiq -e <%= fetch(:sidekiq_env) %> -l <%= fetch(:sidekiq_log) %>
+ExecReload=/bin/kill -TSTP $MAINPID
+ExecStop=/bin/kill -TERM $MAINPID
+<%="User=#{sidekiq_user}" if sidekiq_user %>
+<%="EnvironmentFile=#{fetch(:sidekiq_service_unit_env_file)}" if fetch(:sidekiq_service_unit_env_file) %>
+
+<% fetch(:sidekiq_service_unit_env_vars, []).each do |environment_variable| %>
+  <%="Environment=#{environment_variable}" %>
+<% end %>
+
+RestartSec=1
+Restart=on-failure
+
+SyslogIdentifier=sidekiq
+
+[Install]
+WantedBy=default.target

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-sidekiq
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0.beta2
 platform: ruby
 authors:
 - Abdelkader Boudih
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2020-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -24,20 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: capistrano-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !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: '3.4'
+        version: '6.0'
 description: Sidekiq integration for Capistrano
 email:
 - terminale@gmail.com
@@ -46,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".tool-versions"
 - CHANGELOG.md
 - CONTRIBUTORS.md
 - Gemfile
@@ -56,11 +71,16 @@ files:
 - lib/capistrano-sidekiq.rb
 - lib/capistrano/sidekiq.rb
 - lib/capistrano/sidekiq/monit.rb
+- lib/capistrano/sidekiq/systemd.rb
+- lib/capistrano/sidekiq/upstart.rb
 - lib/capistrano/sidekiq/version.rb
 - lib/capistrano/tasks/monit.rake
 - lib/capistrano/tasks/sidekiq.rake
+- lib/capistrano/tasks/systemd.rake
+- lib/capistrano/tasks/upstart.rake
 - lib/generators/capistrano/sidekiq/monit/template_generator.rb
 - lib/generators/capistrano/sidekiq/monit/templates/sidekiq_monit.conf.erb
+- lib/generators/capistrano/sidekiq/systemd/templates/sidekiq.service.capistrano.erb
 homepage: https://github.com/seuros/capistrano-sidekiq
 licenses:
 - LGPL-3.0
@@ -76,12 +96,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Sidekiq integration for Capistrano