capistrano-sidekiq 2.0.0.beta4 → 2.0.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c60b9de8a0a367ebba98dad3f99cbf3cbee2cc975a42cbe56ff35a0785ee964
-  data.tar.gz: e8e4dfed5f061db2fa453215df32293469f9bffa6bc9ff0fa1917cef45b31765
+  metadata.gz: 50c54a8decaa51b559addb7e9c1d5bfcbdc474cbac2d11054d1cfdc7a8753b1f
+  data.tar.gz: c7b60c5cdb1a19d3131ab83c2a6c2e1c54ddf51f9349969f1e3aac26b83de370
 SHA512:
-  metadata.gz: 50b2da50e06404fcd6298d1be4a0f1df560e519c990ed9a92ae5feff1a90addfc359b91e0f17fa9d5032621d8648f91bd2c4b6a36ebac86cdfd014ee2bf67094
-  data.tar.gz: 4892c095fa04edddea3474e974a95dcb219490b26950a82793035471b84e362527cd45988cf945279c4118ef768c56fb471d94ec7f729e80129f4a5342e9f716
+  metadata.gz: bb67be5724197a7499c41381fccf9f70db21a245957554a3a9a31f4d296c8bcb44a397db1e89cc1ac2116a804da924157a838e0a4958371d25d1cf905ef6f836
+  data.tar.gz: 773d1e88acaae73ed7c62cd3f49c038207d1cf124672fca77f7c7737320bdd037400f573d68edc64aa7f7045c44311a04d570dfd6aaea93dd487636c592be4d9

data/lib/capistrano/sidekiq/version.rb

@@ -1,3 +1,3 @@
 module Capistrano
-  SidekiqVERSION = '2.0.0.beta4'
+  SidekiqVERSION = '2.0.0.beta5'
 end

data/lib/capistrano/tasks/systemd.rake

@@ -113,7 +113,7 @@ namespace :sidekiq do
       backend.execute :sudo, :mv, "/tmp/#{fetch :sidekiq_service_unit_name}.service", "#{systemd_path}/#{fetch :sidekiq_service_unit_name}.service"
       backend.execute :sudo, :systemctl, "daemon-reload"
     else
-      backend.execute :sudo, :mv, "/tmp/#{fetch :sidekiq_service_unit_name}.service", "#{systemd_path}/#{fetch :sidekiq_service_unit_name}.service"
+      backend.execute :mv, "/tmp/#{fetch :sidekiq_service_unit_name}.service", "#{systemd_path}/#{fetch :sidekiq_service_unit_name}.service"
       backend.execute :systemctl, "--user", "daemon-reload"
     end
   end

data/lib/capistrano/tasks/upstart.rake

@@ -1,3 +1,5 @@
+git_plugin = self
+
 namespace :sidekiq do
   desc 'Quiet sidekiq (stop fetching new tasks from Redis)'
   task :quiet do
@@ -26,6 +28,74 @@ namespace :sidekiq do
     end
   end
 
+  desc 'Install upstart sidekiq service'
+  task :install do
+    on roles fetch(:sidekiq_roles) do |role|
+      git_plugin.switch_user(role) do
+        git_plugin.create_upstart_template
+      end
+    end
+  end
+
+  desc 'UnInstall upstart sidekiq service'
+  task :uninstall do
+    on roles fetch(:sidekiq_roles) do |role|
+      git_plugin.switch_user(role) do
+        execute :rm, '-f', File.join(fetch(:service_unit_path, fetch_upstart_unit_path), fetch(:sidekiq_service_unit_name))
+      end
+    end
+  end
+
+  desc 'Generate service_locally'
+  task :generate_service_locally do
+    run_locally do
+      File.write('sidekiq.conf', git_plugin.compiled_template)
+    end
+  end
+
+  def fetch_upstart_unit_path
+    if fetch(:sidekiq_service_unit_user) == :system
+      # if the path is not standard `set :service_unit_path`
+      "/etc/init"
+    else
+      home_dir = backend.capture :pwd
+      File.join(home_dir, '.config', 'upstart')
+    end
+  end
+
+  def compiled_template
+    search_paths = [
+      File.expand_path(
+        File.join(*%w[.. .. .. generators capistrano sidekiq upstart templates sidekiq.conf.erb]),
+        __FILE__
+      ),
+    ]
+    template_path = search_paths.detect { |path| File.file?(path) }
+    template = File.read(template_path)
+    ERB.new(template).result(binding)
+  end
+
+  def create_upstart_template
+    ctemplate = compiled_template
+    upstart_path = fetch(:service_unit_path, fetch_upstart_unit_path)
+
+    if fetch(:sidekiq_service_unit_user) != :system
+      backend.execute :mkdir, "-p", upstart_path
+    end
+    conf_filename = "#{fetch :sidekiq_service_unit_name}.conf"
+    backend.upload!(
+      StringIO.new(ctemplate),
+      "/tmp/#{conf_filename}"
+    )
+    if fetch(:sidekiq_service_unit_user) == :system
+      backend.execute :sudo, :mv, "/tmp/#{conf_filename}", "#{upstart_path}/#{conf_filename}"
+      backend.execute :sudo, :initctl,  'reload-configuration'
+    else
+      backend.execute :sudo, :mv, "/tmp/#{conf_filename}", "#{upstart_path}/#{conf_filename}"
+      #backend.execute :sudo, :initctl,  'reload-configuration' #TODO
+    end
+  end
+
   def switch_user(role)
     su_user = sidekiq_user(role)
     if su_user == role.user
