ruote 2.1.10 → 2.1.11

data/ruote.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruote}
-  s.version = "2.1.10"
+  s.version = "2.1.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mettraux", "Kenneth Kalmer", "Torsten Schoenebaum"]
-  s.date = %q{2010-06-15}
+  s.date = %q{2010-10-01}
   s.description = %q{
 ruote is an open source ruby workflow engine.
     }
@@ -28,6 +28,7 @@ ruote is an open source ruby workflow engine.
      "TODO.txt",
      "examples/barley.rb",
      "examples/flickr_report.rb",
+     "examples/pong.rb",
      "examples/ruote_quickstart.rb",
      "examples/web_first_page.rb",
      "lib/ruote.rb",
@@ -35,12 +36,9 @@ ruote is an open source ruby workflow engine.
      "lib/ruote/engine.rb",
      "lib/ruote/engine/process_error.rb",
      "lib/ruote/engine/process_status.rb",
-     "lib/ruote/error_handler.rb",
-     "lib/ruote/evt/tracker.rb",
      "lib/ruote/exp/command.rb",
      "lib/ruote/exp/commanded.rb",
      "lib/ruote/exp/condition.rb",
-     "lib/ruote/exp/expression_map.rb",
      "lib/ruote/exp/fe_add_branches.rb",
      "lib/ruote/exp/fe_apply.rb",
      "lib/ruote/exp/fe_cancel_process.rb",
@@ -61,6 +59,7 @@ ruote is an open source ruby workflow engine.
      "lib/ruote/exp/fe_noop.rb",
      "lib/ruote/exp/fe_participant.rb",
      "lib/ruote/exp/fe_redo.rb",
+     "lib/ruote/exp/fe_ref.rb",
      "lib/ruote/exp/fe_reserve.rb",
      "lib/ruote/exp/fe_restore.rb",
      "lib/ruote/exp/fe_save.rb",
@@ -73,13 +72,13 @@ ruote is an open source ruby workflow engine.
      "lib/ruote/exp/flowexpression.rb",
      "lib/ruote/exp/iterator.rb",
      "lib/ruote/exp/merge.rb",
-     "lib/ruote/exp/raw.rb",
      "lib/ruote/exp/ro_attributes.rb",
      "lib/ruote/exp/ro_persist.rb",
      "lib/ruote/exp/ro_variables.rb",
      "lib/ruote/fei.rb",
      "lib/ruote/id/mnemo_wfid_generator.rb",
      "lib/ruote/id/wfid_generator.rb",
+     "lib/ruote/log/pretty.rb",
      "lib/ruote/log/storage_history.rb",
      "lib/ruote/log/test_logger.rb",
      "lib/ruote/log/wait_logger.rb",
@@ -87,13 +86,11 @@ ruote is an open source ruby workflow engine.
      "lib/ruote/parser/ruby_dsl.rb",
      "lib/ruote/parser/xml.rb",
      "lib/ruote/part/block_participant.rb",
-     "lib/ruote/part/dispatch_pool.rb",
      "lib/ruote/part/engine_participant.rb",
      "lib/ruote/part/hash_participant.rb",
      "lib/ruote/part/local_participant.rb",
      "lib/ruote/part/no_op_participant.rb",
      "lib/ruote/part/null_participant.rb",
-     "lib/ruote/part/participant_list.rb",
      "lib/ruote/part/smtp_participant.rb",
      "lib/ruote/part/storage_participant.rb",
      "lib/ruote/part/template.rb",
@@ -103,18 +100,23 @@ ruote is an open source ruby workflow engine.
      "lib/ruote/storage/composite_storage.rb",
      "lib/ruote/storage/fs_storage.rb",
      "lib/ruote/storage/hash_storage.rb",
-     "lib/ruote/subprocess.rb",
+     "lib/ruote/svc/dispatch_pool.rb",
+     "lib/ruote/svc/dollar_sub.rb",
+     "lib/ruote/svc/error_handler.rb",
+     "lib/ruote/svc/expression_map.rb",
+     "lib/ruote/svc/participant_list.rb",
+     "lib/ruote/svc/tracker.rb",
+     "lib/ruote/svc/treechecker.rb",
      "lib/ruote/tree_dot.rb",
-     "lib/ruote/util/dollar.rb",
      "lib/ruote/util/hashdot.rb",
      "lib/ruote/util/look.rb",
      "lib/ruote/util/lookup.rb",
      "lib/ruote/util/misc.rb",
      "lib/ruote/util/ometa.rb",
      "lib/ruote/util/serializer.rb",
