Projet

Général

Profil

0001-workflows-add-possibility-to-mark-and-jump-to-marked.patch

Frédéric Péters, 01 juin 2017 13:47

Télécharger (16,6 ko)

Voir les différences:

Subject: [PATCH] workflows: add possibility to mark and jump to marked status
 (#16524)

This keeps a stack of marked status and allow to pop back to previous
ones.
 tests/test_admin_pages.py           |  32 +++++++++++
 tests/test_backoffice_pages.py      | 110 ++++++++++++++++++++++++++++++++++++
 wcs/admin/workflows.py              |   3 +-
 wcs/backoffice/management.py        |  11 +++-
 wcs/formdata.py                     |  27 +++++++--
 wcs/qommon/static/css/dc2/admin.css |   4 ++
 wcs/wf/jump.py                      |   4 +-
 wcs/workflows.py                    |  52 ++++++++++++++---
 8 files changed, 228 insertions(+), 15 deletions(-)
tests/test_admin_pages.py
1909 1909
    resp = resp.click('Edit')
1910 1910
    assert not 'in_listing' in resp.form.fields.keys()
1911 1911

  
1912
def test_workflows_edit_choice_action(pub):
1913
    create_superuser(pub)
1914
    role = create_role()
1915
    Workflow.wipe()
1916
    workflow = Workflow(name='foo')
1917
    workflow.add_status(name='baz')
1918
    workflow.store()
1919

  
1920
    app = login(get_app(pub))
1921
    resp = app.get('/backoffice/workflows/1/')
1922
    resp = resp.click('baz')
1923

  
1924
    resp.forms[0]['type'] = 'Change Status'
1925
    resp = resp.forms[0].submit()
1926
    resp = resp.follow()
1927

  
1928
    resp = resp.click(href='items/1/', index=0)
1929
    assert 'Previously Marked Status' not in [x[2] for x in resp.form['status'].options]
1930
    resp.form['status'].value = 'baz'
1931
    resp = resp.form.submit('submit')
1932
    resp = resp.follow()
1933
    resp = resp.follow()
1934

  
1935
    resp = resp.click(href='items/1/', index=0)
1936
    resp.form['set_marker_on_status'].value = True
1937
    resp = resp.form.submit('submit')
1938
    resp = resp.follow()
1939
    resp = resp.follow()
1940

  
1941
    resp = resp.click(href='items/1/', index=0)
1942
    assert 'Previously Marked Status' in [x[2] for x in resp.form['status'].options]
1943

  
1912 1944
def test_workflows_action_subpath(pub):
1913 1945
    create_superuser(pub)
1914 1946
    role = create_role()
tests/test_backoffice_pages.py
7 7
import StringIO
8 8
import time
9 9
import hashlib
10
import random
10 11

  
11 12
import pytest
12 13
from webtest import Upload
......
3165 3166
            .parents('li').children('div.value span')
3166 3167
            .text() == '\'\\xed\\xa0\\x00\'')
3167 3168

  
3169
def test_workflow_jump_previous(pub):
3170
    user = create_user(pub)
3171
    create_environment(pub)
3172

  
3173
    wf = Workflow(name='jump around')
3174
    #       North
3175
    #     /      \
3176
    # West <----> East
3177
    #   |          |
3178
    #   |         autojump
3179
    #    |         |
3180
    #     \       /
3181
    #       South
3182

  
3183
    st1 = wf.add_status('North')
3184
    st1.id = 'north'
3185
    st2 = wf.add_status('West')
3186
    st2.id = 'west'
3187
    st3 = wf.add_status('East')
3188
    st3.id = 'east'
3189
    st4 = wf.add_status('Autojump')
3190
    st4.id = 'autojump'
3191
    st5 = wf.add_status('South')
3192
    st5.id = 'south'
3193

  
3194
    button_by_id = {}
3195

  
3196
    def add_jump(label, src, dst_id):
3197
        jump = ChoiceWorkflowStatusItem()
3198
        jump.id = str(random.random())
3199
        jump.label = label
3200
        jump.by = ['logged-users']
3201
        jump.status = dst_id
3202
        src.items.append(jump)
3203
        jump.parent = src
3204
        if dst_id != '_previous':
3205
            jump.set_marker_on_status = True
3206
        button_by_id[label] = 'button%s' % jump.id
3207
        return jump
3208

  
3209
    add_jump('Go West', st1, st2.id)
