Merge pull request #10 from 4teamwork/jch/TI-2893

Fix MappingSerializer

Author: Joel-Luca

app/migrations/0005_electiondistrict_person_election_district.py

@@ -0,0 +1,62 @@
+# Generated by Django 4.2.23 on 2025-10-23 05:26
+
+import django.db.models.deletion
+import django_extensions.db.fields
+from django.db import migrations
+from django.db import models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("app", "0004_add_external_uid_field"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="ElectionDistrict",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "created",
+                    django_extensions.db.fields.CreationDateTimeField(
+                        auto_now_add=True, verbose_name="created"
+                    ),
+                ),
+                (
+                    "modified",
+                    django_extensions.db.fields.ModificationDateTimeField(
+                        auto_now=True, verbose_name="modified"
+                    ),
+                ),
+                ("uid", models.UUIDField(unique=True, verbose_name="UUID")),
+                ("title", models.CharField(unique=True, verbose_name="Title")),
+                ("number", models.CharField(verbose_name="Number")),
+            ],
+            options={
+                "verbose_name": "Election district",
+                "verbose_name_plural": "Election districts",
+                "ordering": ("title",),
+            },
+        ),
+        migrations.AddField(
+            model_name="person",
+            name="election_district",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="persons",
+                to="app.electiondistrict",
+                verbose_name="Election district",
+            ),
+        ),
+    ]

app/migrations/max_migration.txt

@@ -1 +1 @@
-0004_add_external_uid_field
+0005_electiondistrict_person_election_district

app/models/__init__.py

@@ -1,6 +1,7 @@
-__all__ = ["Address", "Municipality", "Person", "PersonType"]
+__all__ = ["Address", "ElectionDistrict", "Municipality", "Person", "PersonType"]
 
 from .address import Address
+from .election_distinct import ElectionDistrict
 from .municipality import Municipality
 from .person import Person
 from .person import PersonType

app/models/election_distinct.py

@@ -0,0 +1,16 @@
+from django.db import models
+from django_extensions.db.models import TimeStampedModel
+
+
+class ElectionDistrict(TimeStampedModel):
+    uid = models.UUIDField(verbose_name="UUID", unique=True)
+    title = models.CharField(verbose_name="Title", unique=True)
+    number = models.CharField(verbose_name="Number")
+
+    class Meta:
+        verbose_name = "Election district"
+        verbose_name_plural = "Election districts"
+        ordering = ("title",)
+
+    def __str__(self) -> str:
+        return "{} - {}".format(self.number, self.title)

app/models/person.py

@@ -35,6 +35,14 @@ class Person(CustomFieldBaseModel):
         verbose_name="Place of residence",
         related_name="persons",
     )
+    election_district = models.ForeignKey(
+        "ElectionDistrict",
+        on_delete=models.PROTECT,
+        blank=True,
+        null=True,
+        verbose_name="Election district",
+        related_name="persons",
+    )
 
     class Meta:
         verbose_name = "Person"

app/serializers/person.py

@@ -5,6 +5,8 @@
 from app.models import Person
 from app.serializers import BaseMappingSerializer
 from django_features.custom_fields.serializers import CustomFieldBaseModelSerializer
+from django_features.fields import ExternalUUIDRelatedField
+from django_features.fields import RelatedField
 
 
 class PersonSerializer(CustomFieldBaseModelSerializer):
@@ -18,6 +20,12 @@ class Meta:
 
 
 class PersonMappingSerializer(BaseMappingSerializer):
+    serializer_related_fields = {"addresses": ExternalUUIDRelatedField}
+
+    election_district = RelatedField(
+        related_field_name="title", allow_null=True, creation=False, required=False
+    )
+
     class Meta:
         model = Person
         fields = "__all__"

app/tests/factories/__init__.py

@@ -32,6 +32,15 @@ class Meta:
     email = "john.doe@example.com"
 
 
+class ElectionDistrictFactory(BaseFactory):
+    class Meta:
+        model = models.ElectionDistrict
+
+    uid = LazyFunction(lambda: uuid.uuid4())  # type: ignore
+    number = "1"
+    title = "Election District 1"
+
+
 class AddressFactory(BaseFactory):
     class Meta:
         model = models.Address

app/tests/test_mapping_serializer.py

@@ -5,15 +5,18 @@
 from constance.test import override_config
 from django.contrib.contenttypes.models import ContentType
 
+from app.models import ElectionDistrict
 from app.models import Municipality
 from app.models import Person
 from app.serializers.person import PersonMappingSerializer
 from app.tests import APITestCase
 from app.tests.custom_fields.factories import CustomFieldFactory
 from app.tests.custom_fields.factories import CustomValueFactory
 from app.tests.factories import AddressFactory
+from app.tests.factories import ElectionDistrictFactory
 from app.tests.factories import PersonFactory
 from django_features.custom_fields.models import CustomField
