ruote-amqp 2.2.0 → 2.3.0

data/spec/receiver_spec.rb

@@ -1,126 +1,234 @@
 
-require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'spec_helper'
 
-require 'ruote/participant'
 
+describe Ruote::Amqp::Receiver do
 
-describe RuoteAMQP::Receiver do
+  before(:all) do
+
+    ensure_em_is_running
+  end
+
+  before(:each) do
+
+    @dashboard = Ruote::Dashboard.new(Ruote::Worker.new(Ruote::HashStorage.new))
+
+    @dashboard.noisy = ENV['NOISY'].to_s == 'true'
+
+    @dashboard.register(
+      :toto,
+      Ruote::Amqp::Participant,
+      :exchange => [ 'direct', '' ],
+      :routing_key => 'alpha')
+
+    @queue = AMQP::Channel.new.queue('alpha')
+  end
 
   after(:each) do
-    purge_engine
+
+    @dashboard.shutdown
+    @receiver.shutdown
+
+    #@queue.status { |mc, acc| p [ :messages, mc, :active_consumers, acc ] }
+    @queue.delete
   end
 
-  it "handles replies" do
+  #
+  # A participant that spits back an error (over AMQP)
+  #
+  class ParticipantWithError
+    include Ruote::LocalParticipant
 
-    pdef = Ruote.process_definition :name => 'test' do
-      set :field => 'foo', :value => 'foo'
-      sequence do
-        echo '${f:foo}'
-        amqp :queue => 'test3'
-        echo '${f:foo}'
-      end
+    def initialize(options)
+
+      @options = options
     end
 
-    @engine.register_participant(:amqp, RuoteAMQP::ParticipantProxy)
+    def on_workitem
+
+      wi = workitem.h
+      wi['error'] = @options['error']
 
-    RuoteAMQP::Receiver.new(@engine)
+      exchange = AMQP::Exchange.new(AMQP::Channel.new, :direct, '')
+      exchange.publish(Rufus::Json.encode(wi), :routing_key => 'alpha')
 
-    wfid = @engine.launch(pdef)
+      # no replying to the engine
+    end
 
-    workitem = nil
+    def on_cancel
 
-    begin
-      Timeout::timeout(5) do
+      # nothing
+    end
+  end
 
-        MQ.queue('test3', :durable => true).subscribe { |msg|
-          wi = Ruote::Workitem.new(Rufus::Json.decode(msg))
-          workitem = wi if wi.wfid == wfid
-        }
+  context 'plain receiver' do
 
-        loop do
-          break unless workitem.nil?
-          sleep 0.1
+    before(:each) do
+
+      @receiver = Ruote::Amqp::Receiver.new(@dashboard, @queue)
+
+      sleep 0.100 # give some time for the receiver to settle in
+    end
+
+    context 'with workitems' do
+
+      it 'grabs workitems from a queue' do
+
+        pdef = Ruote.define do
+          toto
         end
+
+        wfid = @dashboard.launch(pdef)
+        r = @dashboard.wait_for(wfid)
+
+        r['action'].should == 'terminated'
+      end
+
+      it 'offers a hook for errors' do
+
+        $errs = []
+
+        def @receiver.handle_error(e)
+          $errs << e
+        end
+
+        exchange = AMQP::Exchange.new(AMQP::Channel.new, :direct, '')
+
+        exchange.publish('nada zero', :routing_key => 'alpha')
+        exchange.publish('nada one', :routing_key => 'alpha')
+
+        sleep 0.300
+
+        $errs.size.should == 2
       end
-    rescue Timeout::Error
-      violated "Timeout waiting for message"
     end
 
-    workitem.fields['foo'] = "bar"
+    context 'with launchitems' do
 
-    MQ.queue('ruote_workitems', :durable => true).publish(Rufus::Json.encode(workitem.to_h), :persistent => true)
+      it 'accepts launchitems' do
 
-    @engine.wait_for(wfid)
+        @dashboard.register('noop', Ruote::NoOpParticipant)
 
-    @engine.should_not have_errors
-    @engine.should_not have_remaining_expressions
+        launchitem = {
+          'definition' => Ruote.define { noop },
+          'fields' => { 'kilroy' => 'was here' }
+        }
 
-    @tracer.to_s.should == "foo\nbar"
-  end
+        exchange = AMQP::Exchange.new(AMQP::Channel.new, :direct, '')
+        exchange.publish(Rufus::Json.encode(launchitem), :routing_key => 'alpha')
 
