Disable the creation of the global webhook in the batch-create command (#1629)

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

Author: tdruez

CHANGELOG.rst

@@ -20,6 +20,11 @@ v34.9.6 (unreleased)
 - Upgrade Bulma CSS library to version 1.0.2
   https://github.com/aboutcode-org/scancode.io/pull/1268
 
+- Disable the creation of the global webhook in the ``batch-create`` command by default.
+  The global webhook can be created by providing the ``--create-global-webhook`` option.
+  A ``--no-global-webhook`` option was also added to the ``create-project`` command to
+  provide the ability to skip the global webhook creation.
+
 v34.9.5 (2025-02-19)
 --------------------
 

docs/command-line-interface.rst

@@ -105,6 +105,9 @@ Optional arguments:
 
 - ``--pipeline PIPELINES`` Pipelines names to add on the project.
 
+.. warning::
+    Pipelines are added and are executed in order.
+
 .. tip::
     Use the "pipeline_name:option1,option2" syntax to select optional steps:
 
@@ -137,8 +140,8 @@ Optional arguments:
   of running in the current thread.
   Applies only when ``--execute`` is provided.
 
-.. warning::
-    Pipelines are added and are executed in order.
+- ``--no-global-webhook`` Skip the creation of the global webhook. This option is
+  only useful if a global webhook is defined in the settings.
 
 .. _cli_batch_create:
 
@@ -196,6 +199,9 @@ Optional arguments:
   of running in the current thread.
   Applies only when ``--execute`` is provided.
 
+- ``--create-global-webhook`` Create the global webhook for each project, if enabled in
+  the settings. If not provided, the global webhook subscriptions are not created.
+
 Example: Processing Multiple Docker Images
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

scanpipe/management/commands/__init__.py

@@ -441,6 +441,7 @@ def create_project(
     labels=None,
     execute=False,
     run_async=False,
+    create_global_webhook=True,
     command=None,
 ):
     verbosity = getattr(command, "verbosity", 1)
@@ -462,7 +463,11 @@ def create_project(
         pipelines=pipelines, input_files=input_files, copy_from=copy_from
     )
 
-    project.save()
+    save_kwargs = {}
+    if not create_global_webhook:
+        save_kwargs = {"skip_global_webhook": True}
+
+    project.save(**save_kwargs)
 
     if labels:
         project.labels.add(*labels)
@@ -520,6 +525,15 @@ def add_arguments(self, parser):
             default=list(),
             help="Optional labels for the project.",
         )
+        parser.add_argument(
+            "--no-global-webhook",
+            action="store_true",
+            help=(
+                "Skip the creation of the global webhook. "
+                "This option is only useful if a global webhook is defined in the "
+                "settings."
+            ),
+        )
 
     def create_project(
         self,
@@ -532,6 +546,7 @@ def create_project(
         labels=None,
         execute=False,
         run_async=False,
+        create_global_webhook=True,
     ):
         if execute and not pipelines:
             raise CommandError("The --execute option requires one or more pipelines.")
@@ -546,5 +561,6 @@ def create_project(
             labels=labels,
             execute=execute,
             run_async=run_async,
+            create_global_webhook=create_global_webhook,
             command=self,
         )

scanpipe/management/commands/batch-create.py

@@ -68,6 +68,16 @@ def add_arguments(self, parser):
                 "a timestamp (in the format [YYMMDD_HHMMSS]) will be used."
             ),
         )
+        parser.add_argument(
+            "--create-global-webhook",
+            action="store_true",
+            default=False,
+            help=(
+                "Create the global webhook for each project, "
+                "if enabled in the settings. "
+                "If not provided, the global webhook subscriptions are not created."
+            ),
+        )
 
     def handle(self, *args, **options):
         self.verbosity = options["verbosity"]
@@ -110,6 +120,7 @@ def handle_input_directory(self, **options):
                     labels=options["labels"],
                     execute=options["execute"],
                     run_async=options["async"],
+                    create_global_webhook=options["create_global_webhook"],
                 )
                 self.created_project_count += 1
 
@@ -143,6 +154,7 @@ def handle_input_list(self, **options):
                 labels=options["labels"],
                 execute=options["execute"],
                 run_async=options["async"],
+                create_global_webhook=options["create_global_webhook"],
             )
             self.created_project_count += 1
 

scanpipe/management/commands/create-project.py

@@ -39,24 +39,15 @@ def add_arguments(self, parser):
 
     def handle(self, *args, **options):
         self.verbosity = options["verbosity"]
-        name = options["name"]
-        pipelines = options["pipelines"]
-        input_files = options["input_files"]
-        input_urls = options["input_urls"]
-        copy_from = options["copy_codebase"]
-        notes = options["notes"]
-        labels = options["labels"]
-        execute = options["execute"]
-        run_async = options["async"]
-
         self.create_project(
-            name=name,
-            pipelines=pipelines,
-            input_files=input_files,
-            input_urls=input_urls,
-            copy_from=copy_from,
-            notes=notes,
-            labels=labels,
-            execute=execute,
-            run_async=run_async,
+            name=options["name"],
+            pipelines=options["pipelines"],
+            input_files=options["input_files"],
+            input_urls=options["input_urls"],
+            copy_from=options["copy_codebase"],
+            notes=options["notes"],
+            labels=options["labels"],
+            execute=options["execute"],
+            run_async=options["async"],
+            create_global_webhook=not options["no_global_webhook"],
         )

