spiff-arena/tests/SpiffWorkflow/bpmn/DataObjectReferenceTest.py

from tests.SpiffWorkflow.bpmn.BpmnWorkflowTestCase import BpmnWorkflowTestCase
from SpiffWorkflow.bpmn.workflow import BpmnWorkflow
from SpiffWorkflow.bpmn.exceptions import WorkflowDataException


class DataObjectReferenceTest(BpmnWorkflowTestCase):

    def setUp(self):
        self.spec, self.subprocesses = self.load_workflow_spec('data_object.bpmn', 'Process')

    def testDataObjectReferences(self):
        self.actual_test(False)

    def testDataObjectSerialization(self):
        self.actual_test(True)

    def testMissingDataInput(self):

        self.workflow = BpmnWorkflow(self.spec, self.subprocesses)
        self.workflow.do_engine_steps()

        # Add the data so that we can advance the workflow
        ready_tasks = self.workflow.get_ready_user_tasks()
        ready_tasks[0].data = { 'obj_1': 'hello' }
        ready_tasks[0].run()

        # Remove the data before advancing
        ready_tasks = self.workflow.get_ready_user_tasks()
        self.workflow.data.pop('obj_1')
        with self.assertRaises(WorkflowDataException) as exc:
            ready_tasks[0].run()
            self.assertEqual(exc.data_output.name, 'obj_1')

    def testMissingDataOutput(self):

        self.workflow = BpmnWorkflow(self.spec, self.subprocesses)
        self.workflow.do_engine_steps()
        ready_tasks = self.workflow.get_ready_user_tasks()
        with self.assertRaises(WorkflowDataException) as exc:
            ready_tasks[0].run()
            self.assertEqual(exc.data_output.name, 'obj_1')

    def actual_test(self, save_restore):

        self.workflow = BpmnWorkflow(self.spec, self.subprocesses)
        self.workflow.do_engine_steps()

        # Set up the data
        ready_tasks = self.workflow.get_ready_user_tasks()
        ready_tasks[0].data = { 'obj_1': 'hello' }
        ready_tasks[0].run()
        # After task completion, obj_1 should be copied out of the task into the workflow
        self.assertNotIn('obj_1', ready_tasks[0].data)
        self.assertIn('obj_1', self.workflow.data)

        if save_restore:
            self.save_restore()

        # Set a value for obj_1 in the task data again
        ready_tasks = self.workflow.get_ready_user_tasks()
        ready_tasks[0].data = { 'obj_1': 'hello again' }
        ready_tasks[0].run()

        # Check to make sure we use the workflow value instead of the value we set
        ready_tasks = self.workflow.get_ready_user_tasks()
        self.assertEqual(ready_tasks[0].data['obj_1'], 'hello')
        # Modify the value in the task
        ready_tasks[0].data = { 'obj_1': 'hello again' }
        ready_tasks[0].run()
        # We did not set an output data reference so obj_1 should remain unchanged in the workflow data
        # and be removed from the task data
        self.assertNotIn('obj_1', ready_tasks[0].data)
        self.assertEqual(self.workflow.data['obj_1'], 'hello')

        # Make sure data objects are accessible inside a subprocess
        self.workflow.do_engine_steps()
        ready_tasks = self.workflow.get_ready_user_tasks()
        self.assertEqual(ready_tasks[0].data['obj_1'], 'hello')
        ready_tasks[0].data['obj_1'] = 'hello again'
        ready_tasks[0].run()
        self.workflow.do_engine_steps()
        sp = self.workflow.get_tasks_from_spec_name('subprocess')[0]
        # It was copied out
        self.assertNotIn('obj_1', sp.data)
        # The update should persist in the main process
        self.assertEqual(self.workflow.data['obj_1'], 'hello again')