sidekiq-runner 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca0010af09c70a83fb3d9a7e19bb1fab9ab8c2d7
+  data.tar.gz: 2a56f515a2abc4174eca0e222161facc262d45bc
+SHA512:
+  metadata.gz: 30074809519b45508efeaa338146c1e601065f1e77c4d7df375d19e1ef67dfc4af440475f2643eb53146b3185092bd0ea361b944aa1683717471cfa2fa03c23f
+  data.tar.gz: c03238275cb23d3a27628abca14a087a22a0a9a519355525103392e05aed0f4039e87a3f7078fe8fdbb26d6c09e5057a434f1eae3d02d73ef0f5ea6d1c441eb8

data/lib/sidekiq-runner.rb

@@ -0,0 +1,98 @@
+require 'sidekiq-runner/sidekiq_configuration'
+require 'sidekiq-runner/god_configuration'
+require 'sidekiq-runner/sidekiq_instance'
+require 'sidekiq-runner/version'
+
+module SidekiqRunner
+  def self.configure
+    yield SidekiqConfiguration.default if block_given?
+  end
+
+  def self.configure_god
+    yield GodConfiguration.default if block_given?
+  end
+
+  def self.start
+    sidekiq_config, god_config = get_all_settings
+
+    fail 'No sidekiq instances defined. There is nothing to run.' if sidekiq_config.empty?
+
+    abort 'God is running. I found an instance of a running god process. Please stop it manually and try again.' if god_alive?(god_config)
+
+    run(:start, sidekiq_config) do
+      puts 'Starting god.'
+      God::CLI::Run.new(god_config.options)
+    end
+  end
+
+  def self.stop
+    sidekiq_config, god_config = get_all_settings
+
+    run(:stop, sidekiq_config) do
+      God::EventHandler.load
+
+      if god_alive?(god_config)
+        puts "Stopping process #{god_config.process_name}."
+
+        # Stop all the processes
+        sidekiq_config.each_key do |name|
+          God::CLI::Command.new('stop', god_config.options, ['', name])
+        end
+
+        puts 'Terminating god.'
+        God::CLI::Command.new('terminate', god_config.options, [])
+      else
+        puts 'God is not running, so no need to stop it.'
+      end
+    end
+  end
+
+  def self.settings
+    SidekiqConfiguration.get.to_hash
+  end
+
+  private
+
+  def self.get_all_settings
+    [SidekiqConfiguration.get, GodConfiguration.get]
+  end
+
+  def self.god_alive?(god_config)
+    puts 'Checking whether god is alive...'
+
+    require 'drb'
+    require 'god/socket'
+    DRb.start_service('druby://127.0.0.1:0')
+    server = DRbObject.new(nil, God::Socket.socket(god_config.port))
+
+    # ping server to ensure that it is responsive
+    begin
+      server.ping
+    rescue DRb::DRbConnError
+      return false
+    end
+    true
+  end
+
+  def self.run(action, sidekiq_config)
+    begin
+      # Use this flag to actually load all of the god infrastructure
+      $load_god = true
+      require 'god'
+      require 'god/cli/run'
+
+      # Peform the action
+      yield if block_given?
+      cb = nil
+    rescue SystemExit => e
+      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
+      end
+    end
+  end
+
+end

data/lib/sidekiq-runner/common_configuration.rb

@@ -0,0 +1,46 @@
+require 'yaml'
+
+module SidekiqRunner
+
+  # common functions for GodConfiguration and Configuration classes
+  class CommonConfiguration
+    # this method MUST be reimplemented
+    def self.default
+      fail(NotImplementedError, "Method \"#{__method__}\" is not implemented in \"#{name}\" class. Please DO implement this method to be able to derive from CommonConfiguration class.")
+    end
+
+    RUNNER_ATTRIBUTES = []
+    CONFIG_FILE_ATTRIBUTES = []
+
+    @config_file = ''
+
+    def to_hash
+      Hash[CONFIG_FILE_ATTRIBUTES.map { |att| [att, send(att)] }]
+    end
+
+    def self.get
+      config = default.dup
+      config.send :merge_config_file!
+      config.send :sane?
+      config
+    end
+
+    private
+
+    def merge_config_file!
+      if File.exist?(config_file)
+        yml = YAML.load_file(config_file)
+        CONFIG_FILE_ATTRIBUTES.each do |k|
+          v = yml[k] || yml[k.to_s]
+          send("#{k}=", v) unless v.nil?
+        end
+      end
+
+      self
+    end
+
+    def sane?
+    end
+
+  end # class
+end # module

data/lib/sidekiq-runner/god_configuration.rb

