openwferu 0.9.1 → 0.9.2

data/lib/openwfe/worklist/worklists.rb

@@ -0,0 +1,175 @@
+#
+#--
+# Copyright (c) 2005-2007, John Mettraux, OpenWFE.org
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without 
+# modification, are permitted provided that the following conditions are met:
+# 
+# . Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.  
+# 
+# . Redistributions in binary form must reproduce the above copyright notice, 
+#   this list of conditions and the following disclaimer in the documentation 
+#   and/or other materials provided with the distribution.
+# 
+# . Neither the name of the "OpenWFE" nor the names of its contributors may be
+#   used to endorse or promote products derived from this software without
+#   specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
+# POSSIBILITY OF SUCH DAMAGE.
+#++
+#
+# $Id: worklistclient.rb 3454 2006-10-08 16:51:00Z jmettraux $
+#
+
+#
+# Nicolas Modrzyk at openwfe.org
+#
+
+module OpenWFE
+
+    class Worklist 
+    
+        att_reader: :stores, :locks, :launchables 
+
+        #
+        # Returns the list of stores of the worklist
+        #
+        def list_stores ()
+            raise "Not Implemented Yet"
+        end
+
+        #
+        # A synonym for listStores()
+        #
+        def getStoreNames ()
+            return listStores()
+        end
+
+        #
+        # Returns the headers of a given store.
+        #
+        def getHeaders (storeName, limit=1000)
+            raise "Not Implemented Yet"
+        end
+
+        def findFlowInstance (storeName, workflowInstanceId)
+            raise "Not Implemented Yet"
+        end
+
+        #
+        # Launches a flow (on a given engine and with a given launchitem).
+        # The 'engineId' corresponds to an engine's participant name
+        # (see etc/engine/participant-map.xml)
+        #
+        def launchFlow (engineId, launchitem)
+            raise "Not Implemented Yet"
+        end
+
+        #
+        # Returns a workitem (but doesn't put a lock on it, thus modifications
+        # to it cannot be communicated with saveWorkitem() or forwardWorkitem()
+        # to the worklist)
+        #
+        def getWorkitem (storeName, flowExpressionId)
+            raise "Not Implemented Yet"
+        end
+
+        #
+        # Returns a workitem and makes sure it's locked in the worklist. Thus,
+        # the usage of the methods saveWorkitem() and forwardWorkitem() is
+        # possible.
+        #
+        def getAndLockWorkitem (storeName, flowExpressionId)
+            raise "Not Implemented Yet"
+        end
+
+        #
+        # Given a queryMap (a dict of keys and values), locks and returns 
+        # the first workitem matching.
+        #
+        def queryAndLockWorkitem (storeName, queryMap)
+            raise "Not Implemented Yet"
+        end
+
+        #
+        # Notifies the worklist that the given workitem has to be unlocked
+        # any local (client-side) modification to it are ignored.
+        #
+        def releaseWorkitem (workitem)
+            raise "Not Implemented Yet"
+        end
+
+        #
+        # Saves back the workitem in the worklist (and releases it)
+        #
+        def saveWorkitem (workitem)
+            raise "Not Implemented Yet"
+        end
+
+        #
+        # Returns the workitem to the worklist so that it can resume 
+        # its flow (changes to the workitem are saved).
+        #
+        def proceedWorkitem (workitem)
+            raise "Not Implemented Yet"
+        end
+
+        #
+        # Returns the list of flow URLs the user owning this session may
+        # launch.
+        #
+        def listLaunchables ()
+            raise "Not Implemented Yet"
+        end
+
+        #
+        # Delegate the workitem (transfer it to another store).
+        #
+        def delegate (workitem, targetStoreName)
+            raise "Not Implemented Yet"
+        end
+
+        #
+        # Delegate the workitem (ask the worklist to deliver it to 
+        # another participant).
+        #
+        def delegateToParticipant (workitem, targetParticipantName)
+            raise "Not Implemented Yet"
+        end
+
+        def queryStore (storeName, query)
+            raise "Not Implemented Yet"
+        end
+
+        alias list_stores listStores
+        alias get_store_names getStoreNames
+        alias get_headers getHeaders
+        alias find_flow_instance findFlowInstance
+        alias launch_flow launchFlow
+        alias get_workitem getWorkitem
+        alias get_and_lock_workitem getAndLockWorkitem
+        alias query_and_lock_workitem queryAndLockWorkitem
+        alias release_workitem releaseWorkitem
+        alias save_workitem saveWorkitem
+        alias proceed_workitem proceedWorkitem
+        alias forwardWorkitem proceedWorkitem
+        alias forward_workitem proceedWorkitem
+        alias list_launchables listLaunchables
+        alias delegate_to_participant delegateToParticipant
+
+    end
+
+end
+

