erp5_workflow_test_data: move livetest script into this template; move...

erp5_workflow_test_data: move livetest script into this template; move PortalTypeRoleTemplateItem list to erp5_workflow.

bt5/erp5_workflow_test_data/PortalTypeRolesTemplateItem/ERP5Workflow%20Test%20Document.xml

-<type_roles>
-  <role id='Assignor; Assignee; Auditor'>
-   <property id='description'>Everyone in the main group can work on documents</property>
-   <multi_property id='category'>group/test_group</multi_property>
-  </role>
-  <role id='Assignor'>
-   <property id='title'>Developer Group</property>
-   <multi_property id='category'>group/develop_group</multi_property>
-  </role>
-</type_roles>
\ No newline at end of file

bt5/erp5_workflow_test_data/PortalTypeRolesTemplateItem/ERP5Workflow%20Test%20Module.xml

-<type_roles>
-  <role id='Assignor; Assignee; Auditor'>
-   <property id='description'>Everyone in the main group can see and create documents</property>
-   <multi_property id='category'>group/test_group</multi_property>
-  </role>
-  <role id='Assignor'>
-   <property id='title'>Developer Group</property>
-   <multi_property id='category'>group/develop_group</multi_property>
-  </role>
-</type_roles>
\ No newline at end of file

bt5/erp5_workflow_test_data/PortalTypeRolesTemplateItem/State.xml

-<type_roles>
-  <role id='Auditor; Author'>
-   <multi_property id='category'>group/test_group</multi_property>
-  </role>
-  <role id='Assignor'>
-   <property id='title'>Developer Group</property>
-   <multi_property id='category'>group/develop_group</multi_property>
-  </role>
-</type_roles>
\ No newline at end of file

bt5/erp5_workflow_test_data/PortalTypeRolesTemplateItem/Transition.xml

-<type_roles>
-  <role id='Auditor; Author'>
-   <multi_property id='category'>group/test_group</multi_property>
-  </role>
-  <role id='Assignor'>
-   <property id='title'>Developer Group</property>
-   <multi_property id='category'>group/develop_group</multi_property>
-  </role>
-</type_roles>
\ No newline at end of file

bt5/erp5_workflow_test_data/PortalTypeRolesTemplateItem/Workflow%20Module.xml

-<type_roles>
-  <role id='Auditor; Author'>
-   <multi_property id='category'>group/test_group</multi_property>
-  </role>
-  <role id='Assignor'>
-   <property id='title'>Developer Group</property>
-   <multi_property id='category'>group/develop_group</multi_property>
-  </role>
-</type_roles>
\ No newline at end of file

bt5/erp5_workflow_test_data/PortalTypeRolesTemplateItem/Workflow.xml

-<type_roles>
-  <role id='Assignor; Assignee; Auditor'>
-   <property id='description'>group/test_group</property>
-  </role>
-  <role id='Assignor'>
-   <property id='title'>Developer Group</property>
-   <multi_property id='category'>group/develop_group</multi_property>
-  </role>
-</type_roles>
\ No newline at end of file

bt5/erp5_workflow_test_data/TestTemplateItem/portal_components/test.erp5.testWorkflowAndDCWorkflow.py

