sneakers 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb490f1549a3348a646ec90b63a8af53e7085896
-  data.tar.gz: a74285f7ae5b6e64158cc6cef77d2846be90a585
+  metadata.gz: 562f562a5bb003fdf3d00ae2a37eaf8e3201f80c
+  data.tar.gz: 922e09184bfd33fd91aac65f3ca109a98f85ad46
 SHA512:
-  metadata.gz: 8836ba87a2032d77e0a8c8713c00c2d00ca53da2d8bae2d3613a2a2f1fcbdf72e6487bd1b45996aafca2e8138e0ea3971beb142eae9706e726a1d32d14669886
-  data.tar.gz: e5c54fb937fdd219c570554a4577ba225a090b0fa5772396c0eeea39207d3176a8bdb880a92d8675e979335d0459f1cb156a40acfeeb231efa0300eb6f4c1d4f
+  metadata.gz: 5261d1b94c18d35bd051313865eec1612a74cfa1b4b5d340f942eec951f3f8fc0cf1f5f169c47ac48a57ef9bbd5aee62baffcdef8eb18741542fe64ce1beaa14
+  data.tar.gz: fbcb6831ef3fa9f5fd28a6ac12c1ef8a83e12aed46e0834a128fc43e752c6bc7f435dfc51fa5cd3307b168ca7b130bc6be0dd702738ceda8e00390d8488e9cf7

data/.travis.yml

@@ -1,3 +1,8 @@
+env:
+  - INTEGRATION_LOG=1 INTEGRATION=1
+services:
+  - rabbitmq
+  - redis-server
 language: ruby
 rvm:
 - 2.2

data/README.md

@@ -54,7 +54,11 @@ gem 'json'
 gem 'redis'
 ```
 
-And a worker
+How do we add a worker? Firstly create a file and name it as `boot.rb`
+then create a worker named as `Processor`.
+
+> touch boot.rb
+
 
 ```ruby
 require 'sneakers'
