ft-add-notifications: Add notifications model

-  Add notifications model
- add signals to create notifications
- add unit tests
- configure django_q and django_cache
- resolve merge conflicts
- update README.md
- apply PR feedback
- remove curly braces from notification body template
- update functionality to close transition report on asset status
  change to `lost` or `damaged`

[Delivers #161678177]

Author: gitau-kinuthia

core/signals.py

@@ -16,25 +16,28 @@ def update_transition_state(**kwargs):
     :return None:
     """
     instance = kwargs.get("instance")  # the instance of the incident report being saved
-    valid_previous_asset_types = (constants.DAMAGED, constants.LOST)
-    valid_current_asset_types = (constants.AVAILABLE, constants.ALLOCATED)
+    valid_previous_asset_types = (constants.AVAILABLE, constants.ALLOCATED)
+    valid_current_asset_types = (constants.DAMAGED, constants.LOST)
 
     # previous_instance = AssetStatus.objects.filter(id=instance.id).latest('created_at')
     current_asset_status = instance.current_status
     previous_asset_status = instance.previous_status
 
-    if previous_asset_status in valid_previous_asset_types:
-        if current_asset_status in valid_current_asset_types:
-            # get the latest incident report
-            # filter out all results that dont have a recorded created_at date
-            latest_incident_report = AssetIncidentReport.objects.filter(
-                asset=instance.asset, created_at__isnull=False
-            ).latest('created_at')
-            # get the transition state associated with the incident report
-            transition_state = StateTransition.objects.get_or_create(
-                asset_incident_report=latest_incident_report
-            )
-            transition_state = transition_state[0]
-            # update the transition state
-            transition_state.incident_report_state = constants.CLOSED
-            transition_state.save()
+    try:
+        if previous_asset_status in valid_previous_asset_types:
+            if current_asset_status in valid_current_asset_types:
+                # get the latest incident report
+                # filter out all results that dont have a recorded created_at date
+                latest_incident_report = AssetIncidentReport.objects.filter(
+                    asset=instance.asset, created_at__isnull=False
+                ).latest('created_at')
+                # get the transition state associated with the incident report
+                transition_state = StateTransition.objects.get_or_create(
+                    asset_incident_report=latest_incident_report
+                )
+                transition_state = transition_state[0]
+                # update the transition state
+                transition_state.incident_report_state = constants.CLOSED
+                transition_state.save()
+    except AssetIncidentReport.DoesNotExist:
+        pass

core/tests/test_state_transition_model.py

@@ -59,90 +59,91 @@ def setUp(self):
         ).objects.get_or_create(asset_incident_report_id=self.incident_report.id)
         self.transition_state = self.transition_state[0]
 
-    def test_update_asset_status_from_lost_to_available(self):
+    def test_update_asset_status_from_available_to_lost(self):
         status = (
             apps.get_model("core", "AssetStatus")
             .objects.filter(asset=self.asset)
             .latest('created_at')
         )
         # update status to lost
-        status.current_status = constants.LOST
+        status.current_status = constants.AVAILABLE
         status.save()
         # update status to available
         status = (
             apps.get_model("core", "AssetStatus")
             .objects.filter(asset=self.asset)
             .latest('created_at')
         )
-        status.current_status = constants.AVAILABLE
+        status.current_status = constants.LOST
         status.save()
         # verify that transition state has been updated to closed
         transition_state = apps.get_model("core", "StateTransition").objects.get(
             asset_incident_report=self.incident_report
         )
         self.assertEqual(transition_state.incident_report_state, constants.CLOSED)
 
-    def test_update_asset_status_from_damaged_to_available(self):
+    def test_update_asset_status_from_available_to_damaged(self):
         status = (
             apps.get_model("core", "AssetStatus")
             .objects.filter(asset=self.asset)
             .latest('created_at')
         )
 
         # update status to lost
-        status.current_status = constants.DAMAGED
+        status.current_status = constants.AVAILABLE
         status.save()
         # update status to available
         status = (
             apps.get_model("core", "AssetStatus")
             .objects.filter(asset=self.asset)
             .latest('created_at')
         )
-        status.current_status = constants.AVAILABLE
+        status.current_status = constants.DAMAGED
         status.save()
         # verify that transition state has been updated to closed
         transition_state = apps.get_model("core", "StateTransition").objects.get(
             asset_incident_report=self.incident_report
         )
         self.assertEqual(transition_state.incident_report_state, constants.CLOSED)
 
-    def test_update_asset_status_from_lost_to_allocated(self):
+    def test_update_asset_status_from_allocated_to_lost(self):
         status = (
             apps.get_model("core", "AssetStatus")
             .objects.filter(asset=self.asset)
             .latest('created_at')
         )
 
-        # update status to lost
-        status.current_status = constants.LOST
-        status.save()
-
         # allocate asset  to a user
         apps.get_model("core", "AllocationHistory").objects.create(
             asset=self.asset, current_assignee=self.asset_assignee2
         )
 
+        # update status to lost
+        status.current_status = constants.LOST
+        status.save()
+
         transition_state = apps.get_model("core", "StateTransition").objects.get(
             asset_incident_report=self.incident_report
         )
 
         self.assertEqual(transition_state.incident_report_state, constants.CLOSED)
 
-    def test_update_asset_status_from_damaged_to_allocated(self):
+    def test_update_asset_status_from_allocated_to_damaged(self):
         status = (
             apps.get_model("core", "AssetStatus")
             .objects.filter(asset=self.asset)
             .latest('created_at')
         )
 
-        # update status to lost
-        status.current_status = constants.DAMAGED
-        status.save()
         # allocate asset  to a user
         apps.get_model("core", "AllocationHistory").objects.create(
             asset=self.asset, current_assignee=self.asset_assignee2
         )
 
+        # update status to lost
+        status.current_status = constants.DAMAGED
+        status.save()
+
         transition_state = apps.get_model("core", "StateTransition").objects.get(
             asset_incident_report=self.incident_report
         )