+import unittest
+from Products.ERP5Type.tests.ERP5TypeTestCase import ERP5TypeTestCase
+from Products.DCWorkflow.DCWorkflow import ValidationFailed
+
+class TestERP5WorkflowMixin(ERP5TypeTestCase):
+
+  def getTestObject(self):
+    self.portal = self.getPortal()
+    test_object = self.portal.erp5workflow_test_module.newContent(portal_type='ERP5Workflow Test Document')
+    return test_object
+
+  def getStateFor(self, document):
+    """
+    Needs to be overidden
+    """
+    pass
+
+  def doActionFor(self, document, action):
+    """
+    Need to be overidden
+    """
+    pass
+
+  def getWorklistDocumentCountFromActionName(self, action_name):
+    self.assertEqual(action_name[-1], ')')
+    left_parenthesis_offset = action_name.rfind('(')
+    self.assertNotEquals(left_parenthesis_offset, -1)
+    return int(action_name[left_parenthesis_offset + 1:-1])
+
+  def checkWorklist(self, result, name, count, url_parameter_dict=None):
+    entry_list = [x for x in result if x['name'].startswith(name)]
+    #raise NotImplementedError (result)
+    self.assertEqual(len(entry_list), count and 1)
+    if count:
+      self.assertEqual(count,
+        self.getWorklistDocumentCountFromActionName(entry_list[0]['name']))
+    if not entry_list:
+      return
+    url = entry_list[0].get('url')
+    if url_parameter_dict:
+      self.assertTrue(url, 'Can not check url parameters without url')
+      url = '%s%s' % (self.portal.getId(), url[len(self.portal.absolute_url()):])
+      # Touch URL to save worklist parameters in listbox selection
+      self.publish(url, 'manager:') # XXX which user ?
+      selection_parameter_dict = self.portal.portal_selections.getSelectionParamsFor(
+                                                    self.module_selection_name)
+      for parameter, value in url_parameter_dict.iteritems():
+        self.assertTrue(parameter in selection_parameter_dict)
+        self.assertEqual(value, selection_parameter_dict[parameter])
+
+  def clearCache(self):
+    self.portal.portal_caches.clearAllCache()
+
+  def resetComponentTool(self):
+    # Force reset of portal_components to regenerate accessors
+    # Since it is already handled by interactions, we only need to commit
+    # to allow component tool to do it's reset
+    self.commit()
+
+  def test_01_testAfterScript(self):
+    new_object = self.getTestObject()
+    self.doActionFor(new_object, "validate")
+    # self.assertEqual(new_object.getDescription(), "After script was executed.")
+    ### zwj: mechanism: validate => validate interaction =>
+    ### setTitle => setTitle interaction => setDescription
+    self.assertEqual(new_object.getDescription(), "Interaction of setTitle executed.")
+
+  def test_02_testBeforeScript(self):
+    new_object = self.getTestObject()
+    self.doActionFor(new_object, "validate")
+    self.doActionFor(new_object, "invalidate")
+    self.assertEqual(new_object.getDescription(), "Before script was executed.")
+
+  def test_03_testChangeOfState(self):
+    new_object = self.getTestObject()
+    self.doActionFor(new_object, "validate")
+    self.assertEqual(self.getStateFor(new_object), 'validated')
+    self.doActionFor(new_object, "invalidate")
+    self.assertEqual(self.getStateFor(new_object), 'invalidated')
+
+  def test_04_testDoWorkflowMethodTransition(self):
+    """
+    Check if workflow methods allows to change of state
+    """
+    new_object = self.getTestObject()
+    self.assertEqual(self.getStateFor(new_object), 'draft')
+    new_object.validate()
+    self.assertEqual(self.getStateFor(new_object), 'validated')
+
+  def test_05_testCheckHistoryStateAndActionForASingleTransition(self):
+    """
+    Basic checking of workflow history, only check that state and actions
+    are available
+    """
+    new_object = self.getTestObject()
+    self.doActionFor(new_object, "validate")
+    history_list = new_object.workflow_history["testing_workflow"]
+    # 3 history lines are expected : draft->validation_action->validate
+    self.assertEqual(3, len(history_list))
+    last_history = history_list[-1]
+    self.assertEqual(last_history.get("action", None), "validate")
+    self.assertEqual(last_history.get("validation_state", None), "validated")
+
+  def test_06_testCheckPermissionAreWellSet(self):
+    new_object = self.getTestObject()
+    self.assertEqual(new_object._View_Permission, ('Assignee', 'Assignor',
+      'Associate', 'Auditor', 'Author', 'Manager', 'Owner'))
+    self.doActionFor(new_object, "validate")
+    self.assertEqual(new_object._View_Permission, ('Assignee', 'Assignor',
+      'Associate', 'Auditor', 'Manager'))
+
+  def test_07_testUserTransitionRaiseValidationFailed(self):
+    """
+    perform a fail_action which does nothing but add an error message in the workflow history
+    """
+    new_object = self.getTestObject()
+    exception_raised = False
+    try:
+      self.doActionFor(new_object, "fail")
+    except ValidationFailed:
+      exception_raised = True
+    self.assertEqual(True, exception_raised)
+    history_list = new_object.workflow_history["testing_workflow"]
+    self.assertEqual(2, len(history_list))
+    last_history = history_list[-1]
+    self.assertEqual(last_history.get("error_message", None), "foo error")
+
+  def test_08_testUserActionDisplay(self):
+    new_object = self.getTestObject()
+    action_list = self.getWorkflowTool().listActions(object=new_object)
+    self.assertEqual(1, len(action_list))
+    action = action_list[0]
+    def checkExpectedDict(expected_dict, action):
+      for key in expected_dict.keys():
+        self.assertEqual(expected_dict[key], action.get(key))
+    checkExpectedDict({"category": "workflow", "name": "Validate"},
+                      action)
+    self.doActionFor(new_object, "validate")
+    action_list = self.getWorkflowTool().listActions(object=new_object)
+    self.assertEqual(1, len(action_list))
+    action = action_list[0]
+    checkExpectedDict({"category": "workflow", "name": "Invalidate"},
+                      action)
+
+  def test_09_testBaseGetWorkflowHistoryItemListScript(self):
+    """
+    Base_getWorkflowHistoryItemList is used for user interface, make sure it is still
+    working fine
+    """
+    new_object = self.getTestObject()
+    self.doActionFor(new_object, "validate")
+    item_list = new_object.Base_getWorkflowHistoryItemList("testing_workflow", display=0)
+    self.assertEqual(3, len(item_list))
+    def checkLine(expected_data, index):
+      line = item_list[index]
+      for key in expected_data.keys():
+        self.assertEqual(expected_data[key], line.getProperty(key))
+    checkLine({'state': 'draft'}, 0)
+    checkLine({'state': 'draft'}, 1)
+    checkLine({'state': 'validated'}, 2)
+  """
+  def test_10_testSimpleWorklist(self):
+    
+    #check the counter from worklist action_name.
+    # need another way to check, because worklist update every 5 mins
+
+    self.login("workflow_development")
+    self.portal = self.getPortal()
+    new_object = self.getTestObject()
+    workflow_tool = self.portal.portal_workflow
+    self.clearCache()
+    new_object.reindexObject()
+    self.clearCache()
+    result = workflow_tool.listActions(object=new_object)
+    self.checkWorklist(result, 'Document', 1)
+  """
+  def test_11_testValidationInteraction(self):
+    """
+    check the validate interaction which changes the title of the object.
+    """
+    new_object = self.getTestObject()
+    new_object.setTitle('nana')
+    self.doActionFor(new_object, "validate")
+    self.assertEqual(new_object.getTitle(), "toto")
+    self.assertEqual(self.getStateFor(new_object), 'validated')
+    new_object.setTitle("tictic")
+    self.assertEqual(new_object.getDescription(), "Interaction of setTitle executed.")
+
+  def test_12_testIsTransitionPossible(self):
+    new_object = self.getTestObject()
+    self.portal = self.getPortal()
+    workflow_tool = self.portal.portal_workflow
+    self.assertEqual(workflow_tool.isTransitionPossible(new_object, 'invalidate'), 0)
+    self.doActionFor(new_object, "validate")
+    self.assertEqual(self.getStateFor(new_object), 'validated')
+    self.assertEqual(workflow_tool.isTransitionPossible(new_object, 'invalidate'), 1)
+
+  def test_13_testDCWorkflowMigrationScript(self):
+    new_object = self.getTestObject()
+    portal_type = new_object.getTypeInfo()
+    self.portal = self.getPortal()
+    workflow_tool = self.portal.portal_workflow
+    workflow_tool.getWorkflowValueListFor(portal_type)
+  """
+  def beforeTearDown(self):
+    self.portal = self.getPortal()
+    self.getWorkflowTool().setChainForPortalTypes(['ERP5Workflow Test Document'], ())
+    type_test_object = self.portal.portal_types._getOb('ERP5Workflow Test Document')
+    type_test_object.edit(type_base_category_list=('validation_state',))
+    type_test_object.edit(type_erp5workflow_list=('testing_workflow',))
+    #self.commit()
+  """
+
+class TestERP5Workflow(TestERP5WorkflowMixin):
+  """
+    Tests ERP5 Workflow.
+  """
+  def afterSetUp(self):
+    self.portal = self.getPortal()
+    self.getWorkflowTool().setChainForPortalTypes(['ERP5Workflow Test Document'], ())
+    self.workflow_module = self.portal.portal_workflow
+    self.wf = self.workflow_module._getOb('testing_workflow_workflow') # workflow id comes with suffix
+    type_test_object = self.portal.portal_types._getOb('ERP5Workflow Test Document')
+    type_test_object.edit(type_erp5workflow_list=('testing_workflow_workflow', 'testing_interaction_workflow_interactionworkflow', ))
+    self.resetComponentTool()
+    self.assertFalse('testing_workflow' in self.getWorkflowTool().getChainFor(type_test_object.getId()))
+    self.login()
+
+  def getStateFor(self, document):
+    return getattr(document, 'getValidationState')()
+
+  def doActionFor(self, document, action):
+    user_action = '_'.join(action.split('_')[0:-1]) + '_action' # remove suffix
+    self.portal.portal_workflow.doActionFor(document, user_action, wf_id = 'testing_workflow_workflow')
+
+class TestDCWorkflow(TestERP5WorkflowMixin):
+  """
+    Check DC Workflow
+  """
+  def afterSetUp(self):
+    # make sure erp5 workflow list is empty
+    self.portal = self.getPortal()
+    self.workflow_module = self.portal.portal_workflow
+    self.getWorkflowTool().setChainForPortalTypes(['ERP5Workflow Test Document'], ('testing_workflow', 'testing_interaction_workflow', 'edit_workflow', ))
+    self.wf = self.workflow_module._getOb('testing_workflow')
+    type_test_object = self.portal.portal_types['ERP5Workflow Test Document']
+    type_test_object.edit(type_erp5workflow_list=())
+    type_test_object.edit(type_interaction_workflow_list=())
+    self.resetComponentTool()
+    self.assertEqual(type_test_object.getTypeErp5workflowList(), [])
+    self.login()
+
+  def getStateFor(self, document):
+    return self.wf._getWorkflowStateOf(document, id_only=True)
+
+  def doActionFor(self, document, action):
+    user_action = action + '_action'
+    self.portal.portal_workflow.doActionFor(document, user_action, wf_id = 'testing_workflow')
+
+def test_suite():
+  suite = unittest.TestSuite()
+  suite.addTest(unittest.makeSuite(TestERP5Workflow))
+  suite.addTest(unittest.makeSuite(TestDCWorkflow))
+  return suite
\ No newline at end of file

