- Add map image serializer

- Add map images to the map serializer.
- Test map images return

Author: alexlambson

kirovy/models/cnc_map.py

@@ -238,8 +238,6 @@ class CncMapImageFile(file_base.CncNetFileBaseModel):
         ``name`` is auto-generated for this file subclass.
     """
 
-    objects = CncMapFileManager()
-
     width = models.IntegerField()
     height = models.IntegerField()
 
@@ -267,7 +265,8 @@ class Meta:
         indexes = [models.Index(fields=["cnc_map"])]
 
     def save(self, *args, **kwargs):
-        self.name = self.cnc_map.map_name
+        if not self.name:
+            self.name = self.cnc_map.map_name
         self.cnc_game = self.cnc_map.cnc_game
         super().save(*args, **kwargs)
 

kirovy/serializers/cnc_map_serializers.py

@@ -95,6 +95,76 @@ def update(self, instance: cnc_map.CncMapFile, validated_data: t.DictStrAny) ->
         )
 
 
+class CncMapImageFileSerializer(KirovySerializer):
+
+    class Meta:
+        model = cnc_map.CncMapImageFile
+        # We return the ID instead of the whole object.
+        exclude = ["cnc_game", "cnc_map", "file_extension", "hash_md5", "hash_sha512", "hash_sha1"]
+        fields = "__all__"
+
+    width = serializers.IntegerField()
+    """attr: The map height.
+
+    Extracted using :class:`kirovy.services.cnc_gen_2_services.CncGen2MapParser`
+    """
+
+    height = serializers.IntegerField()
+    """attr: The map height.
+
+    Extracted using :class:`kirovy.services.cnc_gen_2_services.CncGen2MapParser`
+    """
+
+    is_extracted = serializers.BooleanField()
+    """attr: Whether the image was automatically extracted from the map file.
+
+    Extracted using :class:`kirovy.services.cnc_gen_2_services.CncGen2MapParser`
+    """
+
+    cnc_map_id = serializers.PrimaryKeyRelatedField(
+        source="cnc_map",
+        queryset=cnc_map.CncMap.objects.all(),
+        pk_field=serializers.UUIDField(),
+    )
+
+    name = serializers.CharField(max_length=100, allow_null=True)
+    """attr: The filename.
+
+    If blank, uses map name in :func:`kirovy.models.cnc_map.CncMapImageFile.save`.
+    """
+
+    image_order = serializers.IntegerField(min_value=0)
+    """attr: The order in which the image will appear.
+
+    If there are collsions, we fallback to the created date.
+    """
+
+    file = serializers.FileField(use_url=True)
+
+    file_extension_id = serializers.PrimaryKeyRelatedField(
+        source="file_extension",
+        queryset=CncFileExtension.objects.filter(extension_type__in=cnc_map.CncMapImageFile.ALLOWED_EXTENSION_TYPES),
+        pk_field=serializers.UUIDField(),
+    )
+
+    cnc_game_id = serializers.PrimaryKeyRelatedField(
+        source="cnc_game",
+        queryset=CncGame.objects.all(),
+        pk_field=serializers.UUIDField(),
+    )
+
+    def create(self, validated_data: t.DictStrAny) -> cnc_map.CncMapImageFile:
+        image_file = cnc_map.CncMapImageFile(**validated_data)
+        image_file.save()
+        return image_file
+
+    def update(self, instance: cnc_map.CncMapImageFile, validated_data: t.DictStrAny) -> cnc_map.CncMapImageFile:
+        instance.name = validated_data.get("name", instance.name)
+        instance.image_order = validated_data.get("image_order", instance.image_order)
+        instance.save(update_fields=["name", "image_order"])
+        return instance
+
+
 class CncMapBaseSerializer(CncNetUserOwnedModelSerializer):
     map_name = serializers.CharField(
         required=True,
@@ -151,6 +221,9 @@ class CncMapBaseSerializer(CncNetUserOwnedModelSerializer):
         default=None,
     )
 
+    files = CncMapFileSerializer(many=True, read_only=True, source="cncmapfile_set")
+    images = CncMapImageFileSerializer(many=True, read_only=True, source="cncmapimagefile_set")
+
     # TODO: These serializer method fields really ought to be sub serializers
     # TODO: Make sure queries are optimized in the views for listing maps.
     latest_map_file_hash = serializers.SerializerMethodField()
@@ -160,7 +233,7 @@ class CncMapBaseSerializer(CncNetUserOwnedModelSerializer):
     class Meta:
         model = cnc_map.CncMap
         # We return the ID instead of the whole object.
-        exclude = ["cnc_game", "categories", "parent"]
+        exclude = ["cnc_game", "categories", "parent", "cnc_map_files"]
         fields = "__all__"
 
     def get_latest_map_file_hash(self, obj: cnc_map.CncMap) -> t.Optional[str]:

kirovy/views/cnc_map_views.py

@@ -155,7 +155,7 @@ def get_queryset(self):
             # Prefetch the categories because they're displayed like tags.
             # TODO: Since the category list is going to be somewhat small,
             #  maybe the UI should just cache them and I return IDs instead of objects?
-            .prefetch_related("categories", "cncmapfile_set")
+            .prefetch_related("categories", "cncmapfile_set", "cncmapimagefile_set")
         )
         return base_query
 

kirovy/views/map_upload_views.py

@@ -166,14 +166,22 @@ def extract_preview(self, new_map_file: cnc_map.CncMapFile, map_parser: CncGen2M
             image_extension = CncFileExtension.objects.get(extension="jpg")
             extracted_image.save(image_io, format="JPEG", quality=95)
             django_image = InMemoryUploadedFile(image_io, None, "temp.jpg", "image/jpeg", image_io.tell(), None)
-            new_map_preview = map_preview.MapPreview(
-                is_extracted=True,
-                cnc_map_file=new_map_file,
-                file=django_image,
-                file_extension=image_extension,
+            image_serializer = cnc_map_serializers.CncMapImageFileSerializer(
+                data=dict(
+                    name=None,  # will default to map name.
+                    width=extracted_image.width,
+                    height=extracted_image.height,
+                    is_extracted=True,
+                    cnc_map_id=new_map_file.cnc_map_id,
+                    cnc_game_id=new_map_file.cnc_game_id,
+                    file=django_image,
+                    file_extension_id=image_extension.id,
+                    image_order=999,
+                )
             )
-            new_map_preview.save()
-            extracted_image_url = new_map_preview.file.url
+            image_serializer.is_valid(raise_exception=True)
+            image_serializer.save()
+            extracted_image_url = image_serializer.instance.file.url
 
         return extracted_image_url
 

tests/models/test_cnc_map.py

@@ -18,7 +18,6 @@ def test_cnc_map_generate_upload_to(game_yuri, extension_map, file_map_desert, c
 
     This test will fail if you alter the initial migrations.
     """
