Use proper serializer_class for the ProjectViewSet (#1952)

Signed-off-by: tdruez <[email protected]>

Author: tdruez

.github/workflows/run-unit-tests-macos.yml

@@ -17,7 +17,7 @@ env:
 
 jobs:
   run-unit-tests:
-    runs-on: macos-13
+    runs-on: macos-15
 
     strategy:
       matrix:
@@ -32,16 +32,18 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: ikalnytskyi/action-setup-postgres@v7
-        id: postgres
+      - name: Set up PostgreSQL
+        uses: ikalnytskyi/action-setup-postgres@v8
         with:
-          postgres-version: "14"  # 13 is not supported.
+          postgres-version: "17"
           database: ${{ env.POSTGRES_DB }}
           username: ${{ env.POSTGRES_USER }}
           password: ${{ env.POSTGRES_PASSWORD }}
           port: 5432
 
+      - name: Install libmagic
+        run: brew install libmagic
+
       - name: Install Python dependencies
         run: make dev envfile
 

.github/workflows/run-unit-tests.yml

@@ -22,7 +22,7 @@ jobs:
 
     services:
       postgres:
-        image: postgres:13
+        image: postgres:17
         env:
           POSTGRES_DB: ${{ env.POSTGRES_DB }}
           POSTGRES_USER: ${{ env.POSTGRES_USER }}

scanpipe/api/serializers.py

@@ -518,6 +518,20 @@ def get_traceback(self, project_error):
         return project_error.traceback.splitlines()
 
 
+class InputSerializer(serializers.Serializer):
+    """Serializer used in the `ProjectViewSet.add_input` action."""
+
+    upload_file = serializers.FileField(required=False, help_text="A file to upload.")
+    upload_file_tag = serializers.CharField(
+        required=False,
+        allow_blank=True,
+        help_text="An optional tag to add on the uploaded file.",
+    )
+    input_urls = serializers.ListField(
+        required=False, default=list, help_text="A list of URLs to download."
+    )
+
+
 class PipelineSerializer(PipelineChoicesMixin, serializers.ModelSerializer):
     """Serializer used in the `ProjectViewSet.add_pipeline` action."""
 
@@ -536,6 +550,50 @@ class Meta:
         ]
 
 
+class ProjectArchiveSerializer(serializers.Serializer):
+    """Serializer for the `ProjectViewSet.archive` action."""
+
+    remove_input = serializers.BooleanField(
+        required=False,
+        default=False,
+        help_text=(
+            "Delete the input directory during archival. "
+            "InputSource entries are kept for reference."
+        ),
+    )
+    remove_codebase = serializers.BooleanField(
+        required=False,
+        default=False,
+        help_text="Delete the codebase directory during archival.",
+    )
+    remove_output = serializers.BooleanField(
+        required=False,
+        default=False,
+        help_text="Delete the output directory during archival.",
+    )
+
+
+class ProjectResetSerializer(serializers.Serializer):
+    """Serializer for the `ProjectViewSet.reset` action."""
+
+    keep_input = serializers.BooleanField(
+        required=False,
+        default=True,
+        initial=True,
+        help_text="Keep the input directory and input sources when resetting.",
+    )
+    restore_pipelines = serializers.BooleanField(
+        required=False,
+        default=False,
+        help_text="Restore all pipelines that were previously existing on the project.",
+    )
+    execute_now = serializers.BooleanField(
+        required=False,
+        default=False,
+        help_text="Execute the restored pipelines immediately after restoration.",
+    )
+
+
 def get_model_serializer(model_class):
     """Return a Serializer class that ia related to a given `model_class`."""
     serializer = {

scanpipe/api/views.py

@@ -41,8 +41,11 @@
 from scanpipe.api.serializers import CodebaseResourceSerializer
 from scanpipe.api.serializers import DiscoveredDependencySerializer
 from scanpipe.api.serializers import DiscoveredPackageSerializer
+from scanpipe.api.serializers import InputSerializer
 from scanpipe.api.serializers import PipelineSerializer
+from scanpipe.api.serializers import ProjectArchiveSerializer
 from scanpipe.api.serializers import ProjectMessageSerializer
+from scanpipe.api.serializers import ProjectResetSerializer
 from scanpipe.api.serializers import ProjectSerializer
 from scanpipe.api.serializers import RunSerializer
 from scanpipe.api.serializers import WebhookSubscriptionSerializer
@@ -356,7 +359,7 @@ def add_pipeline(self, request, *args, **kwargs):
         }
         return ErrorResponse(message)
 
-    @action(detail=True, methods=["get", "post"])
+    @action(detail=True, methods=["get", "post"], serializer_class=InputSerializer)
     def add_input(self, request, *args, **kwargs):
         project = self.get_object()
 