-  it "launches processes" do
+        r = @dashboard.wait_for('terminated')
 
-    json = {
-      'definition' => %{
-        Ruote.process_definition :name => 'test' do
-          sequence do
-            echo '${f:foo}'
-          end
-        end
-      },
-      'fields' => { 'foo' => 'bar' }
-    }.to_json
+        r['workitem']['fields']['kilroy'].should == 'was here'
+      end
+    end
+
+    context 'with errors' do
+
+      it 'propagates errors passed back as strings' do
+
+        @dashboard.register_participant(
+          'alf', ParticipantWithError, 'error' => 'something went wrong')
+
+        wfid = @dashboard.launch(Ruote.define { alf })
+        r = @dashboard.wait_for(wfid)
+
+        r['action'].should == 'error_intercepted'
+
+        r['error']['class'].should == 'Ruote::Amqp::RemoteError'
+        r['error']['message'].should == 'something went wrong'
+      end
+
+      it 'propagates errors passed back as hashes' do
+
+        @dashboard.register_participant(
+          'alf',
+          ParticipantWithError,
+          'error' => {
+            'class' => 'ArgumentError', 'message' => 'something missing' })
+
+        wfid = @dashboard.launch(Ruote.define { alf })
+        r = @dashboard.wait_for(wfid)
+
+        r['action'].should == 'error_intercepted'
+
+        r['error']['class'].should == 'ArgumentError'
+        r['error']['message'].should == 'something missing'
+      end
 
-    RuoteAMQP::Receiver.new(@engine, :launchitems => true, :unsubscribe => true)
+      it 'propagates errors passed back as whatever' do
 
-    MQ.queue(
-      'ruote_workitems', :durable => true
-    ).publish(
-      json, :persistent => true
-    )
+        @dashboard.register_participant(
+          'alf', ParticipantWithError, 'error' => %w[ not good ])
 
-    sleep 0.5
+        wfid = @dashboard.launch(Ruote.define { alf })
+        r = @dashboard.wait_for(wfid)
 
-    @engine.should_not have_errors
-    @engine.should_not have_remaining_expressions
+        r['action'].should == 'error_intercepted'
 
-    @tracer.to_s.should == 'bar'
+        r['error']['class'].should == 'Ruote::Amqp::RemoteError'
+        r['error']['message'].should == %w[ not good ].inspect
+      end
+    end
   end
 
-  it 'accepts a custom :queue' do
+  context 'launch_only receiver' do
 
-    #@engine.noisy = true
+    before(:each) do
 
-    RuoteAMQP::Receiver.new(
-      @engine, :queue => 'mario', :launchitems => true, :unsubscribe => true)
+      @receiver = Ruote::Amqp::Receiver.new(
+        #@dashboard, @queue, 'launch_only' => true)
+        @dashboard, @queue, :launch_only => true)
+
+      sleep 0.100 # give some time for the receiver to settle in
+    end
 
-    @engine.register_participant 'alpha', Ruote::StorageParticipant
+    # ...
 
-    json = Rufus::Json.encode({
-      'definition' => "Ruote.define { alpha }"
-    })
+    it 'accepts launchitems' do
 
-    MQ.queue(
-      'ruote_workitems', :durable => true
-    ).publish(
-      json, :persistent => true
-    )
+      @dashboard.register('noop', Ruote::NoOpParticipant)
 
-    sleep 1
+      launchitem = {
+        'definition' => Ruote.define { noop },
+        'fields' => { 'launch' => 'yes' }
+      }
 
-    @engine.processes.size.should == 0
-      # nothing happened
+      exchange = AMQP::Exchange.new(AMQP::Channel.new, :direct, '')
+      exchange.publish(Rufus::Json.encode(launchitem), :routing_key => 'alpha')
 
-    MQ.queue(
-      'mario', :durable => true
-    ).publish(
-      json, :persistent => true
-    )
+      r = @dashboard.wait_for('terminated')
 
-    sleep 1
+      r['workitem']['fields']['launch'].should == 'yes'
+    end
+
+    it 'discards workitems' do
+
+      pdef = Ruote.define do
+        toto
+      end
 
-    @engine.processes.size.should == 1
-      # launch happened
+      wfid = @dashboard.launch(pdef)
+      @dashboard.wait_for('dispatched')
+      sleep 0.500
+
+      @dashboard.ps(wfid).should_not == nil
+    end
+
+    it 'discards errors' do
+
+      @dashboard.register_participant(
+        'alf', ParticipantWithError, 'error' => 'something went wrong')
+
+      wfid = @dashboard.launch(Ruote.define { alf })
+      @dashboard.wait_for('dispatched')
+      sleep 0.500
+
+      status = @dashboard.ps(wfid)
+
+      status.should_not == nil
+      status.errors.size.should == 0
+    end
   end
 end
 

data/spec/spec_helper.rb

@@ -1,79 +1,21 @@
 
-require 'rubygems'
-require 'rspec'
+require 'rufus-json/automatic'
+require 'ruote/amqp'
 
-$:.unshift(File.join(File.dirname(__FILE__), '../lib'))
-$:.unshift(File.join(File.dirname(__FILE__), '../../ruote/lib'))
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |f| require(f) }
 
-#gem 'amqp', '=0.6.7'
-
-require 'fileutils'
-require 'json'
-require 'timeout'
-
-require 'ruote/engine'
-require 'ruote/worker'
-require 'ruote/storage/hash_storage'
-require 'ruote/log/test_logger'
-
-require 'ruote-amqp'
-
-Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |path|
-  require(path)
-}
-
-
-# AMQP magic worked here
-AMQP.settings[:host]  = 'localhost'
-AMQP.settings[:vhost] = 'ruote-test'
-AMQP.settings[:user]  = 'ruote'
-AMQP.settings[:pass]  = 'ruote'
-
-#AMQP.logging = true
 
 RSpec.configure do |config|
 
-  config.include(RuoteSpecHelpers)
-
-  config.before(:each) do
-    @tracer = Tracer.new
-
-    @engine = Ruote::Engine.new(
-      Ruote::Worker.new(
-        Ruote::HashStorage.new(
-          's_logger' => [ 'ruote/log/test_logger', 'Ruote::TestLogger' ])))
-
-    @engine.add_service('tracer', @tracer)
-  end
-
-  config.after(:each) do
-    @engine.shutdown
-    @engine.context.storage.purge!
-  end
-
-  config.after(:all) do
-    base = File.expand_path(File.dirname(__FILE__) + '/..')
-    FileUtils.rm_rf(base + '/logs')
-    FileUtils.rm_rf(base + '/work')
-  end
-end
-
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
 
-class Tracer
-  def initialize
-    @trace = ''
-  end
-  def to_s
-    @trace.to_s.strip
-  end
-  def << s
-    @trace << s
-  end
-  def clear
-    @trace = ''
-  end
-  def puts s
-    @trace << "#{s}\n"
-  end
+  config.include RuoteAmqpHelper
 end
 

data/spec/support/ruote_amqp_helper.rb

@@ -0,0 +1,40 @@
+
+module RuoteAmqpHelper
+
+  def ensure_em_is_running
+
+    unless @em
+      @em = Thread.new { EM.run {} }
+      sleep 0.5
+    end
+  end
+
+  def count_amqp_objects
+
+    objects = {}
+
+    ObjectSpace.each_object do |o|
+
+      next unless [
+        AMQP::Queue, AMQP::Channel, AMQP::Exchange
+      ].include?(o.class)
+
+      k = o.class.to_s
+
+      objects[k] ||= 0
+      objects[k] = objects[k] + 1
+    end
+
+    objects
+  end
+
+  def display_amqp_object_count
+
+    objects = count_amqp_objects
+
+    objects.keys.sort.each do |k|
+      puts "#{k}: #{objects[k]}"
+    end
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruote-amqp
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 3
   prerelease: 
   segments: 
   - 2
-  - 2
+  - 3
   - 0
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors: 
 - Kenneth Kalmer
@@ -16,8 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-01 00:00:00 +09:00
-default_executable: 
+date: 2012-09-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: amqp
@@ -25,14 +24,13 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 25
         segments: 
         - 0
-        - 7
-        - 0
-        version: 0.7.0
+        - 9
+        version: "0.9"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -43,12 +41,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 3
         segments: 
         - 2
-        - 2
+        - 3
         - 0
-        version: 2.2.0
+        version: 2.3.0
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -71,18 +69,17 @@ dependencies:
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
+        hash: 19
         segments: 
         - 2
-        - 2
-        - 1
-        version: 2.2.1
+        - 8
+        version: "2.8"
   type: :development
   version_requirements: *id004
 description: "\n\
-  AMQP participant/listener pair for ruote 2.1\n  "
+  AMQP participant/listener pair for ruote\n  "
 email: 
 - kenneth.kalmer@gmail.com
 - jmettraux@gmail.com
@@ -94,27 +91,24 @@ extra_rdoc_files: []
 
 files: 
 - Rakefile
-- lib/ruote-amqp/launchitem_listener.rb
-- lib/ruote-amqp/participant.rb
-- lib/ruote-amqp/receiver.rb
-- lib/ruote-amqp/version.rb
-- lib/ruote-amqp/workitem_listener.rb
+- lib/ruote/amqp/alert_participant.rb
+- lib/ruote/amqp/participant.rb
+- lib/ruote/amqp/receiver.rb
+- lib/ruote/amqp/version.rb
+- lib/ruote/amqp.rb
 - lib/ruote-amqp.rb
-- spec/launchitem_listener_spec.rb
+- spec/alert_participant_spec.rb
 - spec/participant_spec.rb
+- spec/participant_subclass_spec.rb
 - spec/receiver_spec.rb
-- spec/ruote_amqp_spec.rb
 - spec/spec_helper.rb
-- spec/support/ruote_helpers.rb
-- spec/support/ruote_matchers.rb
-- spec/workitem_listener_spec.rb
+- spec/support/ruote_amqp_helper.rb
 - ruote-amqp.gemspec
 - CHANGELOG.txt
 - CREDITS.txt
-- PostInstall.txt
+- LICENSE.txt
 - TODO.txt
-- README.rdoc
-has_rdoc: true
+- README.md
 homepage: http://ruote.rubyforge.org
 licenses: []
 
@@ -144,9 +138,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ruote
-rubygems_version: 1.5.0
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: AMQP participant/listener pair for ruote 2.1
+summary: AMQP participant/listener pair for ruote
 test_files: []
 

data/PostInstall.txt

@@ -1,12 +0,0 @@
-
-For more information on ruote-amqp, see http://github.com/kennethkalmer/ruote-amqp
-
-Please note that this gem requires access to an AMQP broker and a good 
-understanding of AMQP and remote participants in general.
-
-Join us in #ruote on Freenode or on the openwfe-users Google Group to discuss
-it's uses.
-
-You might also want to look at daemon-kit for help with writing external
-participants that communicate with ruote via AMQP.
-

data/README.rdoc

@@ -1,91 +0,0 @@
-
-= ruote-amqp
-
-* http://github.com/kennethkalmer/ruote-amqp
-* http://rdoc.info/projects/kennethkalmer/ruote-amqp
-* http://ruote.rubyforge.org
-
-== DESCRIPTION:
-
-ruote-amqp provides an AMQP participant/listener pair that allows you to 
-distribute workitems out to AMQP consumers for processing, as well as launching
-processes over AMQP.
-
-To learn more about remote participants in ruote please see
-http://ruote.rubyforge.org/part_implementations.html
-
-== FEATURES/PROBLEMS:
-
-* Flexible participant for sending workitems
-* Flexible receiver for receiving replies
-* Flexible launch item listener for launching processes over AMQP
-* Fully evented (thanks to the amqp gem)
-
-== SYNOPSIS:
-
-Please review the rdoc in RuoteAMQP::Participant and Ruote::AMQP::Listener
-
-== REQUIREMENTS:
-
-* ruote[http://ruote.rubyforge.org] 2.2.0 or later
-* amqp[http://github.com/tmm1/amqp] 0.6.7 or later
-* rabbitmq[http://www.rabbitmq.com/] 1.6.0 or later
-
-== INSTALL:
-
-Please be sure to have read the requirements section above
-
-* sudo gem install ruote-amqp
-
-== TESTS:
-
-To run the tests you need the following requirements met, or the testing environment
-will fail horribly (or simply get stuck without output).
-
-=== RabbitMQ vhost
-
-The tests use dedicated vhost on a running AMQP broker. To configure RabbitMQ
-you can run the following commands:
-
-  # rabbitmqctl add_vhost ruote-test
-  # rabbitmqctl add_user ruote ruote
-  # rabbitmqctl set_permissions -p ruote-test ruote '.*' '.*' '.*'
-
-If you need to change the AMQP configuration used by the tests, edit the
-+spec/spec_helper.rb+ file.
-
-== DAEMON-KIT:
-
-Although the RuoteAMQP gem will work perfectly well with any AMQP consumer,
-it is recommended that you use daemon-kit[http://github.com/kennethkalmer/daemon-kit]
-to write your remote participants.
-
-daemon-kit offers plenty of convenience for remote participants and includes
-a code generator for ruote remote participants.
-
-DaemonKit doesn't currently support ruote 2.1, support is forthcoming.
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2010-2011 Kenneth Kalmer
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.