Tp2000 1471 task workflow

.github/pull_request_template.md

@@ -1,5 +1,6 @@
-# TP-??? Your PR title here
+# TP2000-??? Your PR title here
 <!---
+                                                  <--- 50 characters
  * Include the JIRA ticket number, eg TP-123, to automatically link.
  * Use 50 characters maximum.
  * Do not end with a full-stop.
@@ -22,12 +23,12 @@ What is this PR doing, e.g. implementations, algorithms, etc.?
 --->
 
 <!---
-Optionally let reviewers know they need to run migrations or update dependencies before
+Let reviewers know they need to run migrations or update dependencies before
 testing by adding the following section:
-## Checklist
-- Requires migrations?
-- Requires dependency updates?
 --->
+## Checklist
+- Requires migrations? Yes / No
+- Requires dependency updates? Yes / No
 
 <!---
 Links to relevant material

common/jinja2/common/homepage.jinja

@@ -144,6 +144,30 @@
       </article>
     {% endif %}
 
+      <article class="masonry-card">
+        <h3 class="govuk-heading-m">Tasks and Workflows - TEST ONLY</h3>
+        <p class="govuk-body">
+          <a href="{{ url('workflow:task-ui-list') }}"
+            class="govuk-link"
+          >Tasks</a>
+        </p>
+        <p class="govuk-body"></p>
+          <a href="{{ url('workflow:task-workflow-ui-list') }}"
+            class="govuk-link"
+          >Workflows</a>
+        </p>
+        <p class="govuk-body"></p>
+          <a href="{{ url('workflow:task-and-workflow-ui-list') }}"
+            class="govuk-link"
+          >Tasks and Workflows</a>
+        </p>
+        <p class="govuk-body"></p>
+          <a href="{{ url('workflow:task-workflow-template-ui-list') }}"
+            class="govuk-link"
+          >Workflow templates</a>
+        </p>
+      </article>
+
     <article class="masonry-card">
       <h3 class="govuk-heading-m">Resources</h3>
       <p class="govuk-body">

common/jinja2/layouts/detail.jinja

@@ -1,4 +1,6 @@
 {% extends "layouts/layout.jinja" %}
+
+{% from "components/tabs/macro.njk" import govukTabs %}
 {% from "components/breadcrumbs.jinja" import breadcrumbs %}
 
 {% block breadcrumb %}

common/models/mixins/__init__.py

@@ -1,6 +1,7 @@
 """Mixins for models."""
 
 from django.db import models
+from django.db.models import signals
 
 
 class TimestampedMixin(models.Model):
@@ -11,3 +12,37 @@ class TimestampedMixin(models.Model):
 
     class Meta:
         abstract = True
+
+
+class WithSignalManagerMixin:
+    """A mixin that overrides default Manager methods to send pre_save signals
+    for model instances."""
+
+    def bulk_create(self, objs, **kwargs) -> list:
+        for obj in objs:
+            signals.pre_save.send(sender=self.model, instance=obj)
+        return super().bulk_create(objs, **kwargs)
+
+
+class WithSignalQuerysetMixin:
+    """A mixin that overrides default QuerySet methods to send pre_save signals
+    for model instances."""
+
+    def update(self, **kwargs) -> int:
+        old_instances_map = {}
+        pk_list = []
+        for old_instance in self.iterator():
+            old_instances_map[old_instance.pk] = old_instance
+            pk_list.append(old_instance.pk)
+
+        rows_updated = super().update(**kwargs)
+
+        for new_instance in self.model.objects.filter(pk__in=pk_list):
+            old_instance = old_instances_map.get(new_instance.pk)
+            signals.pre_save.send(
+                sender=self.model,
+                instance=new_instance,
+                old_instance=old_instance,
+            )
+
+        return rows_updated

common/static/common/js/components/WorkbasketUserAssignment/UnassignUserForm.js

@@ -5,8 +5,8 @@ import accessibleAutocomplete from "accessible-autocomplete";
 import PropTypes from "prop-types";
 
 function UnassignUserForm({ users }) {
-  const elementId = "assignments-select";
-  const elementName = "assignments";
+  const elementId = "assignees-select";
+  const elementName = "assignees";
   const label = "Unassign user";
   const hint = "Select a user to unassign";
 
@@ -66,7 +66,7 @@ UnassignUserForm.propTypes = {
     PropTypes.shape({
       pk: PropTypes.number.isRequired,
       name: PropTypes.string.isRequired,
-    })
+    }),
   ),
 };
 

common/static/common/js/components/WorkbasketUserAssignment/tests/__snapshots__/UnassignUserForm.test.js.snap

