capistrano-sidekiq 0.5.4 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32f341ab53e9dfdb15b39d595948a85f9004460e
-  data.tar.gz: f5ff8d829bc7ae25c517605b61805ba6a79c9abe
+  metadata.gz: 69a2a6423d42f07ee23487128a5539cf2a56b683
+  data.tar.gz: 775482d2ea6668dc3e18b275e943f66661ccddcd
 SHA512:
-  metadata.gz: 02dd736baaa98223d535075aa3b7ccbb8cbad793b1c309e4206d7b11dfd08ad70d72268ed43b520c5b903612d52463d6b8c543b25f16aca9a09a17e68afaf6bf
-  data.tar.gz: e861c2ff9c05b484e4b2c5111bee3b944dfa203d1cdb7b0a4d96c5c34c97a0406fb8d58ebd490bc59d79dddb618cdc7cae53bf9d3d6e7f9e68275310e37e8c65
+  metadata.gz: 2ac6151abfb25fdc04602ee0b7e3ce1d3085dac41f9a7da1a153d536e744778f37a4e00505d95aba1a94d2de17bd789ae1b6bf9c71c784df985b208ae30fbd77
+  data.tar.gz: d9c1a0b198e6b4c460d546b0e9c54ddd73e5e01e20f88f8efd631ffb5193ffe44ea747c4c7390bf51fe89d63e6c6396cbb0c58044f6925be3c9de28a3056d2f3

data/CHANGELOG

@@ -0,0 +1,28 @@
+## Changelog
+- 0.10.0:
+        * Fix Monit tasks
+        * sidekiq:stop task perpertually callable
+- 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
+        * Unmonitor monit while deploy @Saicheg
+- 0.3.7:
+        * fix capistrano2 task @tribble
+        * Run Sidekiq as daemon from Monit @dpaluy
+- 0.3.5: Added :sidekiq_tag for capistrano2 @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

@@ -22,35 +22,38 @@ And then execute:
 
 ## Usage
 ```ruby
-    # Capfile
-
-    require 'capistrano/sidekiq'
-    require 'capistrano/sidekiq/monit' #to require monit tasks # Only for capistrano3
+# Capfile
+require 'capistrano/sidekiq'
+require 'capistrano/sidekiq/monit' #to require monit tasks # Only for capistrano3
 ```
 
 
 Configurable options, shown here with defaults:
 
 ```ruby
-    :sidekiq_default_hooks => true
-    :sidekiq_pid => File.join(shared_path, 'tmp', 'pids', 'sidekiq.pid')
-    :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
-    :sidekiq_queue => nil
-    :sidekiq_timeout => 10
-    :sidekiq_role => :app
-    :sidekiq_processes => 1
-    :sidekiq_options_per_process => nil
-    :sidekiq_concurrency => nil
-    :sidekiq_monit_templates_path => 'config/deploy/templates'
-    :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
+: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_role => :app
+:sidekiq_processes => 1
+:sidekiq_options_per_process => nil
+:sidekiq_concurrency => nil
+:sidekiq_monit_templates_path => 'config/deploy/templates'
+:sidekiq_monit_conf_dir => '/etc/monit/conf.d'
+:sidekiq_monit_use_sudo => true
+:monit_bin => '/usr/bin/monit'
+:sidekiq_monit_default_hooks => true
+:sidekiq_service_name => "sidekiq_#{fetch(:application)}_#{fetch(:sidekiq_env)}"
+: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 on Capistrano 3.
@@ -88,8 +91,7 @@ server 'example-big.com', roles: [:sidekiq_big]
 If you need change some config in redactor, you can
 
 ```
