openwferu 0.9.7 → 0.9.8

data/lib/openwfe/util/scheduler.rb

@@ -91,11 +91,20 @@ module OpenWFE
     #         regenerate_latest_report()
     #     end
     #
+    # The scheduler has a "exit_when_no_more_jobs" attribute. When set to
+    # 'true', the scheduler will exit as soon as there are no more jobs to
+    # run.
+    # Use with care though, if you create a scheduler, set this attribute
+    # to true and start the scheduler, the scheduler will immediately exit.
+    # This attribute is best used indirectly : the method 
+    # join_until_no_more_jobs() wraps it.
+    #
     class Scheduler
         include MonitorMixin
 
         attr_accessor \
-            :precision
+            :precision,
+            :exit_when_no_more_jobs
 
         def initialize
 
@@ -110,6 +119,9 @@ module OpenWFE
                 #
                 # every 250ms, the scheduler wakes up
 
+            @exit_when_no_more_jobs = false
+            @dont_reschedule_every = false
+
             @last_cron_minute = -1
 
             @stopped = false
@@ -123,7 +135,6 @@ module OpenWFE
             @scheduler_thread = Thread.new do
                 while true
                     break if @stopped
-                    #print "."; $stdout.flush
                     step
                     sleep(@precision)
                 end
@@ -134,6 +145,7 @@ module OpenWFE
         # The scheduler is stoppable via sstop()
         #
         def sstop
+
             @stopped = true
         end
 
@@ -144,64 +156,33 @@ module OpenWFE
         # Joins on the scheduler thread
         #
         def join
+
             @scheduler_thread.join
         end
 
         #
-        # Schedules a job by specifying at which time it should trigger.
-        # Returns the a job_id that can be used to unschedule the job.
+        # Like join() but takes care of setting the 'exit_when_no_more_jobs'
+        # attribute of this scheduler to true before joining.
+        # Thus the scheduler will exit (and the join terminates) as soon as
+        # there aren't no more 'at' (or 'every') jobs in the scheduler.
         #
-        def schedule_at (at, schedulable=nil, params=nil, &block)
+        # Currently used only in unit tests.
+        #
+        def join_until_no_more_jobs
 
-            schedule_at_with_id(at, nil, schedulable, params, &block)
+            @exit_when_no_more_jobs = true
+            join
         end
 
         #
-        # Do not call directly.
+        # Schedules a job by specifying at which time it should trigger.
+        # Returns the a job_id that can be used to unschedule the job.
         #
-        def schedule_at_with_id (at, at_id, schedulable=nil, params=nil, &block)
-            synchronize do
-
-                #puts "0 at is '#{at.to_s}' (#{at.class})"
-
-                at = OpenWFE::to_ruby_time(at) \
-                    if at.kind_of? String
-
-                at = OpenWFE::to_gm_time(at) \
-                    if at.kind_of? DateTime
-
-                at = at.to_f \
-                    if at.kind_of? Time
-
-                #puts "1 at is '#{at.to_s}' (#{at.class})"}"
-
-                b = to_block(schedulable, params, &block)
-                job = AtEntry.new(at, at_id, &b)
-
-                if at < (Time.new.to_f + @precision)
-                    job.trigger()
-                    return nil
-                end
-
-                return push(job) \
-                    if @pending_jobs.length < 1
-
-                # shortcut : check if the new job is posterior to
-                # the last job pending
-
-                return push(job) \
-                    if at >= @pending_jobs.last.at
-
-                for i in 0...@pending_jobs.length
-                    if at <= @pending_jobs[i].at
-                        return push(job, i)
-                    end
-                end
+        def schedule_at (at, schedulable=nil, params=nil, &block)
 
-                return push(job)
-            end
+            sschedule_at(false, at, nil, schedulable, params, &block)
         end
-        protected :schedule_at_with_id
+
 
         #
         # Schedules a job by stating in how much time it should trigger.
@@ -231,28 +212,8 @@ module OpenWFE
         #
         def schedule_every (freq, schedulable=nil, params=nil, &block)
 
-            schedule_every_with_id(freq, nil, schedulable, params, &block)
-        end
-
-        #
-        # Do not call directly.
-        #
-        def schedule_every_with_id (freq, at_id, schedulable, params, &block)
-
-            f = duration_to_f(freq)
-
-            job_id = schedule_at_with_id(Time.new.to_f + f, at_id) do |eid, at|
-                if schedulable
-                    schedulable.trigger(params)
-                else
-                    block.call eid, at
-                end
-                schedule_every_with_id(f, eid, schedulable, params, &block)
-            end
-
-            job_id
+            sschedule_every(freq, nil, schedulable, params, &block)
         end
