feat: tree view for project submission structure, cleanups

backend/.tool-versions

@@ -0,0 +1 @@
+python 3.11.4

backend/api/logic/parse_zip_files.py

@@ -12,12 +12,13 @@ def parse_zip(project: Project, zip_file: InMemoryUploadedFile) -> bool:
 
     zip_file.seek(0)
 
-    with zipfile.ZipFile(zip_file, 'r') as zip:
-        files = zip.namelist()
+    with zipfile.ZipFile(zip_file, 'r') as zip_file:
+        files = zip_file.namelist()
         directories = [file for file in files if file.endswith('/')]
 
     # Check if all directories start the same
     common_prefix = os.path.commonprefix(directories)
+
     if '/' in common_prefix:
         prefixes = common_prefix.split('/')
         if common_prefix[-1] != '/':
@@ -31,6 +32,7 @@ def parse_zip(project: Project, zip_file: InMemoryUploadedFile) -> bool:
 
     # Add potential top level files
     top_level_files = [file for file in files if '/' not in file]
+
     if top_level_files:
         create_check(project, '', files)
 

backend/api/models/project.py

@@ -108,6 +108,6 @@ def increase_deadline(self, days):
         self.save()
 
     if TYPE_CHECKING:
-        groups: RelatedManager['Group']
-        structure_checks: RelatedManager['StructureCheck']
-        extra_checks: RelatedManager['ExtraCheck']
+        groups: RelatedManager[Group]
+        structure_checks: RelatedManager[StructureCheck]
+        extra_checks: RelatedManager[ExtraCheck]

backend/api/serializers/checks_serializer.py

@@ -3,104 +3,115 @@
 from api.models.project import Project
 from django.utils.translation import gettext as _
 from rest_framework import serializers
-from rest_framework.exceptions import ValidationError
+from rest_framework.exceptions import ValidationError, NotFound
 
 
 class FileExtensionSerializer(serializers.ModelSerializer):
+    extension = serializers.CharField(
+        required=True,
+        max_length=10
+    )
+
     class Meta:
         model = FileExtension
-        fields = ["extension"]
-
-
-class FileExtensionHyperLinkedRelatedField(serializers.HyperlinkedRelatedField):
-    view_name = "file-extensions-detail"
-    queryset = FileExtension.objects.all()
+        fields = ["id", "extension"]
 
-    def to_internal_value(self, data):
-        try:
-            return self.queryset.get(pk=data)
-        except FileExtension.DoesNotExist:
-            return self.fail("no_match")
 
-
-# TODO: Support partial updates
 class StructureCheckSerializer(serializers.ModelSerializer):
-
     project = serializers.HyperlinkedRelatedField(
-        view_name="project-detail",
-        read_only=True
+        read_only=True,
+        view_name="project-detail"
     )
 
-    obligated_extensions = FileExtensionSerializer(many=True, required=False, default=[])
-
-    blocked_extensions = FileExtensionSerializer(many=True, required=False, default=[])
-
-    class Meta:
-        model = StructureCheck
-        fields = "__all__"
-
+    obligated_extensions = FileExtensionSerializer(
+        many=True
+    )
 
-# TODO: Simplify
-class StructureCheckAddSerializer(StructureCheckSerializer):
+    blocked_extensions = FileExtensionSerializer(
+        many=True
+    )
 
     def validate(self, attrs):
+        """Validate the structure check"""
         project: Project = self.context["project"]
-        if project.structure_checks.filter(path=attrs["path"]).count():
+
+        # The structure check path should not exist already
+        if project.structure_checks.filter(path=attrs["path"]).exists():
             raise ValidationError(_("project.error.structure_checks.already_existing"))
 
-        obl_ext = set()
-        for ext in self.context["obligated"]:
-            extension, result = FileExtension.objects.get_or_create(
-                extension=ext
-            )
-            obl_ext.add(extension)
-        attrs["obligated_extensions"] = obl_ext
+        # The same extension should not be in both blocked and obligated
+        blocked = set([ext["extension"] for ext in attrs["blocked_extensions"]])
+        obligated = set([ext["extension"] for ext in attrs["obligated_extensions"]])
 
