Make Report and Photo primary keys UUIDField.

Author: epou

.gitignore

@@ -265,9 +265,6 @@ Session.vim
 # Temporary
 .netrwhist
 
-# Auto-generated tag files
-tags
-
 # Redis dump file
 dump.rdb
 

config/settings/base.py

@@ -110,9 +110,9 @@
     "mosquito_alert.images",
     "mosquito_alert.individuals",
     "mosquito_alert.moderation",
-    "mosquito_alert.moderation.apps.FlagConfig",
     "mosquito_alert.notifications",
     "mosquito_alert.reports",
+    "mosquito_alert.tags",
     "mosquito_alert.taxa",
     "mosquito_alert.users",
 ]

mosquito_alert/geo/tests/test_models.py

@@ -518,10 +518,10 @@ def test_location_is_deleted_on_self_delete(self):
         loc = LocationFactory()
         geo_loc = self.factory_cls(location=loc)
 
-        assert Location.objects.all().count() == 1
-
         geo_loc.delete()
-        assert Location.objects.all().count() == 0
+
+        with pytest.raises(Location.DoesNotExist):
+            Location.objects.get(pk=loc.pk)
 
 
 @pytest.mark.django_db

mosquito_alert/images/migrations/0001_initial.py

@@ -1,5 +1,7 @@
 # Generated by Django 4.0.8 on 2023-03-01 13:06
 
+import uuid
+
 from django.conf import settings
 from django.db import migrations, models
 import django.db.models.deletion
@@ -8,7 +10,6 @@
 
 
 class Migration(migrations.Migration):
