ruote-amqp 0.9.21.1 → 2.1.5

data/lib/ruote-amqp/workitem_listener.rb

@@ -0,0 +1,84 @@
+module RuoteAMQP
+
+  #
+  # = AMQP Workitem Listener
+  #
+  # Used in conjunction with the RuoteAMQP::Participant, the WorkitemListener
+  # subscribes to a specific direct exchange and monitors for
+  # incoming workitems. It expects workitems to arrive serialized as
+  # JSON.
+  #
+  # == Configuration
+  #
+  # AMQP configuration is handled by directly manipulating the values of
+  # the +AMQP.settings+ hash, as provided by the AMQP gem. No
+  # defaults are set by the listener. The only +option+ parsed by
+  # the initializer of the workitem listener is the +queue+ key (Hash
+  # expected). If no +queue+ key is set, the listener will subscribe
+  # to the +ruote_workitems+ direct exchange for workitems, otherwise it will
+  # subscribe to the direct exchange provided.
+  #
+  # The participant requires version 0.6.6 or later of the amqp gem.
+  #
+  # == Usage
+  #
+  # Register the engine or storage with the listener:
+  #
+  #   RuoteAMQP::WorkitemListener.new( engine_or_storage )
+  #
+  # The workitem listener leverages the asynchronous nature of the amqp gem,
+  # so no timers are setup when initialized.
+  #
+  # See the RuoteAMQP::Participant docs for information on sending
+  # workitems out to remote participants, and have them send replies
+  # to the correct direct exchange specified in the workitem
+  # attributes.
+  #
+  class WorkitemListener < Ruote::Receiver
+
+    class << self
+
+      # Listening queue - set this before initialization
+      attr_writer :queue
+
+      def queue
+        @queue ||= 'ruote_workitems'
+      end
+
+    end
+
+    # Starts a new WorkitemListener
+    #
+    # @param [ Ruote::Engine, Ruote::Storage ] A configured ruote engine or storage instance
+    # @param [ String ] An optional queue name
+    def initialize( engine_or_storage, queue = nil )
+
+      @storage = engine_or_storage.respond_to?( :storage ) ? engine_or_storage.storage : engine_or_storage
+
+      self.class.queue = queue if queue
+
+      RuoteAMQP.start!
+
+      MQ.queue( self.class.queue, :durable => true ).subscribe do |message|
+        if AMQP.closing?
+          # Do nothing, we're going down
+        else
+          workitem = decode_workitem( message )
+          reply( workitem )
+        end
+      end
+    end
+
+    def stop
+      RuoteAMQP.stop!
+    end
+
+    private
+
+    # Complicated guesswork that needs to happen here to detect the format
+    def decode_workitem( msg )
+      hash = Rufus::Json.decode( msg )
+      Ruote::Workitem.new( hash )
+    end
+  end
+end

data/lib/spec/ruote.rb

@@ -2,4 +2,4 @@ require File.dirname(__FILE__) + '/ruote_example_group.rb'
 require File.dirname(__FILE__) + '/ruote_matchers.rb'
 require File.dirname(__FILE__) + '/ruote_helpers.rb'
 
-Spec::Example::ExampleGroupFactory.register(:ruote, Spec::Ruote::Example::RuoteExampleGroup)
+Spec::Example::ExampleGroupFactory.register(:ruote, Spec::RuoteSpec::Example::RuoteExampleGroup)

data/lib/spec/ruote_example_group.rb

@@ -1,5 +1,5 @@
 module Spec
-  module Ruote
+  module RuoteSpec
     module Example
       class RuoteExampleGroup < Spec::Example::ExampleGroup
       end

data/lib/spec/ruote_helpers.rb

@@ -1,14 +1,18 @@
+
 module RuoteSpecHelpers
 
   def purge_engine
-    @engine.application_context.values.each do |s|
-      s.purge if s.respond_to?(:purge)
-    end
+
+    #@engine.context.values.each do |s|
+    #  s.purge if s.respond_to?(:purge)
+    #end
   end
 
   def run_definition( pdef )
-    fei = @engine.launch( pdef )
-    wait( fei )
+
+    wfid = @engine.launch( pdef )
+
+    @engine.context.logger.wait_for( wfid )
 
     @engine.should_not have_errors
     @engine.should_not have_remaining_expressions
