add tests for UUIDv7 history_id

Signed-off-by: Benjamin Skov Kaas-Hansen <[email protected]>

Author: epiben

simple_history/tests/models.py

@@ -797,6 +797,18 @@ class UUIDDefaultModel(models.Model):
     history = HistoricalRecords()
 
 
+# Set the SIMPLE_HISTORY_HISTORY_ID_UUID_VERSION
+setattr(settings, "SIMPLE_HISTORY_HISTORY_ID_UUID_VERSION", 7)
+
+
+class UUIDv7Model(models.Model):
+    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
+    history = HistoricalRecords()
+
+
+# Clear the SIMPLE_HISTORY_HISTORY_ID_UUID_VERSION
+delattr(settings, "SIMPLE_HISTORY_HISTORY_ID_UUID_VERSION")
+
 # Clear the SIMPLE_HISTORY_HISTORY_ID_USE_UUID
 delattr(settings, "SIMPLE_HISTORY_HISTORY_ID_USE_UUID")
 

simple_history/tests/tests/test_models.py

@@ -1,4 +1,5 @@
 import dataclasses
+import time
 import unittest
 import uuid
 import warnings
@@ -122,6 +123,7 @@
     UserTextFieldChangeReasonModel,
     UUIDDefaultModel,
     UUIDModel,
+    UUIDv7Model,
     WaterLevel,
 )
 from .utils import (
@@ -637,6 +639,21 @@ def test_uuid_default_history_id(self):
         history = entry.history.all()[0]
         self.assertTrue(isinstance(history.history_id, uuid.UUID))
 
+    def test_uuidv7_history_id(self):
+        """
+        Tests that UUIDv7 is being used for history_id when defined in the settings,
+        and that consequent PKs are ordered based on creation time.
+        """
+        entries = []
+        for _ in range(10):
+            entries.append(UUIDv7Model.objects.create())
+            time.sleep(0.01)  # Ensure increasing time part of UUIDv7 PKs
+
+        history = [entry.history.all()[0] for entry in entries]
+        self.assertTrue(all(isinstance(h.history_id, uuid.UUID) for h in history))
+        for h1, h2 in zip(history[:-1], history[1:]):
+            self.assertLess(h1.history_id, h2.history_id)
+
     def test_default_history_change_reason(self):
         entry = CharFieldChangeReasonModel.objects.create(greeting="what's up?")
         history = entry.history.get()