sneakers 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c52a398aecf272a36fcb3431f7b242a0d36dc0d1
-  data.tar.gz: c5974b0f7823f4d1e91c99d88adc3bbe50a2e572
+  metadata.gz: '09f8536528b4fa33c1d597f1ca8f513d5ca8f37b'
+  data.tar.gz: c24a191dc06d4457c9f5ac7bfd8f089ca7ed175f
 SHA512:
-  metadata.gz: 85bc282b42260ebb6a08fdab01fc2396a30450f3cabb93bed27ccac801bc216e5e139613349cfb874a9c5c2a453234591759671de64c9f7654ddd5076384f746
-  data.tar.gz: 06fd1978121e6e59971152fd202e1cb2d5b13225d0f08f75583a5d021b0cfb8d52768102a007cef7d1dc191ed9264505a9e4157987054bc9631ee3eaaf749605
+  metadata.gz: 8e24898e348b40e79640d216fa9c56b63bf8c94340f23b4e54a4a163fdcbee8c7628a3db7f3128d3ed0220e9e7f83b36239917e610a9ca5b9c481108847cc61c
+  data.tar.gz: 369b932fef00b62847c74e070cd6248203505bf87ff3d932de8eb9ef80bcd65dd7732d59f7b47def85b4746c4b9cce0e933c0bb0b6845fe2f40f8f6a33b8e07b

data/.gitignore

@@ -7,3 +7,4 @@ coverage/
 tmp/
 .ruby-version
 .ruby-gemset
