Move stuff in platform_helper

Author: okorach-sonar

sonar/platform.py

@@ -40,6 +40,7 @@
 import sonar.utilities as util
 from sonar.util import types, update_center
 import sonar.util.constants as c
+import sonar.util.platform_helper as pfhelp
 
 from sonar import errcodes, settings, devops, version, sif, exceptions, organizations
 from sonar.permissions import permissions, global_permissions, permission_templates
@@ -262,7 +263,7 @@ def delete(self, api: str, params: types.ApiParams = None, **kwargs) -> requests
     def __run_request(self, request: callable, api: str, params: types.ApiParams = None, **kwargs) -> requests.Response:
         """Makes an HTTP request to SonarQube"""
         mute = kwargs.pop("mute", ())
-        api = _normalize_api(api)
+        api = pfhelp.normalize_api(api)
         headers = {"user-agent": self._user_agent, "accept": _APP_JSON} | kwargs.get("headers", {})
         params = params or {}
         with_org = kwargs.pop("with_organization", True)
@@ -791,19 +792,6 @@ def set_standard_experience(self) -> bool:
 this.context = Platform(os.getenv("SONAR_HOST_URL", "http://localhost:9000"), os.getenv("SONAR_TOKEN", ""))
 
 
-def _normalize_api(api: str) -> str:
-    """Normalizes an API based on its multiple original forms"""
-    if api.startswith("/api/"):
-        pass
-    elif api.startswith("api/"):
-        api = "/" + api
-    elif api.startswith("/"):
-        api = "/api" + api
-    else:
-        api = "/api/" + api
-    return api
-
-
 def _audit_setting_value(key: str, platform_settings: dict[str, Any], audit_settings: types.ConfigSettings, url: str) -> list[Problem]:
     """Audits a particular platform setting is set to expected value"""
     if (v := _get_multiple_values(4, audit_settings[key], "MEDIUM", "CONFIGURATION")) is None:
@@ -963,29 +951,3 @@ def audit(endpoint: Platform, audit_settings: types.ConfigSettings, **kwargs) ->
     pbs = endpoint.audit(audit_settings)
     "write_q" in kwargs and kwargs["write_q"].put(pbs)
     return pbs
-
-
-def old_to_new_json(old_json: dict[str, Any]) -> dict[str, Any]:
-    """Converts sonar-config "plaform" section old JSON report format to new format"""
-    if "plugins" in old_json:
-        old_json["plugins"] = util.dict_to_list(old_json["plugins"], "key")
-    return old_json
-
-
-def global_settings_old_to_new_json(old_json: dict[str, Any]) -> dict[str, Any]:
-    """Converts sonar-config "globalSettings" section old JSON report format to new format"""
-    new_json = {}
-    special_categories = (settings.LANGUAGES_SETTINGS, settings.DEVOPS_INTEGRATION, "permissions", "permissionTemplates")
-    for categ in [cat for cat in settings.CATEGORIES if cat not in special_categories]:
-        new_json[categ] = util.sort_list_by_key(util.dict_to_list(old_json[categ], "key"), "key")
-    for k, v in old_json[settings.LANGUAGES_SETTINGS].items():
-        new_json[settings.LANGUAGES_SETTINGS] = new_json.get(settings.LANGUAGES_SETTINGS, None) or {}
-        new_json[settings.LANGUAGES_SETTINGS][k] = util.sort_list_by_key(util.dict_to_list(v, "key"), "key")
-    new_json[settings.LANGUAGES_SETTINGS] = util.dict_to_list(new_json[settings.LANGUAGES_SETTINGS], "language", "settings")
-    new_json[settings.DEVOPS_INTEGRATION] = util.dict_to_list(old_json[settings.DEVOPS_INTEGRATION], "key")
-    new_json["permissions"] = util.perms_to_list(old_json["permissions"])
-    for v in old_json["permissionTemplates"].values():
-        if "permissions" in v:
-            v["permissions"] = util.perms_to_list(v["permissions"])
-    new_json["permissionTemplates"] = util.dict_to_list(old_json["permissionTemplates"], "key")
-    return new_json

sonar/util/platform_helper.py

@@ -0,0 +1,63 @@
+#
+# sonar-tools
+# Copyright (C) 2025 Olivier Korach
+# mailto:olivier.korach AT gmail DOT com
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3 of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+"""Helper tools for the Platform object"""
+
+from typing import Any
+import settings
+import utilities as util
+
+
+def normalize_api(api: str) -> str:
+    """Normalizes an API based on its multiple original forms"""
+    if api.startswith("/api/"):
+        pass
+    elif api.startswith("api/"):
+        api = "/" + api
+    elif api.startswith("/"):
+        api = "/api" + api
+    else:
+        api = "/api/" + api
+    return api
+
+
+def old_to_new_json(old_json: dict[str, Any]) -> dict[str, Any]:
+    """Converts sonar-config "plaform" section old JSON report format to new format"""
+    if "plugins" in old_json:
+        old_json["plugins"] = util.dict_to_list(old_json["plugins"], "key")
+    return old_json
+
+
+def global_settings_old_to_new_json(old_json: dict[str, Any]) -> dict[str, Any]:
+    """Converts sonar-config "globalSettings" section old JSON report format to new format"""
+    new_json = {}
+    special_categories = (settings.LANGUAGES_SETTINGS, settings.DEVOPS_INTEGRATION, "permissions", "permissionTemplates")
+    for categ in [cat for cat in settings.CATEGORIES if cat not in special_categories]:
+        new_json[categ] = util.sort_list_by_key(util.dict_to_list(old_json[categ], "key"), "key")
+    for k, v in old_json[settings.LANGUAGES_SETTINGS].items():
+        new_json[settings.LANGUAGES_SETTINGS] = new_json.get(settings.LANGUAGES_SETTINGS, None) or {}
+        new_json[settings.LANGUAGES_SETTINGS][k] = util.sort_list_by_key(util.dict_to_list(v, "key"), "key")
+    new_json[settings.LANGUAGES_SETTINGS] = util.dict_to_list(new_json[settings.LANGUAGES_SETTINGS], "language", "settings")
+    new_json[settings.DEVOPS_INTEGRATION] = util.dict_to_list(old_json[settings.DEVOPS_INTEGRATION], "key")
+    new_json["permissions"] = util.perms_to_list(old_json["permissions"])
+    for v in old_json["permissionTemplates"].values():
+        if "permissions" in v:
+            v["permissions"] = util.perms_to_list(v["permissions"])
+    new_json["permissionTemplates"] = util.dict_to_list(old_json["permissionTemplates"], "key")
+    return new_json