Cursor-experiment (#2019)

* Fix poor usage of comprehensions

* Relpace any type hint by Any

* Add Optional type hint where needed

* Add type hints to class attributes

* Fix import

* Add AI generated tests

* Formatting

* Change types using any by Any

* MOre type hints

* Remove trailing white spaces

* Fix possible None dereference

* Refactoring

* reload instead of update sq_json

* Reload sq_json instead of update

* Imporved to copy only the right  credentials in the test/gen directory

* Kill TD

* Add mor eissues deliberately

* Put reference issue sin credentials

* Fix is_xxx in MQR mode

* Fix set_type to raise unsupported op

* Small refactoring

* Added type hints for kwargs

* Fix test_refresh()

* Formatting

Author: okorach

cli/audit.py

@@ -109,7 +109,7 @@ def write_json(queue: Queue[list[problem.Problem]], fd: TextIO, settings: types.
 
 
 def _audit_sq(
-    sq: platform.Platform, settings: types.ConfigSettings, what_to_audit: Optional[list[str]] = None, key_list: types.KeyList = None
+    sq: platform.Platform, settings: types.ConfigSettings, what_to_audit: Optional[list[str]] = None, key_list: Optional[types.KeyList] = None
 ) -> list[problem.Problem]:
     """Audits a SonarQube/Cloud platform"""
     everything = what_to_audit is None

cli/options.py

@@ -27,6 +27,7 @@
 import sys
 import random
 from argparse import ArgumentParser
+from typing import Optional
 
 import sonar.logging as log
 from sonar import errcodes, version, utilities, exceptions
@@ -186,7 +187,7 @@ def __check_file_writeable(file: str) -> None:
         os.remove(file)
 
 
-def parse_and_check(parser: ArgumentParser, logger_name: str = None, verify_token: bool = True, is_migration: bool = False) -> object:
+def parse_and_check(parser: ArgumentParser, logger_name: Optional[str] = None, verify_token: bool = True, is_migration: bool = False) -> object:
     """Parses arguments, applies default settings and perform common environment checks"""
     try:
         args = parser.parse_args()
@@ -408,7 +409,7 @@ def set_target_sonar_args(parser: ArgumentParser) -> ArgumentParser:
     return parser
 
 
-def set_output_file_args(parser: ArgumentParser, help_str: str = None, allowed_formats: tuple[str, ...] = ("csv",)) -> ArgumentParser:
+def set_output_file_args(parser: ArgumentParser, help_str: Optional[str] = None, allowed_formats: tuple[str, ...] = ("csv",)) -> ArgumentParser:
     """Sets the output file CLI options"""
     if not help_str:
         help_str = "Report file, stdout by default"

cli/projects_cli.py

@@ -107,7 +107,8 @@ def __import_projects(endpoint: platform.Platform, **kwargs) -> None:
         if proj["key"] in statuses:
             proj.update(statuses[proj["key"]])
         else:
-            _ = [proj.pop(k, None) for k in ("importStatus", "importDate", "importProjectUrl")]
+            for k in ("importStatus", "importDate", "importProjectUrl"):
+                proj.pop(k, None)
     data["importSonarqubeEnvironment"] = {
         "url": endpoint.url(),
         "version": ".".join([str(n) for n in endpoint.version()[:2]]),

conf/build_tests.sh

@@ -43,6 +43,7 @@ do
             b=$(basename "${f}" .py)
             cp "${f}" "${ROOT_DIR}/${GEN_LOC}/${target}/${b}_${target}.py"
         done
+        rm "${ROOT_DIR}/${GEN_LOC}/${target}"/credentials*.py
         cp "credentials-${target}.py" "${ROOT_DIR}/${GEN_LOC}/${target}/credentials.py"
         mv "${ROOT_DIR}/${GEN_LOC}/${target}/conftest_${target}.py" "${ROOT_DIR}/${GEN_LOC}/${target}/conftest.py"
         mv "${ROOT_DIR}/${GEN_LOC}/${target}/utilities_${target}.py" "${ROOT_DIR}/${GEN_LOC}/${target}/utilities.py"

sonar/aggregations.py

@@ -40,8 +40,8 @@ class Aggregation(comp.Component):
     """Parent class of applications and portfolios"""
 
     def __init__(self, endpoint: pf.Platform, key: str, data: types.ApiPayload = None) -> None:
-        self._nbr_projects = None
-        self._permissions = None
+        self._nbr_projects: Optional[int] = None
+        self._permissions: Optional[object] = None
         super().__init__(endpoint=endpoint, key=key)
 
     def reload(self, data: dict[str, any]) -> None:

sonar/app_branches.py

@@ -22,6 +22,7 @@
 
 from __future__ import annotations
 from typing import Optional
+from datetime import datetime
 
 import json
 from requests.utils import quote
@@ -62,7 +63,7 @@ def __init__(
         self.sq_json = branch_data
         self._is_main = is_main
         self._project_branches = project_branches
-        self._last_analysis = None
+        self._last_analysis: Optional[datetime] = None
         log.debug("Created object %s with uuid %d id %x", str(self), hash(self), id(self))
         ApplicationBranch.CACHE.put(self)
 

sonar/applications.py

@@ -71,9 +71,9 @@ class Application(aggr.Aggregation):
     def __init__(self, endpoint: pf.Platform, key: str, name: str) -> None:
         """Don't use this directly, go through the class methods to create Objects"""
         super().__init__(endpoint=endpoint, key=key)
-        self._branches = None
-        self._projects = None
-        self._description = None
+        self._branches: Optional[dict[str, app_branches.ApplicationBranch]] = None
+        self._projects: Optional[dict[str, str]] = None
+        self._description: Optional[str] = None
         self.name = name
         log.debug("Created object %s with uuid %d id %x", str(self), hash(self), id(self))
         Application.CACHE.put(self)
@@ -90,7 +90,7 @@ def get_object(cls, endpoint: pf.Platform, key: str) -> Application:
         :rtype: Application
         """
         check_supported(endpoint)
-        o = Application.CACHE.get(key, endpoint.local_url)
+        o: Application = Application.CACHE.get(key, endpoint.local_url)
         if o:
             return o
         data = json.loads(endpoint.get(Application.API[c.GET], params={"application": key}).text)["application"]
@@ -109,7 +109,7 @@ def load(cls, endpoint: pf.Platform, data: types.ApiPayload) -> Application:
         :rtype: Application
         """
         check_supported(endpoint)
-        o = Application.CACHE.get(data["key"], endpoint.local_url)
+        o: Application = Application.CACHE.get(data["key"], endpoint.local_url)
         if not o:
             o = cls(endpoint, data["key"], data["name"])
         o.reload(data)
@@ -259,7 +259,7 @@ def delete(self) -> bool:
                 branch.delete()
         return super().delete()
 
-    def get_hotspots(self, filters: dict[str, str] = None) -> dict[str, object]:
+    def get_hotspots(self, filters: Optional[dict[str, str]] = None) -> dict[str, object]:
         new_filters = filters.copy() if filters else {}
         pattern = new_filters.pop("branch", None) if new_filters else None
         if not pattern:
@@ -270,7 +270,7 @@ def get_hotspots(self, filters: dict[str, str] = None) -> dict[str, object]:
             findings_list |= comp.get_hotspots(new_filters)
         return findings_list
 
-    def get_issues(self, filters: dict[str, str] = None) -> dict[str, object]:
+    def get_issues(self, filters: Optional[dict[str, str]] = None) -> dict[str, object]:
         new_filters = filters.copy() if filters else {}
         pattern = new_filters.pop("branch", None) if new_filters else None
         if not pattern:
@@ -412,7 +412,8 @@ def update(self, data: types.ObjectJsonRepr) -> None:
         main_branch_name = next((k for k, v in data.get("branches", {}).items() if v.get("isMain", False)), None)
         main_branch_name is None or self.main_branch().rename(main_branch_name)
 
-        _ = [self.set_branches(name, branch_data) for name, branch_data in data.get("branches", {}).items()]
+        for name, branch_data in data.get("branches", {}).items():
+            self.set_branches(name, branch_data)
 
     def api_params(self, op: Optional[str] = None) -> types.ApiParams:
         ops = {c.READ: {"application": self.key}, c.RECOMPUTE: {"key": self.key}}

sonar/audit/problem.py

@@ -19,6 +19,7 @@
 #
 
 import csv
+from typing import Optional
 
 import sonar.logging as log
 from sonar import utilities
@@ -60,7 +61,9 @@ def to_json(self, with_url=False):
         return d
 
 
-def dump_report(problems: list[Problem], file: str, server_id: str = None, format: str = "csv", with_url: bool = False, separator: str = ",") -> None:
+def dump_report(
+    problems: list[Problem], file: str, server_id: Optional[str] = None, format: str = "csv", with_url: bool = False, separator: str = ","
+) -> None:
     """Dumps to file a report about a list of problems
 
     :param list[Problems] problems: List of problems to dump
@@ -76,7 +79,7 @@ def dump_report(problems: list[Problem], file: str, server_id: str = None, forma
         __dump_csv(problems=problems, file=file, server_id=server_id, with_url=with_url, separator=separator)
 
 
-def __dump_csv(problems: list[Problem], file: str, server_id: str = None, with_url: bool = False, separator: str = ",") -> None:
+def __dump_csv(problems: list[Problem], file: str, server_id: Optional[str] = None, with_url: bool = False, separator: str = ",") -> None:
     """Writes a list of problems in CSV format
 
     :param list[Problems] problems: List of problems to dump
@@ -98,7 +101,7 @@ def __dump_csv(problems: list[Problem], file: str, server_id: str = None, with_u
             csvwriter.writerow(data)
 
 
-def __dump_json(problems: list[Problem], file: str, server_id: str = None, with_url: bool = False) -> None:
+def __dump_json(problems: list[Problem], file: str, server_id: Optional[str] = None, with_url: bool = False) -> None:
     """Writes a list of problems in JSON format
 
     :param list[Problems] problems: List of problems to dump

sonar/branches.py

@@ -23,6 +23,7 @@
 from __future__ import annotations
 from http import HTTPStatus
 from typing import Optional
+from datetime import datetime
 import json
 import re
 from urllib.parse import unquote
@@ -67,10 +68,10 @@ def __init__(self, project: projects.Project, name: str) -> None:
         super().__init__(endpoint=project.endpoint, key=name)
         self.name = name
         self.concerned_object = project
-        self._is_main = None
-        self._new_code = None
-        self._last_analysis = None
-        self._keep_when_inactive = None
+        self._is_main: Optional[bool] = None
+        self._new_code: Optional[str] = None
+        self._last_analysis: Optional[datetime] = None
+        self._keep_when_inactive: Optional[bool] = None
         Branch.CACHE.put(self)
         log.debug("Created object %s", str(self))
 

sonar/changelog.py

@@ -36,7 +36,7 @@ def __init__(self, jsonlog: types.ApiPayload, concerned_object: object) -> None:
         """
         self.concerned_object = concerned_object
         self.sq_json = jsonlog
-        self._change_type = None
+        self._change_type: Optional[str] = None
 
     def __str__(self) -> str:
         """str() implementation"""