-        protected :schedule_every_with_id
 
         #
         # Unschedules an 'at' or a 'cron' job identified by the id
@@ -317,12 +278,10 @@ module OpenWFE
                 #
                 # is a job with the same id already scheduled ?
 
-                if cron_id
-                    if unschedule(cron_id)
-                        ldebug do 
-                            "schedule() unscheduled previous job "+
-                            "under same name '#{cron_id}'"
-                        end
+                if cron_id and unschedule(cron_id)
+                    ldebug do 
+                        "schedule() unscheduled previous job "+
+                        "under same name '#{cron_id}'"
                     end
                 end
 
@@ -368,7 +327,8 @@ module OpenWFE
         end
 
         #
-        # Returns the number of currently pending jobs in this scheduler.
+        # Returns the number of currently pending jobs in this scheduler
+        # ('at' jobs and 'every' jobs).
         #
         def pending_job_count
             @pending_jobs.size
@@ -381,6 +341,20 @@ module OpenWFE
             @cron_entries.size
         end
 
+        #
+        # Returns the current count of 'every' jobs scheduled.
+        #
+        def every_job_count
+            @pending_jobs.select { |j| j.is_a?(EveryEntry) }.size
+        end
+
+        #
+        # Returns the current count of 'at' jobs scheduled (not 'every').
+        #
+        def at_job_count
+            @pending_jobs.select { |j| j.instance_of?(AtEntry) }.size
+        end
+
         #
         # Returns true if the given string seems to be a cron string.
         #
@@ -390,6 +364,74 @@ module OpenWFE
 
         protected
 
+            def sschedule_at (
+                is_every, at, at_id, schedulable=nil, params=nil, &block)
+
+                synchronize do
+
+                    #puts "0 at is '#{at.to_s}' (#{at.class})"
+
+                    at = OpenWFE::to_ruby_time(at) \
+                        if at.kind_of? String
+
+                    at = OpenWFE::to_gm_time(at) \
+                        if at.kind_of? DateTime
+
+                    at = at.to_f \
+                        if at.kind_of? Time
+
+                    #puts "1 at is '#{at.to_s}' (#{at.class})"}"
+
+                    jobClass = AtEntry
+                    jobClass = EveryEntry if is_every
+
+                    b = to_block(schedulable, params, &block)
+                    job = jobClass.new(at, at_id, &b)
+
+                    if at < (Time.new.to_f + @precision)
+                        job.trigger()
+                        return nil
+                    end
+
+                    return push(job) \
+                        if @pending_jobs.length < 1
+
+                    # shortcut : check if the new job is posterior to
+                    # the last job pending
+
+                    return push(job) \
+                        if at >= @pending_jobs.last.at
+
+                    for i in 0...@pending_jobs.length
+                        if at <= @pending_jobs[i].at
+                            return push(job, i)
+                        end
+                    end
+
+                    return push(job)
+                end
+            end
+
+            def sschedule_every (freq, at_id, schedulable, params, &block)
+
+                f = duration_to_f(freq)
+
+                job_id = sschedule_at(
+                    true, Time.new.to_f + f, at_id) do |eid, at|
+
+                    if schedulable
+                        schedulable.trigger(params)
+                    else
+                        block.call eid, at
+                    end
+                    
+                    sschedule_every(f, eid, schedulable, params, &block) \
+                        unless @dont_reschedule_every
+                end
+
+                job_id
+            end
+
             #
             # Ensures that a duration is a expressed as a Float instance.
             #
@@ -448,9 +490,21 @@ module OpenWFE
             #
             def step
                 synchronize do
+
                     now = Time.new
                     minute = now.min
 
+                    if @exit_when_no_more_jobs
+
+                       if @pending_jobs.size < 1
+
+                            @stopped = true
+                            return
+                        end
+
+                        @dont_reschedule_every = true if at_job_count < 1
+                    end
+
                     #
                     # cron entries
 
@@ -577,6 +631,9 @@ module OpenWFE
             end
         end
 
+        class EveryEntry < AtEntry
+        end
+
         class CronEntry < Entry
 
             attr_accessor \

data/lib/openwfe/utils.rb

@@ -262,7 +262,7 @@ module OpenWFE
                 end
             end
         end
-        # implicitely return the thread
+        # returns the thread
     end
 
     #

data/lib/openwfe/version.rb

@@ -1,6 +1,6 @@
 #
 #--
-# Copyright (c) 2007, John Mettraux, OpenWFE.org
+# Copyright (c) 2005-2007, John Mettraux, OpenWFE.org
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without 
@@ -34,5 +34,5 @@
 #
 
 module OpenWFE