+.bundle/*

data/ChangeLog.md

@@ -0,0 +1,67 @@
+# Sneakers Change Log
+
+## Changes Between 2.6.0 and 2.7.0
+
+This release requires Ruby 2.2 and has **breaking API changes**
+around custom error handlers.
+
+### Use Provided Connections in WorkerGroup
+
+It is now possible to use a custom connection instance in worker groups.
+
+Contributed by @pomnikita.
+
+GitHub issue: [#322](https://github.com/jondot/sneakers/pull/322)
+
+
+### Worker Context Available to Worker Instances
+
+Contributed by Jason Lombardozzi.
+
+GitHub issue: [#307](https://github.com/jondot/sneakers/pull/307)
+
+
+### Ruby 2.2 Requirement
+
+Sneakers now [requires Ruby 2.2](https://github.com/jondot/sneakers/commit/f33246a1bd3b5fe53ee662253dc5bac7864eec97).
+
+
+### Bunny 2.9.x
+
+Bunny was [upgraded](https://github.com/jondot/sneakers/commit/c7fb0bd23280082e43065d7199668486db005c13) to 2.9.x.
+
+
+
+### Server Engine 2.0.5
+
+Server Engine dependency was [upgraded to 2.0.5](https://github.com/jondot/sneakers/commit/3f60fd5e88822169fb04088f0ce5d2f94f803339).
+
+
+### Refactored Publisher Connection
+
+Contributed by Christoph Wagner.
+
+GitHub issue: [#325](https://github.com/jondot/sneakers/pull/325)
+
+
+### New Relic Reporter Migrated to the Modern API
+
+Contributed by @adamors.
+
+GitHub issue: [#324](https://github.com/jondot/sneakers/pull/324)
+
+
+### Configuration Logged at Debug Level
+
+To avoid potentially leaking credentials in the log.
+
+Contributed by Kimmo Lehto.
+
+GitHub issue: [#301](https://github.com/jondot/sneakers/pull/301).
+
+
+### Comment Corrections
+
+Contributed by Andrew Babichev
+
+GitHub issue: [#346](https://github.com/jondot/sneakers/pull/346)

data/Gemfile

@@ -1,3 +1,5 @@
 source 'https://rubygems.org'
 
+gem 'ruby-prof', platforms: [:ruby_22, :ruby_23, :ruby_24]
+
 gemspec

data/README.md

@@ -18,8 +18,8 @@ Sneakers is being used in production for both I/O and CPU intensive workloads, a
 
 
 Visit the [wiki](https://github.com/jondot/sneakers/wiki) for
-complete docs.
-
+documentation and [GitHub releases](https://github.com/jondot/sneakers/releases) for release
+notes.
 
 [![Build Status](https://travis-ci.org/jondot/sneakers.svg?branch=master)](https://travis-ci.org/jondot/sneakers)
 
@@ -172,7 +172,7 @@ environment needed locally on your development box.
   running `script/local_worker`. This will use docker-compose as well. It will
   also help you get a feeling for how to run Sneakers in a Docker based
   production environment
-* User `Dockerfile.slim` instead of `Dockerfile` for production docker builds.
+* Use `Dockerfile.slim` instead of `Dockerfile` for production docker builds.
   It generates a more compact image, while the "regular" `Dockerfile` generates
   a fatter image - yet faster to iterate when developing
 

data/lib/sneakers.rb

@@ -79,7 +79,7 @@ module Sneakers
 
   # Register a proc to handle any error which occurs within the Sneakers process.
   #
-  #   Sneakers.error_reporters << proc {|ex,ctx_hash| MyErrorService.notify(ex, ctx_hash) }
+  #   Sneakers.error_reporters << proc { |exception, worker, context_hash| MyErrorService.notify(exception, context_hash) }
   #
   # The default error handler logs errors to Sneakers.logger.
   # Ripped off from https://github.com/mperham/sidekiq/blob/6ad6a3aa330deebd76c6cf0d353f66abd3bef93b/lib/sidekiq.rb#L165-L174

data/lib/sneakers/error_reporter.rb

@@ -2,10 +2,10 @@
 module Sneakers
   module ErrorReporter
     class DefaultLogger
-      def call(exception, context_hash)
+      def call(exception, worker, context_hash)
         Sneakers.logger.warn(context_hash) unless context_hash.empty?
         log_string = ''
-        log_string += "[Exception error=#{exception.message.inspect} error_class=#{exception.class}" unless exception.nil?
+        log_string += "[Exception error=#{exception.message.inspect} error_class=#{exception.class} worker_class=#{worker.class}"  unless exception.nil?
         log_string += " backtrace=#{exception.backtrace.take(50).join(',')}" unless exception.nil? || exception.backtrace.nil?
         log_string += ']'
         Sneakers.logger.error log_string
@@ -15,7 +15,7 @@ module Sneakers
     def worker_error(exception, context_hash = {})
       Sneakers.error_reporters.each do |handler|
         begin
-          handler.call(exception, context_hash)
+          handler.call(exception, self, context_hash)
         rescue => inner_exception
           Sneakers.logger.error '!!! ERROR REPORTER THREW AN ERROR !!!'
           Sneakers.logger.error inner_exception

data/lib/sneakers/metrics/newrelic_metrics.rb

@@ -15,7 +15,8 @@ module Sneakers
       end
 
       def record_stat(metric, num)
-        stats(metric).record_data_point(num)
+        metric_name = "Custom/#{metric.gsub("\.", "\/")}"
+        NewrelicMetrics.eagent::Agent.record_metric(metric_name, num)
       rescue Exception => e
         puts "NewrelicMetrics#record_stat: #{e}"
       end
@@ -25,12 +26,6 @@ module Sneakers
         block.call
         record_stat(metric, ((Time.now - start)*1000).floor)
       end
-
-      def stats(metric)
-        metric.gsub! "\.", "\/"
-        NewrelicMetrics.eagent::Agent.get_stats("Custom/#{metric}")
-      end
-
     end
   end
 end

data/lib/sneakers/publisher.rb

@@ -1,28 +1,32 @@
 module Sneakers
   class Publisher
+
+    attr_reader :exchange, :channel
+
     def initialize(opts = {})
       @mutex = Mutex.new
       @opts = Sneakers::CONFIG.merge(opts)
+      # If we've already got a bunny object, use it.  This allows people to
+      # specify all kinds of options we don't need to know about (e.g. for ssl).
+      @bunny = @opts[:connection]
     end
 
     def publish(msg, options = {})
-      @mutex.synchronize do
-        ensure_connection! unless connected?
-      end
+      ensure_connection!
       to_queue = options.delete(:to_queue)
       options[:routing_key] ||= to_queue
       Sneakers.logger.info {"publishing <#{msg}> to [#{options[:routing_key]}]"}
       @exchange.publish(ContentType.serialize(msg, options[:content_type]), options)
     end
 
-
-    attr_reader :exchange
+    def ensure_connection!
+      @mutex.synchronize do
+        connect! unless connected?
+      end
+    end
 
   private
-    def ensure_connection!
-      # If we've already got a bunny object, use it.  This allows people to
-      # specify all kinds of options we don't need to know about (e.g. for ssl).
-      @bunny = @opts[:connection]
+    def connect!
       @bunny ||= create_bunny_connection
       @bunny.start
       @channel = @bunny.create_channel
@@ -30,7 +34,7 @@ module Sneakers
     end
 
     def connected?
-      @bunny && @bunny.connected?
+      @bunny && @bunny.connected? && channel
     end
 
     def create_bunny_connection

data/lib/sneakers/queue.rb

@@ -1,6 +1,6 @@
 
 class Sneakers::Queue
-  attr_reader :name, :opts, :exchange
+  attr_reader :name, :opts, :exchange, :channel
 
   def initialize(name, opts)
     @name = name

data/lib/sneakers/runner.rb

@@ -58,8 +58,7 @@ module Sneakers
         Sneakers::CONFIG[:hooks][hook] = config.delete(hook) if config[hook]
       end
 
-
-      Sneakers.logger.info("New configuration: #{config.inspect}")
+      Sneakers.logger.debug("New configuration: #{config.inspect}")
       config
     end
 
@@ -73,6 +72,7 @@ module Sneakers
       serverengine_config =  Sneakers::CONFIG.merge(@conf)
       serverengine_config.merge!(
         :logger => Sneakers.logger,
+        :log_level => Sneakers.logger.level,
         :worker_type => 'process',
         :worker_classes => @worker_classes,
 

data/lib/sneakers/version.rb

@@ -1,3 +1,3 @@
 module Sneakers
-  VERSION = "2.6.0"
+  VERSION = "2.7.0"
 end

data/lib/sneakers/worker.rb

@@ -19,7 +19,7 @@ module Sneakers
 
       @should_ack =  opts[:ack]
       @timeout_after = opts[:timeout_job_after]
-      @pool = pool || Concurrent::FixedThreadPool.new(opts[:threads])
+      @pool = pool || Concurrent::FixedThreadPool.new(opts[:threads] || Sneakers::Configuration::DEFAULTS[:threads])
       @call_with_params = respond_to?(:work_with_params)
       @content_type = opts[:content_type]
 
@@ -47,53 +47,57 @@ module Sneakers
       worker_trace "Working off: #{msg.inspect}"
 
       @pool.post do
-        res = nil
-        error = nil
-
-        begin
-          metrics.increment("work.#{self.class.name}.started")
-          Timeout.timeout(@timeout_after, WorkerTimeout) do
-            metrics.timing("work.#{self.class.name}.time") do
-              deserialized_msg = ContentType.deserialize(msg, @content_type || metadata && metadata[:content_type])
-              if @call_with_params
-                res = work_with_params(deserialized_msg, delivery_info, metadata)
-              else
-                res = work(deserialized_msg)
-              end
+        process_work(delivery_info, metadata, msg, handler)
+      end
+    end
+
+    def process_work(delivery_info, metadata, msg, handler)
+      res = nil
+      error = nil
+
+      begin
+        metrics.increment("work.#{self.class.name}.started")
+        Timeout.timeout(@timeout_after, WorkerTimeout) do
+          metrics.timing("work.#{self.class.name}.time") do
+            deserialized_msg = ContentType.deserialize(msg, @content_type || metadata && metadata[:content_type])
+            if @call_with_params
+              res = work_with_params(deserialized_msg, delivery_info, metadata)
+            else
+              res = work(deserialized_msg)
             end
           end
-        rescue WorkerTimeout => ex
-          res = :timeout
-          worker_error(ex, log_msg: log_msg(msg), class: self.class.name,
-                       message: msg, delivery_info: delivery_info, metadata: metadata)
-        rescue => ex
-          res = :error
-          error = ex
-          worker_error(ex, log_msg: log_msg(msg), class: self.class.name,
-                       message: msg, delivery_info: delivery_info, metadata: metadata)
         end
+      rescue WorkerTimeout => ex
+        res = :timeout
+        worker_error(ex, log_msg: log_msg(msg), class: self.class.name,
+                     message: msg, delivery_info: delivery_info, metadata: metadata)
+      rescue => ex
+        res = :error
+        error = ex
+        worker_error(ex, log_msg: log_msg(msg), class: self.class.name,
+                     message: msg, delivery_info: delivery_info, metadata: metadata)
+      end
 
-        if @should_ack
-
-          if res == :ack
-            # note to future-self. never acknowledge multiple (multiple=true) messages under threads.
-            handler.acknowledge(delivery_info, metadata, msg)
-          elsif res == :timeout
-            handler.timeout(delivery_info, metadata, msg)
-          elsif res == :error
-            handler.error(delivery_info, metadata, msg, error)
-          elsif res == :reject
-            handler.reject(delivery_info, metadata, msg)
-          elsif res == :requeue
-            handler.reject(delivery_info, metadata, msg, true)
-          else
-            handler.noop(delivery_info, metadata, msg)
-          end
-          metrics.increment("work.#{self.class.name}.handled.#{res || 'noop'}")
+      if @should_ack
+
+        if res == :ack
+          # note to future-self. never acknowledge multiple (multiple=true) messages under threads.
+          handler.acknowledge(delivery_info, metadata, msg)
+        elsif res == :timeout
+          handler.timeout(delivery_info, metadata, msg)
+        elsif res == :error
+          handler.error(delivery_info, metadata, msg, error)
+        elsif res == :reject
+          handler.reject(delivery_info, metadata, msg)
+        elsif res == :requeue
+          handler.reject(delivery_info, metadata, msg, true)
+        else
+          handler.noop(delivery_info, metadata, msg)
         end
+        metrics.increment("work.#{self.class.name}.handled.#{res || 'noop'}")
+      end
 
-        metrics.increment("work.#{self.class.name}.ended")
-      end #post
+      metrics.increment("work.#{self.class.name}.ended")
     end
 
     def stop
@@ -152,4 +156,3 @@ module Sneakers
     end
   end
 end
-

data/lib/sneakers/workergroup.rb

@@ -29,13 +29,13 @@ module Sneakers
         worker_classes = worker_classes.call
       end
 
-      # if we don't provide a connection to a worker,
+      # If we don't provide a connection to a worker,
       # the queue used in the worker will create a new one
-      # so if we want to have a shared bunny connection for the workers
-      # we must create it here
-      bunny_connection = create_connection_or_nil
 
-      @workers = worker_classes.map{|w| w.new(nil, pool, {connection: bunny_connection}) }
+      @workers = worker_classes.map do |worker_class|
+        worker_class.new(nil, pool, { connection: config[:connection] })
+      end
+
       # if more than one worker this should be per worker
       # accumulate clients and consumers as well
       @workers.each do |worker|
@@ -47,7 +47,6 @@ module Sneakers
         Sneakers.logger.debug("Heartbeat: running threads [#{Thread.list.count}]")
         # report aggregated stats?
       end
-
     end
 
     def stop
@@ -57,14 +56,5 @@ module Sneakers
       end
       @stop_flag.set!
     end
-
-    def create_bunny_connection
-      Bunny.new(Sneakers::CONFIG[:amqp], :vhost => Sneakers::CONFIG[:vhost], :heartbeat => Sneakers::CONFIG[:heartbeat], :logger => Sneakers::logger)
-    end
-
-    def create_connection_or_nil
-      config[:share_bunny_connection] ? create_bunny_connection : nil
-    end
-    private :create_bunny_connection, :create_connection_or_nil
   end
 end

data/sneakers.gemspec

@@ -12,14 +12,14 @@ Gem::Specification.new do |gem|
   gem.summary       = %q( Fast background processing framework for Ruby and RabbitMQ )
   gem.homepage      = 'http://sneakers.io'
   gem.license       = 'MIT'
-  gem.required_ruby_version = Gem::Requirement.new(">= 2.0")
+  gem.required_ruby_version = Gem::Requirement.new(">= 2.2")
 
   gem.files         = `git ls-files`.split($/).reject { |f| f == 'Gemfile.lock' }
   gem.executables   = gem.files.grep(/^bin/).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(/^(test|spec|features)\//)
   gem.require_paths = ['lib']
-  gem.add_dependency 'serverengine', '~> 1.5.11'
-  gem.add_dependency 'bunny', '~> 2.7.0'
+  gem.add_dependency 'serverengine', '~> 2.0.5'
+  gem.add_dependency 'bunny', '~> 2.9.2'
   gem.add_dependency 'concurrent-ruby', '~> 1.0'
   gem.add_dependency 'thor'
 
@@ -29,7 +29,6 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rr'
   gem.add_development_dependency 'unparser', '0.2.2' # keep below 0.2.5 for ruby 2.0 compat.
-  gem.add_development_dependency 'ruby-prof'
   gem.add_development_dependency 'guard-minitest'
   gem.add_development_dependency 'metric_fu'
   gem.add_development_dependency 'simplecov'
@@ -38,4 +37,3 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'minitest'
   gem.add_development_dependency 'guard'
 end
-

data/spec/sneakers/integration_spec.rb

@@ -4,6 +4,7 @@ require 'sneakers/runner'
 require 'fixtures/integration_worker'
 
 require "rabbitmq/http/client"
+require 'timeout'
 
 
 describe "integration" do
@@ -17,23 +18,30 @@ describe "integration" do
       puts msg if ENV['INTEGRATION_LOG']
     end
 
+    def rmq_addr
+      @rmq_addr ||= compose_or_localhost("rabbitmq")
+    end
+
+    def admin
+      @admin ||=
+        begin
+          puts "RABBITMQ is at #{rmq_addr}"
+          RabbitMQ::HTTP::Client.new("http://#{rmq_addr}:15672/", username: "guest", password: "guest")
+        rescue
+          fail "Rabbitmq admin seems to not exist? you better be running this on Travis or Docker. proceeding.\n#{$!}"
+        end
+    end
+
     def prepare
       # clean up all integration queues; admin interface must be installed
       # in integration env
-      rmq_addr = compose_or_localhost("rabbitmq")
-      puts "RABBITMQ is at #{rmq_addr}"
-      begin
-        admin = RabbitMQ::HTTP::Client.new("http://#{rmq_addr}:15672/", username: "guest", password: "guest")
-        qs = admin.list_queues
-        qs.each do |q|
-          name = q.name
-          if name.start_with? 'integration_'
-            admin.delete_queue('/', name)
-            integration_log "cleaning up #{name}."
-          end
+      qs = admin.list_queues
+      qs.each do |q|
+        name = q.name
+        if name.start_with? 'integration_'
+          admin.delete_queue('/', name)
+          integration_log "cleaning up #{name}."
         end
-      rescue
-        puts "Rabbitmq admin seems to not exist? you better be running this on Travis or Docker. proceeding.\n#{$!}"
       end
 
       Sneakers.clear!
@@ -85,22 +93,27 @@ describe "integration" do
       pid
     end
 
-    def any_consumers
-      rmq_addr = compose_or_localhost("rabbitmq")
-      result = false
-      begin
-        admin = RabbitMQ::HTTP::Client.new("http://#{rmq_addr}:15672/", username: "guest", password: "guest")
-        qs = admin.list_queues
-        qs.each do |q|
-          if q.name.start_with? 'integration_'
-            puts "We see #{q.consumers} consumers on #{q.name}"
-            return true if q.consumers > 0
-          end
+    def consumers_count
+      qs = admin.list_queues
+      qs.each do |q|
+        if q.name.start_with? 'integration_'
+          return [q.consumers, q.name]
         end
-        return false
-      rescue
-        puts "Rabbitmq admin seems to not exist? you better be running this on Travis or Docker. proceeding.\n#{$!}"
       end
+      return [0, nil]
+    end
+
+    def assert_any_consumers(consumers_should_be_there, maximum_wait_time = 15)
+      Timeout::timeout(maximum_wait_time) do
+        loop do
+          consumers, queue = consumers_count
+          fail 'no queues so no consumers' if consumers_should_be_there && !queue
+          puts "We see #{consumers} consumers on #{queue}"
+          (consumers_should_be_there == consumers.zero?) ? sleep(1) : return
+        end
+      end
+    rescue Timeout::Error
+      fail "Consumers should #{'not' unless consumers_should_be_there} be here but #{consumers} consumers were after #{maximum_wait_time}s waiting."
     end
 
     it 'should be possible to terminate when queue is full' do
@@ -116,11 +129,10 @@ describe "integration" do
       end
 
       pid = start_worker(IntegrationWorker)
-      any_consumers.must_equal true
+      assert_any_consumers true
       integration_log "Killing #{pid} now!"
       Process.kill("TERM", pid)
-      sleep(2)
-      any_consumers.must_equal false
+      assert_any_consumers false
     end
 
     it 'should pull down 100 jobs from a real queue' do
@@ -144,5 +156,3 @@ describe "integration" do
 
   end
 end
-
-

data/spec/sneakers/publisher_spec.rb

@@ -63,7 +63,7 @@ describe Sneakers::Publisher do
       p.instance_variable_set(:@exchange, xchg)
 
       mock(p).connected? { true }
-      mock(p).ensure_connection!.times(0)
+      mock(p).connect!.times(0)
 
       p.publish('test msg', to_queue: 'downloads')
     end
@@ -95,34 +95,46 @@ describe Sneakers::Publisher do
       p.publish('test msg', to_queue: 'downloads')
     end
 
-    it 'should use an externally instantiated bunny session if provided' do
-      logger = Logger.new('/dev/null')
-      channel = Object.new
-      exchange = Object.new
-      existing_session = Bunny.new
-      my_vars = pub_vars.merge(to_queue: 'downloads')
-
-      mock(existing_session).start
-      mock(existing_session).create_channel { channel }
-
-      mock(channel).exchange('another_exchange', type: :topic, durable: false, :auto_delete => false, arguments: { 'x-arg' => 'value' }) do
-        exchange
+    describe 'externally instantiated bunny session' do
+      let(:my_vars) { pub_vars.merge(to_queue: 'downloads') }
+      before do
+        logger = Logger.new('/dev/null')
+        channel = Object.new
+        exchange = Object.new
+        existing_session = Bunny.new
+
+        mock(existing_session).start
+        mock(existing_session).create_channel { channel }
+
+        mock(channel).exchange('another_exchange', type: :topic, durable: false, :auto_delete => false, arguments: { 'x-arg' => 'value' }) do
+          exchange
+        end
+
+        mock(exchange).publish('test msg', my_vars)
+
+        Sneakers.configure(
+          connection: existing_session,
+          heartbeat: 1, exchange: 'another_exchange',
+          exchange_type: :topic,
+          exchange_arguments: { 'x-arg' => 'value' },
+          log: logger,
+          durable: false
+        )
+        @existing_session = existing_session
       end
 
-      mock(exchange).publish('test msg', my_vars)
-
-      Sneakers.configure(
-        connection: existing_session,
-        heartbeat: 1, exchange: 'another_exchange',
-        exchange_type: :topic,
-        exchange_arguments: { 'x-arg' => 'value' },
-        log: logger,
-        durable: false
-      )
+      it 'can handle an existing connection that is offline' do
+        p = Sneakers::Publisher.new
+        p.publish('test msg', my_vars)
+        p.instance_variable_get(:@bunny).must_equal @existing_session
+      end
 
-      p = Sneakers::Publisher.new
-      p.publish('test msg', my_vars)
-      p.instance_variable_get(:@bunny).must_equal existing_session
+      it 'can handle an existing connection that is online' do
+        mock(@existing_session).connected? { true }
+        p = Sneakers::Publisher.new
+        p.publish('test msg', my_vars)
+        p.instance_variable_get(:@bunny).must_equal @existing_session
+      end
     end
 
     it 'should publish using the content type serializer' do

data/spec/sneakers/runner_spec.rb

@@ -1,6 +1,7 @@
 require 'logger'
 require 'spec_helper'
 require 'sneakers'
+require 'sneakers/runner'
 
 describe Sneakers::Runner do
   let(:logger) { Logger.new('logtest.log') }
@@ -29,10 +30,10 @@ describe Sneakers::RunnerConfig do
   let(:logger) { Logger.new("logtest.log") }
   let(:runner_config) { Sneakers::Runner.new([]).instance_variable_get("@runnerconfig") }
 
-
-
   describe "with a connection" do
-    before { Sneakers.configure(log: logger, connection: Object.new) }
+    let(:connection) { Object.new }
+
+    before { Sneakers.configure(log: logger, connection: connection) }
 
     describe "#reload_config!" do
       it "does not throw exception" do
@@ -46,6 +47,10 @@ describe Sneakers::RunnerConfig do
       it "must have :logger key as an instance of Logger" do
         runner_config.reload_config![:logger].is_a?(Logger).must_equal true
       end
+
+      it "must have :connection" do
+        runner_config.reload_config![:connection].is_a?(Object).must_equal true
+      end
     end
   end
 

data/spec/sneakers/worker_spec.rb

@@ -313,6 +313,22 @@ describe Sneakers::Worker do
         DummyWorker.new.id.must_match(/^worker-/)
       end
     end
+
+    describe 'when connection provided' do
+      before do
+        @connection = Bunny.new(host: 'any-host.local')
+        Sneakers.configure(
+          exchange:          'some-exch',
+          exchange_options:  { type: :direct },
+          connection:        @connection,
+        )
+      end
+
+      it "should build a queue with given connection" do
+        @dummy_q = DummyWorker.new.queue
+        @dummy_q.opts[:connection].must_equal(@connection)
+      end
+    end
   end
 
 
@@ -384,7 +400,7 @@ describe Sneakers::Worker do
       handler = Object.new
       header = Object.new
       mock(handler).error(header, nil, "msg", anything)
-      mock(w.logger).error(/\[Exception error="foo" error_class=RuntimeError backtrace=.*/)
+      mock(w.logger).error(/\[Exception error="foo" error_class=RuntimeError worker_class=AcksWorker backtrace=.*/)
       w.do_work(header, nil, "msg", handler)
     end
 
@@ -393,7 +409,7 @@ describe Sneakers::Worker do
       header = Object.new
       w = AcksWorker.new(@queue, TestPool.new)
       mock(w).work("msg").once{ raise "foo" }
-      mock(w.logger).error(/error="foo" error_class=RuntimeError backtrace=/)
+      mock(w.logger).error(/error="foo" error_class=RuntimeError worker_class=AcksWorker backtrace=/)
       mock(handler).error(header, nil, "msg", anything)
       w.do_work(header, nil, "msg", handler)
     end
@@ -406,7 +422,7 @@ describe Sneakers::Worker do
       header = Object.new
 
       mock(handler).timeout(header, nil, "msg")
-      mock(w.logger).error(/error="execution expired" error_class=Sneakers::WorkerTimeout backtrace=/)
+      mock(w.logger).error(/error="execution expired" error_class=Sneakers::WorkerTimeout worker_class=TimeoutWorker backtrace=/)
 
       w.do_work(header, nil, "msg", handler)
     end
@@ -526,11 +542,10 @@ describe Sneakers::Worker do
       it 'only logs backtraces if present' do
         w = DummyWorker.new(@queue, TestPool.new)
         mock(w.logger).warn('cuz')
-        mock(w.logger).error(/\[Exception error="boom!" error_class=RuntimeError\]/)
+        mock(w.logger).error(/\[Exception error="boom!" error_class=RuntimeError worker_class=DummyWorker\]/)
         w.worker_error(RuntimeError.new('boom!'), 'cuz')
       end
     end
-
   end
 
 

data/spec/sneakers/workergroup_spec.rb

@@ -0,0 +1,83 @@
+require 'logger'
+require 'spec_helper'
+require 'sneakers'
+require 'sneakers/runner'
+
+class DummyFlag
+  def wait_for_set(*)
+    true
+  end
+end
+
+class DummyEngine
+  include Sneakers::WorkerGroup
+
+  attr_reader :config
+
+  def initialize(config)
+    @config = config
+    @stop_flag = DummyFlag.new
+  end
+end
+
+class DefaultsWorker
+  include Sneakers::Worker
+  from_queue 'defaults'
+
+  def work(msg); end
+end
+
+class StubbedWorker
+  attr_reader :opts
+
+  def initialize(_, _, opts)
+    @opts = opts
+  end
+
+  def run
+    true
+  end
+end
+
+describe Sneakers::WorkerGroup do
+  let(:logger) { Logger.new('logtest.log') }
+  let(:connection) { Bunny.new(host: 'any-host.local') }
+  let(:runner) { Sneakers::Runner.new([DefaultsWorker]) }
+  let(:runner_config) { runner.instance_variable_get('@runnerconfig') }
+  let(:config) { runner_config.reload_config! }
+  let(:engine) { DummyEngine.new(config) }
+
+  describe '#run' do
+    describe 'with connecion provided' do
+      before do
+        Sneakers.clear!
+        Sneakers.configure(connection: connection, log: logger)
+      end
+
+      it 'creates workers with connection: connection' do
+        DefaultsWorker.stub(:new, ->(*args) { StubbedWorker.new(*args) }) do
+          engine.run
+
+          workers = engine.instance_variable_get('@workers')
+          workers.first.opts[:connection].must_equal(connection)
+        end
+      end
+    end
+
+    describe 'without connecion provided' do
+      before do
+        Sneakers.clear!
+        Sneakers.configure(log: logger)
+      end
+
+      it 'creates workers with connection: nil' do
+        DefaultsWorker.stub(:new, ->(*args) { StubbedWorker.new(*args) }) do
+          engine.run
+
+          workers = engine.instance_variable_get('@workers')
+          assert_nil(workers.first.opts[:connection])
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sneakers
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Dotan Nahum
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-30 00:00:00.000000000 Z
+date: 2018-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serverengine
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.11
+        version: 2.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.11
+        version: 2.0.5
 - !ruby/object:Gem::Dependency
   name: bunny
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.9.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.9.2
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -122,20 +122,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.2.2
-- !ruby/object:Gem::Dependency
-  name: ruby-prof
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
@@ -244,13 +230,13 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- ChangeLog.md
 - Dockerfile
 - Dockerfile.slim
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
-- ROADMAP.md
 - Rakefile
 - bin/sneakers
 - docker-compose.yaml
@@ -304,6 +290,7 @@ files:
 - spec/sneakers/support/utils_spec.rb
 - spec/sneakers/worker_handlers_spec.rb
 - spec/sneakers/worker_spec.rb
+- spec/sneakers/workergroup_spec.rb
 - spec/spec_helper.rb
 homepage: http://sneakers.io
 licenses:
@@ -317,7 +304,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -325,7 +312,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Fast background processing framework for Ruby and RabbitMQ
@@ -345,4 +332,5 @@ test_files:
 - spec/sneakers/support/utils_spec.rb
 - spec/sneakers/worker_handlers_spec.rb
 - spec/sneakers/worker_spec.rb
+- spec/sneakers/workergroup_spec.rb
 - spec/spec_helper.rb

data/ROADMAP.md

@@ -1,18 +0,0 @@
-# Roadmap
-
-It is essential to keep a clear roadmap.
-In its core, Sneakers is already production-ready. However, it is vital
-to take in feedback and improve what can be improved :)
-
-This document will communicate the stages that the next version is at.
-See `CHANGELOG.md` for new features that are in.
-
-
-# v0.1.0 (next version)
-
-- Taking in community pull requests and feedback
-- Verify production readiness and performance
-- Full performance test suite
-
-
-