Moved assertRecordValues() to new HistoricalTestCase

This makes the method available for use in other test cases.

Author: ddabble

simple_history/tests/tests/test_models.py

@@ -30,11 +30,6 @@
     pre_create_historical_m2m_records,
     pre_create_historical_record,
 )
-from simple_history.tests.tests.utils import (
-    database_router_override_settings,
-    database_router_override_settings_history_in_diff_db,
-    middleware_override_settings,
-)
 from simple_history.utils import get_history_model_for_model, update_change_reason
 
 from ..external.models import (
@@ -126,6 +121,12 @@
     UUIDModel,
     WaterLevel,
 )
+from .utils import (
+    HistoricalTestCase,
+    database_router_override_settings,
+    database_router_override_settings_history_in_diff_db,
+    middleware_override_settings,
+)
 
 get_model = apps.get_model
 User = get_user_model()
@@ -140,18 +141,10 @@ def get_fake_file(filename):
     return fake_file
 
 
-class HistoricalRecordsTest(TestCase):
+class HistoricalRecordsTest(HistoricalTestCase):
     def assertDatetimesEqual(self, time1, time2):
         self.assertAlmostEqual(time1, time2, delta=timedelta(seconds=2))
 
-    def assertRecordValues(self, record, klass, values_dict):
-        for key, value in values_dict.items():
-            self.assertEqual(getattr(record, key), value)
-        self.assertEqual(record.history_object.__class__, klass)
-        for key, value in values_dict.items():
-            if key not in ["history_type", "history_change_reason"]:
-                self.assertEqual(getattr(record.history_object, key), value)
-
     def test_create(self):
         p = Poll(question="what's up?", pub_date=today)
         p.save()

simple_history/tests/tests/utils.py

@@ -1,9 +1,9 @@
 from enum import Enum
+from typing import Type
 
-import django
 from django.conf import settings
-
-from simple_history.tests.models import HistoricalModelWithHistoryInDifferentDb
+from django.db.models import Model
+from django.test import TestCase
 
 request_middleware = "simple_history.middleware.HistoryRequestMiddleware"
 
@@ -14,6 +14,27 @@
 }
 
 
+class HistoricalTestCase(TestCase):
+    def assertRecordValues(self, record, klass: Type[Model], values_dict: dict):
+        """
+        Fail if ``record`` doesn't contain the field values in ``values_dict``.
+        ``record.history_object`` is also checked.
+        History-tracked fields in ``record`` that are not in ``values_dict``, are not
+        checked.
+
+        :param record: A historical record.
+        :param klass: The type of the history-tracked class of ``record``.
+        :param values_dict: Field names of ``record`` mapped to their expected values.
+        """
+        for key, value in values_dict.items():
+            self.assertEqual(getattr(record, key), value)
+
+        self.assertEqual(record.history_object.__class__, klass)
+        for key, value in values_dict.items():
+            if key not in ("history_type", "history_change_reason"):
+                self.assertEqual(getattr(record.history_object, key), value)
+
+
 class TestDbRouter:
     def db_for_read(self, model, **hints):
         if model._meta.app_label == "external":
@@ -46,23 +67,35 @@ def allow_migrate(self, db, app_label, model_name=None, **hints):
 
 class TestModelWithHistoryInDifferentDbRouter:
     def db_for_read(self, model, **hints):
+        # Avoids circular importing
+        from ..models import HistoricalModelWithHistoryInDifferentDb
+
         if model == HistoricalModelWithHistoryInDifferentDb:
             return OTHER_DB_NAME
         return None
 
     def db_for_write(self, model, **hints):
+        # Avoids circular importing
+        from ..models import HistoricalModelWithHistoryInDifferentDb
+
         if model == HistoricalModelWithHistoryInDifferentDb:
             return OTHER_DB_NAME
         return None
 
     def allow_relation(self, obj1, obj2, **hints):
+        # Avoids circular importing
+        from ..models import HistoricalModelWithHistoryInDifferentDb
+
         if isinstance(obj1, HistoricalModelWithHistoryInDifferentDb) or isinstance(
             obj2, HistoricalModelWithHistoryInDifferentDb
         ):
             return False
         return None
 
     def allow_migrate(self, db, app_label, model_name=None, **hints):
+        # Avoids circular importing
+        from ..models import HistoricalModelWithHistoryInDifferentDb
+
         if model_name == HistoricalModelWithHistoryInDifferentDb._meta.model_name:
             return db == OTHER_DB_NAME
         return None