Add auto-close-tasks param to task transitions on dossier closure

Author: Abdu-moustafa

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,77 @@ 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'}
+                },
+                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)

opengever/api/transition.py

@@ -238,14 +238,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/resolve.py

@@ -154,6 +154,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 +192,23 @@ 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()
+            task.force_finish_task()
+
+    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 +323,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