-        block_ext = set()
-        for ext in self.context["blocked"]:
-            extension, result = FileExtension.objects.get_or_create(
-                extension=ext
-            )
-            if extension in obl_ext:
-                raise ValidationError(_("project.error.structure_checks.extension_blocked_and_obligated"))
-            block_ext.add(extension)
-        attrs["blocked_extensions"] = block_ext
+        if blocked.intersection(obligated):
+            raise ValidationError(_("project.error.structure_checks.extension_blocked_and_obligated"))
 
         return attrs
 
+    def create(self, validated_data: dict) -> StructureCheck:
+        """Create a new structure check"""
+        blocked = validated_data.pop("blocked_extensions")
+        obligated = validated_data.pop("obligated_extensions")
 
-class DockerImagerHyperLinkedRelatedField(serializers.HyperlinkedRelatedField):
-    view_name = "docker-image-detail"
-    queryset = DockerImage.objects.all()
+        check: StructureCheck = StructureCheck.objects.create(
+            path=validated_data.pop("path"),
+            **validated_data
+        )
 
-    def to_internal_value(self, data):
-        try:
-            return self.queryset.get(pk=data)
-        except DockerImage.DoesNotExist:
-            return self.fail("no_match")
+        for ext in obligated:
+            ext, _ = FileExtension.objects.get_or_create(
+                extension=ext["extension"]
+            )
+            check.obligated_extensions.add(ext)
 
+        # Add blocked extensions
+        for ext in blocked:
+            ext, _ = FileExtension.objects.get_or_create(
+                extension=ext["extension"]
+            )
+            check.blocked_extensions.add(ext)
 
-class ExtraCheckSerializer(serializers.ModelSerializer):
+        return check
+
+    class Meta:
+        model = StructureCheck
+        fields = "__all__"
 
+
+class ExtraCheckSerializer(serializers.ModelSerializer):
     project = serializers.HyperlinkedRelatedField(
-        view_name="project-detail",
-        read_only=True
+        read_only=True,
+        view_name="project-detail"
     )
 
-    docker_image = DockerImagerHyperLinkedRelatedField()
+    docker_image = serializers.HyperlinkedRelatedField(
+        read_only=True,
+        view_name="docker-image-detail"
+    )
 
     class Meta:
         model = ExtraCheck
         fields = "__all__"
 
-    def validate(self, attrs):
+    def validate(self, attrs: dict) -> dict:
+        """Validate the extra check"""
         data = super().validate(attrs)
 
-        # Only check if docker image is present when it is not a partial update
-        if not self.partial:
-            if "docker_image" not in data:
-                raise serializers.ValidationError(_("extra_check.error.docker_image"))
+        # Check if the docker image is provided
+        if "docker_image" not in self.initial_data:
+            raise serializers.ValidationError(_("extra_check.error.docker_image"))
+
+        # Check if the docker image exists
+        image = DockerImage.objects.get(
+            id=self.initial_data["docker_image"]
+        )
+
+        if image is None:
+            raise NotFound(_("extra_check.error.docker_image"))
+
+        data["docker_image"] = image
 
+        # Check if the time limit and memory limit are in the correct range
         if "time_limit" in data and not 10 <= data["time_limit"] <= 1000:
             raise serializers.ValidationError(_("extra_check.error.time_limit"))
 

backend/api/serializers/course_serializer.py

@@ -45,7 +45,11 @@ class CourseSerializer(serializers.ModelSerializer):
 
     def validate(self, attrs: dict) -> dict:
         """Extra custom validation for course serializer"""
+        attrs = super().validate(attrs)
+
+        # Clean the description
         attrs['description'] = clean(attrs['description'])
+
         return attrs
 
     def to_representation(self, instance):

backend/api/serializers/fields/expandable_hyperlinked_field.py

