ruote-resque 0.1.0

data/spec/lib/ruote/resque/receiver_spec.rb

@@ -0,0 +1,208 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+require 'ruote/storage/fs_storage'
+
+class BravoJob
+  @queue = :rspec
+  extend Ruote::Resque::Job
+  def self.perform(workitem)
+    workitem['fields']['resque_bravo'] = 'was here'
+  end
+end
+
+class BravoError < RuntimeError
+end
+
+class BravoFailureJob < BravoJob
+  @queue = :rspec
+  extend Ruote::Resque::Job
+  def self.perform(workitem)
+    raise BravoError, 'im a failure'
+  end
+end
+
+RUOTE_WAIT_TIMEOUT = 10
+
+describe Ruote::Resque::Receiver do
+
+  before :each do
+
+    Resque.redis.flushdb
+
+    @board = Ruote::Dashboard.new(Ruote::Worker.new(Ruote::HashStorage.new))
+    # @board.noisy = true
+
+    @board.register(/^block_/) do |workitem|
+      workitem.fields[workitem.participant_name] = 'was here'
+    end
+
+    @worker = Thread.new do
+      queues = ['rspec']
+      worker = Resque::Worker.new(*queues)
+      worker.term_timeout = 4
+      worker.term_child = true
+      # worker.verbose = true
+      worker.work(1)
+    end
+
+    Ruote::Resque.configure do |config|
+      config.interval = 1
+    end
+
+    @receiver = Ruote::Resque::Receiver.new(@board)
+
+  end
+
+  after :each do
+
+    @board.shutdown
+    @board.storage.purge!
+    @receiver.shutdown
+    @worker.kill
+
+    Ruote::Resque.configure do |config|
+      config.interval = 5
+    end
+  end
+
+  let(:definition) do
+    Ruote.define :on_error => 'block_delta' do
+      block_alpha
+      resque_bravo
+      block_charly
+    end
+  end
+
+  context 'invalid job handling' do
+
+    it 'raises InvalidJob' do
+
+      class AnotherJob
+      end
+
+      Ruote::Resque::Receiver.any_instance.should_receive(:handle_error) do |e|
+        e.class.should eq(Ruote::Resque::InvalidJob)
+      end
+
+      Resque.enqueue_to(Ruote::Resque.configuration.reply_queue, 'AnotherJob')
+
+      # Ensure it is picked up by the receiver + cleanup afterwards
+      sleep 2
+      ::Resque.reserve(Ruote::Resque.configuration.reply_queue)
+
+    end
+
+    it 'raises InvalidWorkitem' do
+
+      Ruote::Resque::Receiver.any_instance.should_receive(:handle_error) do |e|
+        e.class.should eq(Ruote::Resque::InvalidWorkitem)
+      end
+
+      Resque.enqueue_to(Ruote::Resque.configuration.reply_queue, Ruote::Resque::ReplyJob, {})
+
+      # Ensure it is picked up by the receiver + cleanup afterwards
+      sleep 2
+      ::Resque.reserve(Ruote::Resque.configuration.reply_queue)
+
+    end
+
+  end
+
+  context 'participant/reply flow' do
+
+    context 'with no exceptions raised' do
+
+      before(:each) do
+        Ruote::Resque.register @board do
+          resque_bravo BravoJob, :rspec
+        end
+      end
+
+      it 'completes successfully' do
+
+        wfid = @board.launch(definition)
+
+        r = @board.wait_for(wfid, :timeout => RUOTE_WAIT_TIMEOUT)
+          # wait until process terminates or hits an error
+
+        r['workitem'].should_not eq(nil)
+        r['workitem']['fields']['block_alpha'].should eq('was here')
+        r['workitem']['fields']['resque_bravo'].should eq('was here')
+        r['workitem']['fields']['block_charly'].should eq('was here')
+        r['workitem']['fields']['block_delta'].should eq(nil)
+      end
+    end
+
+    context 'with an exception raised' do
+
+      before(:each) do
+        Ruote::Resque.register @board do
+          resque_bravo BravoFailureJob, :rspec
+        end
+      end
+
+      it 'routes to the error handler' do
+
+        wfid = @board.launch(definition)
+
+        r = @board.wait_for(wfid, :timeout => RUOTE_WAIT_TIMEOUT)
+          # wait until process terminates or hits an error
+
+        r['workitem'].should_not eq(nil)
+        r['workitem']['fields']['block_alpha'].should eq('was here')
+        r['workitem']['fields']['resque_bravo'].should eq(nil)
+        r['workitem']['fields']['block_charly'].should eq(nil)
+        r['workitem']['fields']['block_delta'].should eq('was here')
+      end
+
+      it 'marks the job as failed in Resque' do
+
+        wfid = @board.launch(definition)
+
+        r = @board.wait_for(wfid, :timeout => RUOTE_WAIT_TIMEOUT)
+          # wait until process terminates or hits an error
+
+        Resque::Failure.count.should eq(1)
+        failed = Resque::Failure.all(0, 1)
+        failed.class.should eq(Hash)
+        failed['payload']['class'].should eq('BravoFailureJob')
+        failed['exception'].should eq('BravoError')
+        failed['error'].should eq('im a failure')
+      end
+
+      it 'can be replayed from Ruote' do
+
+        definition = Ruote.define do
+          block_alpha
+          resque_bravo
+          block_charly
+        end
+
+        wfid = @board.launch(definition)
+
+        r = @board.wait_for(wfid, :timeout => RUOTE_WAIT_TIMEOUT)
+        error = @board.errors(wfid).first
+
+        expect(error.class).to eq(Ruote::ProcessError)
+        expect(error.klass).to eq('Ruote::ReceivedError')
+        expect(error.message).to eq('raised: Ruote::ReceivedError: BravoError: im a failure')
+        expect(error.trace).to include("/lib/resque/worker.rb:195:in `perform'")
+
+        Ruote::Resque.register @board do
+          resque_bravo BravoJob, :rspec
+        end
+        @board.replay_at_error(error)
+
+        r = @board.wait_for(wfid, :timeout => RUOTE_WAIT_TIMEOUT)
+
+        r['workitem'].should_not eq(nil)
+        r['workitem']['fields']['block_alpha'].should eq('was here')
+        r['workitem']['fields']['resque_bravo'].should eq('was here')
+        r['workitem']['fields']['block_charly'].should eq('was here')
+
+      end
+    end
+  end
+
+end