@@ -0,0 +1,39 @@
+require 'sidekiq-runner/common_configuration'
+
+module SidekiqRunner
+  class GodConfiguration < CommonConfiguration
+    def self.default
+      @default ||= GodConfiguration.new
+    end
+
+    RUNNER_ATTRIBUTES = [:config_file, :daemonize, :port, :syslog, :events, :options]
+    RUNNER_ATTRIBUTES.each { |att| attr_accessor att }
+
+    CONFIG_FILE_ATTRIBUTES = [:process_name, :interval, :stop_timeout, :log_file]
+    CONFIG_FILE_ATTRIBUTES.each { |att| attr_accessor att }
+
+    def initialize
+      @process_name = 'sidekiq'
+      @interval  = 30
+      @stop_timeout = 30
+      @log_file   = File.join(Dir.pwd, 'log', 'god.log')
+
+      @config_file  = File.join(Dir.pwd, 'config', 'god.yml')
+      @daemonize = true
+      # This is going to be a part of the .sock file name e.g. "/tmp/god.17165.sock"
+      # Change this in the configuration file to be able to run multiple instances of god
+      @port = 17165
+      @syslog = true
+      @events = true
+      @options = {
+        daemonize: @daemonize,
+        port: @port,
+        syslog: @syslog,
+        events: @events,
+        config: File.expand_path("../#{@process_name}.god", __FILE__),
+        log: @log_file
+      }
+    end
+
+  end
+end

data/lib/sidekiq-runner/sidekiq_command_builder.rb

@@ -0,0 +1,31 @@
+module SidekiqCommandBuilder
+
+  def self.build_start_command(sidekiq_config, skiq)
+    cmd = []
+    cmd << (skiq.bundle_env ? 'bundle exec sidekiq' : 'sidekiq')
+    cmd << '-d' if sidekiq_config.daemonize
+    cmd << "-c #{skiq.concurrency}"
+    cmd << "-e #{Rails.env}" if defined?(Rails)
+    cmd << '-v' if skiq.verbose
+    cmd << "-L #{skiq.logfile}"
+    cmd << "-P #{skiq.pidfile}"
+    cmd << "-r #{skiq.requirefile}" if skiq.requirefile
+
+    skiq.queues.each do |q, w|
+      cmd << "-q #{q},#{w.to_s}"
+    end
+
+    cmd.join(' ')
+  end
+
+  def self.build_stop_command(skiq, timeout)
+    cmd = []
+    cmd << (skiq.bundle_env ? 'bundle exec sidekiqctl' : 'sidekiqctl')
+    cmd << 'stop'
+    cmd << skiq.pidfile
+    cmd << timeout
+
+    cmd.join(' ')
+  end
+
+end

data/lib/sidekiq-runner/sidekiq_configuration.rb

@@ -0,0 +1,115 @@
+require 'sidekiq-runner/common_configuration'
+require 'fileutils'
+
+module SidekiqRunner
+  class SidekiqConfiguration < CommonConfiguration
+    include Enumerable
+
+    RUNNER_ATTRIBUTES = [:config_file, :daemonize]
+    RUNNER_ATTRIBUTES.each { |att| attr_accessor att }
+
+    attr_reader :sidekiqs
+
+    def initialize
+      @config_file = File.join(Dir.pwd, 'config', 'sidekiq.yml')
+      @daemonize   = true
+
+      @sidekiqs    = {}
+    end
+
+    def self.default
+      @default ||= SidekiqConfiguration.new
+    end
+
+    def each(&block)
+      @sidekiqs.each(&block)
+    end
+
+    def each_key(&block)
+      @sidekiqs.each_key(&block)
+    end
+
+    def empty?
+      @sidekiqs.empty?
+    end
+
+    # DELETEME in the future
+    # Redefined and kept for bakward compatibility
+    def queue(name, weight = 1)
+      # Create a default sidekiq instance when no instances were created
+      fail 'Sidekiq instances hash does not seem to be empty. 
+      It means you are using the newer syntax in the initializer to create at least one instance. 
+      Therefore you should not be using the old queue() function.' unless @sidekiqs.empty?
+
+      add_instance('sidekiq_default') do |skiq|
+        skiq.add_queue('default')
+      end
+    end
+
+    def add_instance(name)
+      skiq = SidekiqInstance.new(name)
+      yield skiq if block_given?
+
+      fail "Sidekick instance with the name of #{name} already exists! No duplicates please." if @sidekiqs.has_key?(name)
+
+      FileUtils.mkdir_p(File.dirname(skiq.pidfile))
+      FileUtils.mkdir_p(File.dirname(skiq.logfile))
+
+      @sidekiqs[name] = skiq
+
+      skiq
+    end
+
+    %w(start stop).each do |action|
+      %w(success error).each do |state|
+        attr_reader "#{action}_#{state}_cb".to_sym
+
+        define_method("on_#{action}_#{state}") do |&block|
+          instance_variable_set("@#{action}_#{state}_cb".to_sym, block)
+        end
+      end
+    end
+
+    private
+
+    def merge_config_file!
+      sidekiqs_common_config = {}
+      yml = {}
+
+      if File.exist?(config_file)
+        yml = YAML.load_file(config_file)
+        # Get sidekiq config common for all instances
+        SidekiqInstance::CONFIG_FILE_ATTRIBUTES.each do |k|
+          v = yml[k] || yml[k.to_s]
+          sidekiqs_common_config[k] = v if v
+        end
+      end
+
+      # Backwards compatibility
+      # Get sidekiq pidfile and logfile if no sidekiq instance was specified
+      SidekiqInstance::INDIVIDUAL_FILE_ATTRIBUTES.each do |k|
+        v = yml[k] || yml[k.to_s]
+        sidekiqs_common_config[k] = v if v
+      end
+
+      @sidekiqs.each do |name, skiq|
+        # Symbolize keys in yml hash
+        if yml[name] && yml[name].is_a?(Hash)
+          yml_config = Hash[yml[name].map { |k, v| [k.to_sym, v] }]
+        end
+        # Merge common and specific sidekiq instance configs
+        # Sidekiq instances not defined in the initializer but present in yml will be ignored
+        final_skiq_config = yml_config ? sidekiqs_common_config.merge(yml_config) : sidekiqs_common_config
+        skiq.merge_config!(final_skiq_config)
+        skiq.sane?
+      end
+
+      self
+    end
+
+    def sane?
+      fail 'No requirefile given and not in Rails env.' if !defined?(Rails) && !requirefile
+      fail 'No sidekiq instances defined. Nothing to run.' if @sidekiqs.empty?
+    end
+  end
+end

