resque-clues 0.1.0

data/spec/job_extension_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe Resque::Plugins::Clues::JobExtension do
+  def base_item(overrides={})
+    {"class" => TestWorker.to_s, "args" => [1,2]}.merge!(overrides)
+  end
+
+  before do
+    Resque::Plugins::Clues.event_publisher = nil
+    @job = Resque::Job.new(:test_queue, base_item('clues_metadata' => {}))
+  end
+
+  it "should pass Resque lint detection" do
+    Resque::Plugin.lint(Resque::Plugins::Clues::JobExtension)
+  end
+
+  context "with clues not configured" do
+    describe "#perform" do
+      it "should delegate to original perform" do
+        @job.should_receive(:_base_perform)
+        @job.perform
+      end
+    end
+
+    describe "#fail" do
+      it "should delegate to original fail" do
+        @job.should_receive(:_base_fail)
+        @job.fail(Exception.new)
+      end
+    end
+  end
+
+  context "with clues configured" do
+    let(:publisher) {TestPublisher.new}
+
+    before do
+      Resque::Plugins::Clues.event_publisher = publisher
+    end
+
+    describe "#perform" do
+      it "should publish a perform_started event" do
+        @job.perform
+        verify_event :perform_started, event_index: -2
+      end
+
+      it "should publish a perform_finished event that includes the time_to_perform" do
+        @job.perform
+        verify_event :perform_finished do |metadata|
+          metadata['time_to_perform'].nil?.should == false
+        end
+      end
+    end
+
+    describe "#fail" do
+      it "should publish a perform_failed event" do
+        @job.fail(Exception.new)
+        verify_event :failed
+      end
+
+      it "should delegate to original fail" do
+        @job.should_receive(:_base_fail)
+        @job.fail(Exception.new)
+      end
+
+      context "includes metadata in the perform_failed event that should" do
+        it "should include the time_to_perform" do
+          @job.fail(Exception.new)
+          verify_event :failed do |metadata|
+            metadata['time_to_perform'].nil?.should == false
+          end
+        end
+
+        it "should include the exception class" do
+          @job.fail(Exception.new)
+          verify_event :failed do |metadata|
+            metadata['exception'].should == Exception
+          end
+        end
+
+        it "should include the exception message" do
+          @job.fail(Exception.new('test'))
+          verify_event :failed do |metadata|
+            metadata['message'].should == 'test'
+          end
+        end
+
+        it "should include the exception backtrace" do
+          begin
+            raise 'test'
+          rescue => e
+            @job.fail(e)
+            verify_event :failed do |metadata|
+              metadata['backtrace'].nil?.should == false
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/queue_extension_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+
+describe Resque::Plugins::Clues::QueueExtension do
+  it "should pass Resque lint detection" do
+    Resque::Plugin.lint(Resque::Plugins::Clues::QueueExtension)
+  end
+
+  it "should expose original push method as _base_push" do
+    Resque.respond_to?(:_base_push).should == true
+  end
+
+  it "should expose original pop method as _base_pop" do
+    Resque.respond_to?(:_base_pop).should == true
+  end
+
+  context "with clues not configured" do
+    before {Resque::Plugins::Clues.event_publisher = nil}
+    describe "#push" do
+      it "should delegate directly to original Resque push method" do
+        Resque.should_receive(:_base_push).with(:test_queue, {})
+        Resque.push(:test_queue, {})
+      end
+    end
+
+    describe "#pop" do
+      it "should delegate directly to original Resque pop method" do
+        Resque.stub(:_base_pop) do |queue|
+          queue.should == :test_queue
+          {}
+        end
+        Resque.pop(:test_queue).should == {}
+      end
+    end
+  end
+
+  context "with clues properly configured" do
+    let(:publisher) {TestPublisher.new}
+
+    before do
+      Resque::Plugins::Clues.event_publisher = publisher
+    end
+
+    describe "#push" do
+      def base_item(overrides={})
+        {:class => TestWorker.to_s, :args => [1,2]}.merge!(overrides)
+      end
+
+      it "should invoke _base_push with a queue and item args and return the result" do
+        Resque.should_receive(:_base_push)
+        Resque.push(:test_queue, base_item)
+      end
+
+      context "adds metadata to item stored in redis that" do
+        it "should contain an event_hash identifying the job entering the queue" do
+          Resque.push(:test_queue, base_item)
+          verify_event :enqueued do |metadata|
+            metadata['event_hash'].nil?.should == false
+          end
+        end
+
+        it "should contain the host's hostname" do
+          Resque.push(:test_queue, base_item)
+          verify_event :enqueued do |metadata|
+            metadata['hostname'].should == `hostname`.strip
+          end
+        end
+
+        it "should contain the process id" do
+          Resque.push(:test_queue, base_item)
+          verify_event :enqueued do |metadata|
+            metadata['process'].should == $$
+          end
+        end
+
+        it "should allow an item_preprocessor to inject arbitrary data" do
+          Resque::Plugins::Clues.item_preprocessor = proc {|queue, item| item['clues_metadata']['employer_id'] = 1}
+          Resque.push(:test_queue, base_item)
+          verify_event :enqueued do |metadata|
+            metadata['employer_id'].should == 1
+          end
+        end
+      end
+    end
+
+    describe "#pop" do
+      def base_item(overrides={})
+        {'class' => TestWorker.to_s, 'args' => [1,2]}.merge!(overrides)
+      end
+
+      it "should invoke _base_pop with a queue arg and return the result" do
+        Resque.should_receive(:_base_pop)
+        Resque.pop(:test_queue)
+      end
+
+      context "when nothing is in the queue" do
+        it "should not die horribly" do
+          expect{Resque.pop(:test_queue)}.to_not raise_error
+        end
+      end
+
+      context "when retrieving an item without metadata" do
+        it "should delegate directly to _base_pop" do
+          result = base_item 'clues_metadata' => {}
+          Resque.stub(:_base_pop) {|queue| result}
+          Resque.pop(:test_queue).should == result
+        end
+      end
+
+      context "metadata in the item retrieved from redis" do
+        before do
+          Resque.stub(:_base_pop){ base_item 'clues_metadata' => {}}
+        end
+
+        it "should contain the hostname" do
+          Resque.pop(:test_queue)
+          verify_event :dequeued do |metadata|
+            metadata['hostname'].should == `hostname`.chop
+          end
+        end
+
+        it "should contain the process id" do
+          Resque.pop(:test_queue)
+          verify_event :dequeued do |metadata|
+            metadata['process'].should == $$
+          end
+        end
+
+        it "should contain an enqueued_time" do
+          Resque.pop(:test_queue)
+          verify_event :dequeued do |metadata|
+            metadata['time_in_queue'].nil?.should == false
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,73 @@
+require 'rspec'
+require 'pry'
+require 'resque-clues'
+require 'test_worker'
+require 'test_publisher'
+
+def base_item(overrides={})
+  {"class" => TestWorker.to_s, "args" => [1,2]}.merge!(overrides)
+end
+
+RSpec.configure do |config|
+  config.before(:each) do
+    reset_redis
+  end
+end
+
+def reset_redis
+  Resque.redis.select 15
+  Resque.redis.flushdb
+end
+
+def verify_event(event_type, opts={event_index: -1})
+  publisher.event_type(opts[:event_index]).should == event_type
+  publisher.timestamp(opts[:event_index]).should_not be_empty
+  publisher.queue(opts[:event_index]).should == :test_queue
+  publisher.klass(opts[:event_index]).should == 'TestWorker'
+  publisher.args(opts[:event_index]).should == [1, 2]
+  yield(publisher.metadata(opts[:event_index])) if block_given?
+end
+
+def unpatch_resque
+  Resque.instance_exec do
+    def push(queue, item)
+      _base_push(queue, item)
+    end
+
+    def pop(queue)
+      _base_pop(queue)
+    end
+  end
+
+  Resque::Job.class_exec do
+    def perform
+      _base_perform
+    end
+
+    def fail(exception)
+      _base_fail(exception)
+    end
+  end
+end
+
+def repatch_resque
+  Resque.instance_exec do
+    def push(queue, item)
+      _clues_push(queue, item)
+    end
+
+    def pop(queue)
+      _clues_pop(queue)
+    end
+  end
+
+  Resque::Job.class_exec do
+    def perform
+      _clues_perform
+    end
+
+    def fail(exception)
+      _clues_fail(exception)
+    end
+  end
+end

data/spec/test_publisher.rb

@@ -0,0 +1,42 @@
+class TestPublisher
+  attr_reader :events
+
+  def initialize
+    @events = []
+  end
+
+  def publish(event_type, timestamp, queue, metadata, klass, *args)
+    events << {
+      event_type: event_type,
+      timestamp: timestamp,
+      queue: queue,
+      metadata: metadata,
+      klass: klass,
+      args: args
+    }
+  end
+
+  def event_type(tail=-1)
+    @events[tail][:event_type]
+  end
+
+  def timestamp(tail=-1)
+    @events[tail][:timestamp]
+  end
+
+  def queue(tail=-1)
+    @events[tail][:queue]
+  end
+
+  def metadata(tail=-1)
+    @events[tail][:metadata]
+  end
+
+  def klass(tail=-1)
+    @events[tail][:klass]
+  end
+
+  def args(tail=-1)
+    @events[tail][:args]
+  end
+end

data/spec/test_worker.rb

@@ -0,0 +1,6 @@
+class TestWorker
+  @queue = :test_queue
+
+  def self.perform(first, second)
+  end
+end

data/spec/util_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Resque::Plugins::Clues do
+  describe "#event_hash" do
+    it "should generate different hashes for different times" do
+      hash1 = Resque::Plugins::Clues.event_hash
+      sleep(1)
+      hash2 = Resque::Plugins::Clues.event_hash
+      (hash1 == hash2).should == false
+    end
+
+    it "should generate different hashes for different processes" do
+      hash = Resque::Plugins::Clues.event_hash
+      fork {(hash == Resque::Plugins::Clues.event_hash).should == false}
+      Process.wait
+    end
+  end
+
+  describe "#time_delta_since" do
+    it "should detect ~1 second run time" do
+      start = Time.now.utc
+      sleep(1)
+      Resque::Plugins::Clues.time_delta_since(start).between?(0.99, 1.01).should == true
+    end
+
+    it "should not allow negative numbers (time sync)" do
+      start = Time.now.utc + 1
+      Resque::Plugins::Clues.time_delta_since(start).should == 0.0
+    end
+  end
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: resque-clues
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors:
+- Lance Woodson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.20.0
+    none: false
+  prerelease: false
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.20.0
+    none: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.4
+    none: false
+  prerelease: false
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.4
+    none: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+    none: false
+  prerelease: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+    none: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+description: Adds event publishing and job tracking ability to Resque
+email:
+- lance.woodson@peopleadmin.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO
+- lib/resque-clues.rb
+- lib/resque/plugins/clues/event_publisher.rb
+- lib/resque/plugins/clues/job_extension.rb
+- lib/resque/plugins/clues/queue_extension.rb
+- lib/resque/plugins/clues/util.rb
+- lib/resque/plugins/clues/version.rb
+- resque-clues.gemspec
+- spec/event_publisher_spec.rb
+- spec/integration_spec.rb
+- spec/job_extension_spec.rb
+- spec/queue_extension_spec.rb
+- spec/spec_helper.rb
+- spec/test_publisher.rb
+- spec/test_worker.rb
+- spec/util_spec.rb
+homepage: https://github.com/PeopleAdmin/resque-clues
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3444382190622690926
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3444382190622690926
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Adds event publishing and job tracking
+test_files:
+- spec/event_publisher_spec.rb
+- spec/integration_spec.rb
+- spec/job_extension_spec.rb
+- spec/queue_extension_spec.rb
+- spec/spec_helper.rb
+- spec/test_publisher.rb
+- spec/test_worker.rb
+- spec/util_spec.rb