sidekiq-runner 0.1.4 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 57a4e9f7dfaa5e130c98c69f2d05a852d696af26
-  data.tar.gz: 3093eff6494a39f44bdaea11d848a27384133c3f
+SHA256:
+  metadata.gz: 4ab39cb1000c541dae57dc976f97fc96002d4a57c50c00e7161f8885646ba381
+  data.tar.gz: 03de0934038502d732faaa2761c6b0a05bf03dc316fd0b6222f62fd021861881
 SHA512:
-  metadata.gz: d51beac3bd2f37585ab90441458acf2d30c4f818cc50444a0956cd6d8424e039aa2571da42be1d560201fc3d355fd183a95f1808f9bfead9d1aa40753b979e00
-  data.tar.gz: 05696ee4c2ee05ab4ef78e8e495d32da443aaad81e9d52ea2d721e500ffcde2a878dd7e1a6db43a91b4215cc686487c5f7e8a66545026ff74d61eb17ae2b14c5
+  metadata.gz: 68a6a2a2876e21a93007082e5ca3ba60fbf6ee71481e631d09cde639d2d6a357b36339bbcec17289123fccdb8c21297ca43d4ba6333d28b38cb0d7ce6ccf0582
+  data.tar.gz: bc64fedeb29a0152532bbcd6ab7bd9213a36aa812c07cf6e8b4191a699a62828c60bad442f200c0fe73797133eb4b17d4daa61056a1887bf3e25dad5164875da

data/lib/sidekiq-runner.rb

@@ -17,7 +17,7 @@ module SidekiqRunner
 
     abort 'God is already running.' if god_alive?(god_config)
 
-    run(:start, sidekiq_config) do
+    run(:start, sidekiq_config, god_config) do
       $0 = "SidekiqRunner/God (#{god_config.process_name})"
 
       puts 'Starting god.'
@@ -31,7 +31,7 @@ module SidekiqRunner
   def self.stop
     sidekiq_config, god_config = SidekiqConfiguration.get, GodConfiguration.get
 
-    run(:stop, sidekiq_config) do
+    run(:stop, sidekiq_config, god_config) do
       God::EventHandler.load
 
       if god_alive?(god_config)
@@ -48,6 +48,19 @@ module SidekiqRunner
     end
   end
 
+  def self.restart(sidekiq_instances: [])
+    sidekiq_config = SidekiqConfiguration.get
+    god_config = GodConfiguration.get
+
+    return unless god_alive?(god_config)
+
+    run(:restart, sidekiq_config, god_config) do
+      sidekiq_config.each_key do |name|
+        God::CLI::Command.new('restart', god_config.options, ['', name]) if sidekiq_instances.empty? || sidekiq_instances.include?(name.to_sym)
+      end
+    end
+  end
+
   def self.running?
     god_alive? GodConfiguration.get
   end
@@ -69,7 +82,7 @@ module SidekiqRunner
     true
   end
 
-  def self.run(action, sidekiq_config)
+  def self.run(action, sidekiq_config, god_config)
     begin
 
       # Use this flag to actually load all of the god infrastructure.
@@ -77,16 +90,21 @@ module SidekiqRunner
       require 'god'
       require 'god/cli/run'
 
+      if [:start, :stop].include? action
+        cb = god_config.send("before_#{action}_cb".to_sym)
+        cb.call if cb
+      end
+
       # Peform the action.
       yield if block_given?
 
     rescue SystemExit => e
-      cb = e.success? ? "#{action}_success_cb" : "#{action}_error_cb"
+      sidekiq_cb = e.success? ? "#{action}_success_cb" : "#{action}_error_cb"
     ensure
       if [:start, :stop].include? action
-        cb = "#{action}_success_cb" unless cb
-        cb = sidekiq_config.send(cb.to_sym)
-        cb.call if cb
+        sidekiq_cb = "#{action}_success_cb" unless sidekiq_cb
+        sidekiq_cb = sidekiq_config.send(sidekiq_cb.to_sym)
+        sidekiq_cb.call if sidekiq_cb
       end
     end
   end

data/lib/sidekiq-runner/god_configuration.rb

@@ -15,9 +15,11 @@ module SidekiqRunner
     RUNNER_ATTRIBUTES = [:config_file, :daemonize, :port, :syslog, :events]
     RUNNER_ATTRIBUTES.each { |att| attr_accessor att }
 
-    CONFIG_FILE_ATTRIBUTES = [:process_name, :interval, :stop_timeout, :log_file, :maximum_memory_usage, :pid]
+    CONFIG_FILE_ATTRIBUTES = [:process_name, :interval, :stop_timeout, :log_file, :log_level, :maximum_memory_usage, :pid]
     CONFIG_FILE_ATTRIBUTES.each { |att| attr_accessor att }
 
