capistrano-sidekiq 0.20.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50ef7df7aa365e37232b22ba2083cc679d1dc695
-  data.tar.gz: 823d9f95a0ef7de7ab150b0e787b9f6404896998
+  metadata.gz: 32880c1c6b9be519c9495ac2c5d96339b1349c0d
+  data.tar.gz: e4957a5475c6b66ca3834c7ebfce013d944df4a1
 SHA512:
-  metadata.gz: c5d075cf0db606e94647fa6b6247813fd26f9357f74022edecef03235d085de47cc52211b0e8c18b54bb4a8e63d5f30ccf03305a6a999c913964fa22a34ba682
-  data.tar.gz: 269fc014f4ae8b33fa4d94505873ee3eaa254d2f254a09f3e0ddc1a5d38bff63c01ced1223c5da1f67bfbdea9900ab78d321e39fc5efb5ec06c8f34c1ebd702e
+  metadata.gz: '0229b5c4bdcc2504750737b61c8cc1960ff5f1e45f1d0ef19e61a38678862530ef0f1ae563bbc16d93e3be1a23ee0e0ae86c8d348de93c37f52d1b4ed6907883'
+  data.tar.gz: 651c4e097370eb64cf1a5a695982783522a8804a3a1282552e75a56e36b2fc43e89d59493e77b320abf46a4ca28053d67de8bc951b409371faa97d8ed7785bc4

data/CHANGELOG.md

@@ -0,0 +1,101 @@
+# Changelog
+
+## 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
+
+## 0.20.0
+
+- Use new capistrano DSL for reenable tasks @Tensho
+
+## 0.10.0
+
+- Fix Monit tasks
+- `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
+- 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 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

@@ -41,16 +41,19 @@ Configurable options, shown here with defaults:
 :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_roles => :app
 :sidekiq_processes => 1
 :sidekiq_options_per_process => nil
 :sidekiq_concurrency => nil
+# sidekiq monit
 :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_monit_group => nil
+:sidekiq_service_name => "sidekiq_#{fetch(:application)}_#{fetch(:sidekiq_env)}" + (index ? "_#{index}" : '') 
+
 :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
@@ -74,12 +77,12 @@ and `low`:
 set :sidekiq_options_per_process, ["--queue high", "--queue default --queue low"]
 ```
 
-## Different number of processes per host
+## Different number of processes per role
 
 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_roles, [:sidekiq_small, :sidekiq_big]
 set :sidekiq_small_processes, 1
 set :sidekiq_big_processes, 4
 server 'example-small.com', roles: [:sidekiq_small]

data/capistrano-sidekiq.gemspec

@@ -5,7 +5,7 @@ require 'capistrano/sidekiq/version'
 
 Gem::Specification.new do |spec|
   spec.name = 'capistrano-sidekiq'
-  spec.version = Capistrano::Sidekiq::VERSION
+  spec.version = Capistrano::SidekiqVERSION
   spec.authors = ['Abdelkader Boudih']
   spec.email = ['terminale@gmail.com']
   spec.summary = %q{Sidekiq integration for Capistrano}

data/lib/capistrano/sidekiq.rb

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

data/lib/capistrano/sidekiq/monit.rb

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

data/lib/capistrano/sidekiq/version.rb

@@ -1,5 +1,3 @@
 module Capistrano
-  module Sidekiq
-    VERSION = '0.20.0'
-  end
+  SidekiqVERSION = '1.0.0'
 end

data/lib/capistrano/tasks/monit.rake

@@ -5,6 +5,7 @@ namespace :load do
     set :monit_bin, '/usr/bin/monit'
     set :sidekiq_monit_default_hooks, true
     set :sidekiq_monit_templates_path, 'config/deploy/templates'
+    set :sidekiq_monit_group, nil
   end
 end
 
@@ -26,7 +27,7 @@ namespace :sidekiq do
 
     desc 'Config Sidekiq monit-service'
     task :config do
