Don't defer validation of null foreignkey references

Author: jamalex

morango/models/core.py

@@ -900,6 +900,8 @@ def deferred_clean_fields(self):
         for field in self._meta.fields:
             if not isinstance(field, models.ForeignKey):
                 continue
+            if getattr(self, field.attname) is None:
+                continue
             excluded_fields.append(field.name)
             deferred_fks[field.related_model.__name__].append(
                 ForeignKeyReference(from_pk=self.pk, to_pk=getattr(self, field.attname))

tests/testapp/facility_profile/migrations/0002_auto_20220427_0449.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.29 on 2022-04-27 04:49
+from __future__ import unicode_literals
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('facility_profile', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='interactionlog',
+            name='user',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL),
+        ),
+    ]

tests/testapp/facility_profile/models.py

@@ -94,7 +94,7 @@ class InteractionLog(FacilityDataSyncableModel):
     # Morango syncing settings
     morango_model_name = "contentinteractionlog"
 
-    user = models.ForeignKey(MyUser)
+    user = models.ForeignKey(MyUser, blank=True, null=True)
     content_id = UUIDField(db_index=True, default=uuid.uuid4)
 
     def calculate_source_id(self, *args, **kwargs):

tests/testapp/tests/sync/test_controller.py

@@ -8,6 +8,7 @@
 from django.test import TestCase
 from facility_profile.models import Facility
 from facility_profile.models import MyUser
+from facility_profile.models import InteractionLog
 from facility_profile.models import SummaryLog
 from test.support import EnvironmentVarGuard
 
@@ -616,6 +617,12 @@ def _test_deserialization_of_model_with_missing_parent(self, correct_self_ref_fk
         self.assertTrue(new_child.dirty_bit)
         self.assertIn("exist", new_child.deserialization_error)
 
+
+class ForeignKeyDeserializationTestCase(TestCase):
+    def setUp(self):
+        (self.current_id, _) = InstanceIDModel.get_or_create_current_instance()
+        self.mc = MorangoProfileController("facilitydata")
+
     def test_deserialization_of_model_with_missing_foreignkey_referent(self):
 
         user = MyUser.objects.create(username="penguin")
@@ -636,6 +643,67 @@ def test_deserialization_of_model_with_missing_foreignkey_referent(self):
         self.assertTrue(new_log.dirty_bit)
         self.assertIn("missing MyUser", new_log.deserialization_error)
 
+    def test_deserialization_of_model_with_disallowed_null_foreignkey(self):
+
+        user = MyUser.objects.create(username="penguin")
+        log = SummaryLog.objects.create(user=user)
+        self.mc.serialize_into_store()
+
+        new_log = Store.objects.get(id=log.id)
+        data = json.loads(new_log.serialized)
+        new_log.id = data["id"] = "f" * 32
+        data["user_id"] = None
+        new_log.serialized = json.dumps(data)
+        new_log.dirty_bit = True
+        new_log.save()
+
+        self.mc.deserialize_from_store()
+
+        new_log.refresh_from_db()
+        self.assertTrue(new_log.dirty_bit)
+        self.assertIn("cannot be null", new_log.deserialization_error)
+
+    def test_deserialization_of_model_with_allowed_null_foreignkey(self):
+
+        user = MyUser.objects.create(username="penguin")
+        log = InteractionLog.objects.create(user=user)
+        self.mc.serialize_into_store()
+
+        new_log = Store.objects.get(id=log.id)
+        data = json.loads(new_log.serialized)
+        new_log.id = data["id"] = "f" * 32
+        data["user_id"] = None
+        new_log.serialized = json.dumps(data)
+        new_log.dirty_bit = True
+        new_log.save()
+
+        self.mc.deserialize_from_store()
+
+        new_log.refresh_from_db()
+        self.assertFalse(new_log.dirty_bit)
+        self.assertTrue(new_log.deserialization_error == "")
+        self.assertTrue(InteractionLog.objects.filter(id=new_log.id).exists())
+
+    def test_deserialization_of_model_with_valid_foreignkey_referent(self):
+
+        user = MyUser.objects.create(username="penguin")
+        log = SummaryLog.objects.create(user=user)
+        self.mc.serialize_into_store()
+
+        new_log = Store.objects.get(id=log.id)
+        data = json.loads(new_log.serialized)
+        new_log.id = data["id"] = "f" * 32
+        new_log.serialized = json.dumps(data)
+        new_log.dirty_bit = True
+        new_log.save()
+
+        self.mc.deserialize_from_store()
+
+        new_log.refresh_from_db()
+        self.assertFalse(new_log.dirty_bit)
+        self.assertTrue(new_log.deserialization_error == "")
+        self.assertTrue(SummaryLog.objects.filter(id=new_log.id).exists())
+
 
 class SessionControllerTestCase(SimpleTestCase):
     def setUp(self):