@@ -365,9 +368,15 @@ def add_input(self, request, *args, **kwargs):
                 "Cannot add inputs once a pipeline has started to execute."
             )
 
-        upload_file = request.data.get("upload_file")
-        upload_file_tag = request.data.get("upload_file_tag", "")
-        input_urls = request.data.get("input_urls", [])
+        # Validate input using the action serializer
+        serializer = self.get_serializer(data=request.data)
+        if not serializer.is_valid():
+            return ErrorResponse(serializer.errors)
+
+        # Extract validated data
+        upload_file = serializer.validated_data.get("upload_file")
+        upload_file_tag = serializer.validated_data.get("upload_file_tag", "")
+        input_urls = serializer.validated_data.get("input_urls", [])
 
         if not (upload_file or input_urls):
             return ErrorResponse("upload_file or input_urls required.")
@@ -393,24 +402,25 @@ def add_input(self, request, *args, **kwargs):
     def add_webhook(self, request, *args, **kwargs):
         project = self.get_object()
 
-        # Validate input using the serializer
-        serializer = WebhookSubscriptionSerializer(data=request.data)
-        if serializer.is_valid():
-            project.add_webhook_subscription(**serializer.validated_data)
-            return Response(
-                {"status": "Webhook added."}, status=status.HTTP_201_CREATED
-            )
+        # Validate input using the action serializer
+        serializer = self.get_serializer(data=request.data)
+        if not serializer.is_valid():
+            return ErrorResponse(serializer.errors)
 
-        # Return validation errors
-        return ErrorResponse(serializer.errors)
+        project.add_webhook_subscription(**serializer.validated_data)
+        return Response({"status": "Webhook added."}, status=status.HTTP_201_CREATED)
 
     def destroy(self, request, *args, **kwargs):
         try:
             return super().destroy(request, *args, **kwargs)
         except RunInProgressError:
             return ErrorResponse("Cannot delete project while a run is in progress.")
 
-    @action(detail=True, methods=["get", "post"])
+    @action(
+        detail=True,
+        methods=["get", "post"],
+        serializer_class=ProjectArchiveSerializer,
+    )
     def archive(self, request, *args, **kwargs):
         project = self.get_object()
 
@@ -423,36 +433,41 @@ def archive(self, request, *args, **kwargs):
             )
             return Response({"status": message})
 
+        # Validate input using the action serializer
+        serializer = self.get_serializer(data=request.data)
+        if not serializer.is_valid():
+            return ErrorResponse(serializer.errors)
+
         try:
-            project.archive(
-                remove_input=request.data.get("remove_input"),
-                remove_codebase=request.data.get("remove_codebase"),
-                remove_output=request.data.get("remove_output"),
-            )
+            project.archive(**serializer.validated_data)
         except RunInProgressError:
             return ErrorResponse("Cannot archive project while a run is in progress.")
 
         return Response({"status": f"The project {project} has been archived."})
 
-    @action(detail=True, methods=["get", "post"])
+    @action(
+        detail=True,
+        methods=["get", "post"],
+        serializer_class=ProjectResetSerializer,
+    )
     def reset(self, request, *args, **kwargs):
         project = self.get_object()
 
         if self.request.method == "GET":
             message = "POST on this URL to reset the project."
             return Response({"status": message})
 
+        # Validate input using the action serializer
+        serializer = self.get_serializer(data=request.data)
+        if not serializer.is_valid():
+            return ErrorResponse(serializer.errors)
+
         try:
-            project.reset(
-                keep_input=request.data.get("keep_input", True),
-                restore_pipelines=request.data.get("restore_pipelines", False),
-                execute_now=request.data.get("execute_now", False),
-            )
+            project.reset(**serializer.validated_data)
         except RunInProgressError:
             return ErrorResponse("Cannot reset project while a run is in progress.")
-        else:
-            message = f"The {project} project has been reset."
-            return Response({"status": message})
+
+        return Response({"status": f"The {project} project has been reset."})
 
     @action(detail=True, methods=["get"])
     def outputs(self, request, *args, **kwargs):

scanpipe/tests/test_api.py

@@ -1035,6 +1035,16 @@ def test_scanpipe_api_project_action_add_input(self):
         self.assertEqual(data["input_urls"], input_source.download_url)
         self.assertEqual("tag", input_source.tag)
 
+        data = {
+            "input_urls": ["docker://alpine", "docker://postgresql"],
+        }
+        response = self.csrf_client.post(url, data=data)
+        self.assertEqual({"status": "Input(s) added."}, response.data)
+        input_sources = self.project1.inputsources.filter(
+            download_url__startswith="docker://"
+        )
+        self.assertEqual(2, len(input_sources))
+
         data = {
             "upload_file": io.BytesIO(b"Content"),
             "upload_file_tag": "tag value",