-      on roles(fetch(:sidekiq_role)) do |role|
+      on roles(fetch(:sidekiq_roles)) do |role|
         @role = role
         upload_sidekiq_template 'sidekiq_monit', "#{fetch(:tmp_dir)}/monit.conf", @role
 
@@ -39,7 +40,7 @@ namespace :sidekiq do
 
     desc 'Monitor Sidekiq monit-service'
     task :monitor do
-      on roles(fetch(:sidekiq_role)) do
+      on roles(fetch(:sidekiq_roles)) do
         fetch(:sidekiq_processes).times do |idx|
           begin
             sudo_if_needed "#{fetch(:monit_bin)} monitor #{sidekiq_service_name(idx)}"
@@ -53,7 +54,7 @@ namespace :sidekiq do
 
     desc 'Unmonitor Sidekiq monit-service'
     task :unmonitor do
-      on roles(fetch(:sidekiq_role)) do
+      on roles(fetch(:sidekiq_roles)) do
         fetch(:sidekiq_processes).times do |idx|
           begin
             sudo_if_needed "#{fetch(:monit_bin)} unmonitor #{sidekiq_service_name(idx)}"
@@ -66,7 +67,7 @@ namespace :sidekiq do
 
     desc 'Start Sidekiq monit-service'
     task :start do
-      on roles(fetch(:sidekiq_role)) do
+      on roles(fetch(:sidekiq_roles)) do
         fetch(:sidekiq_processes).times do |idx|
           sudo_if_needed "#{fetch(:monit_bin)} start #{sidekiq_service_name(idx)}"
         end
@@ -75,7 +76,7 @@ namespace :sidekiq do
 
     desc 'Stop Sidekiq monit-service'
     task :stop do
-      on roles(fetch(:sidekiq_role)) do
+      on roles(fetch(:sidekiq_roles)) do
         fetch(:sidekiq_processes).times do |idx|
           sudo_if_needed "#{fetch(:monit_bin)} stop #{sidekiq_service_name(idx)}"
         end
@@ -84,7 +85,7 @@ namespace :sidekiq do
 
     desc 'Restart Sidekiq monit-service'
     task :restart do
-      on roles(fetch(:sidekiq_role)) do
+      on roles(fetch(:sidekiq_roles)) do
         fetch(:sidekiq_processes).times do |idx|
           sudo_if_needed"#{fetch(:monit_bin)} restart #{sidekiq_service_name(idx)}"
         end
@@ -92,7 +93,7 @@ namespace :sidekiq do
     end
 
     def sidekiq_service_name(index=nil)
-      fetch(:sidekiq_service_name, "sidekiq_#{fetch(:application)}_#{fetch(:sidekiq_env)}") + index.to_s
+      fetch(:sidekiq_service_name, "sidekiq_#{fetch(:application)}_#{fetch(:sidekiq_env)}") + (index ? "_#{index}" : '')
     end
 
     def sidekiq_config
@@ -137,5 +138,30 @@ namespace :sidekiq do
       fetch(:sidekiq_monit_use_sudo)
     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
 end

data/lib/capistrano/tasks/sidekiq.rake

@@ -1,15 +1,15 @@
 namespace :load do
   task :defaults do
-    set :sidekiq_default_hooks, -> { true }
+    set :sidekiq_default_hooks, true
 
     set :sidekiq_pid, -> { File.join(shared_path, 'tmp', 'pids', 'sidekiq.pid') }
     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_role, -> { :app }
-    set :sidekiq_processes, -> { 1 }
-    set :sidekiq_options_per_process, -> { nil }
-    set :sidekiq_user, -> { nil }
+    set :sidekiq_timeout, 10
+    set :sidekiq_roles, :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))
@@ -29,110 +29,20 @@ namespace :deploy do
 end
 
 namespace :sidekiq do