+    attr_reader :generic_watchers
+
     def initialize
       @process_name = 'sidekiq'
       @interval  = 30
@@ -31,10 +33,17 @@ module SidekiqRunner
       @syslog = true
       @events = true
       @pid = nil
+      @log_level = :warn
 
       # This is going to be a part of the .sock file name e.g. "/tmp/god.17165.sock" and the pidfile name
       # Change this in the configuration file to be able to run multiple instances of god.
       @port = 17165
+
+      @generic_watchers = []
+    end
+
+    def add_generic(&blk)
+      @generic_watchers << blk
     end
 
     def options
@@ -47,7 +56,8 @@ module SidekiqRunner
         events: @events,
         config: File.expand_path("../sidekiq.god", __FILE__),
         log: @log_file,
-        pid: @pid
+        pid: @pid,
+        log_level: @log_level
       }
     end
 
@@ -62,7 +72,15 @@ module SidekiqRunner
     end
 
     def create_directories!
-      FileUtils.mkdir_p(File.dirname(log_file))
+      FileUtils.mkdir_p(File.dirname(log_file)) if log_file
+    end
+
+    %w(start stop).each do |action|
+      attr_reader "before_#{action}_cb".to_sym
+
+      define_method("before_#{action}") do |&block|
+        instance_variable_set("@before_#{action}_cb".to_sym, block)
+      end
     end
   end
 end

data/lib/sidekiq-runner/sidekiq.god

@@ -6,6 +6,12 @@ god_config = SidekiqRunner::GodConfiguration.get
 
 God.terminate_timeout = god_config.stop_timeout + 10
 
+god_config.generic_watchers.each do |block|
+  God.watch do |w|
+    block.call(w)
+  end
+end
+
 sidekiq_config.each do |name, skiq|
   God.watch do |w|
     w.name = name
@@ -13,13 +19,15 @@ sidekiq_config.each do |name, skiq|
     # Set start command.
     w.start = skiq.build_start_command
 
+    # Set logfile
+    w.log = skiq.logfile
+
     # Set stop command.
-    w.stop = skiq.build_stop_command(god_config.stop_timeout)
     w.stop_timeout = god_config.stop_timeout
 
-    # Make sure the pidfile is deleted as sidekiqctl does not delete stale pidfiles.
-    w.pid_file = skiq.pidfile
-    w.behavior(:clean_pid_file)
+    # Set uid/gid if requested.
+    w.uid = skiq.uid if skiq.uid
+    w.gid = skiq.gid if skiq.gid
 
     # Working directory has to be set properly.
     # Be aware that by default, God sets the working directory to / (root dir).
@@ -72,6 +80,10 @@ sidekiq_config.each do |name, skiq|
       end
     end
 
+    if skiq.config_blocks.length > 0
+      skiq.config_blocks.each { |blk| blk.call(w) }
+    end
+
     w.lifecycle do |on|
       on.condition(:flapping) do |c|
         c.to_state = [:start, :restart] # If this watch is started or restarted...

data/lib/sidekiq-runner/sidekiq_configuration.rb

@@ -12,7 +12,7 @@ module SidekiqRunner
     def initialize
       @config_file =
         if defined?(Rails)
-          File.join(Rails.root, 'config', 'sidekiq.yml')  
+          File.join(Rails.root, 'config', 'sidekiq.yml')
         else
           File.join(Dir.pwd, 'config', 'sidekiq.yml')
         end
@@ -86,8 +86,6 @@ module SidekiqRunner
     end
 
     def merge_config_file!
-      sidekiqs_common_config = {}
-
       yml = File.exist?(config_file) ? YAML.load_file(config_file) : {}
       yml = Hash[yml.map { |k, v| [k.to_sym, v] }]
 
@@ -96,8 +94,6 @@ module SidekiqRunner
 
     def sane?
       fail 'No sidekiq instances defined. Nothing to run.' if @sidekiqs.empty?
-      fail 'Sidekiq instances with the same pidfile found.' if @sidekiqs.values.map(&:pidfile).uniq.size < @sidekiqs.size
-      fail 'Sidekiq instances with the same logfile found.' if @sidekiqs.values.map(&:logfile).uniq.size < @sidekiqs.size
 
       @sidekiqs.each_value { |skiq| skiq.sane? }
     end

data/lib/sidekiq-runner/sidekiq_instance.rb

@@ -1,16 +1,15 @@
 module SidekiqRunner
   class SidekiqInstance