3210
    add_jump('Go East', st1, st3.id)
3211
    add_jump('Go South', st2, st5.id)
3212
    add_jump('Go Autojump', st3, st4.id)
3213
    add_jump('Go Back', st5, '_previous')
3214

  
3215
    add_jump('Jump West', st3, st2.id)
3216
    add_jump('Jump East', st2, st3.id)
3217

  
3218
    jump = JumpWorkflowStatusItem()
3219
    jump.id = '_auto-jump'
3220
    jump.status = st5.id
3221
    st4.items.append(jump)
3222
    jump.parent = st4
3223

  
3224
    wf.store()
3225

  
3226
    formdef = FormDef.get_by_urlname('form-title')
3227
    formdef.data_class().wipe()
3228
    formdef.workflow = wf
3229
    formdef.store()
3230

  
3231
    formdata = formdef.data_class()()
3232
    formdata.data = {}
3233
    formdata.just_created()
3234
    formdata.store()
3235

  
3236
    app = login(get_app(pub))
3237
    resp = app.get('/backoffice/management/form-title/%s/' % formdata.id)
3238

  
3239
    # jump around using buttons
3240
    resp = resp.form.submit(button_by_id['Go West']).follow()  # push (north)
3241
    assert formdef.data_class().get(formdata.id).status == 'wf-%s' % st2.id
3242
    resp = resp.form.submit(button_by_id['Go South']).follow() # push (north, west)
3243
    assert formdef.data_class().get(formdata.id).status == 'wf-%s' % st5.id
3244
    resp = resp.form.submit(button_by_id['Go Back']).follow()  # pop (north)
3245
    assert formdef.data_class().get(formdata.id).status == 'wf-%s' % st2.id
3246
    resp = resp.form.submit(button_by_id['Go South']).follow() # push (north, west)
3247
    assert formdef.data_class().get(formdata.id).status == 'wf-%s' % st5.id
3248
    resp = resp.form.submit(button_by_id['Go Back']).follow()  # pop (north)
3249
    assert formdef.data_class().get(formdata.id).status == 'wf-%s' % st2.id
3250
    resp = resp.form.submit(button_by_id['Jump East']).follow() # push (north, west)
3251
    assert formdef.data_class().get(formdata.id).status == 'wf-%s' % st3.id
3252
    resp = resp.form.submit(button_by_id['Go Autojump']).follow() # push (north, west, east)
3253
    assert formdef.data_class().get(formdata.id).status == 'wf-%s' % st5.id
3254

  
3255
    # check markers are displayed in /inspect page
3256
    user.is_admin = True
3257
    user.store()
3258
    resp2 = app.get('/backoffice/management/form-title/%s/inspect' % formdata.id)
3259
    assert 'Markers Stack' in resp2.body
3260
    assert '<span class="status">East</span>' in resp2.body
3261
    assert '<span class="status">West</span>' in resp2.body
3262
    assert '<span class="status">North</span>' in resp2.body
3263
    assert resp2.body.find('<span class="status">East</span>') < resp2.body.find('<span class="status">West</span>')
3264
    assert resp2.body.find('<span class="status">West</span>') < resp2.body.find('<span class="status">North</span>')
3265

  
3266
    resp = resp.form.submit(button_by_id['Go Back']).follow() # pop (north, west)
3267
    assert formdef.data_class().get(formdata.id).status == 'wf-%s' % st3.id
3268

  
3269
    # and do a last jump using the API
3270
    formdata = formdef.data_class().get(formdata.id)
3271
    formdata.jump_status('_previous') # pop (north)
3272
    assert formdata.status == 'wf-%s' % st2.id
3273

  
3274
    formdata = formdef.data_class().get(formdata.id)
3275
    formdata.jump_status('_previous') # pop ()
3276
    assert formdata.status == 'wf-%s' % st1.id
3277

  
3168 3278
def test_backoffice_fields(pub):
3169 3279
    user = create_user(pub)
3170 3280
    create_environment(pub)
wcs/admin/workflows.py
153 153
    for status in workflow.possible_status:
154 154
        i = status.id
155 155
        for item in status.items:
156
            next_status_ids = [x.id for x in item.get_target_status() if x.id != status.id]
156
            next_status_ids = [x.id for x in item.get_target_status()
157
                               if x.id and x.id != status.id]
157 158
            if not next_status_ids:
158 159
                next_status_ids = [status.id]