-    OPENWFERU_VERSION = '0.9.7'
+    OPENWFERU_VERSION = '0.9.8'
 end

data/lib/openwfe/workitem.rb

@@ -49,6 +49,12 @@ require 'openwfe/rest/definitions'
 
 module OpenWFE
 
+    #
+    # The convention for the result of some expressions is to store
+    # their result in a workitem field named "__result__".
+    #
+    FIELD_RESULT = "__result__"
+
     #
     # WORKITEMS
     #
@@ -280,6 +286,38 @@ module OpenWFE
             wi.filter = h[:filter]
             wi
         end
+
+        #
+        # Sets the '__result__' field of this workitem
+        #
+        def set_result (result)
+            @attributes[FIELD_RESULT] = result
+        end
+
+        #
+        # Makes sure the '__result__' field of this workitem is empty.
+        #
+        def unset_result
+            @attributes.delete FIELD_RESULT
+        end
+
+        #
+        # Just a shortcut (for consistency) of
+        #
+        #     workitem.attributes["__result__"]
+        #
+        def get_result
+            @attributes[FIELD_RESULT]
+        end
+
+        #
+        # Returns true or false.
+        #
+        def get_boolean_result
+            r = get_result
+            return false unless r
+            return (r == true or r == "true")
+        end
     end
 
     #

data/lib/openwfe/worklist/storeparticipant.rb

@@ -73,10 +73,14 @@ module OpenWFE
         # Called by the engine (the participant expression) when handing
         # out a workitem (to this participant).
         #
+        # This method can also be used when delegating a workitem from
+        # one store participant to the other.
+        #
         def consume (workitem)
 
             self[workitem.flow_expression_id] = workitem
         end
+        alias :push :consume
 
         #
         # Called by the participant expression when this participant is
@@ -112,7 +116,9 @@ module OpenWFE
             raise "Workitem not found in #{self.class}, cannot forward." \
                 unless self.has_key? workitem.flow_expression_id
 
-            self.delete(workitem.flow_expression_id)
+            #self.delete(workitem.flow_expression_id)
+            self.delete(workitem)
+
             reply_to_engine(workitem)
         end
 
@@ -121,6 +127,25 @@ module OpenWFE
         #
         alias :proceed :forward
 
+        #
+        # This delete() method accepts a workitem or simply its FlowExpressionId
+        # identifier.
+        #
+        def delete (wi_or_fei)
+            fei = wi_or_fei
+            fei = fei.fei if fei.is_a? InFlowWorkItem
+            super fei
+        end
+
+        #
+        # A convenience method for delegating a workitem to another
+        # store participant.
+        #
+        def delegate (wi_or_fei, other_store_participant)
+            wi = delete(wi_or_fei)
+            other_store_participant.push(wi)
+        end
+
         #
         # Returns all the workitems for a given workflow instance id.
         # If no workflow_instance_id is given, all the workitems will be
@@ -143,7 +168,7 @@ module OpenWFE
         # consecutive calls to this method might not return the same workitem
         # (except if the store is empty or contains 1! workitem).
         #
-        def first_workitem ()
+        def first_workitem
 
             result = nil
 

data/test/console_test.rb

@@ -0,0 +1,15 @@
+
+a = "A"
+b = 2
+
+require 'openwfe/util/irb'
+
+#trap 'INT' do
+#    OpenWFE::start_irb_session binding()
+#end
+OpenWFE::bind_console(binding())
+
+sleep(30)
+
+puts "out"
+

data/test/flowtestbase.rb

@@ -57,6 +57,17 @@ module FlowTestBase
             require 'pp'; pp workitem
             puts
         end
+
+        @engine.register_participant('test-.*', PrintParticipant.new())
+
+        @engine.register_participant('block-participant') do |workitem|
+            @tracer << "the block participant received a workitem"
+            @tracer << "\n"
+        end
+
+        @engine.register_participant('p-toto') do |workitem|
+            @tracer << "toto"
+        end
     end
 
     def teardown
@@ -89,35 +100,10 @@ module FlowTestBase
         #
         # dotest()
         #
-        def dotest (flowDef, expectedTrace, sleepTime=0, allowRemainingExpressions=false)
+        def dotest (flowDef, expectedTrace, join=false, allowRemainingExpressions=false)
 
             @tracer.clear
 