scanpipe/models.py

@@ -607,6 +607,8 @@ def save(self, *args, **kwargs):
         is_new = self._state.adding
         # True if the new instance is a clone of an existing one.
         is_clone = kwargs.pop("is_clone", False)
+        # True if the global webhook creation should be skipped.
+        skip_global_webhook = kwargs.pop("skip_global_webhook", False)
 
         if not self.slug:
             self.slug = get_project_slug(project=self)
@@ -617,7 +619,8 @@ def save(self, *args, **kwargs):
 
         super().save(*args, **kwargs)
 
-        if settings.SCANCODEIO_GLOBAL_WEBHOOK and is_new and not is_clone:
+        global_webhook = settings.SCANCODEIO_GLOBAL_WEBHOOK
+        if global_webhook and is_new and not is_clone and not skip_global_webhook:
             self.setup_global_webhook()
 
     def setup_global_webhook(self):

scanpipe/tests/test_commands.py

@@ -199,6 +199,22 @@ def test_scanpipe_management_command_create_project_execute(self):
             "Project other_project created with work directory", out.getvalue()
         )
 
+    @override_settings(SCANCODEIO_GLOBAL_WEBHOOK={"target_url": "https://webhook.url"})
+    @mock.patch.object(Project, "setup_global_webhook")
+    def test_scanpipe_management_command_create_project_no_global_webhook(
+        self, mock_setup_webhook
+    ):
+        out = StringIO()
+        options = ["--no-global-webhook"]
+        call_command("create-project", "my_project", *options, stdout=out)
+        self.assertIn("Project my_project created", out.getvalue())
+        mock_setup_webhook.assert_not_called()
+
+        options = []
+        call_command("create-project", "my_project_v2", *options, stdout=out)
+        self.assertIn("Project my_project_v2 created", out.getvalue())
+        mock_setup_webhook.assert_called()
+
     def test_scanpipe_management_command_batch_create(self):
         expected = "You must provide either --input-directory or --input-list as input."
         with self.assertRaisesMessage(CommandError, expected):
@@ -277,6 +293,28 @@ def test_scanpipe_management_command_batch_create_input_list_csv(self):
         self.assertEqual("", input_source3.tag)
         self.assertFalse(input_source3.exists())
 
+    @override_settings(SCANCODEIO_GLOBAL_WEBHOOK={"target_url": "https://webhook.url"})
+    @mock.patch.object(Project, "setup_global_webhook")
+    def test_scanpipe_management_command_batch_create_global_webhook(
+        self, mock_setup_webhook
+    ):
+        input_directory = self.data / "commands" / "batch-create-directory"
+        options = ["--input-directory", str(input_directory)]
+        out = StringIO()
+        call_command("batch-create", *options, stdout=out)
+        self.assertIn("2 projects created.", out.getvalue())
+        mock_setup_webhook.assert_not_called()
+
+        options += [
+            "--create-global-webhook",
+            "--project-name-suffix",
+            "with-webhook",
+        ]
+        out = StringIO()
+        call_command("batch-create", *options, stdout=out)
+        self.assertIn("2 projects created.", out.getvalue())
+        mock_setup_webhook.assert_called()
+
     def test_scanpipe_management_command_add_input_file(self):
         out = StringIO()
 
@@ -1288,3 +1326,19 @@ def test_scanpipe_management_command_mixin_create_project_execute(self):
                     execute=True,
                     run_async=True,
                 )
+
+    @override_settings(SCANCODEIO_GLOBAL_WEBHOOK={"target_url": "https://webhook.url"})
+    @mock.patch.object(Project, "setup_global_webhook")
+    def test_scanpipe_management_command_mixin_create_project_no_global_webhook(
+        self, mock_setup_webhook
+    ):
+        project = self.create_project_command.create_project(
+            name="no global webhook",
+            create_global_webhook=False,
+        )
+        self.assertTrue(project.pk)
+        mock_setup_webhook.assert_not_called()
+
+        project = self.create_project_command.create_project(name="with global webhook")
+        self.assertTrue(project.pk)
+        mock_setup_webhook.assert_called()

scanpipe/tests/test_models.py

@@ -868,7 +868,12 @@ def test_scanpipe_project_model_call_setup_global_webhook(self, mock_setup_webho
             project.save(is_clone=True)
             mock_setup_webhook.assert_not_called()
 
-        # Case 3: Global webhook is disabled (Webhook should NOT be called)
+            # Case 3: Skip global webhook (Webhook should NOT be called)
+            project = Project(name="Project with skip")
+            project.save(skip_global_webhook=True)
+            mock_setup_webhook.assert_not_called()
+
+        # Case 4: Global webhook is disabled (Webhook should NOT be called)
         with override_settings(SCANCODEIO_GLOBAL_WEBHOOK=None):
             project = Project(name="No Webhook Project")
             project.save()