159 160
            done = {}
wcs/backoffice/management.py
2090 2090
            if not isinstance(v, basestring):
2091 2091
                r += htmltext(' <span class="type">(%r)</span>') % type(v)
2092 2092
            r += htmltext('</div></li>')
2093

  
2094
        if '_markers_stack' in (self.filled.workflow_data or {}):
2095
            r += htmltext('<li><h3>%s</h3></li>') % _('Markers Stack')
2096
            for marker in reversed(self.filled.workflow_data['_markers_stack']):
2097
                status = self.filled.get_status(marker['status_id'])
2098
                if status:
2099
                    r += htmltext('<li><span class="status">%s</span></li>') % status.name
2100
                else:
2101
                    r += htmltext('<li><span class="status">%s</span></li>') % _('Unknown')
2102

  
2093 2103
        r += htmltext('</ul>')
2094 2104
        r += htmltext('</div>')
2095

  
2096 2105
        return r.getvalue()
2097 2106

  
2098 2107

  
wcs/formdata.py
404 404
            return None
405 405
        if not self.formdef:
406 406
            return None
407
        if status.startswith('wf-'):
408
            status = status[3:]
407 409
        try:
408
            status_id = status.split('-')[1]
409
            wf_status = [x for x in self.formdef.workflow.possible_status if x.id == status_id][0]
410
            wf_status = [x for x in self.formdef.workflow.possible_status if x.id == status][0]
410 411
        except IndexError:
411 412
            return None
412 413
        return wf_status
......
453 454
            return None
454 455
        return wf_status.handle_form(form, self, user)
455 456

  
457
    def get_previous_marked_status(self):
458
        if not self.workflow_data or not '_markers_stack' in self.workflow_data:
459
            return None
460
        try:
461
            marker_data = self.workflow_data['_markers_stack'].pop()
462
            status_id = marker_data['status_id']
463
        except IndexError:
464
            return None
465
        return self.formdef.workflow.get_status(status_id)
466

  
456 467
    def jump_status(self, status_id):
468
        if status_id == '_previous':
469
            previous_status = self.get_previous_marked_status()
470
            assert previous_status, 'failed to compute previous status'
471
            status_id = previous_status.id
457 472
        evo = Evolution()
458 473
        evo.time = time.localtime()
459 474
        evo.status = 'wf-%s' % status_id
......
632 647

  
633 648
        if self.workflow_data:
634 649
            d.update(self.workflow_data)
635
            # pass over uploaded files and attach an extra attribute with the
636
            # url to the file.
650
            # pass over workflow data to:
651
            #  - attach an extra url attribute to uploaded files
652
            #  - remove "private" attributes
637 653
            for k, v in self.workflow_data.items():
654
                if k[0] == '_':
655
                    del d[k]
656
                    continue
638 657
                if isinstance(v, Upload):
639 658
                    try:
640 659
                        formvar, fieldvar = re.match('(.*)_var_(.*)_raw$', k).groups()
wcs/qommon/static/css/dc2/admin.css
1525 1525
	font-size: 100%;