@@ -79,17 +83,6 @@ class Processor
 end
 ```
 
-We'll count errors and error types with Redis. As an example, make a message that looks like this:
-
-```javascript
-{
-   "type": "error",
-   "message": "HALP!",
-   "error": "CODE001"
-}
-```
-
-
 Let's test it out quickly from the command line:
 
 
@@ -99,8 +92,17 @@ $ sneakers work Processor --require boot.rb
 
 We just told Sneakers to spawn a worker named `Processor`, but first `--require` a file that we dedicate to setting up environment, including workers and what-not.
 
-If you go to your RabbitMQ admin now, you'll see a new queue named `logs` was created. Push a couple messages, and this is the output you should see at your terminal.
+If you go to your RabbitMQ admin now, you'll see a new queue named `logs` was created. Push a couple messages like below:
+
+```javascript
+{
+   "type": "error",
+   "message": "HALP!",
+   "error": "CODE001"
+}
+```
 
+And this is the output you should see at your terminal.
 
 ```
 2013-10-11T19:26:36Z p-4718 t-ovqgyb31o DEBUG: [worker-logs:1:213mmy][#<Thread:0x007fae6b05cc58>][logs][{:prefetch=>10, :durable=>true, :ack=>true, :heartbeat_interval=>2, :exchange=>"sneakers"}] Working off: log log
@@ -109,8 +111,8 @@ If you go to your RabbitMQ admin now, you'll see a new queue named `logs` was cr
 2013-10-11T19:26:40Z p-4719 t-ovqgyrx8g INFO: log log
 ```
 
-And redis will show this: 
 
+We'll count errors and error types with Redis.
 
 ``` shell-session
 $ redis-cli monitor

data/lib/sneakers/configuration.rb

@@ -77,7 +77,7 @@ module Sneakers
       redacted.merge! to_hash
 
       # redact passwords
-      redacted[:amqp] = redacted[:amqp].sub(/(?<=\Aamqp:\/)[^@]+(?=@)/, "<redacted>")
+      redacted[:amqp] = redacted[:amqp].sub(/(?<=\Aamqp:\/)[^@]+(?=@)/, "<redacted>") if redacted.has_key?(:amqp)
       return redacted.inspect_without_redaction
     end
     alias_method :inspect_without_redaction, :inspect

data/lib/sneakers/version.rb

@@ -1,3 +1,3 @@
 module Sneakers
-  VERSION = "2.2.0"
+  VERSION = "2.2.1"
 end

data/sneakers.gemspec

@@ -22,6 +22,10 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'thread', '~> 0.1.7'
   gem.add_dependency 'thor'
 
+  # for integration environment (see .travis.yml and integration_spec)
+  gem.add_development_dependency 'rabbitmq_http_api_client'
+  gem.add_development_dependency 'redis'
+
   gem.add_development_dependency 'rr'
   gem.add_development_dependency 'ruby-prof'
   gem.add_development_dependency 'nokogiri'

data/spec/fixtures/integration_worker.rb

@@ -0,0 +1,15 @@
+require 'sneakers'
+require 'thread'
+require 'redis'
+
+$redis = Redis.new
+
+class IntegrationWorker
+  include Sneakers::Worker
+  
+  def work(msg)
+    $redis.incr(self.class.queue_name)
+    ack!
+  end
+end
+

data/spec/sneakers/integration_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+require 'sneakers'
+require 'sneakers/runner'
+require 'fixtures/integration_worker'
+
+require "rabbitmq/http/client"
+
+
+describe "integration" do
+  describe 'first' do
+    before :each do
+      skip unless ENV['INTEGRATION']
+      prepare
+    end
+
+    def integration_log(msg)
+      puts msg if ENV['INTEGRATION_LOG']
+    end
+
+    def prepare
+      # clean up all integration queues; admin interface must be installed
+      # in integration env
+      begin
+        admin = RabbitMQ::HTTP::Client.new("http://127.0.0.1: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
+        end
+      rescue
+        puts "Rabbitmq admin seems to not exist? you better be running this on Travis or Docker. proceeding.\n#{$!}"
+      end
+
+
+      Sneakers.configure
+      Sneakers.logger.level = Logger::ERROR
+
+      # configure integration worker on a random generated queue
+      random_queue = "integration_#{rand(10**36).to_s(36)}"
+
+      @redis = Redis.new
+      @redis.del(random_queue)
+      IntegrationWorker.from_queue(random_queue)
+    end
+
+    def assert_all_accounted_for(opts)
+      integration_log 'waiting for publishes to stabilize (5s).'
+      sleep 5
+
+      integration_log "polling for changes (max #{opts[:within_sec]}s)."
+      pid = opts[:pid]
+      opts[:within_sec].times do
+        sleep 1
+        count = @redis.get(opts[:queue]).to_i
+        if count == opts[:jobs]
+          integration_log "#{count} jobs accounted for successfully."
+          Process.kill("TERM", pid)
+          sleep 1
+          return
+        end
+      end
+      
+      integration_log "failed test. killing off workers."
+      Process.kill("TERM", pid)
+      sleep 1
+      fail "incomplete!"
+    end
+
+    def start_worker(w)
+      integration_log "starting workers."
+      r = Sneakers::Runner.new([w])
+      pid = fork {
+         r.run
+      }
+
+      integration_log "waiting for workers to stabilize (5s)."
+      sleep 5
+
+      pid
+    end
+
+    it 'should pull down 100 jobs from a real queue' do
+      job_count = 100
+
+      pid = start_worker(IntegrationWorker)
+
+      integration_log "publishing..."
+      p = Sneakers::Publisher.new
+      job_count.times do |i|
+        p.publish("m #{i}", to_queue: IntegrationWorker.queue_name)
+      end
+      
+      assert_all_accounted_for(
+         queue: IntegrationWorker.queue_name,
+         pid: pid,
+         within_sec: 15,
+         jobs: job_count,
+      )
+    end
+    
+  end
+end
+  
+

data/spec/sneakers/runner_spec.rb

@@ -29,16 +29,37 @@ describe Sneakers::RunnerConfig do
   let(:logger) { Logger.new("logtest.log") }
   let(:runner_config) { Sneakers::Runner.new([]).instance_variable_get("@runnerconfig") }
 
-  before { Sneakers.configure(log: logger) }
 
 
-  describe "#reload_config!" do
-    it "must not have :log key" do
-      runner_config.reload_config!.has_key?(:log).must_equal false
+  describe "with a connection" do
+    before { Sneakers.configure(log: logger, connection: Object.new) }
+
+    describe "#reload_config!" do
+      it "does not throw exception" do
+        runner_config.reload_config!
+      end
+
+      it "must not have :log key" do
+        runner_config.reload_config!.has_key?(:log).must_equal false
+      end
+
+      it "must have :logger key as an instance of Logger" do
+        runner_config.reload_config![:logger].is_a?(Logger).must_equal true
+      end
     end
+  end
+
+  describe "without a connection" do
+    before { Sneakers.configure(log: logger) }
 
-    it "must have :logger key as an instance of Logger" do
-      runner_config.reload_config![:logger].is_a?(Logger).must_equal true
+    describe "#reload_config!" do
+      it "must not have :log key" do
+        runner_config.reload_config!.has_key?(:log).must_equal false
+      end
+
+      it "must have :logger key as an instance of Logger" do
+        runner_config.reload_config![:logger].is_a?(Logger).must_equal true
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sneakers
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Dotan Nahum
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-09 00:00:00.000000000 Z
+date: 2015-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serverengine
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rabbitmq_http_api_client
+  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: redis
+  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: rr
   requirement: !ruby/object:Gem::Requirement
@@ -216,7 +244,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
-- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -254,11 +281,13 @@ files:
 - lib/sneakers/worker.rb
 - lib/sneakers/workergroup.rb
 - sneakers.gemspec
+- spec/fixtures/integration_worker.rb
 - spec/fixtures/require_worker.rb
 - spec/sneakers/cli_spec.rb
 - spec/sneakers/concerns/logging_spec.rb
 - spec/sneakers/concerns/metrics_spec.rb
 - spec/sneakers/configuration_spec.rb
+- spec/sneakers/integration_spec.rb
 - spec/sneakers/publisher_spec.rb
 - spec/sneakers/queue_spec.rb
 - spec/sneakers/runner_spec.rb
@@ -291,11 +320,13 @@ signing_key:
 specification_version: 4
 summary: Fast background processing framework for Ruby and RabbitMQ
 test_files:
+- spec/fixtures/integration_worker.rb
 - spec/fixtures/require_worker.rb
 - spec/sneakers/cli_spec.rb
 - spec/sneakers/concerns/logging_spec.rb
 - spec/sneakers/concerns/metrics_spec.rb
 - spec/sneakers/configuration_spec.rb
+- spec/sneakers/integration_spec.rb
 - spec/sneakers/publisher_spec.rb
 - spec/sneakers/queue_spec.rb
 - spec/sneakers/runner_spec.rb

data/CHANGELOG.md

@@ -1,20 +0,0 @@
-# 0.1.0, Not released yet
- 
-+ Added newrelic stats reporter (@arielze)
-+ Added explicit routing_key at queue (@arielze)
-+ Depracating self-daemonization (@jondot)
-+ updating bunny (@michaelklishin)
-+ Fix reference in publisher (@sergei-matheson)
-+ Allow binding of multiple routing keys (@SebastianEdwards)
-+ added work_with_params for advanced handling of work items with amqp
-headers. (#12)
-+ Sneakers.not_environmental! will no disable auto-environment discovery.
-(#15)
-
-
-
-
-# 0.0.7
-
-+ Sneakers core.
-