data/spec/lib/ruote/resque/reply_job_spec.rb

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe Ruote::Resque::ReplyJob do
+
+  context '::queue' do
+
+    let(:queue) { :my_queue }
+    let!(:default_queue) { Ruote::Resque.configuration.reply_queue }
+
+    before :each do
+      Ruote::Resque.configure do |config|
+        config.reply_queue = queue
+      end
+    end
+
+    after :each do
+      Ruote::Resque.configure do |config|
+        config.reply_queue = default_queue
+      end
+    end
+
+    it 'returns the configured reply queue' do
+      expect(Ruote::Resque::ReplyJob.queue).to eq :my_queue
+    end
+
+  end
+
+  context '::perform' do
+
+    it 'returns nil' do
+      expect(Ruote::Resque::ReplyJob.perform).to be_nil
+    end
+
+  end
+
+end

data/spec/lib/ruote/resque_spec.rb

@@ -0,0 +1,99 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe Ruote::Resque do
+
+  context '::logger' do
+
+    it 'returns a Logger instance' do
+      expect(Ruote::Resque.logger.class).to eq Logger
+    end
+
+  end
+
+  context '::reply' do
+
+    it 'enqueues a reply' do
+      Ruote::Resque.reply({ 'field' => 'test' })
+
+      expected_job = { 'class' => 'Ruote::Resque::ReplyJob', 'args' => [{ 'field' => 'test' }] }
+      expect(::Resque.pop(:ruote_replies)).to eq expected_job
+
+    end
+
+  end
+
+  context '::register' do
+
+    class MyAwesomeJob; end
+
+    let(:mock_dashboard) { Object.new }
+
+    it 'allows registration of participants with a block' do
+
+      mock_dashboard.should_receive(:register_participant).with('be_awesome', Ruote::Resque::Participant, { :class => MyAwesomeJob, :queue => :rspec })
+      Ruote::Resque.register mock_dashboard do
+        be_awesome MyAwesomeJob, :rspec
+      end
+
+    end
+
+  end
+
+  context '::configuration' do
+
+    it 'returns a Configuration object' do
+      expect(Ruote::Resque.configuration.class.to_s).to eq 'Ruote::Resque::Configuration'
+    end
+
+    context '::reply_queue' do
+
+      it 'is :ruote_replies by default' do
+        expect(Ruote::Resque.configuration.reply_queue).to eq :ruote_replies
+      end
+
+      it 'is setable' do
+        Ruote::Resque.configuration.reply_queue = :another_queue
+        expect(Ruote::Resque.configuration.reply_queue).to eq :another_queue
+      end
+
+    end
+
+    context '::interval' do
+
+      it 'is 5 by default' do
+        expect(Ruote::Resque.configuration.interval).to eq 5
+      end
+
+      it 'is setable' do
+        Ruote::Resque.configuration.interval = 1
+        expect(Ruote::Resque.configuration.interval).to eq 1
+      end
+
+    end
+
+    context '::logger' do
+
+      it 'is a Logger instance' do
+        expect(Ruote::Resque.configuration.logger.class).to eq Logger
+      end
+
+      it 'is logging at INFO level' do
+        expect(Ruote::Resque.configuration.logger.level).to eq Logger::INFO
+      end
+
+      it 'is a setable' do
+
+        class MyLogger < Logger
+        end
+        Ruote::Resque.configuration.logger = MyLogger.new(STDOUT)
+
+        expect(Ruote::Resque.configuration.logger.class).to eq MyLogger
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'resque'
+require 'ruote/resque'
+
+RSpec.configure do |config|
+
+  config.mock_with :rspec
+
+  config.before(:suite) do
+    Resque.redis.namespace = 'resque:rspec'
+  end
+
+  config.after(:each) do
+    Resque.queues.each { |queue| Resque.remove_queue(queue) }
+  end
+
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: ruote-resque
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adrien Kohlbecker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mutant
+  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: rubocop
+  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: yard
+  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: redcarpet
+  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'
+description: Resque participant/receiver pair for Ruote
+email:
+- adrien.kohlbecker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/ruote/resque.rb
+- lib/ruote/resque/client.rb
+- lib/ruote/resque/job.rb
+- lib/ruote/resque/participant.rb
+- lib/ruote/resque/participant_registrar.rb
+- lib/ruote/resque/receiver.rb
+- lib/ruote/resque/reply_job.rb
+- lib/ruote/resque/version.rb
+- ruote-resque.gemspec
+- spec/lib/ruote/resque/job_spec.rb
+- spec/lib/ruote/resque/participant_registrar_spec.rb
+- spec/lib/ruote/resque/participant_spec.rb
+- spec/lib/ruote/resque/receiver_spec.rb
+- spec/lib/ruote/resque/reply_job_spec.rb
+- spec/lib/ruote/resque_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/adrienkohlbecker/ruote-resque
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Resque participant/receiver pair for Ruote
+test_files:
+- spec/lib/ruote/resque/job_spec.rb
+- spec/lib/ruote/resque/participant_registrar_spec.rb
+- spec/lib/ruote/resque/participant_spec.rb
+- spec/lib/ruote/resque/receiver_spec.rb
+- spec/lib/ruote/resque/reply_job_spec.rb
+- spec/lib/ruote/resque_spec.rb
+- spec/spec_helper.rb
+has_rdoc: