Add a list-pipelines management command #1397 (#1428)

* Add a `list-pipelines` management command #1397

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

* Refine the output of the list-pipelines command #1397

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

* Add unit test for the list-pipelines command #1397

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

---------

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

Author: tdruez

CHANGELOG.rst

@@ -7,6 +7,9 @@ v34.9.0 (unreleased)
 - Add ability to declared pipeline selected groups in create project REST API endpoint.
   https://github.com/aboutcode-org/scancode.io/issues/1426
 
+- Add a new ``list-pipelines`` management command.
+  https://github.com/aboutcode-org/scancode.io/issues/1397
+
 v34.8.3 (2024-10-30)
 --------------------
 

docs/built-in-pipelines.rst

@@ -45,7 +45,7 @@ Analyse Docker Windows Image
 .. _pipeline_collect_strings_gettext:
 
 Collect string with Xgettext (addon)
----------------------------------------------
+------------------------------------
 .. autoclass:: scanpipe.pipelines.collect_strings_gettext.CollectStringsGettext()
     :members:
     :member-order: bysource

docs/command-line-interface.rst

@@ -54,16 +54,23 @@ ScanPipe's own commands are listed under the ``[scanpipe]`` section::
     $ scanpipe --help
     ...
     [scanpipe]
-        add-input
-        add-pipeline
-        archive-project
-        create-project
-        delete-project
-        execute
-        list-project
-        output
-        show-pipeline
-        status
+      add-input
+      add-pipeline
+      archive-project
+      check-compliance
+      create-project
+      create-user
+      delete-project
+      execute
+      flush-projects
+      list-pipelines
+      list-project
+      output
+      purldb-scan-worker
+      reset-project
+      run
+      show-pipeline
+      status
 
 
 `$ scanpipe <subcommand> --help`
@@ -127,6 +134,17 @@ Optional arguments:
     Pipelines are added and are executed in order.
 
 
+`$ scanpipe list-pipeline [--verbosity {0,1,2,3}]`
+--------------------------------------------------
+
+Displays a list of available pipelines.
+Use ``--verbosity=2`` to include details of each pipeline's steps."
+
+Optional arguments:
+
+- ``--verbosity {0,1,2}`` Verbosity level.
+
+
 `$ scanpipe list-project [--search SEARCH] [--include-archived]`
 ----------------------------------------------------------------
 

scanpipe/management/commands/list-pipelines.py

@@ -0,0 +1,59 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# http://nexb.com and https://github.com/aboutcode-org/scancode.io
+# The ScanCode.io software is licensed under the Apache License version 2.0.
+# Data generated with ScanCode.io is provided as-is without warranties.
+# ScanCode is a trademark of nexB Inc.
+#
+# You may not use this software except in compliance with the License.
+# You may obtain a copy of the License at: http://apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed
+# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+# CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+#
+# Data Generated with ScanCode.io is provided on an "AS IS" BASIS, WITHOUT WARRANTIES
+# OR CONDITIONS OF ANY KIND, either express or implied. No content created from
+# ScanCode.io should be considered or used as legal advice. Consult an Attorney
+# for any legal advice.
+#
+# ScanCode.io is a free software code scanning tool from nexB Inc. and others.
+# Visit https://github.com/aboutcode-org/scancode.io for support and download.
+
+
+from django.apps import apps
+from django.core.management.base import BaseCommand
+
+scanpipe_app = apps.get_app_config("scanpipe")
+
+
+class Command(BaseCommand):
+    help = (
+        "Displays a list of available pipelines. "
+        "Use --verbosity=2 to include details of each pipeline's steps."
+    )
+
+    def handle(self, *args, **options):
+        verbosity = options["verbosity"]
+
+        for module_name, pipeline_class in scanpipe_app.pipelines.items():
+            msg = self.style.HTTP_INFO(module_name)
+            if pipeline_class.is_addon:
+                msg += " (addon)"
+            self.stdout.write(msg)
+            pipeline_info = pipeline_class.get_info()
+            if verbosity >= 1:
+                self.stdout.write(pipeline_info["summary"])
+
+            if verbosity >= 2:
+                steps = pipeline_info["steps"]
+                for step_info in steps:
+                    step_name = step_info["name"]
+                    step_doc = step_info["doc"].replace("\n", "\n   ")
+                    step_groups = step_info["groups"]
+                    self.stdout.write(f" > [{step_name}]: {step_doc}")
+                    if step_groups:
+                        self.stdout.write(f"   {{Group}}: {','.join(step_groups)}")
+
+            if verbosity >= 1:
+                self.stdout.write("\n")

scanpipe/tests/test_commands.py

@@ -451,6 +451,32 @@ def test_scanpipe_management_command_status(self):
         )
         self.assertIn(expected, output)
 
+    def test_scanpipe_management_command_list_pipelines(self):
+        options = []
+        out = StringIO()
+        call_command("list-pipelines", *options, stdout=out)
+        output = out.getvalue()
+        self.assertIn("analyze_docker_image", output)
+        self.assertIn("Analyze Docker images.", output)
+        self.assertIn("(addon)", output)
+        self.assertNotIn("[extract_images]", output)
+        self.assertNotIn("Extract images from input tarballs.", output)
+
+        options = ["--verbosity=2"]
+        out = StringIO()
+        call_command("list-pipelines", *options, stdout=out)
+        output = out.getvalue()
+        self.assertIn("[extract_images]", output)
+        self.assertIn("Extract images from input tarballs.", output)
+
+        options = ["--verbosity=0"]
+        out = StringIO()
+        call_command("list-pipelines", *options, stdout=out)
+        output = out.getvalue()
+        self.assertIn("analyze_docker_image", output)
+        self.assertNotIn("Analyze Docker images.", output)
+        self.assertIn("(addon)", output)
+
     def test_scanpipe_management_command_list_project(self):
         project1 = Project.objects.create(name="project1")
         project2 = Project.objects.create(name="project2")