@@ -16,9 +20,8 @@ module RuoteSpecHelpers
     purge_engine
   end
 
-  def wait( fei )
-    Thread.pass
-    return if @terminated_processes.include?( fei.wfid )
-    @engine.wait_for( fei )
+  def noisy( on = true )
+    @engine.context.logger.noisy = on
   end
 end
+

data/lib/spec/ruote_matchers.rb

@@ -1,16 +1,15 @@
+
 Spec::Matchers.define :have_errors do |*args|
+
   match do |engine|
-    @ps = if fei = args.shift
-      engine.process_status( fei )
-    else
-      engine.process_statuses.values.first
-    end
 
-    if @ps
-      @ps.errors.size != 0
+    @ps = if wfid = args.shift
+      engine.processes( wfid )
     else
-      false
+      engine.processes.first
     end
+
+    @ps ? (@ps.errors.size != 0) : false
   end
 
   failure_message_for_should do |engine|
@@ -18,9 +17,10 @@ Spec::Matchers.define :have_errors do |*args|
   end
   failure_message_for_should_not do |engine|
     "Expected the engine to not have errors, but it did.\n" +
-    @ps.errors.values.map do |e|
-      "  * error: #{e.error_class} \"#{e.stacktrace}\""
-    end.join("\n")
+    @ps.errors.map { |e|
+      "  * error: #{e.error_class} #{e.error_message} " +
+      "\n\"#{e.error_backtrace.join("\n")}\""
+    }.join("\n")
   end
   description do
     #
@@ -28,29 +28,19 @@ Spec::Matchers.define :have_errors do |*args|
 end
 
 Spec::Matchers.define :have_remaining_expressions do
+
   match do |engine|
-    exp_count = engine.get_expression_storage.size
 
-    if exp_count == 1
-      false
-    else
-      50.times { Thread.pass }
-      exp_count = engine.get_expression_storage.size
-      if exp_count == 1
-        false
-      else
-        true
-      end
-    end
+    (engine.storage.get_many('expressions').size != 0)
   end
 
   failure_message_for_should do |engine|
     "Expected engine to have processes remaining, but it didn't"
   end
   failure_message_for_should_not do |engine|
-    "Expected engine to have no processes remaining, but it did.#{engine.get_expression_storage.to_s}"
+    "Expected engine to have no processes remaining, but it did.#{engine.storage.get_many('expressions').inspect}"
   end
   description do
-
   end
 end
+

data/ruote-amqp.gemspec