-  def for_each_process(reverse = false, &block)
-    pids = processes_pids
-    pids.reverse! if reverse
-    pids.each_with_index do |pid_file, idx|
-      within release_path do
-        yield(pid_file, idx)
-      end
-    end
-  end
-
-  def processes_pids
-    pids = []
-    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 fetch(:sidekiq_pid).gsub(/\.pid$/, "-#{idx}.pid")
-      end
-    end
-
-    pids
-  end
-
-  def pid_process_exists?(pid_file)
-    pid_file_exists?(pid_file) and test(*("kill -0 $( cat #{pid_file} )").split(' '))
-  end
-
-  def pid_file_exists?(pid_file)
-    test(*("[ -f #{pid_file} ]").split(' '))
-  end
-
-  def stop_sidekiq(pid_file)
-    if fetch(:stop_sidekiq_in_background, fetch(:sidekiq_run_in_background))
-      if fetch(:sidekiq_use_signals)
-        background "kill -TERM `cat #{pid_file}`"
-      else
-        background :sidekiqctl, 'stop', "#{pid_file}", fetch(:sidekiq_timeout)
-      end
-    else
-      execute :sidekiqctl, 'stop', "#{pid_file}", fetch(:sidekiq_timeout)
-    end
-  end
-
-  def quiet_sidekiq(pid_file)
-    if fetch(:sidekiq_use_signals)
-      background "kill -USR1 `cat #{pid_file}`"
-    else
-      begin
-        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)'
-      end
-    end
-  end
-
-  def start_sidekiq(pid_file, idx = 0)
-    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 "--require #{fetch(:sidekiq_require)}" if fetch(:sidekiq_require)
-    args.push "--tag #{fetch(:sidekiq_tag)}" if fetch(:sidekiq_tag)
-    Array(fetch(:sidekiq_queue)).each do |queue|
-      args.push "--queue #{queue}"
-    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)
-      args.push process_options[idx]
-    end
-    # use sidekiq_options for special options
-    args.push fetch(:sidekiq_options) if fetch(:sidekiq_options)
-
-    if defined?(JRUBY_VERSION)
-      args.push '>/dev/null 2>&1 &'
-      warn 'Since JRuby doesn\'t support Process.daemon, Sidekiq will not be running as a daemon.'
-    else
-      args.push '--daemon'
-    end
-
-    if fetch(:start_sidekiq_in_background, fetch(:sidekiq_run_in_background))
-      background :sidekiq, args.compact.join(' ')
-    else
-      execute :sidekiq, args.compact.join(' ')
-    end
-  end
-
   task :add_default_hooks do
-    after 'deploy:starting', 'sidekiq:quiet'
-    after 'deploy:updated', 'sidekiq:stop'
-    after 'deploy:reverted', 'sidekiq:stop'
+    after 'deploy:starting',  'sidekiq:quiet'
+    after 'deploy:updated',   'sidekiq:stop'
+    after 'deploy:reverted',  'sidekiq:stop'
     after 'deploy:published', 'sidekiq:start'
   end
 
-  desc 'Quiet sidekiq (stop processing new tasks)'
+  desc 'Quiet sidekiq (stop fetching new tasks from Redis)'
   task :quiet do
-    on roles fetch(:sidekiq_role) do |role|
+    on roles fetch(:sidekiq_roles) 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)
+        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
@@ -141,13 +51,13 @@ namespace :sidekiq do
     end
   end
 
-  desc 'Stop sidekiq'
+  desc 'Stop sidekiq (graceful shutdown within timeout, put unfinished tasks back to Redis)'
   task :stop do
-    on roles fetch(:sidekiq_role) do |role|
+    on roles fetch(:sidekiq_roles) 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)
+          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
@@ -158,10 +68,12 @@ namespace :sidekiq do
 
   desc 'Start sidekiq'
   task :start do
-    on roles fetch(:sidekiq_role) do |role|
+    on roles fetch(:sidekiq_roles) do |role|
       switch_user(role) do