+from django_features.custom_fields.models import CustomValue
 
 
 MODEL_MAPPING_FIELD = {
@@ -30,6 +33,7 @@
         "external_choice_field": "choice_value",
         "external_multiple_choice_field": "multiple_choice_value",
         "external_municipality_title": "place_of_residence.title",
+        "external_election_district_title": "election_district",
         "external_addresses": "addresses",
     }
 }
@@ -42,66 +46,68 @@ class MappingSerializerTestCase(APITestCase):
     def setUp(self) -> None:
         self.person_ct = ContentType.objects.get_for_model(Person)
 
-        self.char_field = CustomFieldFactory(
+        self.char_field: CustomField = CustomFieldFactory(  # type: ignore
             identifier="char_value",
             content_type=self.person_ct,
             field_type=CustomField.FIELD_TYPES.CHAR,
         )
-        self.text_field = CustomFieldFactory(
+        self.text_field: CustomField = CustomFieldFactory(  # type: ignore
             identifier="text_value",
             content_type=self.person_ct,
             field_type=CustomField.FIELD_TYPES.TEXT,
         )
-        self.date_field = CustomFieldFactory(
+        self.date_field: CustomField = CustomFieldFactory(  # type: ignore
             identifier="date_value",
             content_type=self.person_ct,
             field_type=CustomField.FIELD_TYPES.DATE,
         )
-        self.datetime_field = CustomFieldFactory(
+        self.datetime_field: CustomField = CustomFieldFactory(  # type: ignore
             identifier="datetime_value",
             content_type=self.person_ct,
             field_type=CustomField.FIELD_TYPES.DATETIME,
         )
-        self.integer_field = CustomFieldFactory(
+        self.integer_field: CustomField = CustomFieldFactory(  # type: ignore
             identifier="integer_value",
             content_type=self.person_ct,
             field_type=CustomField.FIELD_TYPES.INTEGER,
         )
-        self.boolean_field = CustomFieldFactory(
+        self.boolean_field: CustomField = CustomFieldFactory(  # type: ignore
             identifier="boolean_value",
             content_type=self.person_ct,
             field_type=CustomField.FIELD_TYPES.BOOLEAN,
         )
-        self.multiple_date_field = CustomFieldFactory(
+        self.multiple_date_field: CustomField = CustomFieldFactory(  # type: ignore
             identifier="multiple_date_value",
             content_type=self.person_ct,
             field_type=CustomField.FIELD_TYPES.DATE,
             multiple=True,
         )
-        self.choice_field = CustomFieldFactory(
+        self.choice_field: CustomField = CustomFieldFactory(  # type: ignore
             identifier="choice_value",
             content_type=self.person_ct,
             field_type=CustomField.FIELD_TYPES.DATE,
             choice_field=True,
         )
-        self.multiple_choice_field = CustomFieldFactory(
+        self.multiple_choice_field: CustomField = CustomFieldFactory(  # type: ignore
             identifier="multiple_choice_value",
             content_type=self.person_ct,
             field_type=CustomField.FIELD_TYPES.DATE,
             choice_field=True,
             multiple=True,
         )
 
-        self.choice_1 = CustomValueFactory(field=self.choice_field, value="2000-01-01")
-        self.choice_2 = CustomValueFactory(field=self.choice_field, value="2001-01-01")
+        self.choice_1: CustomValue = CustomValueFactory(field=self.choice_field, value="2000-01-01")  # type: ignore
+        self.choice_2: CustomValue = CustomValueFactory(  # type: ignore
+            field=self.choice_field, value="2001-01-01"
+        )
 
-        self.multiple_choice_1 = CustomValueFactory(
+        self.multiple_choice_1: CustomValue = CustomValueFactory(  # type: ignore
             field=self.multiple_choice_field, value="2000-01-01"
         )
-        self.multiple_choice_2 = CustomValueFactory(
+        self.multiple_choice_2: CustomValue = CustomValueFactory(  # type: ignore
             field=self.multiple_choice_field, value="2001-01-01"
         )
-        self.multiple_choice_3 = CustomValueFactory(
+        self.multiple_choice_3: CustomValue = CustomValueFactory(  # type: ignore
             field=self.multiple_choice_field, value="2002-01-01"
         )
 
@@ -111,6 +117,8 @@ def setUp(self) -> None:
 
     @override_config(MODEL_MAPPING_FIELD=MODEL_MAPPING_FIELD)
     def test_mapping_serializer_create(self) -> None:
+        election_district = ElectionDistrictFactory(title="Koeniz")
+
         data = {
             "external_firstname": "Hugo",
             "external_lastname": "Boss",
@@ -124,6 +132,7 @@ def test_mapping_serializer_create(self) -> None:
             "external_choice_field": "2000-01-01",
             "external_multiple_choice_field": ["2000-01-01", "2001-01-01"],
             "external_municipality_title": "Muri",
+            "external_election_district_title": "Koeniz",
             "external_addresses": [
                 self.address_1.external_uid,
                 self.address_2.external_uid,
@@ -164,13 +173,21 @@ def test_mapping_serializer_create(self) -> None:
 
         self.assertEqual("Muri", instance.place_of_residence.title)
         self.assertEqual(1, Municipality.objects.count())
+
+        self.assertEqual(election_district, instance.election_district)
+        self.assertEqual(1, ElectionDistrict.objects.count())
+
         self.assertEqual(2, instance.addresses.count())
         self.assertEqual(instance, instance.addresses.first().target)
         self.assertEqual(instance, instance.addresses.last().target)
 
     @override_config(MODEL_MAPPING_FIELD=MODEL_MAPPING_FIELD)
     def test_mapping_serializer_update(self) -> None:
-        person: Person = PersonFactory(firstname="old", lastname="old")  # type: ignore
+        old_election_district = ElectionDistrictFactory(title="Old")
+        election_district = ElectionDistrictFactory(title="Koeniz")
+        person: Person = PersonFactory(  # type: ignore
+            firstname="old", lastname="old", election_district=old_election_district
+        )
 
         person.refresh_with_custom_fields()
 
@@ -187,6 +204,7 @@ def test_mapping_serializer_update(self) -> None:
             "external_choice_field": "2001-01-01",
             "external_multiple_choice_field": ["2000-01-01", "2002-01-01"],
             "external_municipality_title": "Koeniz",
+            "external_election_district_title": "Koeniz",
             "external_addresses": [
                 self.address_1.external_uid,
                 self.address_3.external_uid,
@@ -227,6 +245,10 @@ def test_mapping_serializer_update(self) -> None:
 
         self.assertEqual("Koeniz", instance.place_of_residence.title)
         self.assertEqual(1, Municipality.objects.count())
+
+        self.assertEqual(election_district, instance.election_district)
+        self.assertEqual(2, ElectionDistrict.objects.count())
+
         self.assertEqual(2, instance.addresses.count())
         self.assertEqual(person, instance.addresses.first().target)
         self.assertEqual(person, instance.addresses.last().target)

app/tests/test_mapping_serializer_data.py

@@ -0,0 +1,72 @@
+from typing import Any
+
+from app import models
+from app.tests import APITestCase
+from django_features.serializers import MappingSerializer
+
+
+class TestMappingSerializer(MappingSerializer):
+    class Meta:
+        model = models.Person
+        fields = "__all__"
+
+    @property
+    def mapping(self) -> dict[str, dict[str, Any]]:
+        return {
+            "person": {
+                "external_base_field": "base_field",
+                "external_single_field_1": "dict_field.nested_field_1",
+                "external_single_field_2": "dict_field.nested_field_2",
+                "external_dict_field.nested_field": "single_field",
+                "external_object_field.nested_external_field_1": "object_field.nested_field_1",
+                "external_object_field.nested_external_field_2": "object_field.nested_field_2",
+                "external_object_field_with_object.external_object_field_1.external_field_1": "object_field_with_object.object_field_1.field_1",  # noqa: E501
+                "external_object_field_with_object.external_object_field_1.external_field_2": "object_field_with_object.object_field_1.field_2",  # noqa: E501
+                "external_object_field_with_object.external_object_field_2.external_field_1": "object_field_with_object.object_field_2.field_1",  # noqa: E501
+                "external_object_field_with_object.external_object_field_2.external_field_2": "object_field_with_object.object_field_2.field_2",  # noqa: E501
+            }
+        }
+
+
+class MappingSerializerTestCase(APITestCase):
+    def test_mapping_serializer_map_initial_data(self) -> None:
+        data = {
+            "external_base_field": "base_value",
+            "external_single_field_1": "nested_value_1",
+            "external_single_field_2": "nested_value_2",
+            "external_dict_field": {"nested_field": "single_value"},
+            "external_object_field": {
+                "nested_external_field_1": "nested_value_1",
+                "nested_external_field_2": "nested_value_2",
+            },
+            "external_object_field_with_object": {
+                "external_object_field_1": {
+                    "external_field_1": "value_1",
+                    "external_field_2": "value_2",
+                },
+                "external_object_field_2": {
+                    "external_field_1": "value_1",
+                    "external_field_2": "value_2",
+                },
+            },
+        }
+
+        expected_data = {
+            "base_field": "base_value",
+            "dict_field": {
+                "nested_field_1": "nested_value_1",
+                "nested_field_2": "nested_value_2",
+            },
+            "single_field": "single_value",
+            "object_field": {
+                "nested_field_1": "nested_value_1",
+                "nested_field_2": "nested_value_2",
+            },
+            "object_field_with_object": {
+                "object_field_1": {"field_1": "value_1", "field_2": "value_2"},
+                "object_field_2": {"field_1": "value_1", "field_2": "value_2"},
+            },
+        }
+
+        mapped_data = TestMappingSerializer().map_data(data)
+        self.assertEqual(mapped_data, expected_data)

changes/TI-2893.other

@@ -0,0 +1 @@
+Improve MappingSerializer and add option for more related fields. (`TI-2893 <https://4teamwork.atlassian.net/browse/TI-2893>`_)