-    bundle exec rails generate capistrano:sidekiq:monit:template
-
+bundle exec rails generate capistrano:sidekiq:monit:template
 ```
 
 If your deploy user has no need in `sudo` for using monit, you can disable it as follows:
@@ -98,32 +100,6 @@ If your deploy user has no need in `sudo` for using monit, you can disable it as
 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
-- 0.3.8:
-        * Update monit template: use su instead of sudo / permit all Sidekiq options @bensie
-        * Unmonitor monit while deploy @Saicheg
-- 0.3.7:
-        * fix capistrano2 task @tribble
-        * Run Sidekiq as daemon from Monit @dpaluy
-- 0.3.5: Added :sidekiq_tag for capistrano2 @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
-
 ## Contributing
 
 1. Fork it

data/lib/capistrano/sidekiq/version.rb

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

data/lib/capistrano/tasks/monit.rake

@@ -119,6 +119,12 @@ namespace :sidekiq do
       end
     end
 
+    def sidekiq_require
+      if fetch(:sidekiq_require)
+        "--require #{fetch(:sidekiq_require)}"
+      end
+    end
+
     def sidekiq_options_per_process
       fetch(:sidekiq_options_per_process) || []
     end

data/lib/capistrano/tasks/sidekiq.rake

@@ -128,8 +128,8 @@ namespace :sidekiq do
 
   desc 'Quiet sidekiq (stop processing new tasks)'
   task :quiet do
-    on roles fetch(:sidekiq_role) do
-      switch_user do
+    on roles fetch(:sidekiq_role) do |role|
+      switch_user(role) do
         if test("[ -d #{release_path} ]") # fixes #11
           for_each_process(true) do |pid_file, idx|
             if pid_process_exists?(pid_file)
@@ -143,8 +143,8 @@ namespace :sidekiq do
 
   desc 'Stop sidekiq'
   task :stop do
-    on roles fetch(:sidekiq_role) do
-      switch_user do
+    on roles fetch(:sidekiq_role) do |role|
+      switch_user(role) do
         if test("[ -d #{release_path} ]")
           for_each_process(true) do |pid_file, idx|
             if pid_process_exists?(pid_file)
@@ -154,12 +154,13 @@ namespace :sidekiq do
         end
       end
     end
+    Rake::Task["sidekiq:stop"].reenable
   end
 
   desc 'Start sidekiq'
   task :start do
-    on roles fetch(:sidekiq_role) do
-      switch_user do
+    on roles fetch(:sidekiq_role) do |role|
+      switch_user(role) do
         for_each_process do |pid_file, idx|
           start_sidekiq(pid_file, idx) unless pid_process_exists?(pid_file)
         end
@@ -175,8 +176,8 @@ namespace :sidekiq do
 
   desc 'Rolling-restart sidekiq'
   task :rolling_restart do
-    on roles fetch(:sidekiq_role) do
-      switch_user do
+    on roles fetch(:sidekiq_role) do |role|
+      switch_user(role) do
         for_each_process(true) do |pid_file, idx|
           if pid_process_exists?(pid_file)
             stop_sidekiq(pid_file)
@@ -189,8 +190,8 @@ namespace :sidekiq do
 
   # Delete any pid file not in use
   task :cleanup do
-    on roles fetch(:sidekiq_role) do
-      switch_user do
+    on roles fetch(:sidekiq_role) do |role|
+      switch_user(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)
@@ -204,8 +205,8 @@ namespace :sidekiq do
   desc 'Respawn missing sidekiq processes'
   task :respawn do
     invoke 'sidekiq:cleanup'
-    on roles fetch(:sidekiq_role) do
-      switch_user do
+    on roles fetch(:sidekiq_role) do |role|
+      switch_user(role) do
         for_each_process do |pid_file, idx|
           unless pid_file_exists?(pid_file)
             start_sidekiq(pid_file, idx)
@@ -215,15 +216,23 @@ namespace :sidekiq do
     end
   end
 
-  def switch_user(&block)
-    su_user = fetch(:sidekiq_user)
-    if su_user
+  def switch_user(role, &block)
+    su_user = sidekiq_user(role)
+    if su_user == role.user
+      block.call
+    else
       as su_user do
-        yield
+        block.call
       end
     end
+  end
 
-    yield
+  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
 
   def upload_sidekiq_template(from, to, role)

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[: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
+  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 - <%= @role.user %> -c 'cd <%= current_path %> && <%= SSHKit.config.command_map[:sidekiqctl] %> stop <%= pid_file %>'" with timeout <%= fetch(:sidekiq_timeout).to_i + 10  %> 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
 
 <% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.10.0
 platform: ruby
 authors:
 - Abdelkader Boudih
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-09 00:00:00.000000000 Z
+date: 2016-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG
 - CONTRIBUTORS.md
 - Gemfile
 - LICENSE.txt
@@ -81,9 +82,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Sidekiq integration for Capistrano
 test_files: []
-has_rdoc: