Merge pull request #16 from uktrade/DST-209-db-historical-audit-trail

DST-209: DB historical audit trail

Pipfile

@@ -20,6 +20,7 @@ django-formtools = "*"
 gevent = "*"
 sentry-sdk = "*"
 whitenoise = "*"
+django-simple-history = "~=3.4.0"
 
 [dev-packages]
 black = "~=23.12"

config/settings/base.py

@@ -51,6 +51,7 @@
     "crispy_forms",
     "crispy_forms_gds",
     "django_chunk_upload_handlers",
+    "simple_history",
 ]
 
 INSTALLED_APPS = DJANGO_APPS + OUR_APPS + THIRD_PARTY_APPS
@@ -67,6 +68,7 @@
     "django.contrib.auth.middleware.AuthenticationMiddleware",
     "django.contrib.messages.middleware.MessageMiddleware",
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
+    "simple_history.middleware.HistoryRequestMiddleware",
 ]
 
 ROOT_URLCONF = "config.urls"

report_a_breach/base_classes/models.py

@@ -1,12 +1,14 @@
 import uuid
 
 from django.db import models
+from simple_history.models import HistoricalRecords
 
 
 class BaseModel(models.Model):
     id = models.UUIDField(primary_key=True, editable=False, default=uuid.uuid4)
     created_at = models.DateTimeField(auto_now_add=True)
     modified_at = models.DateTimeField(auto_now=True)
+    history = HistoricalRecords(inherit=True)
 
     class Meta:
         abstract = True

report_a_breach/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 4.2.9 on 2024-02-05 13:43
+# Generated by Django 4.2.9 on 2024-02-05 16:40
 
 import uuid