-        for_each_process do |pid_file, idx|
-          start_sidekiq(pid_file, idx) unless pid_process_exists?(pid_file)
+        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
@@ -175,10 +87,10 @@ namespace :sidekiq do
 
   desc 'Rolling-restart sidekiq'
   task :rolling_restart do
-    on roles fetch(:sidekiq_role) do |role|
+    on roles fetch(:sidekiq_roles) do |role|
       switch_user(role) do
-        for_each_process(true) do |pid_file, idx|
-          if pid_process_exists?(pid_file)
+        each_process_with_index(true) do |pid_file, idx|
+          if pid_file_exists?(pid_file) && process_exists?(pid_file)
             stop_sidekiq(pid_file)
           end
           start_sidekiq(pid_file, idx)
@@ -187,26 +99,28 @@ namespace :sidekiq do
     end
   end
 
-  # Delete any pid file not in use
+  desc 'Delete any pid file not in use'
   task :cleanup do
-    on roles fetch(:sidekiq_role) do |role|
+    on roles fetch(:sidekiq_roles) 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)
+        each_process_with_index do |pid_file, idx|
+          unless process_exists?(pid_file)
+            if pid_file_exists?(pid_file)
+              execute "rm #{pid_file}"
+            end
           end
         end
       end
     end
   end
 
-  # TODO : Don't start if all processes are off, raise warning.
+  # TODO: Don't start if all processes are off, raise warning.
   desc 'Respawn missing sidekiq processes'
   task :respawn do
     invoke 'sidekiq:cleanup'
-    on roles fetch(:sidekiq_role) do |role|
+    on roles fetch(:sidekiq_roles) do |role|
       switch_user(role) do
-        for_each_process do |pid_file, idx|
+        each_process_with_index do |pid_file, idx|
           unless pid_file_exists?(pid_file)
             start_sidekiq(pid_file, idx)
           end
@@ -215,6 +129,75 @@ namespace :sidekiq do
     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|
+      within release_path do
+        yield(pid_file, idx)
+      end
+    end
+  end
+
+  def pid_files
+    sidekiq_roles = Array(fetch(:sidekiq_roles))
+    sidekiq_roles.select! { |role| host.roles.include?(role) }
+    sidekiq_roles.flat_map do |role|
+      processes = fetch(:"#{ role }_processes") || fetch(:sidekiq_processes)
+      Array.new(processes) { |idx| fetch(:sidekiq_pid).gsub(/\.pid$/, "-#{idx}.pid") }
+    end
+  end
+
+  def pid_file_exists?(pid_file)
+    test(*("[ -f #{pid_file} ]").split(' '))
+  end
+
+  def process_exists?(pid_file)
+    test(*("kill -0 $( cat #{pid_file} )").split(' '))
+  end
+
+  def quiet_sidekiq(pid_file)
+    begin
+      execute :sidekiqctl, 'quiet', "#{pid_file}"
+    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)'
+    end
+  end
+
+  def stop_sidekiq(pid_file)
+    execute :sidekiqctl, 'stop', "#{pid_file}", fetch(:sidekiq_timeout)
+  end
+
+  def start_sidekiq(pid_file, idx = 0)
+    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 "--require #{fetch(:sidekiq_require)}" if fetch(:sidekiq_require)
+    args.push "--tag #{fetch(:sidekiq_tag)}" if fetch(:sidekiq_tag)
+    Array(fetch(:sidekiq_queue)).each do |queue|
+      args.push "--queue #{queue}"
+    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)
+      args.push process_options[idx]
+    end
+    # use sidekiq_options for special options
+    args.push fetch(:sidekiq_options) if fetch(:sidekiq_options)
+
+    if defined?(JRUBY_VERSION)
+      args.push '>/dev/null 2>&1 &'
+      warn 'Since JRuby doesn\'t support Process.daemon, Sidekiq will not be running as a daemon.'
+    else
+      args.push '--daemon'
+    end
+
+    execute :sidekiq, args.compact.join(' ')
+  end
+
   def switch_user(role, &block)
     su_user = sidekiq_user(role)
     if su_user == role.user
