capistrano-sidekiq 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b43a2e9a957a57fca9cddeb61fe2dab7f38d5d7f
-  data.tar.gz: bd9d98c7eef3166efa9c1043a06cd138029c3b9a
+  metadata.gz: 32f341ab53e9dfdb15b39d595948a85f9004460e
+  data.tar.gz: f5ff8d829bc7ae25c517605b61805ba6a79c9abe
 SHA512:
-  metadata.gz: 75ded52a6a43fbb98913af4efeaaf5f21ab52e3d6648f48600fda9bf875aa7ba803fc2312e502d3732aa1e5bff82a2210ec778d264603592e657e76860c86623
-  data.tar.gz: 1fdc6a4f79c26271f8a54d2b251b7da90215c97027e97a3ede44ca354c4263624cebca7873bf9cbbe09e85d8300e08d3ba6a79460257249f0599abac38a0e196
+  metadata.gz: 02dd736baaa98223d535075aa3b7ccbb8cbad793b1c309e4206d7b11dfd08ad70d72268ed43b520c5b903612d52463d6b8c543b25f16aca9a09a17e68afaf6bf
+  data.tar.gz: e861c2ff9c05b484e4b2c5111bee3b944dfa203d1cdb7b0a4d96c5c34c97a0406fb8d58ebd490bc59d79dddb618cdc7cae53bf9d3d6e7f9e68275310e37e8c65

data/CONTRIBUTORS.md