+     "lib/ruote/util/subprocess.rb",
      "lib/ruote/util/time.rb",
      "lib/ruote/util/tree.rb",
-     "lib/ruote/util/treechecker.rb",
      "lib/ruote/version.rb",
      "lib/ruote/worker.rb",
      "lib/ruote/workitem.rb",
@@ -158,6 +160,7 @@ ruote is an open source ruby workflow engine.
      "test/functional/eft_28_when.rb",
      "test/functional/eft_29_cron.rb",
      "test/functional/eft_2_sequence.rb",
+     "test/functional/eft_30_ref.rb",
      "test/functional/eft_3_participant.rb",
      "test/functional/eft_4_set.rb",
      "test/functional/eft_5_subprocess.rb",
@@ -198,9 +201,13 @@ ruote is an open source ruby workflow engine.
      "test/functional/ft_38_participant_more.rb",
      "test/functional/ft_39_wait_for.rb",
      "test/functional/ft_3_participant_registration.rb",
-     "test/functional/ft_40_participant_on_reply.rb",
+     "test/functional/ft_40_wait_logger.rb",
      "test/functional/ft_41_participants.rb",
      "test/functional/ft_42_storage_copy.rb",
+     "test/functional/ft_43_participant_on_reply.rb",
+     "test/functional/ft_44_var_participant.rb",
+     "test/functional/ft_45_participant_accept.rb",
+     "test/functional/ft_46_launch_single.rb",
      "test/functional/ft_4_cancel.rb",
      "test/functional/ft_5_on_error.rb",
      "test/functional/ft_6_on_cancel.rb",
