capistrano-sidekiq 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32880c1c6b9be519c9495ac2c5d96339b1349c0d
-  data.tar.gz: e4957a5475c6b66ca3834c7ebfce013d944df4a1
+  metadata.gz: 26aff29f42bea923b68df1bb882bd0ae1a4289ee
+  data.tar.gz: b512116ee2722510550958339899136abb399958
 SHA512:
-  metadata.gz: '0229b5c4bdcc2504750737b61c8cc1960ff5f1e45f1d0ef19e61a38678862530ef0f1ae563bbc16d93e3be1a23ee0e0ae86c8d348de93c37f52d1b4ed6907883'
-  data.tar.gz: 651c4e097370eb64cf1a5a695982783522a8804a3a1282552e75a56e36b2fc43e89d59493e77b320abf46a4ca28053d67de8bc951b409371faa97d8ed7785bc4
+  metadata.gz: 8b8b90a8bfd058f771270b665bf6c76d43a99312f85ce64ffaf8e6ae01ce14e3f6029f1831f99cb9cf6df926df2ce4c9bade86ee6283a06b1093f9e426d0db05
+  data.tar.gz: 6ab3ce241dcc7d8c66ee5e017290187b7d8ed6afc8198c416262c5f3d48d17012d3d970db8a5f4a85773566ed009b0924618a3b28031903470bae19759e428f6

data/CHANGELOG.md

@@ -1,11 +1,20 @@
 # Changelog
 
+## 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 +26,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 +52,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

@@ -59,11 +59,22 @@ Configurable options, shown here with defaults:
 :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
 ```
 
+## 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
+SSHKit.config.command_map[:sidekiq] = "bundle exec sidekiq"
+SSHKit.config.command_map[:sidekiqctl] = "bundle exec sidekiqctl"
+```
+
 ## Multiple processes
 
 You can configure sidekiq to start with multiple processes. Just set the proper amount in `sidekiq_processes`.
@@ -89,6 +100,26 @@ server 'example-small.com', roles: [:sidekiq_small]
 server 'example-big.com', roles: [:sidekiq_big]
 ```
 
+## Integration with systemd
+
+Set init system to systemd in the cap deploy config:
+
+```ruby
+set :init_system, :systemd
+```
+
+Install systemd.service template file and enable the service with:
+
+```
+bundle exec cap sidekiq:install
+```
+
+Default name for the service file is `sidekiq-stage.service`. This can be changed as needed, for example:
+
+```ruby
+set :service_unit_name, "sidekiq-#{fetch(:application)}-#{fetch(:stage)}.service"
+```
+
 ## Customizing the monit sidekiq templates
 
 If you need change some config in redactor, you can

data/lib/capistrano/sidekiq/version.rb

@@ -1,3 +1,3 @@
 module Capistrano
-  SidekiqVERSION = '1.0.0'
+  SidekiqVERSION = '1.0.1'
 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

@@ -6,16 +6,20 @@ namespace :load do
     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_roles, fetch(:sidekiq_role, :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 })
+    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))
+    set :bundle_bins, fetch(:bundle_bins).to_a.concat(%w[sidekiq sidekiqctl])
+    # Init system integration
+    set :init_system, -> { nil }
+    # systemd integration
+    set :service_unit_name, "sidekiq-#{fetch(:stage)}.service"
   end
 end
 
@@ -26,6 +30,9 @@ namespace :deploy do
   after :publishing, :restart_sidekiq do
     invoke 'sidekiq:restart' if fetch(:sidekiq_default_hooks)
   end
+  after :failed, :restart_sidekiq do
+    invoke 'sidekiq:restart' if fetch(:sidekiq_default_hooks)
+  end
 end
 
 namespace :sidekiq do
@@ -40,10 +47,15 @@ namespace :sidekiq do
   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)
+        case fetch(:init_system)
+        when :systemd
+          execute :systemctl, "--user", "reload", fetch(:service_unit_name), raise_on_non_zero_exit: false
+        else
+          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
@@ -55,10 +67,15 @@ namespace :sidekiq do
   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)
+        case fetch(:init_system)
+        when :systemd
+          execute :systemctl, "--user", "stop", fetch(:service_unit_name)
+        else
+          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
@@ -70,9 +87,14 @@ namespace :sidekiq do
   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)
+        case fetch(:init_system)
+        when :systemd
+          execute :systemctl, '--user', 'start', fetch(:service_unit_name)
+        else
+          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
@@ -89,7 +111,7 @@ namespace :sidekiq do
   task :rolling_restart do
     on roles fetch(:sidekiq_roles) do |role|
       switch_user(role) do
-        each_process_with_index(true) do |pid_file, idx|
+        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
@@ -103,11 +125,10 @@ namespace :sidekiq do
   task :cleanup do
     on roles fetch(:sidekiq_roles) do |role|
       switch_user(role) do
-        each_process_with_index do |pid_file, idx|
+        each_process_with_index do |pid_file, _idx|
           unless process_exists?(pid_file)
-            if pid_file_exists?(pid_file)
-              execute "rm #{pid_file}"
-            end
+            next unless pid_file_exists?(pid_file)
+            execute "rm #{pid_file}"
           end
         end
       end
@@ -121,26 +142,71 @@ namespace :sidekiq 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)
-            start_sidekiq(pid_file, idx)
-          end
+          start_sidekiq(pid_file, idx) unless pid_file_exists?(pid_file)
+        end
+      end
+    end
+  end
+
+  task :install do
+    on roles fetch(:sidekiq_roles) do |role|
+      switch_user(role) do
+        case fetch(:init_system)
+        when :systemd
+          create_systemd_template
+          execute :systemctl, "--user", "enable", fetch(:service_unit_name)
+        end
+      end
+    end
+  end
+
+  task :uninstall do
+    on roles fetch(:sidekiq_roles) do |role|
+      switch_user(role) do
+        case fetch(:init_system)
+        when :systemd
+          execute :systemctl, "--user", "disable", fetch(:service_unit_name)
+          execute :rm, File.join(fetch(:service_unit_path, fetch_systemd_unit_path),fetch(:service_unit_name))
         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|
+    pid_file_list = pid_files
+    pid_file_list.reverse! if reverse
+    pid_file_list.each_with_index do |pid_file, idx|
       within release_path do
         yield(pid_file, idx)
       end
     end
   end
 
+  def fetch_systemd_unit_path
+    home_dir = capture :pwd
+    File.join(home_dir, ".config", "systemd", "user")
+  end
+
+  def create_systemd_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)
+    systemd_path = fetch(:service_unit_path, fetch_systemd_unit_path)
+    execute :mkdir, "-p", systemd_path
+    upload!(
+      StringIO.new(ERB.new(template).result(binding)),
+      "#{systemd_path}/#{fetch :service_unit_name}"
+    )
+    execute :systemctl, "--user", "daemon-reload"
+  end
+
   def pid_files
-    sidekiq_roles = Array(fetch(:sidekiq_roles))
+    sidekiq_roles = Array(fetch(:sidekiq_roles)).dup
     sidekiq_roles.select! { |role| host.roles.include?(role) }
     sidekiq_roles.flat_map do |role|
       processes = fetch(:"#{ role }_processes") || fetch(:sidekiq_processes)
@@ -158,7 +224,7 @@ namespace :sidekiq do
 
   def quiet_sidekiq(pid_file)
     begin
-      execute :sidekiqctl, 'quiet', "#{pid_file}"
+      execute :sidekiqctl, 'quiet', pid_file.to_s
     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)'
@@ -166,7 +232,7 @@ namespace :sidekiq do
   end
 
   def stop_sidekiq(pid_file)
-    execute :sidekiqctl, 'stop', "#{pid_file}", fetch(:sidekiq_timeout)
+    execute :sidekiqctl, 'stop', pid_file.to_s, fetch(:sidekiq_timeout)
   end
 
   def start_sidekiq(pid_file, idx = 0)
@@ -182,7 +248,7 @@ namespace :sidekiq do
     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)
+    if (process_options = fetch(:sidekiq_options_per_process))
       args.push process_options[idx]
     end
     # use sidekiq_options for special options
@@ -198,13 +264,13 @@ namespace :sidekiq do
     execute :sidekiq, args.compact.join(' ')
   end
 
-  def switch_user(role, &block)
+  def switch_user(role)
     su_user = sidekiq_user(role)
     if su_user == role.user
-      block.call
+      yield
     else
       as su_user do
-        block.call
+        yield
       end
     end
   end
@@ -212,8 +278,8 @@ namespace :sidekiq do
   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
+      fetch(:sidekiq_user) ||
+      properties.fetch(:run_as) || # global property across multiple capistrano gems
+      role.user
   end
 end

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

@@ -0,0 +1,19 @@
+[Unit]
+Description=sidekiq for <%= "#{fetch(:application)} (#{fetch(:stage)})" %>
+After=syslog.target network.target
+
+[Service]
+Type=simple
+Environment=RAILS_ENV=<%= fetch(:rails_env) %>
+WorkingDirectory=<%= fetch(:deploy_to) %>/current
+ExecStart=<%= fetch(:bundler_path, '/usr/local/bin/bundler') %> exec sidekiq -e <%= fetch(:rails_env) %>
+ExecReload=/bin/kill -TSTP $MAINPID
+ExecStop=/bin/kill -TERM $MAINPID
+
+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: 1.0.1
 platform: ruby
 authors:
 - Abdelkader Boudih
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2018-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -61,6 +61,7 @@ files:
 - lib/capistrano/tasks/sidekiq.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
@@ -81,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Sidekiq integration for Capistrano