@@ -0,0 +1,11 @@
+## Contributors
+
+- [Jérémy Lecour] (https://github.com/jlecour)
+- [Fabien Penso] (https://github.com/penso)
+- [Alex Dunae] (https://github.com/alexdunae)
+- [andreygerasimchuk] (https://github.com/andreygerasimchuk)
+- [Saicheg] (https://github.com/Saicheg)
+- [Alex Yakubenko] (https://github.com/alexyakubenko)
+- [Robert Strobl] (https://github.com/rstrobl)
+- [Eurico Doirado] (https://github.com/okoriko)
+- [Huang Bin](https://github.com/hbin)

data/README.md

@@ -50,9 +50,10 @@ Configurable options, shown here with defaults:
     :sidekiq_monit_use_sudo => true
     :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
 ```
 
-There is a known bug that prevents sidekiq from starting when pty is true
+There is a known bug that prevents sidekiq from starting when pty is true on Capistrano 3.
 ```ruby
 set :pty,  false
 ```
@@ -98,6 +99,7 @@ set :sidekiq_monit_use_sudo, false
 ```
 
 ## Changelog
+- 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
@@ -122,16 +124,6 @@ set :sidekiq_monit_use_sudo, false
 - 0.2.3: Added monit tasks (alpha)
 - 0.2.0: Added sidekiq:rolling_restart - @jlecour
 
-## Contributors
-
-- [Jérémy Lecour] (https://github.com/jlecour)
-- [Fabien Penso] (https://github.com/penso)
-- [Alex Dunae] (https://github.com/alexdunae)
-- [andreygerasimchuk] (https://github.com/andreygerasimchuk)
-- [Saicheg] (https://github.com/Saicheg)
-- [Alex Yakubenko] (https://github.com/alexyakubenko)
-- [Robert Strobl] (https://github.com/rstrobl)
-
 ## Contributing
 
 1. Fork it

data/capistrano-sidekiq.gemspec

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

data/lib/capistrano/sidekiq.rb

@@ -1,5 +1,5 @@
 if Gem::Specification.find_by_name('capistrano').version >= Gem::Version.new('3.0.0')
-  load File.expand_path('../tasks/sidekiq.cap', __FILE__)
+  load File.expand_path('../tasks/sidekiq.rake', __FILE__)
 else
   require_relative 'tasks/capistrano2'
 end

data/lib/capistrano/sidekiq/monit.rb

@@ -1,2 +1,2 @@
 # load monit tasks
-load File.expand_path('../../tasks/monit.cap', __FILE__)
+load File.expand_path('../../tasks/monit.rake', __FILE__)

data/lib/capistrano/sidekiq/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Sidekiq
-    VERSION = '0.5.3'
+    VERSION = '0.5.4'
   end
 end

data/lib/capistrano/tasks/capistrano2.rb

@@ -21,6 +21,8 @@ Capistrano::Configuration.instance.load do
   _cset(:sidekiq_processes) { 1 }
   _cset(:sidekiq_options_per_process) { nil }
 
+  _cset(:sidekiq_user) { nil }
+
   if fetch(:sidekiq_default_hooks)
     before 'deploy:update_code', 'sidekiq:quiet'
     after 'deploy:stop', 'sidekiq:stop'
@@ -32,11 +34,7 @@ Capistrano::Configuration.instance.load do
     def for_each_process(sidekiq_role, &block)
       sidekiq_processes = fetch(:"#{ sidekiq_role }_processes") rescue 1
       sidekiq_processes.times do |idx|
-        if idx.zero? && sidekiq_processes <= 1
-          pid_file = fetch(:sidekiq_pid)
-        else
-          pid_file = fetch(:sidekiq_pid).gsub(/\.pid$/, "-#{idx}.pid")
-        end
+        pid_file = fetch(:sidekiq_pid).gsub(/\.pid$/, "-#{idx}.pid")
         yield(pid_file, idx)
       end
     end
@@ -56,12 +54,21 @@ Capistrano::Configuration.instance.load do
       end
     end
 
+    def run_as(cmd)
+      opts = {
+        roles: sidekiq_role
+      }
+      su_user = fetch(:sidekiq_user)
+      opts[:shell] = "su - #{su_user}" if su_user
+      run cmd, opts
+    end
+
     def quiet_process(pid_file, idx, sidekiq_role)
-      run "if [ -d #{current_path} ] && [ -f #{pid_file} ] && kill -0 `cat #{pid_file}`> /dev/null 2>&1; then cd #{current_path} && #{fetch(:sidekiqctl_cmd)} quiet #{pid_file} ; else echo 'Sidekiq is not running'; fi", roles: sidekiq_role
+      run_as "if [ -d #{current_path} ] && [ -f #{pid_file} ] && kill -0 `cat #{pid_file}`> /dev/null 2>&1; then cd #{current_path} && #{fetch(:sidekiqctl_cmd)} quiet #{pid_file} ; else echo 'Sidekiq is not running'; fi"
     end
 
     def stop_process(pid_file, idx, sidekiq_role)
-      run "if [ -d #{current_path} ] && [ -f #{pid_file} ] && kill -0 `cat #{pid_file}`> /dev/null 2>&1; then cd #{current_path} && #{fetch(:sidekiqctl_cmd)} stop #{pid_file} #{fetch :sidekiq_timeout} ; else echo 'Sidekiq is not running'; fi", roles: sidekiq_role
+      run_as "if [ -d #{current_path} ] && [ -f #{pid_file} ] && kill -0 `cat #{pid_file}`> /dev/null 2>&1; then cd #{current_path} && #{fetch(:sidekiqctl_cmd)} stop #{pid_file} #{fetch :sidekiq_timeout} ; else echo 'Sidekiq is not running'; fi"
     end
 
     def start_process(pid_file, idx, sidekiq_role)
@@ -90,7 +97,7 @@ Capistrano::Configuration.instance.load do
         args.push '--daemon'
       end
 
-      run "if [ -d #{current_path} ] && [ ! -f #{pid_file} ] || ! kill -0 `cat #{pid_file}` > /dev/null 2>&1; then cd #{current_path} ; #{fetch(:sidekiq_cmd)} #{args.compact.join(' ')} ; else echo 'Sidekiq is already running'; fi", pty: false, roles: sidekiq_role
+      run_as "if [ -d #{current_path} ] && [ ! -f #{pid_file} ] || ! kill -0 `cat #{pid_file}` > /dev/null 2>&1; then cd #{current_path} ; #{fetch(:sidekiq_cmd)} #{args.compact.join(' ')} ; else echo 'Sidekiq is already running'; fi"
     end
 
     desc 'Quiet sidekiq (stop accepting new work)'

data/lib/capistrano/tasks/{monit.cap → monit.rake}

@@ -1,9 +1,10 @@
 namespace :load do
   task :defaults do
-    set :sidekiq_monit_conf_dir, -> { '/etc/monit/conf.d' }
-    set :sidekiq_monit_use_sudo, -> { true }
-    set :monit_bin, -> { '/usr/bin/monit' }
-    set :sidekiq_monit_default_hooks, -> { true }
+    set :sidekiq_monit_conf_dir, '/etc/monit/conf.d'
+    set :sidekiq_monit_use_sudo, true
+    set :monit_bin, '/usr/bin/monit'
+    set :sidekiq_monit_default_hooks, true
+    set :sidekiq_monit_templates_path, 'config/deploy/templates'
   end
 end
 
@@ -118,6 +119,10 @@ namespace :sidekiq do
       end
     end
 
+    def sidekiq_options_per_process
+      fetch(:sidekiq_options_per_process) || []
+    end
+
     def sudo_if_needed(command)
       send(use_sudo? ? :sudo : :execute, command)
     end

data/lib/capistrano/tasks/{sidekiq.cap → sidekiq.rake}

@@ -9,11 +9,13 @@ namespace :load do
     set :sidekiq_role, -> { :app }
     set :sidekiq_processes, -> { 1 }
     set :sidekiq_options_per_process, -> { nil }
-    # Rbenv and RVM integration
+    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 :sidekiq_monit_templates_path, -> { 'config/deploy/templates' }
+    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
 
@@ -44,9 +46,7 @@ namespace :sidekiq do
       next unless host.roles.include?(role)
       processes = fetch(:"#{ role }_processes") || fetch(:sidekiq_processes)
       processes.times do |idx|
-        pids.push (idx.zero? && processes <= 1) ?
-                      fetch(:sidekiq_pid) :
-                      fetch(:sidekiq_pid).gsub(/\.pid$/, "-#{idx}.pid")
+        pids.push fetch(:sidekiq_pid).gsub(/\.pid$/, "-#{idx}.pid")
       end
     end
 
@@ -66,10 +66,10 @@ namespace :sidekiq do
       if fetch(:sidekiq_use_signals)
         background "kill -TERM `cat #{pid_file}`"
       else
-        background :bundle, :exec, :sidekiqctl, 'stop', "#{pid_file}", fetch(:sidekiq_timeout)
+        background :sidekiqctl, 'stop', "#{pid_file}", fetch(:sidekiq_timeout)
       end
     else
-      execute :bundle, :exec, :sidekiqctl, 'stop', "#{pid_file}", fetch(:sidekiq_timeout)
+      execute :sidekiqctl, 'stop', "#{pid_file}", fetch(:sidekiq_timeout)
     end
   end
 
@@ -78,7 +78,7 @@ namespace :sidekiq do
       background "kill -USR1 `cat #{pid_file}`"
     else
       begin
-        execute :bundle, :exec, :sidekiqctl, 'quiet', "#{pid_file}"
+        execute :sidekiqctl, 'quiet', "#{pid_file}"
       rescue SSHKit::Command::Failed
         # If gems are not installed eq(first deploy) and sidekiq_default_hooks as active
         warn 'sidekiqctl not found (ignore if this is the first deploy)'
@@ -113,9 +113,9 @@ namespace :sidekiq do
     end
 
     if fetch(:start_sidekiq_in_background, fetch(:sidekiq_run_in_background))
-      background :bundle, :exec, :sidekiq, args.compact.join(' ')
+      background :sidekiq, args.compact.join(' ')
     else
-      execute :bundle, :exec, :sidekiq, args.compact.join(' ')
+      execute :sidekiq, args.compact.join(' ')
     end
   end
 
@@ -129,10 +129,12 @@ namespace :sidekiq do
   desc 'Quiet sidekiq (stop processing new tasks)'
   task :quiet do
     on roles fetch(:sidekiq_role) do
-      if test("[ -d #{release_path} ]") # fixes #11
-        for_each_process(true) do |pid_file, idx|
-          if pid_process_exists?(pid_file)
-            quiet_sidekiq(pid_file)
+      switch_user do
+        if test("[ -d #{release_path} ]") # fixes #11
+          for_each_process(true) do |pid_file, idx|
+            if pid_process_exists?(pid_file)
+              quiet_sidekiq(pid_file)
+            end
           end
         end
       end
@@ -142,10 +144,12 @@ namespace :sidekiq do
   desc 'Stop sidekiq'
   task :stop do
     on roles fetch(:sidekiq_role) do
-      if test("[ -d #{release_path} ]")
-        for_each_process(true) do |pid_file, idx|
-          if pid_process_exists?(pid_file)
-            stop_sidekiq(pid_file)
+      switch_user do
+        if test("[ -d #{release_path} ]")
+          for_each_process(true) do |pid_file, idx|
+            if pid_process_exists?(pid_file)
+              stop_sidekiq(pid_file)
+            end
           end
         end
       end
@@ -155,8 +159,10 @@ namespace :sidekiq do
   desc 'Start sidekiq'
   task :start do
     on roles fetch(:sidekiq_role) do
-      for_each_process do |pid_file, idx|
-        start_sidekiq(pid_file, idx) unless pid_process_exists?(pid_file)
+      switch_user do
+        for_each_process do |pid_file, idx|
+          start_sidekiq(pid_file, idx) unless pid_process_exists?(pid_file)
+        end
       end
     end
   end
@@ -170,11 +176,13 @@ namespace :sidekiq do
   desc 'Rolling-restart sidekiq'
   task :rolling_restart do
     on roles fetch(:sidekiq_role) do
-      for_each_process(true) do |pid_file, idx|
-        if pid_process_exists?(pid_file)
-          stop_sidekiq(pid_file)
+      switch_user do
+        for_each_process(true) do |pid_file, idx|
+          if pid_process_exists?(pid_file)
+            stop_sidekiq(pid_file)
+          end
+          start_sidekiq(pid_file, idx)
         end
-        start_sidekiq(pid_file, idx)
       end
     end
   end
@@ -182,9 +190,11 @@ namespace :sidekiq do
   # Delete any pid file not in use
   task :cleanup do
     on roles fetch(:sidekiq_role) do
-      for_each_process do |pid_file, idx|
-        if pid_file_exists?(pid_file)
-          execute "rm #{pid_file}" unless pid_process_exists?(pid_file)
+      switch_user do
+        for_each_process do |pid_file, idx|
+          if pid_file_exists?(pid_file)
+            execute "rm #{pid_file}" unless pid_process_exists?(pid_file)
+          end
         end
       end
     end
@@ -195,14 +205,27 @@ namespace :sidekiq do
   task :respawn do
     invoke 'sidekiq:cleanup'
     on roles fetch(:sidekiq_role) do
-      for_each_process do |pid_file, idx|
-        unless pid_file_exists?(pid_file)
-          start_sidekiq(pid_file, idx)
+      switch_user do
+        for_each_process do |pid_file, idx|
+          unless pid_file_exists?(pid_file)
+            start_sidekiq(pid_file, idx)
+          end
         end
       end
     end
   end
 
+  def switch_user(&block)
+    su_user = fetch(:sidekiq_user)
+    if su_user
+      as su_user do
+        yield
+      end
+    end
+
+    yield
+  end
+
   def upload_sidekiq_template(from, to, role)
     template = sidekiq_template(from, role)
     upload!(StringIO.new(ERB.new(template).result(binding)), to)

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

@@ -2,9 +2,9 @@
 <% processes_pids.each_with_index do |pid_file, idx| %>
 check process <%= sidekiq_service_name(idx) %>
   with pidfile "<%= pid_file %>"
-  start program = "/bin/su - <%= @role.user %> -c 'cd <%= current_path %> && <%= SSHKit.config.command_map[:bundle] %> exec sidekiq  <%= sidekiq_config %> --index <%= idx %> --pidfile <%= pid_file %> --environment <%= fetch(:sidekiq_env) %> <%= sidekiq_concurrency %> <%= sidekiq_logfile %> <%= sidekiq_queues %> -d'" with timeout 30 seconds
+  start program = "/bin/su - <%= @role.user %> -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_queues %> <%= sidekiq_options_per_process[idx] %> -d'" with timeout 30 seconds
 
-  stop program = "/bin/su - <%= @role.user %> -c 'cd <%= current_path %> && <%= SSHKit.config.command_map[:bundle] %> exec sidekiqctl stop <%= pid_file %>'" with timeout <%= fetch(:sidekiq_timeout).to_i + 10  %> seconds
+  stop program = "/bin/su - <%= @role.user %> -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
 
 <% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - Abdelkader Boudih
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-02 00:00:00.000000000 Z
+date: 2015-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
 description: Sidekiq integration for Capistrano
 email:
 - terminale@gmail.com
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CONTRIBUTORS.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -56,8 +57,8 @@ files:
 - lib/capistrano/sidekiq/monit.rb
 - lib/capistrano/sidekiq/version.rb
 - lib/capistrano/tasks/capistrano2.rb
-- lib/capistrano/tasks/monit.cap
-- lib/capistrano/tasks/sidekiq.cap
+- lib/capistrano/tasks/monit.rake
+- lib/capistrano/tasks/sidekiq.rake
 - lib/generators/capistrano/sidekiq/monit/template_generator.rb
 - lib/generators/capistrano/sidekiq/monit/templates/sidekiq_monit.conf.erb
 homepage: https://github.com/seuros/capistrano-sidekiq
@@ -80,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Sidekiq integration for Capistrano