@@ -16,20 +16,20 @@ exports[`UnassignUserForm renders form 1`] = `
   >
     <label
       className="govuk-label"
-      htmlFor="assignments-select"
+      htmlFor="assignees-select"
     >
       Unassign user
     </label>
     <div
       className="govuk-hint"
-      id="assignments-hint"
+      id="assignees-hint"
     >
       Select a user to unassign
     </div>
     <select
       data-testid="unassign-user-select"
-      id="assignments-select"
-      name="assignments"
+      id="assignees-select"
+      name="assignees"
       required={true}
     >
       <option

common/static/common/scss/application.scss

@@ -28,6 +28,7 @@ $govuk-image-url-function: frontend-image-url;
 @import "regulations";
 @import "workbaskets";
 @import "reference_documents";
+@import "tasks";
 @import "versions";
 @import "fake-link";
 @import "violations";

common/tests/factories.py

@@ -7,6 +7,7 @@
 
 import factory
 from django.contrib.auth import get_user_model
+from django.db.models import signals
 from factory.fuzzy import FuzzyChoice
 from factory.fuzzy import FuzzyText
 from faker import Faker
@@ -30,7 +31,8 @@
 from measures.validators import OrderNumberCaptureCode
 from publishing.models import ProcessingState
 from quotas.validators import QuotaEventType
-from tasks.models import UserAssignment
+from tasks.models import ProgressState
+from tasks.models import TaskAssignee
 from workbaskets.validators import WorkflowStatus
 
 User = get_user_model()
@@ -1533,40 +1535,62 @@ class Meta:
         model = "notifications.CrownDependenciesEnvelopeFailedNotification"
 
 
+class CategoryFactory(factory.django.DjangoModelFactory):
+    name = factory.Faker("bs")
+
+    class Meta:
+        model = "tasks.Category"
+
+
+class ProgressStateFactory(factory.django.DjangoModelFactory):
+    name = FuzzyChoice(ProgressState.State.values)
+
+    class Meta:
+        model = "tasks.ProgressState"
+        django_get_or_create = ("name",)
+
+
 class TaskFactory(factory.django.DjangoModelFactory):
     title = factory.Faker("sentence")
     description = factory.Faker("sentence")
+    category = factory.SubFactory(CategoryFactory)
+    progress_state = factory.SubFactory(ProgressStateFactory)
     workbasket = factory.SubFactory(WorkBasketFactory)
+    creator = factory.SubFactory(UserFactory)
 
     class Meta:
         model = "tasks.Task"
 
 
-class UserAssignmentFactory(factory.django.DjangoModelFactory):
+class SubTaskFactory(TaskFactory):
+    parent_task = factory.SubFactory(TaskFactory)
+
+
+@factory.django.mute_signals(signals.pre_save)
+class TaskAssigneeFactory(factory.django.DjangoModelFactory):
     user = factory.SubFactory(UserFactory)
-    assigned_by = factory.SubFactory(UserFactory)
-    assignment_type = FuzzyChoice(UserAssignment.AssignmentType.values)
+    assignment_type = FuzzyChoice(TaskAssignee.AssignmentType.values)
     task = factory.SubFactory(TaskFactory)
 
     class Meta:
-        model = "tasks.UserAssignment"
+        model = "tasks.TaskAssignee"
 
 
 class AssignedWorkBasketFactory(WorkBasketFactory):
     """Creates a workbasket which has an assigned worker and reviewer."""
 
     @factory.post_generation
-    def user_assignments(self, create, extracted, **kwargs):
+    def create_workbasket_assignments(self, create, extracted, **kwargs):
         if not create:
             return
 
         task = TaskFactory.create(workbasket=self)
-        UserAssignmentFactory.create(
-            assignment_type=UserAssignment.AssignmentType.WORKBASKET_WORKER,
+        TaskAssigneeFactory.create(
+            assignment_type=TaskAssignee.AssignmentType.WORKBASKET_WORKER,
             task=task,
         )
-        UserAssignmentFactory.create(
-            assignment_type=UserAssignment.AssignmentType.WORKBASKET_REVIEWER,
+        TaskAssigneeFactory.create(
+            assignment_type=TaskAssignee.AssignmentType.WORKBASKET_REVIEWER,
             task=task,
         )
 

common/tests/test_util.py

@@ -586,6 +586,45 @@ def test_make_real_edit_create_delete():
     assert workbasket.tracked_models.count() == 0
 
 
+@mock.patch("django.db.transaction.get_connection")
+def test_tablelock_as_context_manager(mock_get_connection):
+    mock_cursor = mock.MagicMock()
+    mock_get_connection.return_value.cursor.return_value.__enter__.return_value = (
+        mock_cursor
+    )
+
+    instance = factories.TestModel1Factory.create()
+    model = instance._meta.model
+    lock = util.TableLock.EXCLUSIVE
+
+    with util.TableLock(model, lock=lock):
+        assert model.objects.select_for_update().get(pk=instance.pk)
+        mock_cursor.execute.assert_called_once_with(
+            f"LOCK TABLE {model._meta.db_table} IN {lock} MODE",
+        )
+
+
+@mock.patch("django.db.transaction.get_connection")
+def test_tablelock_as_decorator(mock_get_connection):
+    mock_cursor = mock.MagicMock()
+    mock_get_connection.return_value.cursor.return_value.__enter__.return_value = (
+        mock_cursor
+    )
+
+    instance = factories.TestModel1Factory.create()
+    model = instance._meta.model
+    lock = util.TableLock.EXCLUSIVE
+
+    @util.TableLock.acquire_lock(model, lock=lock)
+    def decorated_function():
+        return True
+
+    assert decorated_function()
+    mock_cursor.execute.assert_called_once_with(
+        f"LOCK TABLE {model._meta.db_table} IN {lock} MODE",
+    )
+
+
 @pytest.mark.parametrize(
     "date_range,compared_date_range,expected",
     (

common/tests/test_views.py

@@ -16,7 +16,7 @@
 from common.views import HealthCheckView
 from common.views import handler403
 from common.views import handler500
-from tasks.models import UserAssignment
+from tasks.models import TaskAssignee
 from workbaskets.validators import WorkflowStatus
 
 pytestmark = pytest.mark.django_db
@@ -281,9 +281,9 @@ def test_homepage_cards_contain_expected_links(superuser_client):
 def test_homepage_card_currently_working_on(status, valid_user, valid_user_client):
     test_reason = "test reason"
     workbasket = factories.WorkBasketFactory.create(status=status, reason=test_reason)
-    factories.UserAssignmentFactory.create(
+    factories.TaskAssigneeFactory.create(
         user=valid_user,
-        assignment_type=UserAssignment.AssignmentType.WORKBASKET_REVIEWER,
+        assignment_type=TaskAssignee.AssignmentType.WORKBASKET_REVIEWER,
         task__workbasket=workbasket,
     )
     TrackedModelCheckFactory.create(