-            @engine.register_participant('test-.*', PrintParticipant.new())
-
-            @engine.register_participant('block-participant') do |workitem|
-                @tracer << "the block participant received a workitem"
-                @tracer << "\n"
-            end
-
-            @engine.register_participant('p-toto') do |workitem|
-                @tracer << "toto"
-            end
-
-#            @engine.register_participant(
-#                'eno', 
-#                EmailNotificationParticipant.new(
-#                    "googlemail.l.google.com",
-#                    25,
-#                    "eno@outoftheblue.co.jp",
-#                    """Subject: test 0
-#
-#0 : ${r:Time.new}
-#1 : ${f:customer_name}
-#                    """))
-
-            # register unique tracing participant
-
             li = if flowDef.kind_of? OpenWFE::LaunchItem
                 flowDef
             else
@@ -126,7 +112,8 @@ module FlowTestBase
 
             fei = @engine.launch(li)
 
-            sleep(sleepTime)
+            #sleep(sleep_time)
+            @engine.get_scheduler.join_until_no_more_jobs if join
 
             trace = @tracer.to_s
 
@@ -146,9 +133,14 @@ module FlowTestBase
                 assert \
                     result,
                     "flow failed : trace doesn't correspond to any expected traces"
+            elsif expectedTrace.kind_of? Regexp
+
+                assert \
+                    trace.match(expectedTrace)
             else
+
                 assert \
-                    trace == expectedTrace, \
+                    trace == expectedTrace,
                     """flow failed : 
                     
 '#{trace}'

data/test/ft_12_blockparticipant.rb

@@ -69,5 +69,29 @@ done.""")
             """bp1a : OpenWFE::ParticipantExpression""")
     end
 
+
+    #
+    # Test 2
+    #
+
+    class BpDef2 < OpenWFE::ProcessDefinition
+        sequence do
+            bp
+            _print "${f:__result__}"
+        end
+    end
+
+    def test_bp_2
+
+        @engine.register_participant("bp") do |fexp, wi|
+            "a string result"
+                #
+                # the 'return' value of a block participant is stored
+                # in the "__result__" field of the workitem
+        end
+
+        dotest(BpDef2, "a string result")
+    end
+
 end
 

data/test/ft_14b_subprocess.rb

@@ -111,5 +111,23 @@ rei A""")
 c d""")
     end
 
+
+    #
+    # TEST 3
+
+    class SubTest3 < OpenWFE::ProcessDefinition
+
+        subprocess "c", "d", :ref => :sub1
+
+        process_definition :name => :sub1 do
+            _print "${0} ${1}"
+        end
+    end
+
+    #def xxxx_sub_3
+    def test_sub_3
+        dotest(SubTest3, "c d")
+    end
+
 end
 

data/test/ft_22_history.rb

@@ -62,9 +62,30 @@ c""")
         #    (history.entries.size == 36),
         #    "invalid history count : #{history.entries.size}"
         assert \
-            (history.entries.size > 33 and history.entries.size < 39),
+            history.entries.size == 22,
             "invalid history count : #{history.entries.size}"
     end
 
+    def test_history_1
+
+        @engine.init_service("history", FileHistory)
+
+        dotest(
+            TestDefinition0,
+            """a
+b
+c""")
+
+        @engine.ac["history"].output_file.flush
+
+        linecount = File.open("work/history.log") do |f|
+            f.readlines.size
+        end
+
+        assert \
+            linecount == 22,
+            "invalid history count : #{linecount}"
+    end
+
 end
 

data/test/ft_23_when.rb

@@ -43,8 +43,35 @@ class FlowTest23 < Test::Unit::TestCase
     end
 
     def test_0
-        #dotest(TestDefinition0, "done\nok")
-        dotest(TestDefinition0, "done\nok", 4)
+        dotest(TestDefinition0, "done\nok", true)
+    end
+
+    #
+    # Test 1
+    #
+
+    class TestWhen1 < ProcessDefinition
+        concurrence do
+            _when :frequency => "2s" do
+                sequence do
+                    #reval "puts '___ equals : ' + fei.wfid"
+                    _equals :value => "${done}", :other_value => "true"
+                end
+                sequence do
+                    #reval "puts '___ consequence : ' + fei.wfid"
+                    _print "ok"
+                end
+            end
+            sequence do
+                _sleep "500"
+                _set :variable => "done", :value => "true"
+                _print "done"
+            end
+        end
+    end
+
+    def test_1
+        dotest(TestWhen1, "done\nok", true)
     end
 
 end

data/test/ft_23b_when.rb

@@ -42,5 +42,22 @@ class FlowTest23b < Test::Unit::TestCase
         dotest(TestDefinition0, "ok", 5)
     end
 
+
+    #
+    # Test 1
+    #
+
+    class TestWait23b1 < ProcessDefinition
+        concurrence do
+            _when :test => "true == true" do
+            end
+            _print "ok"
+        end
+    end
+
+    def test_1
+        dotest(TestWait23b1, "ok", true)
+    end
+
 end