@@ -248,7 +255,7 @@ ruote is an open source ruby workflow engine.
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{ruote}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{an open source ruby workflow engine}
   s.test_files = [
     "test/test.rb"
@@ -259,10 +266,9 @@ ruote is an open source ruby workflow engine.
     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.2.2"])
-      s.add_runtime_dependency(%q<rufus-cloche>, [">= 0.1.17"])
+      s.add_runtime_dependency(%q<rufus-json>, [">= 0.2.5"])
+      s.add_runtime_dependency(%q<rufus-cloche>, [">= 0.1.20"])
       s.add_runtime_dependency(%q<rufus-dollar>, [">= 0"])
-      s.add_runtime_dependency(%q<rufus-lru>, [">= 0"])
       s.add_runtime_dependency(%q<rufus-mnemo>, [">= 1.1.0"])
       s.add_runtime_dependency(%q<rufus-scheduler>, [">= 2.0.5"])
       s.add_runtime_dependency(%q<rufus-treechecker>, [">= 1.0.3"])
@@ -273,10 +279,9 @@ ruote is an open source ruby workflow engine.
       s.add_development_dependency(%q<mailtrap>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
     else
-      s.add_dependency(%q<rufus-json>, [">= 0.2.2"])
-      s.add_dependency(%q<rufus-cloche>, [">= 0.1.17"])
+      s.add_dependency(%q<rufus-json>, [">= 0.2.5"])
+      s.add_dependency(%q<rufus-cloche>, [">= 0.1.20"])
       s.add_dependency(%q<rufus-dollar>, [">= 0"])
-      s.add_dependency(%q<rufus-lru>, [">= 0"])
       s.add_dependency(%q<rufus-mnemo>, [">= 1.1.0"])
       s.add_dependency(%q<rufus-scheduler>, [">= 2.0.5"])
       s.add_dependency(%q<rufus-treechecker>, [">= 1.0.3"])
@@ -288,10 +293,9 @@ ruote is an open source ruby workflow engine.
       s.add_dependency(%q<jeweler>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rufus-json>, [">= 0.2.2"])
-    s.add_dependency(%q<rufus-cloche>, [">= 0.1.17"])
+    s.add_dependency(%q<rufus-json>, [">= 0.2.5"])
+    s.add_dependency(%q<rufus-cloche>, [">= 0.1.20"])
     s.add_dependency(%q<rufus-dollar>, [">= 0"])
-    s.add_dependency(%q<rufus-lru>, [">= 0"])
     s.add_dependency(%q<rufus-mnemo>, [">= 1.1.0"])
     s.add_dependency(%q<rufus-scheduler>, [">= 2.0.5"])
     s.add_dependency(%q<rufus-treechecker>, [">= 1.0.3"])

data/test/functional/base.rb

@@ -22,6 +22,8 @@ module FunctionalBase
     #require 'ruote/util/look'
     #Ruote::Look.dump_lsof
     #Ruote::Look.dump_lsof_count
+      #
+      # uncomment this when "too many open files"
 
     @engine =
       Ruote::Engine.new(
@@ -44,6 +46,7 @@ module FunctionalBase
 
     @engine.shutdown
     @engine.context.storage.purge!
+    @engine.context.storage.close if @engine.context.storage.respond_to?(:close)
   end
 
   def assert_log_count (count, &block)

data/test/functional/concurrent_base.rb

@@ -47,6 +47,7 @@ class Ruote::Engine
     (1..77).to_a.inject({}) { |h, i|
       #(i % 10).times { Thread.pass }
       sleep 0.001
+      sleep 0.025 # couch :-(
       m = peek_msg
       h[m['_id']] = m if m
       h

data/test/functional/crunner.sh

@@ -14,6 +14,6 @@ while [ $? == 0 ]
 do
   echo " *** $COUNT"
   ((COUNT=$COUNT + 1))
-  time ruby $TEST $1 $2
+  time ruby -I. $TEST $*
 done
 

data/test/functional/ct_0_concurrence.rb

@@ -13,6 +13,10 @@ require File.join(File.dirname(__FILE__), 'concurrent_base')
 class CtConcurrenceTest < Test::Unit::TestCase
   include ConcurrentBase
 
+  # A collision between two workers replying to the same concurrence expression.
+  #
+  # Worker 0 replies for echo 'a' while worker 1 replies for echo 'b'.
+  #
   def test_collision
 
     pdef = Ruote.process_definition do
@@ -41,6 +45,8 @@ class CtConcurrenceTest < Test::Unit::TestCase
 
     replies.sort! { |a, b| a['put_at'] <=> b['put_at'] }
 
+    #replies.each { |r| p r }
+
     t0 = Thread.new { @engine1.do_process(replies[0]) }
     t1 = Thread.new { @engine0.do_process(replies[1]) }
     t0.join

data/test/functional/ct_1_iterator.rb

@@ -11,6 +11,9 @@ require File.join(File.dirname(__FILE__), 'concurrent_base')
 class CtIteratorTest < Test::Unit::TestCase
   include ConcurrentBase
 
+  # Test proper handling of collisions between an iterator and another worker
+  # passing a stop command.
+  #
   def test_collision
 
     pdef = Ruote.process_definition do

data/test/functional/ct_2_cancel.rb

@@ -11,6 +11,11 @@ require File.join(File.dirname(__FILE__), 'concurrent_base')
 class CtCancelTest < Test::Unit::TestCase
   include ConcurrentBase
 
+  # A collision between a reply and a cancel
+  #
+  # The first one to occur should neutralize the other (and the flow should
+  # not stall).
+  #
   def test_collision
 
     pdef = Ruote.process_definition do

data/test/functional/eft_13_iterator.rb

@@ -7,6 +7,8 @@
 
 require File.join(File.dirname(__FILE__), 'base')
 
+require 'ruote/participant'
+
 
 class EftIteratorTest < Test::Unit::TestCase
   include FunctionalBase
@@ -26,7 +28,15 @@ class EftIteratorTest < Test::Unit::TestCase
     assert_trace('done.', pdef)
   end
 
-  def test_iterator
+  class TraceParticipant
+    include Ruote::LocalParticipant
+    def consume (wi)
+      context.tracer << "#{wi.participant_name}/#{wi.fei.expid}\n"
+      reply(wi)
+    end
+  end
+
+  def test_on_val
 
     pdef = Ruote.process_definition :name => 'test' do
       iterator :on_val => 'alice, bob, charly', :to_var => 'v' do
@@ -34,15 +44,40 @@ class EftIteratorTest < Test::Unit::TestCase
       end
     end
 
-    @engine.register_participant '.*' do |workitem|
-      @tracer << "#{workitem.participant_name}/#{workitem.fei.expid}\n"
-    end
+    @engine.register_participant '.*', TraceParticipant
 
     #noisy
 
     assert_trace(%w[ alice/0_0_0 bob/0_0_0 charly/0_0_0 ], pdef)
   end
 
+  def test_on__list
+
+    pdef = Ruote.process_definition :name => 'test' do
+      iterator :on => 'alice, bob, charly', :to_var => 'v' do
+        participant '${v:v}'
+      end
+    end
+
+    @engine.register_participant '.*', TraceParticipant
+
+    assert_trace(%w[ alice/0_0_0 bob/0_0_0 charly/0_0_0 ], pdef)
+  end
+
+  def test_on_f
+
+    pdef = Ruote.process_definition :name => 'test' do
+      set :f => 'people', :val => %w[ alice bob charly ]
+      iterator :on_f => 'people', :to_var => 'v' do
+        participant '${v:v}'
+      end
+    end
+
+    @engine.register_participant '.*', TraceParticipant
+
+    assert_trace(%w[ alice/0_1_0 bob/0_1_0 charly/0_1_0 ], pdef)
+  end
+
   def test_to_f
 
     pdef = Ruote.process_definition :name => 'test' do

data/test/functional/eft_14_cursor.rb

@@ -274,5 +274,44 @@ class EftCursorTest < Test::Unit::TestCase
 
     assert_trace 'done.', pdef
   end
+
+  class Alpha
+    include Ruote::LocalParticipant
+    def consume (workitem)
+      workitem.command = 'break'
+      reply_to_engine(workitem)
+    end
+    def cancel (fei, flavour)
+    end
+  end
+  class Bravo < Alpha
+    def consume (workitem)
+      workitem.command = 'skip 1'
+      reply_to_engine(workitem)
+    end
+  end
+
+  def test_cursor_and_workitem
+
+    pdef = Ruote.define do
+      cursor do
+        echo 'in'
+        bravo
+        echo 'mid'
+        alpha
+        echo 'out'
+      end
+      echo 'done.'
+    end
+
+    #noisy
+
+    @engine.register do
+      alpha EftCursorTest::Alpha
+      bravo EftCursorTest::Bravo
+    end
+
+    assert_trace "in\ndone.", pdef
+  end
 end
 

data/test/functional/eft_30_ref.rb

@@ -0,0 +1,140 @@
+
+#
+# testing ruote
+#
+# Tue Jul 20 12:47:36 JST 2010
+#
+
+require File.join(File.dirname(__FILE__), 'base')
+
+require 'ruote/participant'
+
+
+class EftRefTest < Test::Unit::TestCase
+  include FunctionalBase
+
+  class AlphaParticipant
+    include Ruote::LocalParticipant
+
+    def consume (workitem)
+      @context.tracer << workitem.fei.expid
+      @context.tracer << "\n"
+      reply(workitem)
+    end
+  end
+
+  def test_participant
+
+    pdef = Ruote.process_definition do
+      ref :ref => 'alpha'
+      ref 'alpha'
+      echo 'done.'
+    end
+
+    @engine.register_participant :alpha, AlphaParticipant
+
+    #noisy
+
+    assert_trace %w[ 0_0 0_1 done. ], pdef
+  end
+
+  def test_subprocess
+
+    pdef = Ruote.process_definition do
+
+      define 'alpha' do
+        echo 'alpha'
+      end
+
+      sequence do
+        ref :ref => 'alpha'
+        ref 'alpha'
+        echo 'done.'
+      end
+    end
+
+    assert_trace %w[ alpha alpha done. ], pdef
+  end
+
+  def test_missing_participant_ref
+
+    pdef = Ruote.process_definition do
+      ref 'alpha'
+    end
+
+    #noisy
+
+    wfid = @engine.launch(pdef)
+
+    @engine.wait_for(wfid)
+
+    ps = @engine.process(wfid)
+
+    assert_equal 1, ps.errors.size
+
+    # correct problem and replay at error
+
+    @engine.register_participant 'alpha', AlphaParticipant
+
+    @engine.replay_at_error(ps.errors.first)
+
+    @engine.wait_for(wfid)
+
+    assert_nil @engine.process(wfid)
+    assert_equal '0_0', @tracer.to_s
+  end
+
+  def test_missing_subprocess_ref
+
+    pdef = Ruote.process_definition do
+      ref 'alpha'
+    end
+
+    #noisy
+
+    wfid = @engine.launch(pdef)
+
+    @engine.wait_for(wfid)
+
+    ps = @engine.process(wfid)
+
+    assert_equal 1, ps.errors.size
+
+    # correct problem and replay at error
+
+    @engine.variables['alpha'] = Ruote.process_definition do
+      echo 'alpha'
+    end
+
+    @engine.replay_at_error(ps.errors.first)
+
+    @engine.wait_for(wfid)
+
+    assert_nil @engine.process(wfid)
+    assert_equal 'alpha', @tracer.to_s
+  end
+
+  # Making sure that the ref expression forces the triggered subprocess to
+  # consider its timeout.
+  #
+  def test_ref_and_subprocess_timeout
+
+    @engine.register_participant :alpha, Ruote::StorageParticipant
+
+    pdef = Ruote.process_definition do
+      define 'sub0' do
+        alpha
+      end
+      sub0 :timeout => '2d'
+    end
+
+    wfid = @engine.launch(pdef)
+    @engine.wait_for(:alpha)
+
+    scheds = @engine.schedules
+
+    assert_equal 1, scheds.size
+    assert_equal '0_1', scheds.first['target'].expid
+  end
+end
+

data/test/functional/eft_3_participant.rb

@@ -7,7 +7,7 @@
 
 require File.join(File.dirname(__FILE__), 'base')
 
-require 'ruote/part/hash_participant'
+require 'ruote/participant'
 
 
 class EftParticipantTest < Test::Unit::TestCase
@@ -35,58 +35,58 @@ class EftParticipantTest < Test::Unit::TestCase
   def test_participant_att_text
 
     pdef = Ruote.process_definition do
-      participant :alpha
+      participant :bravo
     end
 
-    @engine.register_participant :alpha do |workitem|
-      @tracer << 'alpha'
+    @engine.register_participant :bravo do |workitem|
+      @tracer << 'bravo'
     end
 
     #noisy
 
-    assert_trace 'alpha', pdef
+    assert_trace 'bravo', pdef
   end
 
   def test_participant_exp_name
 
     pdef = Ruote.process_definition do
-      alpha
+      charly
     end
 
-    @engine.register_participant :alpha do |workitem|
-      @tracer << 'alpha'
+    @engine.register_participant :charly do |workitem|
+      @tracer << 'charly'
     end
 
     #noisy
 
-    assert_trace 'alpha', pdef
+    assert_trace 'charly', pdef
   end
 
   def test_participant_exp_name_tree_rewriting
 
     pdef = Ruote.process_definition do
-      alpha :tag => 'whatever'
+      delta :tag => 'whatever'
     end
 
-    alpha = @engine.register_participant :alpha, Ruote::HashParticipant.new
+    delta = @engine.register_participant :delta, Ruote::HashParticipant.new
 
     @engine.launch(pdef)
-    wait_for(:alpha)
+    wait_for(:delta)
 
     assert_equal(
-      ['participant', {'tag'=>'whatever', 'ref'=>'alpha'}, []],
-      Ruote::Exp::FlowExpression.fetch(@engine.context, alpha.first.h.fei).tree)
+      ['participant', {'tag'=>'whatever', 'ref'=>'delta'}, []],
+      Ruote::Exp::FlowExpression.fetch(@engine.context, delta.first.h.fei).tree)
   end
 
   def test_participant_if
 
     pdef = Ruote.process_definition do
-      alpha
-      bravo :if => 'false == true'
-      charly
+      eecho
+      fox :if => 'false == true'
+      gamma
     end
 
-    %w[ alpha bravo charly ].each do |pname|
+    %w[ eecho fox gamma ].each do |pname|
       @engine.register_participant pname do |workitem|
         @tracer << "#{pname}\n"
       end
@@ -94,7 +94,7 @@ class EftParticipantTest < Test::Unit::TestCase
 
     #noisy
 
-    assert_trace %w[ alpha charly ], pdef
+    assert_trace %w[ eecho gamma ], pdef
   end
 
   def test_participant_and_att_text
@@ -122,19 +122,21 @@ class EftParticipantTest < Test::Unit::TestCase
 
   def test_dispatched
 
-    part = @engine.register_participant :alpha do
-      sleep 1
+    @engine.register_participant :hotel do
+      sleep 5
     end
 
     pdef = Ruote.process_definition do
-      alpha
+      hotel
     end
 
     #noisy
 
     wfid = @engine.launch(pdef)
 
-    wait_for(:alpha)
+    #wait_for(:hotel)
+    sleep 0.777
+    sleep 1 # just for ruote-couch :-(
 
     ps = @engine.process(wfid)
 

data/test/functional/ft_10_dollar.rb

@@ -154,7 +154,7 @@ class FtDollarTest < Test::Unit::TestCase
     assert_trace 'AA', pdef
   end
 
-  def test_wfid
+  def test_fei_and_wfid
 
     pdef = Ruote.process_definition do
       sequence do
@@ -169,5 +169,21 @@ class FtDollarTest < Test::Unit::TestCase
 
     assert_equal "0_0_0!!#{wfid}\n#{wfid}", @tracer.to_s
   end
+
+  def test_direct_access_to_fields
+
+    pdef = Ruote.process_definition do
+      sequence do
+        set 'f:a' => [ 'alpha', 'bravo', 'charly' ]
+        echo '${r:a.join("/")}'
+      end
+    end
+
+    @engine.context['ruby_eval_allowed'] = true
+
+    #noisy
+
+    assert_trace 'alpha/bravo/charly', pdef
+  end
 end