Import webhooks (#1998)

* Fixes #1989

* Quality pass

Author: okorach

sonar/platform.py

@@ -46,6 +46,7 @@
 import sonar.audit.severities as sev
 import sonar.audit.types as typ
 from sonar.audit.problem import Problem
+from sonar import webhooks
 
 WRONG_CONFIG_MSG = "Audit config property %s has wrong value %s, skipping audit"
 
@@ -442,13 +443,10 @@ def __urlstring(self, api: str, params: types.ApiParams, data: str = None) -> st
             url += f" - BODY: {data}"
         return url
 
-    def webhooks(self) -> dict[str, object]:
+    def webhooks(self) -> dict[str, webhooks.WebHook]:
         """
         :return: the list of global webhooks
-        :rtype: dict{<webhook_name>: <webhook_data>, ...}
         """
-        from sonar import webhooks
-
         return webhooks.get_list(self)
 
     def export(self, export_settings: types.ConfigSettings, full: bool = False) -> types.ObjectJsonRepr:
@@ -491,16 +489,12 @@ def set_webhooks(self, webhooks_data: types.ObjectJsonRepr) -> bool:
         """Sets global webhooks with a list of webhooks represented as JSON
 
         :param webhooks_data: the webhooks JSON representation
-        :return: Whether the operation succeeded or not
+        :return: The number of webhooks configured
         """
+        log.debug("%s setting webhooks %s", str(self), str(webhooks_data))
         if webhooks_data is None:
             return False
-        current_wh = self.webhooks()
-        # FIXME: Handle several webhooks with same name
-        current_wh_names = [wh.name for wh in current_wh.values()]
-        wh_map = {wh.name: k for k, wh in current_wh.items()}
-        log.debug("Current webhooks = %s", str(current_wh_names))
-        _ = [current_wh[wh_map[wh_name]].update(name=wh_name, **wh) for wh_name, wh in webhooks_data.items() if wh_name in current_wh_names]
+        webhooks.import_config(self, webhooks_data)
         return True
 
     def import_config(self, config_data: types.ObjectJsonRepr) -> int:
@@ -515,9 +509,15 @@ def import_config(self, config_data: types.ObjectJsonRepr) -> int:
         count = 0
         config_data = config_data.get("globalSettings", {})
         flat_settings = util.flatten(config_data)
-        count += sum(1 if self.set_webhooks(v) else 0 for k, v in config_data.get("webhooks", None) or {})
         count += sum(1 if self.set_setting(k, v) else 0 for k, v in flat_settings.items())
 
+        try:
+            wh_data = config_data["generalSettings"]["webhooks"]
+            self.set_webhooks(wh_data)
+            count += len(wh_data)
+        except KeyError:
+            pass
+
         if settings.NEW_CODE_PERIOD in config_data.get("generalSettings", {}):
             (nc_type, nc_val) = settings.decode(settings.NEW_CODE_PERIOD, config_data["generalSettings"][settings.NEW_CODE_PERIOD])
             try:

sonar/projects.py

@@ -1226,16 +1226,7 @@ def set_webhooks(self, webhook_data: types.ObjectJsonRepr) -> None:
         :param dict webhook_data: JSON describing the webhooks
         :return: Nothing
         """
-        current_wh = self.webhooks()
-        current_wh_names = [wh.name for wh in current_wh.values()]
-        wh_map = {wh.name: k for k, wh in current_wh.items()}
-        # FIXME: Handle several webhooks with same name
-        for wh_name, wh in webhook_data.items():
-            if wh_name in current_wh_names:
-                current_wh[wh_map[wh_name]].update(name=wh_name, **wh)
-            else:
-                hook = webhooks.WebHook.create(endpoint=self.endpoint, name=wh_name, url="", project=self.key)
-                hook.update(**wh)
+        webhooks.import_config(self.endpoint, webhook_data, self.key)
 
     def set_settings(self, data: types.ObjectJsonRepr) -> None:
         """Sets project settings (webhooks, settings, new code period)

sonar/webhooks.py

@@ -70,6 +70,7 @@ def create(cls, endpoint: pf.Platform, name: str, url: str, secret: Optional[str
         :param str project: Webhook project key, optional
         :return: The created WebHook
         """
+        log.info("Creating webhook name %s, url %s project %s", name, url, str(project))
         params = util.remove_nones({"name": name, "url": url, "secret": secret, "project": project})
         try:
             endpoint.post(WebHook.API[c.CREATE], params=params)
@@ -201,6 +202,22 @@ def export(endpoint: pf.Platform, project_key: str = None, full: bool = False) -
     return json_data if len(json_data) > 0 else None
 
 
+def import_config(endpoint: pf.Platform, data: types.ObjectJsonRepr, project_key: Optional[str] = None) -> None:
+    """Imports a set of webhooks defined from a JSON description"""
+
+    log.debug("Importing webhooks %s for %s", str(data), str(project_key))
+    current_wh = get_list(endpoint, project_key=project_key)
+    existing_webhooks = {wh.name: k for k, wh in current_wh.items()}
+
+    # FIXME: Handle several webhooks with same name
+    for wh_name, wh_data in data.items():
+        if wh_name in existing_webhooks:
+            current_wh[existing_webhooks[wh_name]].update(name=wh_name, **wh_data)
+        else:
+            hook = WebHook.create(endpoint=endpoint, name=wh_name, url=wh_data.get("url", "https://to.be.defined"), project=project_key)
+            hook.update(**wh_data)
+
+
 def audit(endpoint: pf.Platform) -> list[problem.Problem]:
     """Audits web hooks and returns list of found problems"""
     log.info("Auditing webhooks")

test/unit/test_webhooks.py

@@ -95,4 +95,3 @@ def test_create_delete() -> None:
     hook.delete()
     with pytest.raises(exceptions.ObjectNotFound):
         hook.refresh()
-