Changes between Version 11 and Version 12 of TestManagerForTracPluginWorkflow

Timestamp:

Jan 4, 2011, 12:16:19 PM (13 years ago)

Author:

Roberto Longobardi

Comment:

--

TestManagerForTracPluginWorkflow

@@ -3 +3 @@
 The Test Manager plugin is comprised of four plugins, one of which is a Generic Workflow Engine plugin for any Trac resource.
 
-The following figure shows a sample workflow added to Test Cases with custom sample operations. No built-in operation is currently implemented but the sample one shown here, named 'sample_operation', which logs a debug message with the text input by the User.
+The following figure shows a sample workflow added to Test Cases with custom sample operations. A small [wiki:TestManagerPluginWorkflowOperations set of built-in operations] is currently implemented, plus the sample one shown here, named 'sample_operation', which logs a debug message with the text input by the User.
 
 Every object which has a workflow defined is created in a "new" state, so every transition should consider this as the first state in the state machine.
@@ -238 +238 @@
 all this is automatically performed by the plugin.
 
-So, let's take a look at how the [wiki:TestManagerForTracPlugin TestManager] plugin incorporates this web interface support.
+So, let's take a look at (a simplified version of) how the [wiki:TestManagerForTracPlugin TestManager] plugin incorporates this web interface support.
 
 {{{
@@ -252 +252 @@
     def filter_stream(self, req, method, filename, stream, data):
         page_name = req.args.get('page', 'WikiStart')
-        planid = req.args.get('planid', '-1')
-
-        if page_name == 'TC':
-            # The root catalog does not have workflows
-            return stream
-
-        if page_name.startswith('TC') and filename == 'wiki_view.html':
-            req.perm.require('TEST_VIEW')
+        req.perm.require('TEST_VIEW')
             
-            # Determine which object is being displayed (i.e. realm), 
-            # based on Wiki page name and the presence of the planid 
-            # request parameter.
-            realm = None
-            if page_name.find('_TC') >= 0:
-                if not planid or planid == '-1':
-                    realm = 'testcase'
-                    key = {'id': page_name.rpartition('_TC')[2]}
-                else:
-                    realm = 'testcaseinplan'
-                    key = {'id': page_name.rpartition('_TC')[2], 'planid': planid}
-            else:
-                if not planid or planid == '-1':
-                    realm = 'testcatalog'
-                    key = {'id': page_name.rpartition('_TT')[2]}
-                else:
-                    realm = 'testplan'
-                    key = {'id': planid}
-
-            id = get_string_from_dictionary(key)
-            res = Resource(realm, id)
-
-            workflow_markup = ResourceWorkflowSystem(self.env).get_workflow_markup(req, '..', realm, res)
+        realm = 'testcase'
+        key = {'id': page_name.rpartition('_TC')[2]}
+
+        id = get_string_from_dictionary(key)
+        res = Resource(realm, id)
+
+        # This is where we ask the workflow engine to generate the HTML markup
+        # to be displayed in the web page to let the User change a resource workflow state
+        workflow_markup = ResourceWorkflowSystem(self.env).get_workflow_markup(req, '..', realm, res)
             
-            return stream | Transformer('//div[contains(@class,"wikipage")]').after(workflow_markup) 
-
-        return stream
+        return stream | Transformer('//div[contains(@class,"wikipage")]').after(workflow_markup) 
 }}}
 
@@ -310 +287 @@
   res = Resource(realm, id)
 }}}
+
+== Programmatic Interface ==
+
+The workflow engine comes with a programmatic interface, letting other plugins interact with the workflow lifecycle.
+
+There are two interfaces that let you interact with the workflow transitions:
+
+ 1. You can give or deny permission to actually perform the transition => IWorkflowTransitionAuthorization
+ 2. Being notified of state transitions => IWorkflowTransitionListener
+
+
+=== IWorkflowTransitionAuthorization ===
+
+{{{
+class IWorkflowTransitionAuthorization(Interface):
+    """
+    Extension point interface for components that wish to augment the
+    state machine at runtime, by allowing or denying each transition
+    based on the object and the current and new states.
+    """
+
+    def is_authorized(res_wf_state, resource, action, old_state, new_state):
+        """
+        Called before allowing the transition.
+        Return True to allow for the transition, False to deny it.
+        
+        :param res_wf_state: the ResourceWorkflowState being 
+                             transitioned from old_state to new_state
+        :param resource: the Resource object being transitioned.
+        :param action: the action being performed.
+        """
+}}}
+
+=== IWorkflowTransitionListener ===
+
+{{{
+class IWorkflowTransitionListener(Interface):
+    """
+    Extension point interface for components that require notification
+    when objects transition between states.
+    """
+
+    def object_transition(res_wf_state, resource, action, old_state, new_state):
+        """
+        Called when an object has transitioned to a new state.
+
+        :param res_wf_state: the ResourceWorkflowState  
+                             transitioned from old_state to new_state
+        :param resource: the Resource object transitioned.
+        :param action: the action been performed.
+        """
+}}}
+