bt5/erp5_workflow_test_data/TestTemplateItem/portal_components/test.erp5.testWorkflowAndDCWorkflow.xml

+<?xml version="1.0"?>
+<ZopeData>
+  <record id="1" aka="AAAAAAAAAAE=">
+    <pickle>
+      <global name="Test Component" module="erp5.portal_type"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>_recorded_property_dict</string> </key>
+            <value>
+              <persistent> <string encoding="base64">AAAAAAAAAAI=</string> </persistent>
+            </value>
+        </item>
+        <item>
+            <key> <string>default_reference</string> </key>
+            <value> <string>testWorkflowAndDCWorkflow</string> </value>
+        </item>
+        <item>
+            <key> <string>description</string> </key>
+            <value>
+              <none/>
+            </value>
+        </item>
+        <item>
+            <key> <string>id</string> </key>
+            <value> <string>test.erp5.testWorkflowAndDCWorkflow</string> </value>
+        </item>
+        <item>
+            <key> <string>portal_type</string> </key>
+            <value> <string>Test Component</string> </value>
+        </item>
+        <item>
+            <key> <string>sid</string> </key>
+            <value>
+              <none/>
+            </value>
+        </item>
+        <item>
+            <key> <string>text_content_error_message</string> </key>
+            <value>
+              <tuple/>
+            </value>
+        </item>
+        <item>
+            <key> <string>text_content_warning_message</string> </key>
+            <value>
+              <tuple/>
+            </value>
+        </item>
+        <item>
+            <key> <string>version</string> </key>
+            <value> <string>erp5</string> </value>
+        </item>
+        <item>
+            <key> <string>workflow_history</string> </key>
+            <value>
+              <persistent> <string encoding="base64">AAAAAAAAAAM=</string> </persistent>
+            </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+  <record id="2" aka="AAAAAAAAAAI=">
+    <pickle>
+      <global name="PersistentMapping" module="Persistence.mapping"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>data</string> </key>
+            <value>
+              <dictionary/>
+            </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+  <record id="3" aka="AAAAAAAAAAM=">
+    <pickle>
+      <global name="PersistentMapping" module="Persistence.mapping"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>data</string> </key>
+            <value>
+              <dictionary>
+                <item>
+                    <key> <string>component_validation_workflow</string> </key>
+                    <value>
+                      <persistent> <string encoding="base64">AAAAAAAAAAQ=</string> </persistent>
+                    </value>
+                </item>
+              </dictionary>
+            </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+  <record id="4" aka="AAAAAAAAAAQ=">
+    <pickle>
+      <global name="WorkflowHistoryList" module="Products.ERP5Type.patches.WorkflowTool"/>
+    </pickle>
+    <pickle>
+      <tuple>
+        <none/>
+        <list>
+          <dictionary>
+            <item>
+                <key> <string>action</string> </key>
+                <value> <string>validate</string> </value>
+            </item>
+            <item>
+                <key> <string>validation_state</string> </key>
+                <value> <string>validated</string> </value>
+            </item>
+          </dictionary>
+        </list>
+      </tuple>
+    </pickle>
+  </record>
+</ZopeData>

bt5/erp5_workflow_test_data/bt/dependency_list

-erp5_base
\ No newline at end of file

bt5/erp5_workflow_test_data/bt/template_portal_type_role_list

-ERP5Workflow Test Document
-ERP5Workflow Test Module
-State
-Transition
-Workflow
-Workflow Module
\ No newline at end of file

bt5/erp5_workflow_test_data/bt/template_test_id_list

+test.erp5.testWorkflowAndDCWorkflow
\ No newline at end of file