-    settings.CNC_MAP_DIRECTORY = "worlds"  # Change default to check that the settings control the upload path.
     expected_path = pathlib.Path(
         settings.MEDIA_ROOT,
         "yr",
@@ -35,6 +34,7 @@ def test_cnc_map_generate_upload_to(game_yuri, extension_map, file_map_desert, c
         cnc_game=game_yuri,
         name=cnc_map.generate_versioned_name_for_file(),
     )
+    CncMapFile.UPLOAD_TYPE = "worlds"
     saved_map.save()
     saved_map.refresh_from_db()
 

tests/test_views/test_map_upload.py

@@ -7,6 +7,7 @@
 
 from kirovy import settings, typing as t
 from kirovy.constants.api_codes import UploadApiCodes
+from kirovy.models.cnc_map import CncMapImageFile
 from kirovy.utils import file_utils
 from kirovy.models import CncMap, CncMapFile, MapCategory
 from kirovy.response import KirovyResponse
@@ -49,6 +50,7 @@ def test_map_file_upload_happy_path(client_user, file_map_desert, game_yuri, ext
 
     map_object = CncMap.objects.get(id=response.data["result"]["cnc_map_id"])
     file_object = CncMapFile.objects.get(cnc_map_id=map_object.id)
+    image_object = CncMapImageFile.objects.get(cnc_map_id=map_object.id)
 
     assert map_object
 
@@ -76,6 +78,18 @@ def test_map_file_upload_happy_path(client_user, file_map_desert, game_yuri, ext
     assert response_map["legacy_upload_date"] is None, "Non legacy maps should never have this field."
     assert response_map["id"] == str(map_object.id)
 
+    # Check the get endpoint returns the files.
+    assert len(response_map["files"]) == 1
+    assert response_map["files"][0]["id"] == str(file_object.id)
+    assert response_map["files"][0]["file"].endswith(uploaded_file_url)
+
+    # Check that the image was included
+    assert len(response_map["images"]) == 1
+    assert response_map["images"][0]["id"] == str(image_object.id)
+    assert response_map["images"][0]["name"] == map_object.map_name
+    assert response_map["images"][0]["file"].endswith(uploaded_image_url)
+    assert response_map["images"][0]["is_extracted"] is True
+
 
 def test_map_file_upload_banned_user(file_map_desert, game_yuri, client_banned):
     """Test that a banned user cannot upload a new map."""