From 19fb6a8a8a578f0a2842aa47a14c87caf5c13771 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20P=C3=A9ters?= Date: Thu, 25 May 2017 10:48:20 +0200 Subject: [PATCH] workflows: add possibility to mark and jump to marked status (#4228) This keeps a stack of marked status and allow to pop back to previous ones. --- tests/test_backoffice_pages.py | 98 ++++++++++++++++++++++++++++++++++++++++++ wcs/admin/workflows.py | 3 +- wcs/formdata.py | 13 ++++++ wcs/wf/jump.py | 2 +- wcs/workflows.py | 60 ++++++++++++++++++-------- 5 files changed, 156 insertions(+), 20 deletions(-) diff --git a/tests/test_backoffice_pages.py b/tests/test_backoffice_pages.py index 3b239adc..7692f8ec 100644 --- a/tests/test_backoffice_pages.py +++ b/tests/test_backoffice_pages.py @@ -7,6 +7,7 @@ import shutil import StringIO import time import hashlib +import random import pytest from webtest import Upload @@ -3105,6 +3106,103 @@ def test_inspect_page(pub): .parents('li').children('div.value span') .text() == '\'\\xed\\xa0\\x00\'') +def test_workflow_jump_previous(pub): + user = create_user(pub) + create_environment(pub) + + wf = Workflow(name='jump around') + # North + # / \ + # West <----> East + # | | + # | autojump + # | | + # \ / + # South + + st1 = wf.add_status('North') + st1.id = 'north' + st2 = wf.add_status('West') + st2.id = 'west' + st3 = wf.add_status('East') + st3.id = 'east' + st4 = wf.add_status('Autojump') + st4.id = 'autojump' + st5 = wf.add_status('South') + st5.id = 'south' + + button_by_id = {} + + def add_jump(label, src, dst_id): + jump = ChoiceWorkflowStatusItem() + jump.id = str(random.random()) + jump.label = label + jump.by = ['logged-users'] + jump.status = dst_id + src.items.append(jump) + jump.parent = src + if dst_id != '_previous': + jump.set_marker_on_status = True + button_by_id[label] = 'button%s' % jump.id + return jump + + add_jump('Go West', st1, st2.id) + add_jump('Go East', st1, st3.id) + add_jump('Go South', st2, st5.id) + add_jump('Go Autojump', st3, st4.id) + add_jump('Go Back', st5, '_previous') + + add_jump('Jump West', st3, st2.id) + add_jump('Jump East', st2, st3.id) + + jump = JumpWorkflowStatusItem() + jump.id = '_auto-jump' + jump.status = st5.id + st4.items.append(jump) + jump.parent = st4 + + wf.store() + + formdef = FormDef.get_by_urlname('form-title') + formdef.data_class().wipe() + formdef.workflow = wf + formdef.store() + + formdata = formdef.data_class()() + formdata.data = {} + formdata.just_created() + formdata.store() + + app = login(get_app(pub)) + resp = app.get('/backoffice/management/form-title/%s/' % formdata.id) + + # jump around using buttons + resp = resp.form.submit(button_by_id['Go West']).follow() # push (north) + assert formdef.data_class().get(formdata.id).status == 'wf-%s' % st2.id + resp = resp.form.submit(button_by_id['Go South']).follow() # push (north, west) + assert formdef.data_class().get(formdata.id).status == 'wf-%s' % st5.id + resp = resp.form.submit(button_by_id['Go Back']).follow() # pop (north) + assert formdef.data_class().get(formdata.id).status == 'wf-%s' % st2.id + resp = resp.form.submit(button_by_id['Go South']).follow() # push (north, west) + assert formdef.data_class().get(formdata.id).status == 'wf-%s' % st5.id + resp = resp.form.submit(button_by_id['Go Back']).follow() # pop (north) + assert formdef.data_class().get(formdata.id).status == 'wf-%s' % st2.id + resp = resp.form.submit(button_by_id['Jump East']).follow() # push (north, west) + assert formdef.data_class().get(formdata.id).status == 'wf-%s' % st3.id + resp = resp.form.submit(button_by_id['Go Autojump']).follow() # push (north, west, east) + assert formdef.data_class().get(formdata.id).status == 'wf-%s' % st5.id + resp = resp.form.submit(button_by_id['Go Back']).follow() # pop (north, west) + assert formdef.data_class().get(formdata.id).status == 'wf-%s' % st3.id + + # and do a last jump using the API + formdata = formdef.data_class().get(formdata.id) + formdata.jump_status('_previous') # pop (north) + assert formdata.status == 'wf-%s' % st2.id + + formdata = formdef.data_class().get(formdata.id) + formdata.jump_status('_previous') # pop () + assert formdata.status == 'wf-%s' % st1.id + def test_backoffice_fields(pub): user = create_user(pub) create_environment(pub) diff --git a/wcs/admin/workflows.py b/wcs/admin/workflows.py index 71961e1c..daa76895 100644 --- a/wcs/admin/workflows.py +++ b/wcs/admin/workflows.py @@ -153,7 +153,8 @@ def graphviz(workflow, url_prefix='', select=None, svg=True, for status in workflow.possible_status: i = status.id for item in status.items: - next_status_ids = [x.id for x in item.get_target_status() if x.id != status.id] + next_status_ids = [x.id for x in item.get_target_status() + if x.id and x.id != status.id] if not next_status_ids: next_status_ids = [status.id] done = {} diff --git a/wcs/formdata.py b/wcs/formdata.py index c7bd1b2d..7b6266be 100644 --- a/wcs/formdata.py +++ b/wcs/formdata.py @@ -452,7 +452,20 @@ class FormData(StorableObject): return None return wf_status.handle_form(form, self, user) + def get_previous_marked_status(self): + if not self.workflow_data or not 'markers_stack' in self.workflow_data: + return None + try: + status_id = self.workflow_data['markers_stack'].pop() + except IndexError: + return None + return self.formdef.workflow.get_status(status_id[3:]) + def jump_status(self, status_id): + if status_id == '_previous': + previous_status = self.get_previous_marked_status() + assert previous_status, 'failed to compute previous status' + status_id = previous_status.id evo = Evolution() evo.time = time.localtime() evo.status = 'wf-%s' % status_id diff --git a/wcs/wf/jump.py b/wcs/wf/jump.py index af4dcf49..59d2f57b 100644 --- a/wcs/wf/jump.py +++ b/wcs/wf/jump.py @@ -190,7 +190,7 @@ class JumpWorkflowStatusItem(WorkflowStatusJumpItem): return if self.must_jump(formdata): - wf_status = self.get_target_status() + wf_status = self.get_target_status(formdata) if wf_status: formdata.status = 'wf-%s' % wf_status[0].id diff --git a/wcs/workflows.py b/wcs/workflows.py index fb6581b1..d1d3758a 100644 --- a/wcs/workflows.py +++ b/wcs/workflows.py @@ -421,19 +421,7 @@ class Workflow(StorableObject): # a waitpoint status is a status waiting for an event (be it user # interaction or something else), but can also be an endpoint (where # the user would wait, infinitely). - waitpoint_status = [] - for status in self.possible_status: - waitpoint = False - endpoint = True - if status.forced_endpoint: - endpoint = True - else: - for item in status.items: - endpoint = item.endpoint and endpoint - waitpoint = item.waitpoint or waitpoint - if endpoint or waitpoint: - waitpoint_status.append(status) - return waitpoint_status + return [x for x in self.possible_status if x.is_waitpoint()] def get_endpoint_status(self): not_endpoint_status = self.get_not_endpoint_status() @@ -1411,6 +1399,17 @@ class WorkflowStatus(object): return True return False + def is_waitpoint(self): + waitpoint = False + endpoint = True + if self.forced_endpoint: + endpoint = True + else: + for item in self.items: + endpoint = item.endpoint and endpoint + waitpoint = item.waitpoint or waitpoint + return bool(endpoint or waitpoint) + def __getstate__(self): odict = self.__dict__.copy() if odict.has_key('parent'): @@ -1634,11 +1633,21 @@ class WorkflowStatusItem(XmlSerialisable): def get_substitution_variables(self, formdata): return {} - def get_target_status(self): + def get_target_status(self, formdata=None): """Returns a list of status this item can lead to.""" if not getattr(self, 'status', None): return [] + if self.status == '_previous': + if formdata is None: + # must be in a formdata to compute destination, just give a + # fake status for presentation purpose + return [WorkflowStatus(_('Previous Marked Status'))] + previous_status = formdata.get_previous_marked_status() + if previous_status: + return [previous_status] + return [] + try: return [x for x in self.parent.parent.possible_status if x.id == self.status] except IndexError: @@ -1689,7 +1698,9 @@ class WorkflowStatusJumpItem(WorkflowStatusItem): def add_parameters_widgets(self, form, parameters, prefix='', formdef=None): if 'status' in parameters: form.add(SingleSelectWidget, '%sstatus' % prefix, title = _('Status'), value = self.status, - options = [(None, '---')] + [(x.id, x.name) for x in self.parent.parent.possible_status]) + options = [(None, '---')] + + [(x.id, x.name) for x in self.parent.parent.possible_status] + + [('_previous', _('Previous Marked Status'))]) def get_parameters(self): return ('status',) @@ -1867,6 +1878,7 @@ class ChoiceWorkflowStatusItem(WorkflowStatusJumpItem): by = [] backoffice_info_text = None require_confirmation = False + set_marker_on_status = False def render_as_line(self): if self.label: @@ -1892,9 +1904,16 @@ class ChoiceWorkflowStatusItem(WorkflowStatusJumpItem): def submit_form(self, form, formdata, user, evo): if form.get_submit() == 'button%s' % self.id: - wf_status = self.get_target_status() + wf_status = self.get_target_status(formdata) if wf_status: evo.status = 'wf-%s' % wf_status[0].id + if self.set_marker_on_status: + if formdata.workflow_data and 'markers_stack' in formdata.workflow_data: + markers_stack = formdata.workflow_data.get('markers_stack') + else: + markers_stack = [] + markers_stack.append(formdata.status) + formdata.update_workflow_data({'markers_stack': markers_stack}) form.clear_errors() return True # get out of processing loop @@ -1913,13 +1932,18 @@ class ChoiceWorkflowStatusItem(WorkflowStatusJumpItem): form.add(CheckboxWidget, '%srequire_confirmation' % prefix, title=_('Require confirmation'), value=self.require_confirmation) + if 'set_marker_on_status' in parameters: + form.add(CheckboxWidget, '%smark_status' % prefix, + title=_('Set marker on status'), + value=self.set_marker_on_status) if 'backoffice_info_text' in parameters: form.add(WysiwygTextWidget, '%sbackoffice_info_text' % prefix, title=_('Information Text for Backoffice'), value=self.backoffice_info_text) def get_parameters(self): - return ('by', 'status', 'label', 'backoffice_info_text', 'require_confirmation') + return ('by', 'status', 'label', 'backoffice_info_text', + 'require_confirmation', 'set_marker_on_status') register_item_class(ChoiceWorkflowStatusItem) @@ -1940,7 +1964,7 @@ class JumpOnSubmitWorkflowStatusItem(WorkflowStatusJumpItem): def submit_form(self, form, formdata, user, evo): if form.is_submitted() and not form.has_errors(): - wf_status = self.get_target_status() + wf_status = self.get_target_status(formdata) if wf_status: evo.status = 'wf-%s' % wf_status[0].id -- 2.11.0