Refine pipeline choices in the "Add pipeline" modal #1071 (#1072)

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

Author: tdruez

CHANGELOG.rst

@@ -1,6 +1,17 @@
 Changelog
 =========
 
+v33.2.0 (unreleased)
+--------------------
+
+- Refine pipeline choices in the "Add pipeline" modal based on the project context.
+   * When there is at least one existing pipeline in the project, the modal now includes
+     all addon pipelines along with the existing pipeline for selection.
+   * In cases where no pipelines are assigned to the project, the modal displays all
+     base (non-addon) pipelines for user selection.
+
+   https://github.com/nexB/scancode.io/issues/
+
 v33.1.0 (2024-02-02)
 --------------------
 

scanpipe/forms.py

@@ -158,14 +158,32 @@ def save(self, project):
 
 class AddPipelineForm(PipelineBaseForm):
     pipeline = forms.ChoiceField(
-        choices=[
-            (name, pipeline_class.get_summary())
-            for name, pipeline_class in scanpipe_app.pipelines.items()
-        ],
         widget=forms.RadioSelect(),
         required=True,
     )
 
+    def __init__(self, project_runs=None, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        # The pipeline choices are determined based on the project context:
+        # 1. If no pipelines are assigned to the project:
+        #    Include all base (non-addon) pipelines.
+        # 2. If at least one pipeline already exists on the project:
+        #    Include all addon pipelines and the existing pipeline (useful for
+        #    potential re-runs in debug mode).
+        project_run_names = {run.pipeline_name for run in project_runs or []}
+
+        pipeline_choices = [
+            (name, pipeline_class.get_summary())
+            for name, pipeline_class in scanpipe_app.pipelines.items()
+            # no pipelines are assigned to the project
+            if (not project_runs and not pipeline_class.is_addon)
+            # at least one pipeline already exists on the project
+            or (project_runs and (name in project_run_names or pipeline_class.is_addon))
+        ]
+
+        self.fields["pipeline"].choices = pipeline_choices
+
     def save(self, project):
         self.handle_pipeline(project)
         return project

scanpipe/templates/scanpipe/modals/add_pipeline_modal.html

@@ -8,6 +8,19 @@
         <button class="delete" type="button" aria-label="close"></button>
       </header>
       <section class="modal-card-body">
+        {% if pipeline_runs %}
+          <div class="message is-info">
+            <div class="message-body">
+              <span class="icon width-1 height-1 mr-1">
+                <i class="fa-solid fa-info-circle"></i>
+              </span>
+              <span>
+                Pipeline selection is <strong>limited to add-ons</strong> as pipelines
+                have already been assigned to this project.
+              </span>
+            </div>
+          </div>
+        {% endif %}
         <div class="field">
           <div class="control">
             {% for label, summary in add_pipeline_form.pipeline.field.choices %}

scanpipe/tests/test_forms.py

@@ -27,6 +27,7 @@
 
 import requests
 
+from scanpipe.forms import AddPipelineForm
 from scanpipe.forms import EditInputSourceTagForm
 from scanpipe.forms import InputsBaseForm
 from scanpipe.forms import ProjectForm
@@ -83,13 +84,33 @@ def test_scanpipe_forms_project_form_name(self):
 
     def test_scanpipe_forms_project_form_pipeline_choices(self):
         blank_entry = ("", "---------")
-        main_pipline = ("scan_codebase", "scan_codebase")
-        addon_pipline = ("find_vulnerabilities", "find_vulnerabilities")
+        main_pipeline = ("scan_codebase", "scan_codebase")
+        addon_pipeline = ("find_vulnerabilities", "find_vulnerabilities")
 
         choices = ProjectForm().fields["pipeline"].choices
         self.assertIn(blank_entry, choices)
-        self.assertIn(main_pipline, choices)
-        self.assertNotIn(addon_pipline, choices)
+        self.assertIn(main_pipeline, choices)
+        self.assertNotIn(addon_pipeline, choices)
+
+    def test_scanpipe_forms_add_pipeline_form_pipeline_choices(self):
+        main_pipeline1 = "scan_codebase"
+        main_pipeline2 = "scan_single_package"
+        addon_pipeline = "find_vulnerabilities"
+
+        form = AddPipelineForm()
+        choices = form.fields["pipeline"].choices
+        pipeline_choices = [choice[0] for choice in choices]
+        self.assertIn(main_pipeline1, pipeline_choices)
+        self.assertIn(main_pipeline2, pipeline_choices)
+        self.assertNotIn(addon_pipeline, pipeline_choices)
+
+        self.project1.add_pipeline(pipeline_name=main_pipeline1)
+        form = AddPipelineForm(project_runs=self.project1.runs.all())
+        choices = form.fields["pipeline"].choices
+        pipeline_choices = [choice[0] for choice in choices]
+        self.assertIn(main_pipeline1, pipeline_choices)
+        self.assertNotIn(main_pipeline2, pipeline_choices)
+        self.assertIn(addon_pipeline, pipeline_choices)
 
     def test_scanpipe_forms_project_settings_form_update_name_and_notes(self):
         data = {

scanpipe/views.py

@@ -693,7 +693,7 @@ def get_context_data(self, **kwargs):
             {
                 "input_sources": project.get_inputs_with_source(),
                 "labels": list(project.labels.all()),
-                "add_pipeline_form": AddPipelineForm(),
+                "add_pipeline_form": AddPipelineForm(project_runs=pipeline_runs),
                 "add_inputs_form": AddInputsForm(),
                 "add_labels_form": AddLabelsForm(),
                 "edit_input_tag_from": EditInputSourceTagForm(),