data/lib/sidekiq-runner/sidekiq_instance.rb

@@ -0,0 +1,48 @@
+module SidekiqRunner
+  class SidekiqInstance
+
+    CONFIG_FILE_ATTRIBUTES = [:bundle_env, :chdir, :requirefile, :concurrency, :verbose]
+    INDIVIDUAL_FILE_ATTRIBUTES = [:pidfile, :logfile]
+    CONFIG_FILE_ATTRIBUTES.concat(INDIVIDUAL_FILE_ATTRIBUTES).each { |att| attr_accessor att }
+
+    attr_reader :name, :queues
+
+    def initialize(name)
+      fail "No sidekiq instance name given!" if name.empty?
+
+      @name = name
+      @queues = []
+
+      @bundle_env   = true
+      @daemonize    = true
+      @chdir        = nil
+      @requirefile  = nil
+      @pidfile      = File.join(Dir.pwd, 'tmp', 'pids', "#{@name}.pid")
+      @logfile      = File.join(Dir.pwd, 'log', "#{@name}.log")
+      @concurrency  = 4
+      @verbose      = false
+
+    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?{|arr| arr.first == queue_name}
+      @queues << [queue_name, weight]
+    end
+
+    def sane?
+      fail "No queues given for #{@name}!" if @queues.empty?  
+    end
+
+    def merge_config!(skiq)
+        CONFIG_FILE_ATTRIBUTES.each do |k|
+          v = nil || skiq[k]
+          send("#{k}=", v) unless v.nil?
+        end
+
+      self
+    end
+
+  end
+end

data/lib/sidekiq-runner/tasks.rb

@@ -0,0 +1,20 @@
+require 'sidekiq-runner'
+
+rails_env = Rake::Task.task_defined?(:environment) ? [:environment] : []
+
+namespace :sidekiqrunner do
+  desc 'Start sidekiq-runner instances'
+  task start: rails_env do
+    puts 'Starting sidekiq instances...'
+    SidekiqRunner.start
+  end
+
+  desc 'Stop sidekiq-runner instances'
+  task stop: rails_env do
+    puts 'Gracefully shutting down sidekiq instances...'
+    SidekiqRunner.stop
+  end
+
+  desc 'Restart sidekiq-runner instances'
+  task restart: ['sidekiq:stop', 'sidekiq:start']
+end

data/lib/sidekiq-runner/version.rb

@@ -0,0 +1,3 @@
+module SidekiqRunner
+  VERSION = '0.0.3'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-runner
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- FlavourSys Technology GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-29 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: god
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: A little collection of Sidekiq start/stop rake tasks and configuration
+  framework
+email: technology@flavoursys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sidekiq-runner.rb
+- lib/sidekiq-runner/common_configuration.rb
+- lib/sidekiq-runner/god_configuration.rb
+- lib/sidekiq-runner/sidekiq_command_builder.rb
+- lib/sidekiq-runner/sidekiq_configuration.rb
+- lib/sidekiq-runner/sidekiq_instance.rb
+- lib/sidekiq-runner/tasks.rb
+- lib/sidekiq-runner/version.rb
+homepage: http://flavoursys.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Sidekiq rake task collection
+test_files: []