Fix the ability to provide multiple optional step in API #1454 (#1455)

Signed-off-by: tdruez <tdruez@nexb.com>

Author: tdruez

CHANGELOG.rst

@@ -10,6 +10,13 @@ v34.9.1 (unreleased)
   parameters.
   https://github.com/aboutcode-org/scancode.io/issues/1449
 
+- Fix the ability to provide multiple optional step when defining pipelines in the
+  REST API.
+  The support for providing pipeline names as a comma-separated single string was
+  remove as the comma is used as the optional step separator.
+  Use a list of pipeline names instead.
+  https://github.com/aboutcode-org/scancode.io/issues/1454
+
 v34.9.0 (2024-11-14)
 --------------------
 

docs/rest-api.rst

@@ -129,10 +129,9 @@ Using cURL:
 .. tip::
 
     You can declare multiple pipelines to be executed at the project creation using a
-    list of pipeline names or a comma-separated string:
+    list of pipeline names:
 
-    - ``"pipeline": ["scan_single_package", "scan_for_virus"]``
-    - ``"pipeline": "scan_single_package,scan_for_virus"``
+    ``"pipeline": ["scan_single_package", "scan_for_virus"]``
 
 .. tip::
 

scanpipe/api/serializers.py

@@ -84,9 +84,6 @@ def to_internal_value(self, data):
         if not self.allow_empty and len(data) == 0:
             self.fail("empty")
 
-        # Adds support for providing pipeline names as a comma-separated single string.
-        data = [item.strip() for value in data for item in value.split(",")]
-
         # Pipeline validation
         for pipeline in data:
             pipeline_name, _ = scanpipe_app.extract_group_from_pipeline(pipeline)

scanpipe/tests/test_api.py

@@ -442,44 +442,23 @@ def test_scanpipe_api_project_create_multiple_pipelines(self):
             "scan_single_package", response.data["runs"][1]["pipeline_name"]
         )
 
+        # Not supported as the comma `,` is used as the separator for optional steps.
         data = {
             "name": "Multi string",
             "pipeline": "analyze_docker_image,scan_single_package",
         }
         response = self.csrf_client.post(self.project_list_url, data)
-        self.assertEqual(status.HTTP_201_CREATED, response.status_code)
-        self.assertEqual(2, len(response.data["runs"]))
-        self.assertEqual(
-            "analyze_docker_image", response.data["runs"][0]["pipeline_name"]
-        )
-        self.assertEqual(
-            "scan_single_package", response.data["runs"][1]["pipeline_name"]
-        )
-
-        data = {
-            "name": "Mix of string and list plus selected groups",
+        self.assertEqual(status.HTTP_400_BAD_REQUEST, response.status_code)
+        expected = {
             "pipeline": [
-                "analyze_docker_image",
-                "inspect_packages:StaticResolver,scan_single_package",
-            ],
+                ErrorDetail(
+                    string='"analyze_docker_image,scan_single_package" is not a valid '
+                    "choice.",
+                    code="invalid_choice",
+                )
+            ]
         }
-        response = self.csrf_client.post(self.project_list_url, data)
-        self.assertEqual(status.HTTP_201_CREATED, response.status_code)
-        self.assertEqual(
-            "analyze_docker_image", response.data["runs"][0]["pipeline_name"]
-        )
-        self.assertEqual("inspect_packages", response.data["runs"][1]["pipeline_name"])
-        self.assertEqual(
-            "scan_single_package", response.data["runs"][2]["pipeline_name"]
-        )
-        self.assertEqual(
-            ["StaticResolver"], response.data["runs"][1]["selected_groups"]
-        )
-        runs = Project.objects.get(name=data["name"]).runs.all()
-        self.assertEqual("analyze_docker_image", runs[0].pipeline_name)
-        self.assertEqual("inspect_packages", runs[1].pipeline_name)
-        self.assertEqual("scan_single_package", runs[2].pipeline_name)
-        self.assertEqual(["StaticResolver"], runs[1].selected_groups)
+        self.assertEqual(expected, response.data)
 
     def test_scanpipe_api_project_create_pipeline_old_name_compatibility(self):
         data = {
@@ -532,6 +511,31 @@ def test_scanpipe_api_project_create_pipeline_groups(self):
         self.assertEqual("inspect_packages", run.pipeline_name)
         self.assertEqual(["StaticResolver"], run.selected_groups)
 
+        data = {
+            "name": "Mix of string and list plus selected groups",
+            "pipeline": [
+                "map_deploy_to_develop:Java,JavaScript",
+                "inspect_packages:StaticResolver",
+            ],
+        }
+        response = self.csrf_client.post(self.project_list_url, data)
+        self.assertEqual(status.HTTP_201_CREATED, response.status_code)
+        self.assertEqual(
+            "map_deploy_to_develop", response.data["runs"][0]["pipeline_name"]
+        )
+        self.assertEqual("inspect_packages", response.data["runs"][1]["pipeline_name"])
+        self.assertEqual(
+            ["Java", "JavaScript"], response.data["runs"][0]["selected_groups"]
+        )
+        self.assertEqual(
+            ["StaticResolver"], response.data["runs"][1]["selected_groups"]
+        )
+        runs = Project.objects.get(name=data["name"]).runs.all()
+        self.assertEqual("map_deploy_to_develop", runs[0].pipeline_name)
+        self.assertEqual("inspect_packages", runs[1].pipeline_name)
+        self.assertEqual(["Java", "JavaScript"], runs[0].selected_groups)
+        self.assertEqual(["StaticResolver"], runs[1].selected_groups)
+
     def test_scanpipe_api_project_create_webhooks(self):
         data = {
             "name": "Project1",