-
     initial = True
 
     dependencies = [
@@ -17,18 +18,32 @@ class Migration(migrations.Migration):
 
     operations = [
         migrations.CreateModel(
-            name='Photo',
+            name="Photo",
             fields=[
-                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('image', mosquito_alert.images.fields.ProcessedImageField(upload_to=mosquito_alert.images.models.image_upload_to)),
-                ('created_at', models.DateTimeField(auto_now_add=True)),
-                ('user', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='photos', to=settings.AUTH_USER_MODEL)),
+                ("id", models.UUIDField(default=uuid.uuid4, editable=False, primary_key=True, serialize=False)),
+                (
+                    "image",
+                    mosquito_alert.images.fields.ProcessedImageField(
+                        upload_to=mosquito_alert.images.models.image_upload_to
+                    ),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                (
+                    "user",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="photos",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
             ],
             options={
-                'verbose_name': 'photo',
-                'verbose_name_plural': 'photos',
-                'ordering': ['-created_at'],
-                'permissions': [('view_exif', 'Can view exif metadata')],
+                "verbose_name": "photo",
+                "verbose_name_plural": "photos",
+                "ordering": ["-created_at"],
+                "permissions": [("view_exif", "Can view exif metadata")],
             },
         ),
     ]

mosquito_alert/images/models.py

@@ -1,6 +1,5 @@
 import os
 import uuid
-from pathlib import Path
 
 from django.conf import settings
 from django.db import models
@@ -20,17 +19,13 @@ def image_upload_to(instance, filename):
     # a recommended extension is already found in the filename
     _, ext = os.path.splitext(filename)
 
-    # Checking if filename is already a valid UUID.
-    # Using it if it is valid.
-    try:
-        uuid_str = uuid.UUID(hex=Path(filename).stem, version=4)
-    except ValueError:
-        # Creating a new uuid
-        uuid_str = uuid.uuid4()
-    return os.path.join("images", f"{uuid_str}{ext}")
+    return os.path.join("images", f"{instance.id}{ext}")
 
 
+# NOTE: FlagModeratedModel uses UUID as pk
 class Photo(FlagModeratedModel, TimeStampedModel):
+    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
+
     # Relations
     user = models.ForeignKey(
         settings.AUTH_USER_MODEL,
@@ -90,4 +85,4 @@ class Meta(FlagModeratedModel.Meta, TimeStampedModel.Meta):
         ]
 
     def __str__(self):
-        return os.path.basename(self.image.name)
+        return str(self.id)

mosquito_alert/images/tests/factories.py

@@ -1,12 +1,13 @@
 import factory
-from factory.django import DjangoModelFactory, ImageField
+from factory.django import ImageField
 
+from mosquito_alert.moderation.tests.factories import BaseFlagModeratedModelFactory
 from mosquito_alert.users.tests.factories import UserFactory
 
 from ..models import Photo
 
 
-class PhotoFactory(DjangoModelFactory):
+class PhotoFactory(BaseFlagModeratedModelFactory):
     user = factory.SubFactory(UserFactory)
     image = ImageField()
 

mosquito_alert/images/tests/test_admin.py

@@ -44,10 +44,10 @@ def test_add(self, client, admin_user):
             url,
             data={
                 "image": image,
-                "flag-flag-content_type-object_id-TOTAL_FORMS": "0",
-                "flag-flag-content_type-object_id-INITIAL_FORMS": "0",
-                "flag-flag-content_type-object_id-empty-flags-TOTAL_FORMS": "0",
-                "flag-flag-content_type-object_id-empty-flags-INITIAL_FORMS": "0",
+                "moderation-flag-content_type-object_id-TOTAL_FORMS": "0",
+                "moderation-flag-content_type-object_id-INITIAL_FORMS": "0",
+                "moderation-flag-content_type-object_id-empty-flags-TOTAL_FORMS": "0",
+                "moderation-flag-content_type-object_id-empty-flags-INITIAL_FORMS": "0",
                 "photo_identification_tasks-TOTAL_FORMS": "0",
                 "photo_identification_tasks-INITIAL_FORMS": "0",
             },

mosquito_alert/images/tests/test_models.py

@@ -1,9 +1,11 @@
 import os
+import uuid
 
 import pytest
 from django.db import models
 from PIL import Image
 
+from mosquito_alert.moderation.tests.test_models import BaseTestFlagModeratedModel
 from mosquito_alert.utils.tests.test_models import BaseTestTimeStampedModel
 
 from ..models import Photo
@@ -12,7 +14,7 @@
 
 
 @pytest.mark.django_db
-class TestPhoto(BaseTestTimeStampedModel):
+class TestPhoto(BaseTestFlagModeratedModel, BaseTestTimeStampedModel):
     model = Photo
     factory_cls = PhotoFactory
 
@@ -34,17 +36,11 @@ def test_image_is_uploaded_in_images_path(self):
         p = self.factory_cls()
         assert os.path.dirname(p.image.name) == "images"
 
-    def test_image_filaname_is_replaced_to_uuid(self, mocker):
-        mocker.patch("uuid.uuid4", return_value="mocked_uuid")
-
-        p = self.factory_cls(image__filename="example.jpg")
-        filename, _ = os.path.splitext(os.path.basename(p.image.name))
-        assert filename == "mocked_uuid"
-
-    def test_image_filename_is_kept_if_already_uuid(self):
-        p = self.factory_cls(image__filename="5c240771-4f46-4d0b-972e-a2c0edd31451.png")
+    def test_image_filaname_is_replaced_to_uuid_from_id(self):
+        new_uuid = uuid.uuid4()
+        p = self.factory_cls(id=new_uuid, image__filename="example.jpg")
         filename, _ = os.path.splitext(os.path.basename(p.image.name))
-        assert filename == "5c240771-4f46-4d0b-972e-a2c0edd31451"
+        assert filename == str(new_uuid)
 
     def test_image_is_converted_to_webp(self):
         assert self.model._meta.get_field("image")._original_spec.format == "WEBP"
@@ -145,5 +141,7 @@ def test_default_orderding_shows_newest_first(self):
         assert self.model._meta.ordering == ["-created_at"]
 
     def test__str__(self):
-        p = self.factory_cls(image__filename="5c240771-4f46-4d0b-972e-a2c0edd31451.webp")
-        assert p.__str__() == "5c240771-4f46-4d0b-972e-a2c0edd31451.webp"
+        new_uuid = uuid.uuid4()
+
+        p = self.factory_cls(id=new_uuid)
+        assert p.__str__() == str(new_uuid)

mosquito_alert/moderation/admin.py

@@ -1,8 +1,9 @@
 from django.contrib.admin.options import InlineModelAdmin
 from django.contrib.contenttypes.admin import GenericInlineModelAdmin
-from flag.models import Flag, FlagInstance
 from nested_admin.nested import NestedGenericTabularInlineMixin, NestedTabularInlineMixin
 
+from .models import Flag, FlagInstance
+
 
 class FlagInstanceInlineAdmin(InlineModelAdmin):
     model = FlagInstance

mosquito_alert/moderation/apps.py

@@ -1,10 +1,4 @@
 from django.apps import AppConfig
-from flag.apps import FlagConfig as OriginalFlagConfig
-
-
-class FlagConfig(OriginalFlagConfig):
-    # Overriding FlagConfig to avoid extra migrations when running makemigrations.
-    default_auto_field = "django.db.models.AutoField"
 
 
 class ModerationConfig(AppConfig):