Merge pull request #8162 from 4teamwork/amo/TI-2000/extend_dossier_transactions_with_auth_close_tasks

Force finish dossier pending tasks

Author: elioschmutz

changes/TI-2000-2.feature

@@ -0,0 +1 @@
+Provide the auto_close_tasks parameter on the task transition action when closing a dossier. [amo]

opengever/api/tests/test_dossier_workflow.py

@@ -1,9 +1,12 @@
 from datetime import datetime
+from ftw.builder import Builder
+from ftw.builder import create
 from ftw.testbrowser import browsing
 from ftw.testing import freeze
 from opengever.dossier.resolve import LockingResolveManager
 from opengever.testing import IntegrationTestCase
 from plone import api
+import json
 
 
 class TestDossierWorkflowRESTAPITransitions(IntegrationTestCase):
@@ -21,12 +24,14 @@ def assert_state(self, expected_state, obj):
         self.assertEquals(expected_state,
                           api.content.get_state(obj))
 
-    def api_transition(self, obj, transition, browser):
+    def api_transition(self, obj, transition, browser, data=None):
         url = '/'.join((obj.absolute_url(), '@workflow', transition))
         browser.open(
             url,
-            headers={'Accept': 'application/json'},
-            method='POST')
+            headers=self.api_headers,
+            method='POST',
+            data=data
+        )
 
     @browsing
     def test_resolve_via_restapi(self, browser):
@@ -199,3 +204,118 @@ def test_archive_offered_via_restapi_is_forbidden(self, browser):
                 {u'message': u"Invalid transition 'dossier-transition-archive'.\nValid transitions are:\n",
                  u'type': u'Bad Request'}},
             browser.json)
+
+    @browsing
+    def test_resolve_dossier_auto_close_tasks(self, browser):
+
+        self.login(self.secretariat_user, browser)
+
+        open_task = create(
+            Builder('task')
+            .within(self.resolvable_subdossier)
+            .in_state('task-state-open')
+            .titled(u'Task 1')
+            .having(
+                issuer=self.secretariat_user.id,
+                responsible=self.secretariat_user.id,
+                responsible_client='fa',
+            )
+        )
+        in_progress_task = create(
+            Builder('task')
+            .within(self.resolvable_subdossier)
+            .in_state('task-state-in-progress')
+            .titled(u'Task 2')
+            .having(
+                issuer=self.secretariat_user.id,
+                responsible=self.secretariat_user.id,
+                responsible_client='fa',
+                task_type='approval',
+            )
+        )
+        resolved_task = create(
+            Builder('task')
+            .within(self.resolvable_subdossier)
+            .in_state('task-state-resolved')
+            .titled(u'Task 3')
+            .having(
+                issuer=self.secretariat_user.id,
+                responsible=self.secretariat_user.id,
+                responsible_client='fa',
+            )
+        )
+        with freeze(datetime(2018, 4, 30)):
+            with browser.expect_http_error():
+                self.api_transition(self.resolvable_subdossier, 'dossier-transition-resolve', browser)
+            self.assertEqual(400, browser.status_code)
+            self.assertDictEqual(
+                {
+                    u'error': {
+                        u'message': u'',
+                        u'errors': [u'not all task are closed'],
+                        u'type': u'PreconditionsViolated',
+                        u'has_not_closed_tasks': True,
+                    }
+                },
+                browser.json)
+
+        # dossier and tasks state did not change
+        self.assert_state('dossier-state-active', self.resolvable_subdossier)
+
+        self.assert_state('task-state-open', open_task)
+        self.assert_state('task-state-in-progress', in_progress_task)
+        self.assert_state('task-state-resolved', resolved_task)
+
+        with freeze(datetime(2018, 4, 30)):
+
+            self.api_transition(
+                self.resolvable_subdossier,
+                'dossier-transition-resolve',
+                browser,
+                data=json.dumps({"auto_close_tasks": True})
+            )
+
+        self.assertEqual(200, browser.status_code)
+
+        # dossier and tasks states were changed
+        self.assert_state('dossier-state-resolved', self.resolvable_subdossier)
+
+        self.assert_state('task-state-cancelled', open_task)
+        self.assert_state('task-state-tested-and-closed', in_progress_task)
+        self.assert_state('task-state-tested-and-closed', resolved_task)
+
+    @browsing
+    def test_resolve_dossier_auto_close_tasks_raises_error_if_auto_close_is_not_possible(self, browser):
+        self.login(self.secretariat_user, browser)
+
+        # A private task cannot be closed by the secretarian user.
+        # The api should raise an error in this case.
+        create(
+            Builder('task')
+            .within(self.resolvable_dossier)
+            .in_state('task-state-open')
+            .titled(u'Task 1')
+            .having(
+                issuer=self.regular_user.id,
+                responsible=self.regular_user.id,
+                responsible_client='fa',
+                is_private=True,
+            )
+        )
+
+        with browser.expect_http_error(code=400):
+            self.api_transition(
+                self.resolvable_dossier,
+                'dossier-transition-resolve',
+                browser,
+                data=json.dumps({"auto_close_tasks": True})
+            )
+
+        self.assertEqual(
+            {
+                u'error': {
+                    u'errors': [u'Auto-close tasks is not possible. Please close the tasks manually.'],
+                    u'type': u'AutoCloseTasksNotPossible'
+                }
+            },
+            browser.json)

