capistrano-sidekiq 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d0ff8554dbc131801c66a6d700486ce190d9737
-  data.tar.gz: f2f644ba9ed6733ba9e071330373569eec5453e4
+  metadata.gz: b43a2e9a957a57fca9cddeb61fe2dab7f38d5d7f
+  data.tar.gz: bd9d98c7eef3166efa9c1043a06cd138029c3b9a
 SHA512:
-  metadata.gz: c99d5cb368b2b529c2554ea3338db65f855232a0ee3c489db20b2c692ef908b4a48896aa60fd7447316e434611cd7a0526b1acb75b762ff7e86f4f51380a3042
-  data.tar.gz: 422bf2b9727588094e6333b6b992d76ea4c4b77e0b533e237385e02c077d8e3be1f76ea75e93d9e9b8e7c745d24a74821daeab09df0fd82be37cc6c562ed421b
+  metadata.gz: 75ded52a6a43fbb98913af4efeaaf5f21ab52e3d6648f48600fda9bf875aa7ba803fc2312e502d3732aa1e5bff82a2210ec778d264603592e657e76860c86623
+  data.tar.gz: 1fdc6a4f79c26271f8a54d2b251b7da90215c97027e97a3ede44ca354c4263624cebca7873bf9cbbe09e85d8300e08d3ba6a79460257249f0599abac38a0e196

data/README.md

@@ -47,6 +47,7 @@ Configurable options, shown here with defaults:
     :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
 ```
@@ -69,6 +70,18 @@ and `low`:
 set :sidekiq_options_per_process, ["--queue high", "--queue default --queue low"]
 ```
 
+## Different number of processes per host
+
+You can configure how many processes you want to run on each host next way:
+
+```ruby
+set :sidekiq_role, [: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
 
 If you need change some config in redactor, you can
@@ -78,7 +91,14 @@ If you need change some config in redactor, you can
 
 ```
 
+If your deploy user has no need in `sudo` for using monit, you can disable it as follows:
+
+```ruby
+set :sidekiq_monit_use_sudo, false
+```
+
 ## Changelog
+- 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:
@@ -108,6 +128,9 @@ If you need change some config in redactor, you can
 - [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
 

data/lib/capistrano/sidekiq/version.rb

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

data/lib/capistrano/tasks/capistrano2.rb

@@ -17,6 +17,7 @@ Capistrano::Configuration.instance.load do
 
   _cset(:sidekiq_timeout) { 10 }
   _cset(:sidekiq_role) { :app }
+
   _cset(:sidekiq_processes) { 1 }
   _cset(:sidekiq_options_per_process) { nil }
 
@@ -28,9 +29,10 @@ Capistrano::Configuration.instance.load do
   end
 
   namespace :sidekiq do
-    def for_each_process(&block)
-      fetch(:sidekiq_processes).times do |idx|
-        if idx.zero? && fetch(:sidekiq_processes) <= 1
+    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")
@@ -39,15 +41,30 @@ Capistrano::Configuration.instance.load do
       end
     end
 
-    def quiet_process(pid_file, idx)
-      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"
+    def for_each_role
+      sidekiq_roles = fetch(:sidekiq_role)
+
+      sidekiq_roles = if sidekiq_roles.respond_to?(:to_ary)
+                        sidekiq_roles.to_ary
+                      else
+                        [sidekiq_roles]
+                      end
+
+      sidekiq_roles.to_ary.each do |sidekiq_role|
+        puts "executing on ##{ sidekiq_role }" if sidekiq_roles.size > 1
+        yield(sidekiq_role)
+      end
+    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
     end
 
-    def stop_process(pid_file, idx)
-      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' && if [ -f #{pid_file} ] ; then rm #{pid_file} ; fi ; fi"
+    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
     end
 
-    def start_process(pid_file, idx)
+    def start_process(pid_file, idx, sidekiq_role)
       args = []
       args.push "--index #{idx}"
       args.push "--pidfile #{pid_file}"
@@ -73,35 +90,43 @@ 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
+      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
     end
 
     desc 'Quiet sidekiq (stop accepting new work)'
     task :quiet, roles: lambda { fetch(:sidekiq_role) }, on_no_matching_servers: :continue do
-      for_each_process do |pid_file, idx|
-        quiet_process(pid_file, idx)
+      for_each_role do |sidekiq_role|
+        for_each_process(sidekiq_role) do |pid_file, idx|
+          quiet_process(pid_file, idx, sidekiq_role)
+        end
       end
     end
 
     desc 'Stop sidekiq'
     task :stop, roles: lambda { fetch(:sidekiq_role) }, on_no_matching_servers: :continue do
-      for_each_process do |pid_file, idx|
-        stop_process(pid_file, idx)
+      for_each_role do |sidekiq_role|
+        for_each_process(sidekiq_role) do |pid_file, idx|
+          stop_process(pid_file, idx, sidekiq_role)
+        end
       end
     end
 
     desc 'Start sidekiq'
     task :start, roles: lambda { fetch(:sidekiq_role) }, on_no_matching_servers: :continue do
-      for_each_process do |pid_file, idx|
-        start_process(pid_file, idx)
+      for_each_role do |sidekiq_role|
+        for_each_process(sidekiq_role) do |pid_file, idx|
+          start_process(pid_file, idx, sidekiq_role)
+        end
       end
     end
 
     desc 'Rolling-restart sidekiq'
     task :rolling_restart, roles: lambda { fetch(:sidekiq_role) }, on_no_matching_servers: :continue do
-      for_each_process do |pid_file, idx|
-        stop_process(pid_file, idx)
-        start_process(pid_file, idx)
+      for_each_role do |sidekiq_role|
+        for_each_process(sidekiq_role) do |pid_file, idx|
+          stop_process(pid_file, idx, sidekiq_role)
+          start_process(pid_file, idx, sidekiq_role)
+        end
       end
     end
 

data/lib/capistrano/tasks/monit.cap

@@ -1,6 +1,7 @@
 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 }
   end
@@ -26,18 +27,12 @@ namespace :sidekiq do
     task :config do
       on roles(fetch(:sidekiq_role)) do |role|
         @role = role
-        template_sidekiq 'sidekiq_monit', "#{fetch(:tmp_dir)}/monit.conf", @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"
+        sudo_if_needed mv_command
 
-        # Try execute in case the deploy user doesn't have sudo to mv
-        begin
-          execute mv_command
-        rescue
-          sudo mv_command
-        end
-
-        sudo "#{fetch(:monit_bin)} reload"
+        sudo_if_needed "#{fetch(:monit_bin)} reload"
       end
     end
 
@@ -46,10 +41,10 @@ namespace :sidekiq do
       on roles(fetch(:sidekiq_role)) do
         fetch(:sidekiq_processes).times do |idx|
           begin
-            sudo "#{fetch(:monit_bin)} monitor #{sidekiq_service_name(idx)}"
+            sudo_if_needed "#{fetch(:monit_bin)} monitor #{sidekiq_service_name(idx)}"
           rescue
             invoke 'sidekiq:monit:config'
-            sudo "#{fetch(:monit_bin)} monitor #{sidekiq_service_name(idx)}"
+            sudo_if_needed "#{fetch(:monit_bin)} monitor #{sidekiq_service_name(idx)}"
           end
         end
       end
@@ -60,7 +55,7 @@ namespace :sidekiq do
       on roles(fetch(:sidekiq_role)) do
         fetch(:sidekiq_processes).times do |idx|
           begin
-            sudo "#{fetch(:monit_bin)} unmonitor #{sidekiq_service_name(idx)}"
+            sudo_if_needed "#{fetch(:monit_bin)} unmonitor #{sidekiq_service_name(idx)}"
           rescue
             # no worries here
           end
@@ -72,7 +67,7 @@ namespace :sidekiq do
     task :start do
       on roles(fetch(:sidekiq_role)) do
         fetch(:sidekiq_processes).times do |idx|
-          sudo "#{fetch(:monit_bin)} start #{sidekiq_service_name(idx)}"
+          sudo_if_needed "#{fetch(:monit_bin)} start #{sidekiq_service_name(idx)}"
         end
       end
     end
@@ -81,7 +76,7 @@ namespace :sidekiq do
     task :stop do
       on roles(fetch(:sidekiq_role)) do
         fetch(:sidekiq_processes).times do |idx|
-          sudo "#{fetch(:monit_bin)} stop #{sidekiq_service_name(idx)}"
+          sudo_if_needed "#{fetch(:monit_bin)} stop #{sidekiq_service_name(idx)}"
         end
       end
     end
@@ -90,7 +85,7 @@ namespace :sidekiq do
     task :restart do
       on roles(fetch(:sidekiq_role)) do
         fetch(:sidekiq_processes).times do |idx|
-          sudo "#{fetch(:monit_bin)} restart #{sidekiq_service_name(idx)}"
+          sudo_if_needed"#{fetch(:monit_bin)} restart #{sidekiq_service_name(idx)}"
         end
       end
     end
@@ -123,5 +118,13 @@ namespace :sidekiq do
       end
     end
 
+    def sudo_if_needed(command)
+      send(use_sudo? ? :sudo : :execute, command)
+    end
+
+    def use_sudo?
+      fetch(:sidekiq_monit_use_sudo)
+    end
+
   end
 end

data/lib/capistrano/tasks/sidekiq.cap

@@ -17,7 +17,6 @@ namespace :load do
   end
 end
 
-
 namespace :deploy do
   before :starting, :check_sidekiq_hooks do
     invoke 'sidekiq:add_default_hooks' if fetch(:sidekiq_default_hooks)
@@ -40,12 +39,17 @@ namespace :sidekiq do
 
   def processes_pids
     pids = []
-    fetch(:sidekiq_processes).times do |idx|
-      pids.push (idx.zero? && fetch(:sidekiq_processes) <= 1) ?
-                    fetch(:sidekiq_pid) :
-                    fetch(:sidekiq_pid).gsub(/\.pid$/, "-#{idx}.pid")
-
+    sidekiq_roles = Array(fetch(:sidekiq_role))
+    sidekiq_roles.each do |role|
+      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")
+      end
     end
+
     pids
   end
 
@@ -199,25 +203,29 @@ namespace :sidekiq do
     end
   end
 
-  def template_sidekiq(from, to, role)
-    [
-        "#{fetch(:sidekiq_monit_templates_path)}/#{from}.erb",
-        File.join('lib', 'capistrano', 'templates', "#{from}-#{role.hostname}-#{fetch(:stage)}.conf.rb"),
-        File.join('lib', 'capistrano', 'templates', "#{from}-#{role.hostname}-#{fetch(:stage)}.conf.rb"),
-        File.join('lib', 'capistrano', 'templates', "#{from}-#{role.hostname}.conf.rb"),
-        File.join('lib', 'capistrano', 'templates', "#{from}-#{fetch(:stage)}.conf.rb"),
-        File.join('lib', 'capistrano', 'templates', "#{from}.conf.rb.erb"),
-        File.join('lib', 'capistrano', 'templates', "#{from}.conf.rb"),
-        File.join('lib', 'capistrano', 'templates', "#{from}.conf.erb"),
-        File.expand_path("../../../generators/capistrano/sidekiq/monit/templates/#{from}.conf.rb.erb", __FILE__),
-        File.expand_path("../../../generators/capistrano/sidekiq/monit/templates/#{from}.conf.erb", __FILE__)
-    ].each do |path|
-      if File.file?(path)
-        erb = File.read(path)
-        upload! StringIO.new(ERB.new(erb).result(binding)), to
-        break
-      end
-    end
+  def upload_sidekiq_template(from, to, role)
+    template = sidekiq_template(from, role)
+    upload!(StringIO.new(ERB.new(template).result(binding)), to)
   end
 
+  def sidekiq_template(name, role)
+    local_template_directory = fetch(:sidekiq_monit_templates_path)
+
+    search_paths = [
+      "#{name}-#{role.hostname}-#{fetch(:stage)}.erb",
+      "#{name}-#{role.hostname}.erb",
+      "#{name}-#{fetch(:stage)}.erb",
+      "#{name}.erb"
+    ].map { |filename| File.join(local_template_directory, filename) }
+
+    global_search_path = File.expand_path(
+      File.join(*%w[.. .. .. generators capistrano sidekiq monit templates], "#{name}.conf.erb"),
+      __FILE__
+    )
+
+    search_paths << global_search_path
+
+    template_path = search_paths.detect { |path| File.file?(path) }
+    File.read(template_path)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Abdelkader Boudih
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-20 00:00:00.000000000 Z
+date: 2015-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano