capistrano-sidekiq 0.1.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78bd4deb68cc4de92a788222a9f5944a2c9ee1ca
-  data.tar.gz: eaa42d248f4f7c78e251b47e1d197b2ea1ad725f
+  metadata.gz: 61231f557213995443b79c4d06ceaa5de8238bd6
+  data.tar.gz: 489cf3778f8e5f682a45a88537411d23da415604
 SHA512:
-  metadata.gz: bfccd93b847b249ee2148378c5c2c43ed19bafd010a7d270c8493e23b96399f634fe545c4751e516451d6394e51b49e21b1b3ee80a824af6748f7c143f89828c
-  data.tar.gz: a0473b5e050dbf37940ba96fa516e0f8e4107699342b02eaa0ad3f3af679b6bc3cf2dc3506c75234248980c40b8fe442f45b3838aeb713b267a179f355eed11d
+  metadata.gz: ebbf4e4d9511849571ffc5539c7c412791dbf3bda5c66ff703a624a58ab83310e336f7c4b26e27bb96c1091eceaad8b4ec84bfdf3878c6b00e44848e5277adf2
+  data.tar.gz: a02c3e44e841c492a1da7ecd7adefc5b8b18b68d2d851dfd8ddab46d6d404a1aaa9fc0f9ce5a53433b31feedd5ae3315cea2adcf31c3b8513a20ab5b13eea271

data/README.md

@@ -22,7 +22,7 @@ And then execute:
     # Capfile
 
     require 'capistrano/sidekiq'
-    require 'capistrano/sidekiq/monit #to require monit tasks (V0.2.0+)
+    require 'capistrano/sidekiq/monit' #to require monit tasks # Only for capistrano3
 ```
 
 
@@ -42,7 +42,12 @@ Configurable options, shown here with defaults:
     :sidekiq_cmd => "#{fetch(:bundle_cmd, "bundle")} exec sidekiq"  # Only for capistrano2.5
     :sidekiqctl_cmd => "#{fetch(:bundle_cmd, "bundle")} exec sidekiqctl" # Only for capistrano2.5
 ```
+## Changelog
+- 0.2.0: Added sidekiq:rolling_restart - @jlecour
 
+## Contributors
+
+- [Jérémy Lecour] (https://github.com/jlecour)
 
 ## Contributing
 

data/lib/capistrano/sidekiq/monit.rb

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

data/lib/capistrano/sidekiq/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Sidekiq
-    VERSION = '0.1.3'
+    VERSION = '0.2.5'
   end
 end

data/lib/capistrano/tasks/capistrano2.rb

@@ -3,13 +3,13 @@ Capistrano::Configuration.instance.load do
   _cset(:sidekiq_default_hooks) { true }
 
   _cset(:sidekiq_pid) { File.join(shared_path, 'pids', 'sidekiq.pid') }
-  _cset(:sidekiq_env) { fetch(:rack_env, fetch(:rails_env, fetch(:stage))) }
+  _cset(:sidekiq_env) { fetch(:rack_env, fetch(:rails_env, 'production')) }
   _cset(:sidekiq_log) { File.join(shared_path, 'log', 'sidekiq.log') }
 
   _cset(:sidekiq_options) { nil }
 
-  _cset(:sidekiq_cmd) { "#{fetch(:bundle_cmd, "bundle")} exec sidekiq" }
-  _cset(:sidekiqctl_cmd) { "#{fetch(:bundle_cmd, "bundle")} exec sidekiqctl" }
+  _cset(:sidekiq_cmd) { "#{fetch(:bundle_cmd, 'bundle')} exec sidekiq" }
+  _cset(:sidekiqctl_cmd) { "#{fetch(:bundle_cmd, 'bundle')} exec sidekiqctl" }
 
   _cset(:sidekiq_timeout) { 10 }
   _cset(:sidekiq_role) { :app }
@@ -34,38 +34,58 @@ 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"
+    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'; fi"
+    end
+
+    def start_process(pid_file, idx)
+      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 fetch(:sidekiq_options)
+
+      if defined?(JRUBY_VERSION)
+        args.push '>/dev/null 2>&1 &'
+        logger.info 'Since JRuby doesn\'t support Process.daemon, Sidekiq will not be running as a daemon.'
+      else
+        args.push '--daemon'
+      end
+
+      run "cd #{current_path} ; #{fetch(:sidekiq_cmd)} #{args.compact.join(' ')} ", :pty => false
+    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|
-        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"
+        quiet_process(pid_file, idx)
       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|
-        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"
+        stop_process(pid_file, idx)
       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|
-        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 fetch(:sidekiq_options)
-
-        if defined?(JRUBY_VERSION)
-          args.push ">/dev/null 2>&1 &"
-          logger.info 'Since JRuby doesn\'t support Process.daemon, Sidekiq will not be running as a daemon.'
-        else
-          args.push "--daemon"
-        end
+        start_process(pid_file, idx)
+      end
+    end
 
-        run "cd #{current_path} ; #{fetch(:sidekiq_cmd)} #{args.compact.join(' ')} ", :pty => false
+    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)
       end
     end
 

data/lib/capistrano/tasks/monit.cap

@@ -0,0 +1,60 @@
+namespace :load do
+  task :defaults do
+    set :sidekiq_monit_conf_dir, -> { '/etc/monit/conf.d' }
+    set :monit_bin, -> { '/usr/bin/monit' }
+  end
+end
+
+
+namespace :sidekiq do
+  namespace :monit do
+    desc 'Config Sidekiq monit-service'
+    task :config do
+      on roles(fetch(:sidekiq_role)) do |role|
+        @role = role
+        template_sidekiq 'sidekiq_monit.conf', "#{fetch(:tmp_dir)}/monit.conf", @role
+        sudo "mv #{fetch(:tmp_dir)}/monit.conf #{fetch(:sidekiq_monit_conf_dir)}/#{sidekiq_service_name}.conf"
+      end
+    end
+
+    desc 'Monitor Sidekiq monit-service'
+    task :monitor do
+      on roles(fetch(:sidekiq_role)) do
+        sudo "#{fetch(:monit_bin)} monitor #{sidekiq_service_name(index)}"
+      end
+    end
+
+    desc 'Unmonitor Sidekiq monit-service'
+    task :unmonitor do
+      on roles(fetch(:sidekiq_role)) do
+        sudo "#{fetch(:monit_bin)}  unmonitor #{sidekiq_service_name(index)}"
+      end
+    end
+
+    desc 'Disable Sidekiq monit-service'
+    task :start do
+      on roles(fetch(:sidekiq_role)) do
+        sudo "#{fetch(:monit_bin)}  start #{sidekiq_service_name(index)}"
+      end
+    end
+
+    desc 'Disable Sidekiq monit-service'
+    task :stop do
+      on roles(fetch(:sidekiq_role)) do
+        sudo "#{fetch(:monit_bin)}  stop #{sidekiq_service_name(index)}"
+      end
+    end
+
+    desc 'Disable Sidekiq monit-service'
+    task :restart do
+      on roles(fetch(:sidekiq_role)) do
+        sudo "#{fetch(:monit_bin)}  restart #{sidekiq_service_name(index)}"
+      end
+    end
+
+    def sidekiq_service_name(index=nil)
+      fetch(:sidekiq_service_name, "sidekiq_#{fetch(:application)}") + index.to_s
+    end
+
+  end
+end

data/lib/capistrano/tasks/sidekiq.cap

@@ -26,7 +26,9 @@ namespace :sidekiq do
     pids = processes_pids
     pids.reverse! if reverse
     pids.each_with_index do |pid_file, idx|
-      yield(pid_file, idx)
+      within current_path do
+        yield(pid_file, idx)
+      end
     end
   end
 
@@ -41,8 +43,20 @@ namespace :sidekiq do
     pids
   end
 
+  def pid_process_exists?(pid_file)
+    pid_file_exists?(pid_file) and test("kill -0 $( cat #{pid_file} )")
+  end
+
+  def pid_file_exists?(pid_file)
+    test("[ -f #{pid_file} ]")
+  end
+
   def stop_sidekiq(pid_file)
-    execute :bundle, :exec, :sidekiqctl, 'stop', "#{pid_file}", fetch(:sidekiq_timeout)
+    if  fetch(:stop_sidekiq_in_background, fetch(:sidekiq_run_in_background))
+      background :bundle, :exec, :sidekiqctl, 'stop', "#{pid_file}", fetch(:sidekiq_timeout)
+    else
+      execute :bundle, :exec, :sidekiqctl, 'stop', "#{pid_file}", fetch(:sidekiq_timeout)
+    end
   end
 
   def quit_sidekiq(pid_file)
@@ -71,7 +85,11 @@ namespace :sidekiq do
       args.push "--daemon"
     end
 
-    execute :bundle, :exec, :sidekiq, args.compact.join(' ')
+    if  fetch(:start_sidekiq_in_background, fetch(:sidekiq_run_in_background))
+      background :bundle, :exec, :sidekiq, args.compact.join(' ')
+    else
+      execute :bundle, :exec, :sidekiq, args.compact.join(' ')
+    end
   end
 
   task :add_default_hooks do
@@ -84,9 +102,9 @@ namespace :sidekiq do
   desc 'Quiet sidekiq (stop processing new tasks)'
   task :quiet do
     on roles fetch(:sidekiq_role) do
-      for_each_process(true) do |pid_file, idx|
-        if test("[ -f #{pid_file} ]") and test("kill -0 $( cat #{pid_file} )")
-          within current_path do
+      if test("[ -d #{current_path} ]")   #fixes #11
+        for_each_process(true) do |pid_file, idx|
+          if pid_process_exists?(pid_file)
             quit_sidekiq(pid_file)
           end
         end
@@ -98,10 +116,8 @@ namespace :sidekiq do
   task :stop do
     on roles fetch(:sidekiq_role) do
       for_each_process(true) do |pid_file, idx|
-        if test("[ -f #{pid_file} ]") and test("kill -0 $( cat #{pid_file} )")
-          within current_path do
-            stop_sidekiq(pid_file)
-          end
+        if pid_process_exists?(pid_file)
+          stop_sidekiq(pid_file)
         end
       end
     end
@@ -110,10 +126,8 @@ namespace :sidekiq do
   desc 'Start sidekiq'
   task :start do
     on roles fetch(:sidekiq_role) do
-      within current_path do
-        for_each_process do |pid_file, idx|
-          start_sidekiq(pid_file)
-        end
+      for_each_process do |pid_file, idx|
+        start_sidekiq(pid_file, idx)
       end
     end
   end
@@ -124,12 +138,24 @@ namespace :sidekiq do
     invoke 'sidekiq:start'
   end
 
+  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)
+        end
+        start_sidekiq(pid_file, idx)
+      end
+    end
+  end
+
   #delete any pid file not in use
   task :cleanup do
     on roles fetch(:sidekiq_role) do
       for_each_process do |pid_file, idx|
-        if test("[ -f #{pid_file} ]")
-          execute "rm #{pid_file}" unless test("kill -0 $( cat #{pid_file} )")
+        if pid_file_exists?(pid_file)
+          execute "rm #{pid_file}" unless pid_process_exists?(pid_file)
         end
       end
     end
@@ -140,14 +166,32 @@ namespace :sidekiq do
   task :respawn do
     invoke 'sidekiq:cleanup'
     on roles fetch(:sidekiq_role) do
-      within current_path do
-        for_each_process do |pid_file, idx|
-          unless test("[ -f #{pid_file} ]")
-            start_sidekiq(pid_file, idx)
-          end
+      for_each_process do |pid_file, idx|
+        unless pid_file_exists?(pid_file)
+          start_sidekiq(pid_file, idx)
         end
       end
     end
   end
 
+
+  def template_sidekiq(from, to, role)
+    [
+        File.join('lib','capistrano','templates',"#{from}-#{role.hostname}-#{fetch(:stage)}.rb"),
+        File.join('lib','capistrano','templates',"#{from}-#{role.hostname}.rb"),
+        File.join('lib','capistrano','templates',"#{from}-#{fetch(:stage)}.rb"),
+        File.join('lib','capistrano','templates',"#{from}.rb.erb"),
+        File.join('lib','capistrano','templates',"#{from}.rb"),
+        File.join('lib','capistrano','templates',"#{from}.erb"),
+        File.expand_path("../../templates/#{from}.rb.erb", __FILE__),
+        File.expand_path("../../templates/#{from}.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
+  end
+
 end

data/lib/capistrano/templates/sidekiq_monit.conf.erb

@@ -0,0 +1,9 @@
+# Monit configuration for Sidekiq :  <%= fetch(:application) %>
+<% processes_pids.each_with_index do |pid_file, idx| %>
+check process <%= sidekiq_service_name(idx) %>
+  with pidfile "<%= pid_file %>"
+  start program = "/usr/bin/sudo -u <%= @role.user %> /bin/bash -c 'cd <%= current_path %> && <%= SSHKit.config.command_map[:bundle] %> exec sidekiq  -P <%= pid_file  %>'" with timeout 30 seconds
+  stop program = "/usr/bin/sudo -u <%= @role.user %> /bin/bash -c 'cd <%= current_path %> && <%= SSHKit.config.command_map[:bundle] %> exec 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.1.3
+  version: 0.2.5
 platform: ruby
 authors:
 - Abdelkader Boudih
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-25 00:00:00.000000000 Z
+date: 2014-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -53,9 +53,12 @@ files:
 - capistrano-sidekiq.gemspec
 - lib/capistrano-sidekiq.rb
 - lib/capistrano/sidekiq.rb
+- 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/templates/sidekiq_monit.conf.erb
 homepage: https://github.com/seuros/capistrano-sidekiq
 licenses:
 - LGPL-3.0