@@ -0,0 +1,83 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ruote-amqp}
+  s.version = "2.1.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["kenneth.kalmer@gmail.com"]
+  s.date = %q{2010-02-04}
+  s.email = %q{kenneth.kalmer@gmail.com}
+  s.extra_rdoc_files = [
+    "History.txt",
+     "Manifest.txt",
+     "PostInstall.txt",
+     "README.rdoc",
+     "TODO.txt"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "Manifest.txt",
+     "PostInstall.txt",
+     "README.rdoc",
+     "Rakefile",
+     "TODO.txt",
+     "lib/ruote-amqp.rb",
+     "lib/ruote-amqp/launchitem_listener.rb",
+     "lib/ruote-amqp/participant.rb",
+     "lib/ruote-amqp/workitem_listener.rb",
+     "lib/spec/ruote.rb",
+     "lib/spec/ruote_example_group.rb",
+     "lib/spec/ruote_helpers.rb",
+     "lib/spec/ruote_matchers.rb",
+     "ruote-amqp.gemspec",
+     "script/console",
+     "script/destroy",
+     "script/generate",
+     "spec/launchitem_listener_spec.rb",
+     "spec/participant_spec.rb",
+     "spec/ruote_amqp_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/workitem_listener_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/kennethkalmer/ruote-amqp}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{AMQP participant/listener pair for ruote 2.1}
+  s.test_files = [
+    "spec/launchitem_listener_spec.rb",
+     "spec/participant_spec.rb",
+     "spec/ruote_amqp_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/workitem_listener_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rufus-json>, [">= 0.1.0"])
+      s.add_runtime_dependency(%q<amqp>, [">= 0.6.6"])
+      s.add_runtime_dependency(%q<ruote>, [">= 2.1.5"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rufus-json>, [">= 0.1.0"])
+      s.add_dependency(%q<amqp>, [">= 0.6.6"])
+      s.add_dependency(%q<ruote>, [">= 2.1.5"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rufus-json>, [">= 0.1.0"])
+    s.add_dependency(%q<amqp>, [">= 0.6.6"])
+    s.add_dependency(%q<ruote>, [">= 2.1.5"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+

data/spec/launchitem_listener_spec.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe RuoteAMQP::LaunchitemListener do
+
+  it "should launch processes" do
+    json = {
+      "definition" => "
+        Ruote.process_definition :name => 'test' do
+          sequence do
+            echo '${f:foo}'
+          end
+        end
+      ",
+      "fields" => {
+        "foo" => "bar"
+      }
+    }.to_json
+
+    RuoteAMQP::LaunchitemListener.new( @engine )
+
+    MQ.queue( RuoteAMQP::LaunchitemListener.queue ).publish( json )
+
+    sleep 0.5
+
+    @engine.should_not have_errors
+    @engine.should_not have_remaining_expressions
+
+    @tracer.to_s.should == "bar"
+
+    purge_engine
+  end
+end

data/spec/participant_spec.rb

@@ -4,15 +4,12 @@ describe RuoteAMQP::Participant, :type => :ruote do
 
   it "should support 'reply anyway' on expression parameter" do
 
-    pdef = <<-EOF
-    class AmqpParticipant0 < OpenWFE::ProcessDefinition
-
+    pdef = ::Ruote.process_definition :name => 'test' do
       sequence do
         amqp :queue => 'test1', 'reply_anyway' => true
         echo 'done.'
       end
     end
-    EOF
 
     @engine.register_participant( :amqp, RuoteAMQP::Participant )
 
@@ -38,15 +35,13 @@ describe RuoteAMQP::Participant, :type => :ruote do
   end
 
   it "should support 'reply anyway' as participant configuration" do
-    pdef = <<-EOF
-    class AmqpParticipant0 < OpenWFE::ProcessDefinition
 
+    pdef = ::Ruote.process_definition :name => 'test' do
       sequence do
         amqp :queue => 'test4'
         echo 'done.'
       end
     end
-    EOF
 
     p = RuoteAMQP::Participant.new( :reply_by_default => true )
     @engine.register_participant( :amqp, p )
@@ -56,7 +51,7 @@ describe RuoteAMQP::Participant, :type => :ruote do
     @tracer.to_s.should == "done."
 
     begin
-      Timeout::timeout(10) do
+      Timeout::timeout(5) do
         @msg = nil
         MQ.queue('test4').subscribe { |msg| @msg = msg }
 
@@ -73,15 +68,13 @@ describe RuoteAMQP::Participant, :type => :ruote do
   end
 
   it "should support custom messages instead of workitems" do
-    pdef = <<-EOF
-    class AmqpParticipant1 < OpenWFE::ProcessDefinition
 
+    pdef = ::Ruote.process_definition :name => 'test' do
       sequence do
         amqp :queue => 'test2', :message => 'foo', 'reply_anyway' => true
         echo 'done.'
       end
     end
-    EOF
 
     @engine.register_participant( :amqp, RuoteAMQP::Participant )
 
@@ -90,7 +83,7 @@ describe RuoteAMQP::Participant, :type => :ruote do
     @tracer.to_s.should == "done."
 
     begin
-      Timeout::timeout(10) do
+      Timeout::timeout(5) do
         @msg = nil
         MQ.queue('test2').subscribe { |msg| @msg = msg }
 
@@ -108,15 +101,12 @@ describe RuoteAMQP::Participant, :type => :ruote do
 
   it "should support a default queue name" do
 
-    pdef = <<-EOF
-    class AmqpParticipant0 < OpenWFE::ProcessDefinition
-
+    pdef = ::Ruote.process_definition :name => 'test' do
       sequence do
         amqp 'reply_anyway' => true
         echo 'done.'
       end
     end
-    EOF
 
     amqp = RuoteAMQP::Participant.new( :default_queue => 'test5' )
     @engine.register_participant( :amqp, amqp )
@@ -126,7 +116,7 @@ describe RuoteAMQP::Participant, :type => :ruote do
     @tracer.to_s.should == 'done.'
 
     begin
-      Timeout::timeout(10) do
+      Timeout::timeout(5) do
         @msg = nil
         MQ.queue('test5').subscribe { |msg| @msg = msg }
 
@@ -141,9 +131,8 @@ describe RuoteAMQP::Participant, :type => :ruote do
   end
 
   it "should support mapping participant names to queue names" do
-    pdef = <<-EOF
-    class AmqpParticipant0 < OpenWFE::ProcessDefinition
 
+    pdef = ::Ruote.process_definition :name => 'test' do
       sequence do
         q1
         q2
@@ -151,7 +140,6 @@ describe RuoteAMQP::Participant, :type => :ruote do
         echo 'done.'
       end
     end
-    EOF
 
     amqp = RuoteAMQP::Participant.new( :reply_by_default => true, :default_queue => 'test6' )
     amqp.map_participant( 'q1', 'test7' )
@@ -166,7 +154,7 @@ describe RuoteAMQP::Participant, :type => :ruote do
 
     [ 'test6', 'test7', 'test8' ].each do |q|
       begin
-        Timeout::timeout(10) do
+        Timeout::timeout(5) do
           @msg = nil
           MQ.queue( q ).subscribe { |msg| @msg = msg }
 

data/spec/spec_helper.rb

@@ -1,21 +1,34 @@
-begin
-  require 'spec'
-rescue LoadError
-  require 'rubygems' unless ENV['NO_RUBYGEMS']
-  gem 'rspec'
-  require 'spec'
-end
+require 'rubygems'
+gem 'rspec'
+require 'spec'
 
 $:.unshift(File.dirname(__FILE__) + '/../lib')
+$:.unshift('../ruote/lib')
+
+# For the tests to work you need to use the AMQP gem built from
+# http://github.com/kennethkalmer/amqp.git
+gem 'amqp', '=0.6.6'
+
+require 'fileutils'
+require 'json'
+
+require 'ruote/engine'
+require 'ruote/worker'
+require 'ruote/storage/hash_storage'
+require 'ruote/log/test_logger'
+
 require 'ruote-amqp'
 require 'spec/ruote'
-require 'fileutils'
+
 
 # AMQP magic worked here
-AMQP.settings[:vhost] = '/ruote-test'
+AMQP.settings[:host]  = 'localhost'
+AMQP.settings[:vhost] = 'ruote-test'
 AMQP.settings[:user]  = 'ruote'
 AMQP.settings[:pass]  = 'ruote'
 
+#AMQP.logging = true
+
 Spec::Runner.configure do |config|
 
   config.include( RuoteSpecHelpers )
@@ -23,41 +36,20 @@ Spec::Runner.configure do |config|
   config.before(:each) do
     @tracer = Tracer.new
 
-    ac = {}
-
-    class << ac
-      alias :old_put :[]=
-      def []= (k, v)
-        raise("!!!!! #{k.class}\n#{k.inspect}") \
-          if k.class != String and k.class != Symbol
-        old_put(k, v)
-      end
-    end
-    #
-    # useful for tracking misuses of the application context
-
-    ac['__tracer'] = @tracer
-    ac[:ruby_eval_allowed] = true
-    ac[:definition_in_launchitem_allowed] = true
-
-    @engine = OpenWFE::Engine.new( ac )
-
-    @terminated_processes = []
-    @engine.get_expression_pool.add_observer(:terminate) do |c, fe, wi|
-      @terminated_processes << fe.fei.wfid
-      #p [ :terminated, @terminated_processes ]
-    end
-
-    if ENV['DEBUG']
-      $OWFE_LOG = Logger.new( STDOUT )
-      $OWFE_LOG.level = Logger::DEBUG
-    end
+    @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.stop
-    AMQP.stop { EM.stop }
-    sleep 0.001 while EM.reactor_running?
+    @engine.shutdown
+    @engine.context.storage.purge!
   end
 
   config.after(:all) do