@@ -228,35 +211,9 @@ namespace :sidekiq do
 
   def sidekiq_user(role)
     properties = role.properties
-    properties.fetch(:sidekiq_user) ||               # local property for sidekiq only
+    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)
-    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

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

@@ -1,5 +1,5 @@
 # Monit configuration for Sidekiq :  <%= fetch(:application) %>
-<% processes_pids.each_with_index do |pid_file, idx| %>
+<% pid_files.each_with_index do |pid_file, idx| %>
 check process <%= sidekiq_service_name(idx) %>
   with pidfile "<%= pid_file %>"
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Abdelkader Boudih
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-01 00:00:00.000000000 Z
+date: 2018-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -46,7 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- CHANGELOG
+- CHANGELOG.md
 - CONTRIBUTORS.md
 - Gemfile
 - LICENSE.txt
@@ -57,7 +57,6 @@ files:
 - lib/capistrano/sidekiq.rb
 - lib/capistrano/sidekiq/monit.rb
 - lib/capistrano/sidekiq/version.rb
-- lib/capistrano/tasks/capistrano2.rb
 - lib/capistrano/tasks/monit.rake
 - lib/capistrano/tasks/sidekiq.rake
 - lib/generators/capistrano/sidekiq/monit/template_generator.rb

data/CHANGELOG

@@ -1,28 +0,0 @@
-## 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/lib/capistrano/tasks/capistrano2.rb

@@ -1,147 +0,0 @@
-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, 'production')) }
-  _cset(:sidekiq_tag) { nil }
-  _cset(:sidekiq_log) { File.join(shared_path, 'log', 'sidekiq.log') }
-
-  _cset(:sidekiq_config) { "#{current_path}/config/sidekiq.yml" }
-  _cset(:sidekiq_options) { nil }
-  _cset(:sidekiq_queue) { nil }
-  _cset(:sidekiq_concurrency) { nil }
-
-  _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 }
-
-  _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'
-    after 'deploy:start', 'sidekiq:start'
-    before 'deploy:restart', 'sidekiq:restart'
-  end
-
-  namespace :sidekiq do
-    def for_each_process(sidekiq_role, &block)
-      sidekiq_processes = fetch(:"#{ sidekiq_role }_processes") rescue 1
-      sidekiq_processes.times do |idx|
-        pid_file = fetch(:sidekiq_pid).gsub(/\.pid$/, "-#{idx}.pid")
-        yield(pid_file, idx)
-      end
-    end
-
-    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 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_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_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)
-      args = []
-      args.push "--index #{idx}"
-      args.push "--pidfile #{pid_file}"
-      args.push "--environment #{fetch(:sidekiq_env)}"
-      args.push "--tag #{fetch(:sidekiq_tag)}" if fetch(:sidekiq_tag)
-      args.push "--logfile #{fetch(:sidekiq_log)}" if fetch(:sidekiq_log)
-      args.push "--config #{fetch(:sidekiq_config)}" if fetch(:sidekiq_config)
-      args.push "--concurrency #{fetch(:sidekiq_concurrency)}" if fetch(:sidekiq_concurrency)
-      fetch(:sidekiq_queue).each do |queue|
-        args.push "--queue #{queue}"
-      end if fetch(:sidekiq_queue)
-
-      if process_options = fetch(:sidekiq_options_per_process)
-        args.push process_options[idx]
-      end
-
-      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_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)'
-    task :quiet, roles: lambda { fetch(:sidekiq_role) }, on_no_matching_servers: :continue do
-      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_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_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_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
-
-    desc 'Restart sidekiq'
-    task :restart, roles: lambda { fetch(:sidekiq_role) }, on_no_matching_servers: :continue do
-      stop
-      start
-    end
-
-  end
-end