Do not sys.exit in execute_project function (#1265)

* Use return instead of sys.exit(0) #1264

Signed-off-by: Jono Yang <jyang@nexb.com>

* Add unit test for the execute_project function async option #1264

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

---------

Signed-off-by: Jono Yang <jyang@nexb.com>
Signed-off-by: tdruez <tdruez@nexb.com>
Co-authored-by: Jono Yang <jyang@nexb.com>

Author: tdruez

scanpipe/management/commands/__init__.py

@@ -21,7 +21,6 @@
 # Visit https://github.com/nexB/scancode.io for support and download.
 
 import shutil
-import sys
 import traceback
 from pathlib import Path
 
@@ -396,7 +395,7 @@ def execute_project(project, run_async=False, command=None):  # noqa: C901
         if verbosity > 0:
             msg = f"{run.pipeline_name} added to the tasks queue for execution."
             command.stdout.write(msg, command.style.SUCCESS)
-        sys.exit(0)
+        return
 
     if verbosity > 0:
         command.stdout.write(f"Start the {run.pipeline_name} pipeline execution...")

scanpipe/tests/test_commands.py

@@ -375,6 +375,33 @@ def test_scanpipe_management_command_execute(self):
         self.assertTrue(run3.task_stopped)
         self.assertEqual("", run3.task_output)
 
+    def test_scanpipe_management_command_execute_project_function(self):
+        project = Project.objects.create(name="my_project")
+
+        expected = "No pipelines to run on project my_project"
+        with self.assertRaisesMessage(CommandError, expected):
+            commands.execute_project(project)
+
+        run1 = project.add_pipeline(self.pipeline_name)
+        with mock.patch("scanpipe.tasks.execute_pipeline_task", task_success):
+            returned_value = commands.execute_project(project, run_async=False)
+        self.assertIsNone(returned_value)
+        run1.refresh_from_db()
+        self.assertTrue(run1.task_succeeded)
+        run1.delete()
+
+        project.add_pipeline(self.pipeline_name)
+        expected = "SCANCODEIO_ASYNC=False is not compatible with --async option."
+        with override_settings(SCANCODEIO_ASYNC=False):
+            with self.assertRaisesMessage(CommandError, expected):
+                commands.execute_project(project, run_async=True)
+
+        with override_settings(SCANCODEIO_ASYNC=True):
+            with mock.patch("scanpipe.models.Run.start") as mock_start:
+                returned_value = commands.execute_project(project, run_async=True)
+                mock_start.assert_called_once()
+        self.assertIsNone(returned_value)
+
     def test_scanpipe_management_command_status(self):
         project = Project.objects.create(name="my_project")
         run = project.add_pipeline(self.pipeline_name)