Quality pass

Author: okorach-sonar

cli/config.py

@@ -305,6 +305,7 @@ def __import_config(endpoint: platform.Platform, what: list[str], **kwargs) -> N
 
 
 def convert_json(**kwargs) -> dict[str, Any]:
+    """Converts a sonar-config report from the old to the new JSON format"""
     with open(kwargs["convertFrom"], encoding="utf-8") as fd:
         old_json = json.loads(fd.read())
     mapping = {
@@ -334,7 +335,7 @@ def main() -> None:
     start_time = utilities.start_clock()
     try:
         kwargs = utilities.convert_args(__parse_args("Extract SonarQube Server or Cloud platform configuration"))
-        if kwargs["convertFrom"] != None:
+        if kwargs["convertFrom"] is not None:
             convert_json(**kwargs)
             utilities.final_exit(errcodes.OK, "", start_time)
         endpoint = platform.Platform(**kwargs)

sonar/applications.py

@@ -600,16 +600,18 @@ def search_by_name(endpoint: pf.Platform, name: str) -> dict[str, Application]:
     return data
 
 
-def old_to_new_json_one(old_json: dict[str, Any]) -> dict[str, Any]:
-    new_json = old_json.copy()
-    if "permissions" in old_json:
-        new_json["permissions"] = util.perms_to_list(old_json["permissions"])
-    if "branches" in old_json:
-        new_json["branches"] = util.dict_to_list(old_json["branches"], "name")
+def old_to_new_json_one(old_app_json: dict[str, Any]) -> dict[str, Any]:
+    """Converts sonar-config old JSON report format to new format for a single application"""
+    new_json = old_app_json.copy()
+    if "permissions" in old_app_json:
+        new_json["permissions"] = util.perms_to_list(old_app_json["permissions"])
+    if "branches" in old_app_json:
+        new_json["branches"] = util.dict_to_list(old_app_json["branches"], "name")
     return new_json
 
 
 def old_to_new_json(old_json: dict[str, Any]) -> dict[str, Any]:
+    """Converts sonar-config old JSON report format to new format"""
     new_json = old_json.copy()
     for k, v in new_json.items():
         new_json[k] = old_to_new_json_one(v)

sonar/groups.py

@@ -435,4 +435,5 @@ def exists(endpoint: pf.Platform, name: str) -> bool:
 
 
 def old_to_new_json(old_json: dict[str, Any]) -> dict[str, Any]:
+    """Converts sonar-config old groups JSON report format to new format"""
     return util.dict_to_list(old_json, "name", "description")

sonar/platform.py

@@ -977,13 +977,14 @@ def audit(endpoint: Platform, audit_settings: types.ConfigSettings, **kwargs) ->
 
 
 def old_to_new_json(old_json: dict[str, Any]) -> dict[str, Any]:
-    new_json = {}
+    """Converts sonar-config "plaform" section old JSON report format to new format"""
     if "plugins" in old_json:
-        new_json["plugins"] = util.dict_to_list(old_json["plugins"], "key")
-    return new_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]:

sonar/portfolios.py

@@ -853,6 +853,7 @@ def clear_cache(endpoint: pf.Platform) -> None:
 
 
 def old_to_new_json_one(old_json: dict[str, Any]) -> dict[str, Any]:
+    """Converts the sonar-config old JSON report format for a single portfolio to the new one"""
     new_json = old_json.copy()
     for key in "children", "portfolios":
         if key in new_json:
@@ -865,6 +866,7 @@ def old_to_new_json_one(old_json: dict[str, Any]) -> dict[str, Any]:
 
 
 def old_to_new_json(old_json: dict[str, Any]) -> dict[str, Any]:
+    """Converts the sonar-config portfolios old JSON report format to the new one"""
     new_json = old_json.copy()
     for k, v in new_json.items():
         new_json[k] = old_to_new_json_one(v)

sonar/projects.py

@@ -1699,6 +1699,7 @@ def import_zips(endpoint: pf.Platform, project_list: list[str], threads: int = 2
 
 
 def old_to_new_json_one(old_json: dict[str, Any]) -> dict[str, Any]:
+    """Converts the sonar-config projects old JSON report format for a single project to the new one"""
     new_json = old_json.copy()
     if "permissions" in old_json:
         new_json["permissions"] = util.perms_to_list(old_json["permissions"])
@@ -1710,8 +1711,8 @@ def old_to_new_json_one(old_json: dict[str, Any]) -> dict[str, Any]:
 
 
 def old_to_new_json(old_json: dict[str, Any]) -> dict[str, Any]:
+    """Converts the sonar-config projects old JSON report format to the new one"""
     new_json = old_json.copy()
     for k, v in new_json.items():
-        log.info("Convert %s %s", k, v)
         new_json[k] = old_to_new_json_one(v)
     return util.dict_to_list(new_json, "key")

sonar/qualitygates.py

@@ -564,4 +564,5 @@ def search_by_name(endpoint: pf.Platform, name: str) -> dict[str, QualityGate]:
 
 
 def old_to_new_json(old_json: dict[str, Any]) -> dict[str, Any]:
+    """Converts the sonar-config quality gates old JSON report format to the new one"""
     return util.dict_to_list(old_json, "name")

sonar/rules.py

@@ -582,6 +582,7 @@ def severities(endpoint: platform.Platform, json_data: dict[str, any]) -> Option
 
 
 def old_to_new_json(old_json: dict[str, Any]) -> dict[str, Any]:
+    """Converts the sonar-config rules old JSON report format to the new one"""
     new_json = {}
     for k in ("instantiated", "extended", "standard", "thirdParty"):
         if k in old_json:

sonar/users.py

@@ -571,4 +571,5 @@ def exists(endpoint: pf.Platform, login: str) -> bool:
 
 
 def old_to_new_json(old_json: dict[str, Any]) -> dict[str, Any]:
+    """Converts the sonar-config users old JSON report format to the new one"""
     return util.dict_to_list(old_json, "login")