data/test/README.txt

@@ -0,0 +1,27 @@
+= OpenWFEru - about the unit tests
+
+There are three tests triggerable by Rake :
+
+   rake test
+   rake qtest
+   rake ptest
+
+These 3 tests correspond to the following unit test files *
+
+   test/rake_test.rb
+   test/rake_qtest.rb
+   test/rake_ptest.rb
+
+== test/rake_test.rb
+
+Triggers 'quicktests' and time based tests. Running "rake test" takes 10 seconds more than "rake qtest". These are the 10 seconds necessary to test some time and scheduling aspects of OpenWFEru.
+
+== test/rake_qtest.rb
+
+Runs only 'quick' tests.
+
+== test/rake_ptest.rb
+
+Runs the quicktest but with persistence on. Persistence stores its work file under the work/ directory.
+This set of tests takes care of wiping fresh the work/ directory before beginning the tests.
+

data/test/atomtest.rb

@@ -0,0 +1,99 @@
+#
+# Testing OpenWFE
+#
+# John Mettraux at openwfe.org
+#
+# Sun Oct 29 15:41:44 JST 2006
+#
+# Kita Yokohama
+#
+
+require 'test/unit'
+
+require 'openwfe/workitem'
+require 'openwfe/engine/engine'
+require 'openwfe/expressions/raw_prog'
+require 'openwfe/participants/atomparticipants'
+
+include OpenWFE
+
+
+class AtomTest < Test::Unit::TestCase
+
+    def setup
+        @engine = Engine.new()
+    end
+
+    #def teardown
+    #end
+
+    #
+    # test atom 0
+    
+    class Atom0Definition < ProcessDefinition
+        def make
+            process_definition :name => "atom0", :revision => "0" do
+                sequence do
+
+                    set \
+                        :field => "atom_entry_title", 
+                        :value => "#{$run_index}"
+                    set \
+                        :field => "colour",
+                        :value => "blue"
+                    participant :ref => "feed0-alpha"
+
+                    set \
+                        :field => "atom_entry_title", 
+                        :value => "#{$run_index}"
+                    set \
+                        :field => "colour",
+                        :value => "red"
+                    participant :ref => "feed1-bravo"
+                end
+            end
+        end
+    end
+
+    def test_atom_0
+
+        feed0 = AtomParticipant.new(7,
+"""
+<p>
+    <h1>${f:colour}</h1>
+</p>
+""")
+
+
+        feed1 = AtomParticipant.new(7) do |fe, participant, workitem|
+
+            t = Time.new.to_s
+"""
+<p>
+    <h1>${f:colour}</h1>
+    <ul>
+        <li>flowexpression :     #{fe.fei.to_s}</li>
+        <li>participant class :  #{participant.class}</li>
+        <li>workitem att count : #{workitem.attributes.length}</li>
+        <li>now :                #{t}</li>
+        <li>entry title :        ${f:atom_entry_title}</li>
+    </ul>
+</p>
+"""
+        end
+
+        @engine.register_participant("feed0-.*", feed0)
+        @engine.register_participant("feed1-.*", feed1)
+
+        $run_index = "first run"
+        @engine.launch(LaunchItem.new(Atom0Definition))
+
+        $run_index = "second run"
+        @engine.launch(LaunchItem.new(Atom0Definition))
+
+        $run_index = "third and last run"
+        @engine.launch(LaunchItem.new(Atom0Definition))
+    end
+
+end
+

data/test/crontest.rb