@@ -0,0 +1,34 @@
+from typing import Type
+
+from rest_framework import serializers
+from rest_framework.request import Request
+from rest_framework.serializers import Serializer
+
+
+class ExpandableHyperlinkedIdentityField(serializers.HyperlinkedIdentityField):
+    """A HyperlinkedIdentityField with nested serializer expanding"""
+
+    def __init__(self, serializer: Type[Serializer], view_name: str = None, **kwargs):
+        self.serializer = serializer
+        super().__init__(view_name=view_name, **kwargs)
+
+    def get_url(self, obj: any, view_name: str, request: Request, fm: str):
+        """Get the URL of the related object"""
+        return super().get_url(obj, view_name, request, fm)
+
+    def to_representation(self, value):
+        """Get the representation of the nested instance"""
+        request: Request = self.context.get('request')
+
+        if request and self.field_name in request.query_params:
+            try:
+                instance = getattr(value, self.field_name)
+            except AttributeError:
+                instance = value
+
+            return self.serializer(instance,
+                                   many=self._kwargs.pop('many'),
+                                   context=self.context
+                                   ).data
+
+        return super().to_representation(value)

backend/api/serializers/project_serializer.py

@@ -1,15 +1,18 @@
+from django.core.files.uploadedfile import InMemoryUploadedFile
+
 from api.logic.parse_zip_files import parse_zip
 from api.models.group import Group
 from api.models.project import Project
 from api.models.submission import Submission, ExtraCheckResult, StructureCheckResult, StateEnum
 from api.serializers.course_serializer import CourseSerializer
-from django.core.files.uploadedfile import InMemoryUploadedFile
 from django.utils import timezone
 from django.utils.translation import gettext
 from nh3 import clean
 from rest_framework import serializers
 from rest_framework.exceptions import ValidationError
 
+from api.serializers.fields.expandable_hyperlinked_field import ExpandableHyperlinkedIdentityField
+
 
 class SubmissionStatusSerializer(serializers.Serializer):
     non_empty_groups = serializers.IntegerField(read_only=True)
@@ -30,7 +33,7 @@ def to_representation(self, instance: Project):
 
         #  The total amount of groups with at least one submission should never exceed the total number of non empty groups
         # (the seeder does not account for this restriction)
-        if (groups_submitted > non_empty_groups):
+        if groups_submitted > non_empty_groups:
             non_empty_groups = groups_submitted
 
         passed_structure_checks_submission_ids = StructureCheckResult.objects.filter(
@@ -61,7 +64,7 @@ def to_representation(self, instance: Project):
 
         # The total number of passed extra checks combined with the number of passed structure checks
         # can never exceed the total number of submissions (the seeder does not account for this restriction)
-        if (structure_checks_passed + extra_checks_passed > groups_submitted):
+        if structure_checks_passed + extra_checks_passed > groups_submitted:
             extra_checks_passed = groups_submitted - structure_checks_passed
 
         return {
@@ -93,13 +96,11 @@ class ProjectSerializer(serializers.ModelSerializer):
     )
 
     structure_checks = serializers.HyperlinkedIdentityField(
-        view_name="project-structure-checks",
-        read_only=True
+        view_name="project-structure-checks"
     )
 
     extra_checks = serializers.HyperlinkedIdentityField(
-        view_name="project-extra-checks",
-        read_only=True
+        view_name="project-extra-checks"
     )
 
     groups = serializers.HyperlinkedIdentityField(
@@ -146,6 +147,8 @@ def validate(self, attrs):
         return attrs
 
     def create(self, validated_data):
+        """Create the project object and create groups for the project if specified"""
+
         # Pop the 'number_groups' field from validated_data
         number_groups = validated_data.pop('number_groups', None)
 
@@ -162,7 +165,6 @@ def create(self, validated_data):
                 group.students.add(student)
 
         elif number_groups:
-
             for _ in range(number_groups):
                 Group.objects.create(project=project)
 
@@ -172,10 +174,11 @@ def create(self, validated_data):
             group_size = project.group_size
 
             for _ in range(0, number_students, group_size):
-                group = Group.objects.create(project=project)
+                Group.objects.create(project=project)
 
         # If a zip_structure is provided, parse it to create the structure checks
         zip_structure: InMemoryUploadedFile | None = self.context['request'].FILES.get('zip_structure')
+
         if zip_structure:
             result = parse_zip(project, zip_structure)