-
     RUNNER_ATTRIBUTES = [:bundle_env, :chdir, :requirefile]
     RUNNER_ATTRIBUTES.each { |att| attr_accessor att }
 
-    CONFIG_FILE_ATTRIBUTES = [:concurrency, :verbose, :pidfile, :logfile, :tag, :rbtrace]
+    CONFIG_FILE_ATTRIBUTES = [:concurrency, :verbose, :pidfile, :logfile, :tag, :rbtrace, :uid, :gid]
     CONFIG_FILE_ATTRIBUTES.each { |att| attr_accessor att }
 
-    attr_reader :name, :queues
+    attr_reader :name, :queues, :config_blocks
 
     def initialize(name)
-      fail "No sidekiq instance name given!" if name.empty?
+      raise "No sidekiq instance name given!" if name.empty?
 
       @name = name
       @queues = []
@@ -24,15 +23,23 @@ module SidekiqRunner
       @verbose      = false
       @tag          = name
       @rbtrace      = false
+      @uid          = nil
+      @gid          = nil
+      @config_blocks = []
     end
 
     def add_queue(queue_name, weight = 1)
-      fail "Cannot add the queue. The name is empty!" if queue_name.empty?
-      fail "Cannot add the queue. The weight is not an integer!" unless weight.is_a? Integer
-      fail "Cannot add the queue. The queue with \"#{queue_name}\" name already exist" if @queues.any? { |q| q.first == queue_name }
+      raise "Cannot add the queue. The name is empty!" if queue_name.empty?
+      raise "Cannot add the queue. The weight is not an integer!" unless weight.is_a? Integer
+      raise "Cannot add the queue. The queue with \"#{queue_name}\" name already exist" if @queues.any? { |q| q.first == queue_name }
+
       @queues << [queue_name, weight]
     end
 
+    def god_config(&block)
+      @config_blocks << block
+    end
+
     def merge_config_file!(yml)
       # Get global configuration options.
       SidekiqInstance::CONFIG_FILE_ATTRIBUTES.each do |k|
@@ -40,7 +47,7 @@ module SidekiqRunner
       end
 
       # Override with instance-specific options.
-      if (syml = yml[@name.to_sym]) && (syml.is_a?(Hash))
+      if (syml = yml[@name.to_sym]) && syml.is_a?(Hash)
         syml = Hash[syml.map { |k, v| [k.to_sym, v] }]
 
         SidekiqInstance::CONFIG_FILE_ATTRIBUTES.each do |k|
@@ -50,8 +57,8 @@ module SidekiqRunner
     end
 
     def sane?
-      fail "No queues given for #{@name}!" if @queues.empty?  
-      fail "No requirefile given for #{@name} and not in Rails environment!" if !defined?(Rails) && !requirefile
+      raise "No queues given for #{@name}!" if @queues.empty?
+      raise "No requirefile given for #{@name} and not in Rails environment!" if !defined?(Rails) && !requirefile
     end
 
     def build_start_command
@@ -59,33 +66,21 @@ module SidekiqRunner
 
       cmd = []
       cmd << 'bundle exec' if bundle_env
-      cmd << (rbtrace ? File.expand_path('../../../script/sidekiq_rbtrace', __FILE__) : 'sidekiq')
-      cmd << '-d'
+      cmd << (rbtrace ? File.expand_path('../../script/sidekiq_rbtrace', __dir__) : 'sidekiq')
       cmd << "-c #{concurrency}"
       cmd << '-v' if verbose
-      cmd << "-L #{logfile}"
       cmd << "-P #{pidfile}"
       cmd << "-e #{Rails.env}" if defined?(Rails)
       cmd << "-r #{requirefile}" if requirefile
       cmd << "-g '#{tag}'"
 
       queues.each do |q, w|
-        cmd << "-q #{q},#{w.to_s}"
+        cmd << "-q #{q},#{w}"
       end
 
       cmd.join(' ')
     end
 
-    def build_stop_command(timeout)
-      cmd = []
-      cmd << (bundle_env ? 'bundle exec sidekiqctl' : 'sidekiqctl')
-      cmd << 'stop'
-      cmd << pidfile
-      cmd << timeout
-
-      cmd.join(' ')
-    end
-
     private
 
     def create_directories!

data/lib/sidekiq-runner/version.rb

@@ -1,3 +1,3 @@
 module SidekiqRunner
-  VERSION = '0.1.4'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-runner
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.2
 platform: ruby
 authors:
 - FlavourSys Technology GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2021-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: god
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 description: Provide an easy way to configure, start, and monitor all your Sidekiq
   processes
 email: technology@flavoursys.com
@@ -73,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Sidekiq configuration and rake tasks