@@ -0,0 +1,58 @@
+
+#
+# Testing OpenWFE
+#
+# John Mettraux at openwfe.org
+#
+# Sun Oct 29 16:18:25 JST 2006
+#
+
+require 'test/unit'
+require 'otime'
+require 'ru/util/scheduler'
+
+#
+# testing otime and the scheduler
+#
+
+class TimeTest < Test::Unit::TestCase
+
+    #def setup
+    #end
+
+    #def teardown
+    #end
+
+    def test_cron_0
+        $var = 0
+
+        scheduler = OpenWFE::Scheduler.new()
+        scheduler.start
+
+        sid = scheduler.schedule('* * * * *', CounterSchedulable.new, nil)
+
+        assert \
+            sid,
+            "scheduler did not return a job id"
+
+        sleep(120)
+        scheduler.stop
+
+        #puts ">#{$var}<"
+
+        assert \
+            ($var == 2),
+            "cron_0 failed, $var is #{$var}"
+    end
+
+    protected
+
+        class CounterSchedulable
+            include OpenWFE::Schedulable
+
+            def trigger (params)
+                $var = $var + 1
+            end
+        end
+
+end

data/test/dollartest.rb

@@ -1,6 +1,6 @@
 
 #
-# Testing OpenWFEru
+# Testing OpenWFE
 #
 # John Mettraux at openwfe.org
 #
@@ -8,7 +8,7 @@
 #
 
 require 'test/unit'
-require 'ru/dollar'
+require 'openwfe/util/dollar'
 
 #
 # testing the 'dollar notation'
@@ -67,7 +67,7 @@ class DollarTest < Test::Unit::TestCase
     end
 
     def dotest (text, dict, target)
-        result = OpenWFEru::dsub(text, dict)
+        result = OpenWFE::dsub(text, dict)
         #puts "..>#{text}<"
         #puts "...->"
         #puts "..>#{result}<"

data/test/feitest.rb

@@ -1,6 +1,6 @@
 
 #
-# Testing OpenWFEru
+# Testing OpenWFE
 #
 # John Mettraux at openwfe.org
 #
@@ -8,8 +8,9 @@
 #
 
 require 'test/unit'
-require 'workitem'
-require 'ru/rudefinitions'
+require 'openwfe/workitem'
+require 'openwfe/flowexpressionid'
+require 'openwfe/rudefinitions'
 
 
 class FeiTest < Test::Unit::TestCase
@@ -44,7 +45,7 @@ class FeiTest < Test::Unit::TestCase
         fei1 = new_fei()
 
         fei2 = new_fei()
-        fei2.expressionName = OpenWFEru::EN_ENVIRONMENT
+        fei2.expression_name = OpenWFE::EN_ENVIRONMENT
 
         assert \
             fei1.object_id != fei2.object_id, \
@@ -95,26 +96,53 @@ class FeiTest < Test::Unit::TestCase
             fei0 == fei1,
             "feis should be equal"
 
-        fei1.expressionName = OpenWFEru::EN_ENVIRONMENT
+        fei1.expression_name = OpenWFE::EN_ENVIRONMENT
 
         assert \
             fei0 != fei1, 
             "feis should not be equal"
     end
 
+    def test_parse_unparse
+        fei0 = new_fei()
+        s = fei0.to_s
+        fei1 = OpenWFE::FlowExpressionId.to_fei(s)
+
+        puts "\n#{s}\n#{fei1.to_s}" if fei0 != fei1
+
+        assert \
+            fei0 == fei1,
+            "fei .to_s() and .str_to_fei(s) are not working"
+    end
+
+    def test_parent_wfid
+
+        fei = new_fei
+
+        assert \
+            fei.parent_workflow_instance_id == "123456",
+            "failure 0"
+
+        fei.workflow_instance_id = "123456.0.0"
+
+        assert \
+            fei.parent_workflow_instance_id == "123456",
+            "failure 1"
+    end
+
     protected
 
         def new_fei ()
             fei = OpenWFE::FlowExpressionId.new()
-            fei.owfeVersion = OpenWFEru::OPENWFE_VERSION
-            fei.engineId = 'this'
-            fei.initialEngineId = 'that'
-            fei.workflowDefinitionUrl = 'http://test/test.xml'
-            fei.workflowDefinitionName = 'test'
-            fei.workflowDefinitionRevision = '1.0'
-            fei.workflowInstanceId = '123456'
-            fei.expressionName = 'do-test'
-            fei.expressionId = '0.0'
+            fei.owfe_version = OpenWFE::OPENWFE_VERSION
+            fei.engine_id = 'this'
+            fei.initial_engine_id = 'that'
+            fei.workflow_definition_url = 'http://test/test.xml'
+            fei.workflow_definition_name = 'test'
+            fei.workflow_definition_revision = '1.0'
+            fei.workflow_instance_id = '123456'
+            fei.expression_name = 'do-test'
+            fei.expression_id = '0.0'
             return fei
         end