@@ -37,11 +107,38 @@ namespace :sidekiq do
     end
   end
 
-  def sidekiq_user(role)
-    properties = role.properties
-    properties.fetch(:sidekiq_user) || # local property for sidekiq only
+  def sidekiq_user(role = nil)
+    if role.nil?
+      fetch(:sidekiq_user)
+    else
+      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
+  end
+
+  def num_workers
+    fetch(:sidekiq_upstart_num_workers, nil)
+  end
+
+  def sidekiq_config
+    if fetch(:sidekiq_config)
+      "--config #{fetch(:sidekiq_config)}"
+    end
+  end
+
+  def sidekiq_concurrency
+    if fetch(:sidekiq_concurrency)
+      "--concurrency #{fetch(:sidekiq_concurrency)}"
+    end
   end
+
+  def sidekiq_queues
+    Array(fetch(:sidekiq_queue)).map do |queue|
+      "--queue #{queue}"
+    end.join(' ')
+  end
+
 end

data/lib/generators/capistrano/sidekiq/systemd/templates/sidekiq.service.capistrano.erb

@@ -5,7 +5,7 @@ After=syslog.target network.target
 [Service]
 Type=simple
 WorkingDirectory=<%= File.join(fetch(:deploy_to), 'current') %>
-ExecStart=<%= SSHKit.config.command_map[:bundler] %> exec sidekiq -e <%= fetch(:sidekiq_env) %>
+ExecStart=<%= SSHKit.config.command_map[:bundle] %> exec sidekiq -e <%= fetch(:sidekiq_env) %>
 ExecReload=/bin/kill -TSTP $MAINPID
 ExecStop=/bin/kill -TERM $MAINPID
 <%="StandardOutput=append:#{fetch(:sidekiq_log)}" if fetch(:sidekiq_log) %>

data/lib/generators/capistrano/sidekiq/upstart/templates/sidekiq.conf.erb