opengever/api/transition.py

@@ -6,9 +6,11 @@
 from opengever.dossier.deactivate import DossierDeactivator
 from opengever.dossier.reactivate import Reactivator
 from opengever.dossier.resolve import AlreadyBeingResolved
+from opengever.dossier.resolve import AutoCloseTasksNotPossible
 from opengever.dossier.resolve import InvalidDates
 from opengever.dossier.resolve import LockingResolveManager
 from opengever.dossier.resolve import MSG_ALREADY_BEING_RESOLVED
+from opengever.dossier.resolve import NOT_CLOSED_TASKS
 from opengever.dossier.resolve import PreconditionsViolated
 from opengever.sign.sign import Signer
 from plone import api
@@ -189,6 +191,7 @@ def reply(self):
             return dict(error=dict(
                 type='PreconditionsViolated',
                 errors=map(self.translate, e.errors),
+                has_not_closed_tasks=NOT_CLOSED_TASKS in e.errors,
                 message=self.translate(str(e))))
 
         except InvalidDates as e:
@@ -210,6 +213,12 @@ def reply(self):
                 type='AlreadyBeingResolved',
                 message=msg))
 
+        except AutoCloseTasksNotPossible as e:
+            self.request.response.setStatus(400)
+            return dict(error=dict(
+                type='AutoCloseTasksNotPossible',
+                errors=[self.translate(e.message)]))
+
         except BadRequest as e:
             self.request.response.setStatus(400)
             return dict(error=dict(
@@ -238,14 +247,15 @@ def perform_custom_transition(self):
         # For now we also extract these, but we don't do anything with them
         # in the case of resolving a dossier.
         comment = data.get('comment', '')
+        auto_close_tasks = data.get('auto_close_tasks', False)
         publication_dates = self.parse_publication_dates(data)
         args = [self.context], comment, publication_dates
 
         if adapter and data:
             data = adapter.deserialize(data)
 
         if self.transition == 'dossier-transition-resolve':
-            self.resolve_dossier(*args, **data)
+            self.resolve_dossier(*args, auto_close_tasks=auto_close_tasks, **data)
         elif self.transition == 'dossier-transition-activate':
             self.activate_dossier(*args)
         elif self.transition == 'dossier-transition-deactivate':

opengever/dossier/locales/de/LC_MESSAGES/opengever.dossier.po

@@ -1,7 +1,7 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: 1.0\n"
-"POT-Creation-Date: 2025-03-24 10:10+0000\n"
+"POT-Creation-Date: 2025-06-24 08:51+0000\n"
 "PO-Revision-Date: 2017-05-23 04:53+0000\n"
 "Last-Translator: Jacqueline Sposato <jacqueline.sposato@gmail.com>\n"
 "Language-Team: German <https://translations.onegovgever.ch/projects/onegov-gever/opengever-dossier/de/>\n"
@@ -269,6 +269,11 @@ msgstr "Alle"
 msgid "any_role"
 msgstr "Alle"
 
+#. Default: "Auto-close tasks is not possible. Please close the tasks manually."
+#: ./opengever/dossier/resolve.py
+msgid "auto_close_tasks_not_possible"
+msgstr "Die Aufgaben konnten nicht automatisch geschlossen werden. Bitte schliessen Sie die Aufgaben manuell."
+
 #. Default: "Add"
 #: ./opengever/dossier/browser/forms.py
 msgid "button_add"

opengever/dossier/locales/en/LC_MESSAGES/opengever.dossier.po

@@ -1,7 +1,7 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: 1.0\n"
-"POT-Creation-Date: 2025-03-24 10:10+0000\n"
+"POT-Creation-Date: 2025-06-24 08:51+0000\n"
 "PO-Revision-Date: 2017-05-23 04:53+0000\n"
 "Last-Translator: Jacqueline Sposato <jacqueline.sposato@gmail.com>\n"
 "Language-Team: German <https://translations.onegovgever.ch/projects/onegov-gever/opengever-dossier/de/>\n"
@@ -336,6 +336,11 @@ msgstr "Any participant"
 msgid "any_role"
 msgstr "Any role"
 
+#. Default: "Auto-close tasks is not possible. Please close the tasks manually."
+#: ./opengever/dossier/resolve.py
+msgid "auto_close_tasks_not_possible"
+msgstr "Auto-close tasks is not possible. Please close the tasks manually."
+
 #. German translation: Erstellen
 #. Default: "Add"
 #: ./opengever/dossier/browser/forms.py

opengever/dossier/locales/fr/LC_MESSAGES/opengever.dossier.po

@@ -1,7 +1,7 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2025-03-24 10:10+0000\n"
+"POT-Creation-Date: 2025-06-24 08:51+0000\n"
 "PO-Revision-Date: 2017-12-03 11:16+0000\n"
 "Last-Translator: Jacqueline Sposato <jacqueline.sposato@gmail.com>\n"
 "Language-Team: French <https://translations.onegovgever.ch/projects/onegov-gever/opengever-dossier/fr/>\n"
@@ -267,6 +267,11 @@ msgstr "Tous"
 msgid "any_role"
 msgstr "Tous"
 
+#. Default: "Auto-close tasks is not possible. Please close the tasks manually."
+#: ./opengever/dossier/resolve.py
+msgid "auto_close_tasks_not_possible"
+msgstr "La fermeture automatique des tâches n'est pas possible. Veuillez clôturer les tâches manuellement."
+
 #. Default: "Add"
 #: ./opengever/dossier/browser/forms.py
 msgid "button_add"

opengever/dossier/locales/opengever.dossier.pot

@@ -4,7 +4,7 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2025-03-24 10:10+0000\n"
+"POT-Creation-Date: 2025-06-24 08:51+0000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI +ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -268,6 +268,11 @@ msgstr ""
 msgid "any_role"
 msgstr ""
 
+#. Default: "Auto-close tasks is not possible. Please close the tasks manually."
+#: ./opengever/dossier/resolve.py
+msgid "auto_close_tasks_not_possible"
+msgstr ""
+
 #. Default: "Add"
 #: ./opengever/dossier/browser/forms.py
 msgid "button_add"

opengever/dossier/resolve.py

@@ -19,6 +19,7 @@
 from opengever.dossier.statusmessage_mixin import DossierResolutionStatusmessageMixin
 from opengever.task.task import ITask
 from plone import api
+from plone.api.exc import InvalidParameterError
 from Products.CMFCore.Expression import createExprContext
 from Products.CMFCore.Expression import Expression
 from Products.CMFCore.utils import getToolByName
@@ -64,6 +65,11 @@ def __init__(self, invalid_dossier_titles):
         self.invalid_dossier_titles = invalid_dossier_titles
 
 
+class AutoCloseTasksNotPossible(Exception):
+    """Could not auto close the tasks. Please do it manually.
+    """
+
+
 def get_resolver(dossier):
     """Return the currently configured dossier-resolver."""
 
@@ -154,6 +160,11 @@ def resolve(self, **transition_params):
         # by acquring a lock, resolving, and then releasing the lock
         try:
             resolve_lock.acquire(commit=True)
+            auto_close_tasks = transition_params.get("auto_close_tasks", False)
+            if auto_close_tasks:
+                pending_tasks = self._get_pending_tasks()
+                self._auto_close_tasks(pending_tasks)
+
             result = self.execute_recursive_resolve(**transition_params)
 
             # We need to commit here so that a possible ConflictError already
@@ -187,6 +198,28 @@ def resolve(self, **transition_params):
             # this 'finally' block.
             resolve_lock.release(commit=True)
 
+    def _auto_close_tasks(self, tasks):
+        """Auto-close all pending tasks."""
+        for brain in tasks:
+            task = brain.getObject()
+            try:
+                task.force_finish_task()
+            except InvalidParameterError:
+                raise AutoCloseTasksNotPossible(
+                    _('auto_close_tasks_not_possible',
+                      default=u'Auto-close tasks is not possible. Please close the tasks manually.'))
+
+    def _get_pending_tasks(self):
+        """Get all pending tasks in dossier."""
+        catalog = api.portal.get_tool('portal_catalog')
+        path = '/'.join(self.context.getPhysicalPath())
+        return catalog.searchResults(
+            path=path,
+            object_provides=ITask.__identifier__,
+            is_subtask=False,
+            review_state=['task-state-open', 'task-state-in-progress', 'task-state-resolved']
+        )
+
     def execute_recursive_resolve(self, **transition_params):
         self.resolver.raise_on_failed_preconditions()
         if is_archive_form_needed(self.context):
@@ -301,7 +334,7 @@ def are_enddates_valid(self):
             self.enddates_valid = True
         return errors
 
-    def resolve(self, end_date=None, **kwargs):
+    def resolve(self, end_date=None, auto_close_tasks=False, **kwargs):
         if not self.enddates_valid or not self.preconditions_fulfilled:
             raise TypeError
 

opengever/dossier/tests/test_activate.py

@@ -138,6 +138,7 @@ def assert_errors(self, dossier, browser, error_msgs):
             {u'error':
                 {u'message': u'',
                  u'errors': error_msgs,
+                 u'has_not_closed_tasks': False,
                  u'type': u'PreconditionsViolated'}},
             browser.json)
         expected_url = dossier.absolute_url() + \

opengever/dossier/tests/test_archiver.py

@@ -525,6 +525,7 @@ def test_precondition_violation_raises_error_already_on_resolve_view(self, brows
             {u'error': {
                 u'message': u'',
                 u'errors': [u'not all task are closed'],
+                u'has_not_closed_tasks': True,
                 u'type': u'PreconditionsViolated'}},
             browser.json)