Add DataSourceVersionsSynchronization.clean_data_source_versions()

iaso/migrations/0314_datasourceversionssynchronization_and_more.py

@@ -1,4 +1,4 @@
-# Generated by Django 4.2.17 on 2024-12-24 14:43
+# Generated by Django 4.2.17 on 2024-12-24 15:02
 
 from django.conf import settings
 from django.db import migrations, models
@@ -62,7 +62,7 @@ class Migration(migrations.Migration):
                 (
                     "source_version_to_compare_with",
                     models.ForeignKey(
-                        help_text="The pyramid as a comparison.",
+                        help_text="The version of the pyramid to use as a comparison.",
                         on_delete=django.db.models.deletion.CASCADE,
                         related_name="synchronized_as_source_version_to_compare_with",
                         to="iaso.sourceversion",
@@ -71,7 +71,7 @@ class Migration(migrations.Migration):
                 (
                     "source_version_to_update",
                     models.ForeignKey(
-                        help_text="The pyramid for which we want to generate change requests.",
+                        help_text="The version of the pyramid for which we want to generate change requests.",
                         on_delete=django.db.models.deletion.CASCADE,
                         related_name="synchronized_as_source_version_to_update",
                         to="iaso.sourceversion",

iaso/models/data_source.py

@@ -3,6 +3,7 @@
 
 from django.contrib.auth.models import AnonymousUser, User
 from django.contrib.postgres.fields import ArrayField
+from django.core.exceptions import ValidationError
 from django.db import models
 from django.utils.translation import gettext_lazy as _
 
@@ -206,13 +207,13 @@ class DataSourceVersionsSynchronization(models.Model):
         SourceVersion,
         on_delete=models.CASCADE,
         related_name="synchronized_as_source_version_to_update",
-        help_text=_("The pyramid for which we want to generate change requests."),
+        help_text=_("The version of the pyramid for which we want to generate change requests."),
     )
     source_version_to_compare_with = models.ForeignKey(
         SourceVersion,
         on_delete=models.CASCADE,
         related_name="synchronized_as_source_version_to_compare_with",
-        help_text=_("The pyramid as a comparison."),
+        help_text=_("The version of the pyramid to use as a comparison."),
     )
 
     # The exact JSON format is defined in `iaso.diffing.dumper.DataSourceVersionsSynchronizationEncoder`.
@@ -249,6 +250,20 @@ class Meta:
     def __str__(self) -> str:
         return self.name
 
+    def save(self, *args, **kwargs):
+        self.clean()
+        super().save(*args, **kwargs)
+
+    def clean(self, *args, **kwargs):
+        super().clean()
+        self.clean_data_source_versions()
+
+    def clean_data_source_versions(self) -> None:
+        if self.source_version_to_update.data_source_id != self.source_version_to_compare_with.data_source_id:
+            raise ValidationError({"__all__": "The two versions to compare must be linked to the same data source."})
+        if self.source_version_to_update.pk == self.source_version_to_compare_with.pk:
+            raise ValidationError({"__all__": "The two versions to compare must be different."})
+
     @property
     def total_change_requests(self):
         return self.count_create + self.count_update

iaso/tests/models/test_data_source_synchronization.py → iaso/tests/models/test_data_source_versions_synchronization.py

@@ -5,6 +5,7 @@
 import time_machine
 
 from django.contrib.gis.geos import MultiPolygon, Polygon
+from django.core.exceptions import ValidationError
 
 from iaso import models as m
 from iaso.test import TestCase
@@ -167,6 +168,37 @@ def test_create(self):
         self.assertEqual(data_source_sync.created_at, self.DT)
         self.assertEqual(data_source_sync.updated_at, self.DT)
 
+    def test_clean_data_source_versions(self):
+        other_data_source = m.DataSource.objects.create(name="Other data source")
+        other_source_version = m.SourceVersion.objects.create(
+            data_source=other_data_source, number=1, description="Other data source version"
+        )
+        kwargs = {
+            "name": "Foo",
+            "source_version_to_update": self.source_version_to_update,
+            "source_version_to_compare_with": other_source_version,
+            "account": self.account,
+            "created_by": self.user,
+        }
+        data_source_sync = m.DataSourceVersionsSynchronization(**kwargs)
+
+        with self.assertRaises(ValidationError) as error:
+            data_source_sync.clean_data_source_versions()
+        self.assertIn("The two versions to compare must be linked to the same data source.", error.exception.messages)
+
+        kwargs = {
+            "name": "Foo",
+            "source_version_to_update": self.source_version_to_update,
+            "source_version_to_compare_with": self.source_version_to_update,
+            "account": self.account,
+            "created_by": self.user,
+        }
+        data_source_sync = m.DataSourceVersionsSynchronization(**kwargs)
+
+        with self.assertRaises(ValidationError) as error:
+            data_source_sync.clean_data_source_versions()
+        self.assertIn("The two versions to compare must be different.", error.exception.messages)
+
     def test_create_json_diff(self):
         """
         Test that `create_json_diff()` works as expected.