@@ -0,0 +1,78 @@
+# /etc/init/sidekiq.conf - Sidekiq config | https://github.com/mperham/sidekiq/blob/master/examples/upstart/sidekiq.conf
+
+# This example config should work with Ubuntu 12.04+.  It
+# allows you to manage multiple Sidekiq instances with
+# Upstart, Ubuntu's native service management tool.
+#
+# See workers.conf for how to manage all Sidekiq instances at once.
+#
+# Save this config as /etc/init/sidekiq.conf then manage sidekiq with:
+#   sudo start <%= fetch(:sidekiq_service_unit_name) %> index=0
+#   sudo stop <%= fetch(:sidekiq_service_unit_name) %> index=0
+#   sudo status <%= fetch(:sidekiq_service_unit_name) %> index=0
+#
+# Hack Upstart's reload command to 'quiet' Sidekiq:
+#
+#   sudo reload <%= fetch(:sidekiq_service_unit_name) %> index=0
+#
+# or use the service command:
+#   sudo service <%= fetch(:sidekiq_service_unit_name) %> {start,stop,restart,status}
+#
+
+description "Sidekiq for <%= "#{fetch(:application)} (#{fetch(:stage)})" %>"
+
+# This script is not meant to start on bootup, workers.conf
+# will start all sidekiq instances explicitly when it starts.
+#start on runlevel [2345]
+#stop on runlevel [06]
+<% if sidekiq_user %>
+
+# change to match your deployment user
+setuid <%= sidekiq_user %>
+setgid <%= sidekiq_user %>
+env HOME=/home/<%= sidekiq_user %>
+<% end %>
+
+# Greatly reduce Ruby memory fragmentation and heap usage
+# https://www.mikeperham.com/2018/04/25/taming-rails-memory-bloat/
+env MALLOC_ARENA_MAX=2
+
+respawn
+respawn limit 3 30
+
+# TERM is used when stopping sidekiq. Without declaring these as
+# normal exit codes, it just respawns.
+normal exit 0 TERM
+
+# Older versions of Upstart might not support the reload command and need
+# this commented out.
+reload signal TSTP
+
+# Upstart waits 5 seconds by default to kill a process. Increase timeout to
+# give sidekiq process enough time to exit.
+kill timeout 30
+<% if num_workers %>
+
+instance $index
+<% end %>
+script
+# this script runs in /bin/sh by default
+# respawn as bash so we can source in rbenv
+exec /bin/bash <<'EOT'
+  # Pick your poison :) Or none if you're using a system wide installed Ruby.
+  # rbenv
+  # source /home/apps/.bash_profile
+  # OR
+  # source /home/apps/.profile
+  # OR system:
+  # source /etc/profile.d/rbenv.sh
+  #
+  # rvm
+  # source /home/apps/.rvm/scripts/rvm
+
+  # Logs out to /var/log/upstart/<%= fetch(:sidekiq_service_unit_name) %>.log by default
+
+  cd <%= File.join(fetch(:deploy_to), 'current') %>
+  exec <%= SSHKit.config.command_map[:bundle] %> exec sidekiq -e <%= fetch(:sidekiq_env) %> <%= sidekiq_config %> <%= sidekiq_concurrency %> <%= sidekiq_queues %>
+EOT
+end script

data/lib/generators/capistrano/sidekiq/upstart/templates/workers.conf.erb

@@ -0,0 +1,37 @@
+# /etc/init/workers.conf - manage a set of Sidekiqs | https://github.com/mperham/sidekiq/blob/master/examples/upstart/workers.conf
+
+# This example config should work with Ubuntu 14.10 and below  It
+# allows you to manage multiple Sidekiq instances with
+# Upstart, Ubuntu's native service management tool.
+#
+# See sidekiq.conf for how to manage a single Sidekiq instance.
+#
+# Use "stop workers" to stop all Sidekiq instances.
+# Use "start workers" to start all instances.
+# Use "restart workers" to restart all instances.
+# Crazy, right?
+#
+
+description "manages the set of sidekiq processes"
+
+# This starts upon bootup and stops on shutdown
+start on runlevel [2345]
+stop on runlevel [06]
+
+# Set this to the number of Sidekiq processes you want
+# to run on this machine
+env NUM_WORKERS=2
+
+pre-start script
+  for i in `seq 1 ${NUM_WORKERS}`
+  do
+    start sidekiq index=$i
+  done
+end script
+
+post-stop script
+  for i in `seq 1 ${NUM_WORKERS}`
+  do
+    stop sidekiq index=$i
+  done
+end script

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-sidekiq
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta4
+  version: 2.0.0.beta5
 platform: ruby
 authors:
 - Abdelkader Boudih
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-08 00:00:00.000000000 Z
+date: 2020-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -81,6 +81,8 @@ files:
 - lib/generators/capistrano/sidekiq/monit/template_generator.rb
 - lib/generators/capistrano/sidekiq/monit/templates/sidekiq_monit.conf.erb
 - lib/generators/capistrano/sidekiq/systemd/templates/sidekiq.service.capistrano.erb
+- lib/generators/capistrano/sidekiq/upstart/templates/sidekiq.conf.erb
+- lib/generators/capistrano/sidekiq/upstart/templates/workers.conf.erb
 homepage: https://github.com/seuros/capistrano-sidekiq
 licenses:
 - LGPL-3.0