1526 1526
}
1527 1527

  
1528
ul.form-inspector li span.status {
1529
	padding: 0 1ex;
1530
}
1531

  
1528 1532
ul.form-inspector li div.value {
1529 1533
	display: block;
1530 1534
	padding: 0 0 0.5ex 1em;
wcs/wf/jump.py
145 145
            return _('Change Status Automatically (to %s)') % wf_status[0].name
146 146

  
147 147
    def get_parameters(self):
148
        return ('status', 'condition', 'trigger', 'by', 'timeout')
148
        return ('status', 'set_marker_on_status', 'condition', 'trigger', 'by', 'timeout')
149 149

  
150 150
    def add_parameters_widgets(self, form, parameters, prefix='', formdef=None):
151 151
        WorkflowStatusJumpItem.add_parameters_widgets(self, form, parameters, prefix, formdef)
......
190 190
            return
191 191

  
192 192
        if self.must_jump(formdata):
193
            wf_status = self.get_target_status()
193
            wf_status = self.get_target_status(formdata)
194 194
            if wf_status:
195 195
                formdata.status = 'wf-%s' % wf_status[0].id
196 196

  
wcs/workflows.py
1634 1634
    def get_substitution_variables(self, formdata):
1635 1635
        return {}
1636 1636

  
1637
    def get_target_status(self):
1637
    def get_target_status(self, formdata=None):
1638 1638
        """Returns a list of status this item can lead to."""
1639 1639
        if not getattr(self, 'status', None):
1640 1640
            return []
1641 1641

  
1642
        if self.status == '_previous':
1643
            if formdata is None:
1644
                # must be in a formdata to compute destination, just give a
1645
                # fake status for presentation purpose
1646
                return [WorkflowStatus(_('Previously Marked Status'))]
1647
            previous_status = formdata.get_previous_marked_status()
1648
            if previous_status:
1649
                return [previous_status]
1650
            return []
1651

  
1642 1652
        try:
1643 1653
            return [x for x in self.parent.parent.possible_status if x.id == self.status]
1644 1654
        except IndexError:
......
1685 1695
class WorkflowStatusJumpItem(WorkflowStatusItem):
1686 1696
    status = None
1687 1697
    endpoint = False
1698
    set_marker_on_status = False
1688 1699

  
1689 1700
    def add_parameters_widgets(self, form, parameters, prefix='', formdef=None):
1690 1701
        if 'status' in parameters:
1702
            destinations = [(x.id, x.name) for x in self.parent.parent.possible_status]
1703

  
1704
            # look for existing jumps that are dropping a mark
1705
            has_markers = False
1706
            for status in self.parent.parent.possible_status:
1707
                for item in status.items:
1708
                    if getattr(item, 'set_marker_on_status', False):
1709
                        destinations.append(('_previous', _('Previously Marked Status')))
1710
                        break
1711
                else:
1712
                    continue
1713
                break
1714

  
1691 1715
            form.add(SingleSelectWidget, '%sstatus' % prefix, title = _('Status'), value = self.status,
1692
                options = [(None, '---')] + [(x.id, x.name) for x in self.parent.parent.possible_status])
1716
                options = [(None, '---')] + destinations)
1717

  
1718
        if 'set_marker_on_status' in parameters:
1719
            form.add(CheckboxWidget, '%sset_marker_on_status' % prefix,
1720
                title=_('Set marker on status'),
1721
                value=self.set_marker_on_status,
1722
                advanced=not(self.set_marker_on_status))
1693 1723

  
1694 1724
    def get_parameters(self):
1695
        return ('status',)
1725
        return ('status', 'set_marker_on_status')
1696 1726

  
1697 1727

  
1698 1728
def get_role_translation(formdata, role_name):
......
1892 1922

  
1893 1923
    def submit_form(self, form, formdata, user, evo):
1894 1924
        if form.get_submit() == 'button%s' % self.id:
1895
            wf_status = self.get_target_status()
1925
            wf_status = self.get_target_status(formdata)
1896 1926
            if wf_status:
1897 1927
                evo.status = 'wf-%s' % wf_status[0].id
1928
                if self.set_marker_on_status:
1929
                    if formdata.workflow_data and '_markers_stack' in formdata.workflow_data:
1930
                        markers_stack = formdata.workflow_data.get('_markers_stack')
1931
                    else:
1932
                        markers_stack = []
1933
                    markers_stack.append({'status_id': formdata.status[3:]})
1934
                    formdata.update_workflow_data({'_markers_stack': markers_stack})
1898 1935
                form.clear_errors()
1899 1936
                return True # get out of processing loop
1900 1937

  
......
1919 1956
                     value=self.backoffice_info_text)
1920 1957

  
1921 1958
    def get_parameters(self):
1922
        return ('by', 'status', 'label', 'backoffice_info_text', 'require_confirmation')
1959
        return ('by', 'status', 'label', 'backoffice_info_text',
1960
                'require_confirmation', 'set_marker_on_status')
1923 1961

  
1924 1962
register_item_class(ChoiceWorkflowStatusItem)
1925 1963

  
......
1940 1978

  
1941 1979
    def submit_form(self, form, formdata, user, evo):
1942 1980
        if form.is_submitted() and not form.has_errors():
1943
            wf_status = self.get_target_status()
1981
            wf_status = self.get_target_status(formdata)
1944 1982
            if wf_status:
1945 1983
                evo.status = 'wf-%s' % wf_status[0].id
1946 1984

  
1947 1985
    def get_parameters(self):
1948
        return ('status',)
1986
        return ('status', 'set_marker_on_status')
1949 1987
register_item_class(JumpOnSubmitWorkflowStatusItem)
1950 1988

  
1951 1989

  
1952
-