Hardening from tests (#1459)

* Add vscode config to point to pylint config

* Exclude implicit inherit from object

* Cache is a class variable

* Create cache clear function

* Use clear_cache before deleting portfolios

* Adjust to new portfolio project selection structure

* Clear SQ cache before running SC tests

Author: okorach

.vscode/settings.json

@@ -3,5 +3,8 @@
         "connectionId": "LATEST",
         "projectKey": "okorach_sonar-tools"
     },
-    "sonarlint.focusOnNewCode": true
+    "sonarlint.focusOnNewCode": true,
+    "pylint.args": [
+        "[\"--rcfile=conf/pylintrc\"]"
+    ]
 }

conf/pylintrc

@@ -87,7 +87,8 @@ disable=raw-checker-failed,
         W0238,
         R0911,
         C0325,
-        W1309
+        W1309,
+        R0205
 
 
 # Enable the message, report, category or checker with the given id(s). You can

sonar/app_branches.py

@@ -37,8 +37,6 @@
 from sonar import exceptions, projects, utilities
 import sonar.sqobject as sq
 
-_OBJECTS = {}
-
 APIS = {
     "search": "api/components/search_projects",
     "get": "api/applications/show",
@@ -55,6 +53,8 @@ class ApplicationBranch(Component):
     Abstraction of the SonarQube "application branch" concept
     """
 
+    _OBJECTS = {}
+
     def __init__(self, app: App, name: str, project_branches: list[Branch], is_main: bool = False) -> None:
         """Don't use this directly, go through the class methods to create Objects"""
         super().__init__(endpoint=app.endpoint, key=f"{app.key} BRANCH {name}")
@@ -64,7 +64,7 @@ def __init__(self, app: App, name: str, project_branches: list[Branch], is_main:
         self._project_branches = project_branches
         self._last_analysis = None
         log.debug("Created object %s with uuid %s id %x", str(self), self.uuid(), id(self))
-        _OBJECTS[self.uuid()] = self
+        ApplicationBranch._OBJECTS[self.uuid()] = self
 
     @classmethod
     def get_object(cls, app: App, branch_name: str) -> ApplicationBranch:
@@ -80,13 +80,13 @@ def get_object(cls, app: App, branch_name: str) -> ApplicationBranch:
         if app.endpoint.edition() == "community":
             raise exceptions.UnsupportedOperation(_NOT_SUPPORTED)
         uu = uuid(app.key, branch_name, app.endpoint.url)
-        if uu in _OBJECTS:
-            return _OBJECTS[uu]
+        if uu in ApplicationBranch._OBJECTS:
+            return ApplicationBranch._OBJECTS[uu]
         app.refresh()
         app.branches()
         uu = uuid(app.key, branch_name, app.endpoint.url)
-        if uu in _OBJECTS:
-            return _OBJECTS[uu]
+        if uu in ApplicationBranch._OBJECTS:
+            return ApplicationBranch._OBJECTS[uu]
         raise exceptions.ObjectNotFound(app.key, f"Application key '{app.key}' branch '{branch_name}' not found")
 
     @classmethod
@@ -147,7 +147,7 @@ def delete(self) -> bool:
         if self.is_main():
             log.warning("Can't delete main %s, simply delete the application for that", str(self))
             return False
-        return sq.delete_object(self, APIS["delete"], self.search_params(), _OBJECTS)
+        return sq.delete_object(self, APIS["delete"], self.search_params(), ApplicationBranch._OBJECTS)
 
     def reload(self, data: types.ApiPayload) -> None:
         """Reloads an App Branch from JSON data coming from Sonar"""

sonar/applications.py

@@ -39,7 +39,6 @@
 import sonar.utilities as util
 from sonar.audit import rules, problem
 
-_OBJECTS = {}
 _CLASS_LOCK = Lock()
 
 APIS = {
@@ -59,6 +58,8 @@ class Application(aggr.Aggregation):
     Abstraction of the SonarQube "application" concept
     """
 
+    _OBJECTS = {}
+
     SEARCH_API = "api/components/search_projects"
     SEARCH_KEY_FIELD = "key"
     SEARCH_RETURN_FIELD = "components"
@@ -71,7 +72,7 @@ def __init__(self, endpoint: pf.Platform, key: str, name: str) -> None:
         self._description = None
         self.name = name
         log.debug("Created object %s with uuid %s id %x", str(self), self.uuid(), id(self))
-        _OBJECTS[self.uuid()] = self
+        Application._OBJECTS[self.uuid()] = self
 
     @classmethod
     def get_object(cls, endpoint: pf.Platform, key: str) -> Application:
@@ -86,8 +87,8 @@ def get_object(cls, endpoint: pf.Platform, key: str) -> Application:
         """
         check_supported(endpoint)
         uu = sq.uuid(key=key, url=endpoint.url)
-        if uu in _OBJECTS:
-            return _OBJECTS[uu]
+        if uu in Application._OBJECTS:
+            return Application._OBJECTS[uu]
         try:
             data = json.loads(endpoint.get(APIS["get"], params={"application": key}).text)["application"]
         except (ConnectionError, RequestException) as e:
@@ -111,8 +112,8 @@ def load(cls, endpoint: pf.Platform, data: types.ApiPayload) -> Application:
         """
         check_supported(endpoint)
         uu = sq.uuid(key=data["key"], url=endpoint.url)
-        if uu in _OBJECTS:
-            o = _OBJECTS[uu]
+        if uu in Application._OBJECTS:
+            o = Application._OBJECTS[uu]
         else:
             o = cls(endpoint, data["key"], data["name"])
         o.reload(data)
@@ -152,7 +153,7 @@ def refresh(self) -> None:
             self.reload(json.loads(self.get(APIS["get"], params=self.search_params()).text)["application"])
         except (ConnectionError, RequestException) as e:
             if e.response.status_code == HTTPStatus.NOT_FOUND:
-                _OBJECTS.pop(self.uuid(), None)
+                Application._OBJECTS.pop(self.uuid(), None)
                 raise exceptions.ObjectNotFound(self.key, f"{str(self)} not found")
             log.error("%s while refreshing %s", util.error_msg(e), str(self))
             raise
@@ -261,7 +262,7 @@ def delete(self) -> bool:
             for branch in self.branches().values():
                 if not branch.is_main:
                     ok = ok and branch.delete()
-        return ok and sq.delete_object(self, "applications/delete", {"application": self.key}, _OBJECTS)
+        return ok and sq.delete_object(self, "applications/delete", {"application": self.key}, Application._OBJECTS)
 
     def get_filtered_branches(self, filters: dict[str, str]) -> Union[None, dict[str, object]]:
         """Get lists of branches according to the filter"""
@@ -588,11 +589,11 @@ def search_by_name(endpoint: pf.Platform, name: str) -> dict[str, Application]:
     """Searches applications by name. Several apps may match as name does not have to be unique"""
     get_list(endpoint=endpoint, use_cache=False)
     data = {}
-    for app in _OBJECTS.values():
+    for app in Application._OBJECTS.values():
         if app.name == name:
             log.debug("Found APP %s id %x", app.key, id(app))
             data[app.key] = app
-    # return {app.key: app for app in _OBJECTS.values() if app.name == name}
+    # return {app.key: app for app in Application._OBJECTS.values() if app.name == name}
     return data
 
 

sonar/devops.py

@@ -35,9 +35,6 @@
 #: DevOps platform types in SonarQube
 DEVOPS_PLATFORM_TYPES = ("github", "azure", "bitbucket", "bitbucketcloud", "gitlab")
 
-
-_OBJECTS = {}
-
 _CREATE_API_GITHUB = "alm_settings/create_github"
 _CREATE_API_GITLAB = "alm_settings/create_gitlab"
 _CREATE_API_AZURE = "alm_settings/create_azure"
@@ -54,21 +51,23 @@ class DevopsPlatform(sq.SqObject):
     Abstraction of the SonarQube ALM/DevOps Platform concept
     """
 
+    _OBJECTS = {}
+
     def __init__(self, endpoint: platform.Platform, key: str, platform_type: str) -> None:
         """Constructor"""
         super().__init__(endpoint=endpoint, key=key)
         self.type = platform_type  #: DevOps platform type
         self.url = None  #: DevOps platform URL
         self._specific = None  #: DevOps platform specific settings
-        _OBJECTS[self.uuid()] = self
+        DevopsPlatform._OBJECTS[self.uuid()] = self
         log.debug("Created object %s", str(self))
 
     @classmethod
     def read(cls, endpoint: platform.Platform, key: str) -> DevopsPlatform:
         """Reads a devops platform object in Sonar instance"""
         uu = sq.uuid(key, endpoint.url)
-        if uu in _OBJECTS:
-            return _OBJECTS[uu]
+        if uu in DevopsPlatform._OBJECTS:
+            return DevopsPlatform._OBJECTS[uu]
         data = json.loads(endpoint.get(APIS["list"]).text)
         for plt_type, platforms in data.items():
             for p in platforms:
@@ -81,8 +80,8 @@ def load(cls, endpoint: platform.Platform, plt_type: str, data: types.ApiPayload
         """Finds a devops platform object and loads it with data"""
         key = data["key"]
         uu = sq.uuid(key, endpoint.url)
-        if uu in _OBJECTS:
-            return _OBJECTS[uu]
+        if uu in DevopsPlatform._OBJECTS:
+            return DevopsPlatform._OBJECTS[uu]
         o = DevopsPlatform(endpoint=endpoint, key=key, platform_type=plt_type)
         return o._load(data)
 
@@ -198,9 +197,9 @@ def count(platf_type: str = None) -> int:
     :rtype: int
     """
     if platf_type is None:
-        return len(_OBJECTS)
+        return len(DevopsPlatform._OBJECTS)
     # Hack: check first 5 chars to that bitbucket cloud and bitbucket server match
-    return sum(1 for o in _OBJECTS.values() if o.type[0:4] == platf_type[0:4])
+    return sum(1 for o in DevopsPlatform._OBJECTS.values() if o.type[0:4] == platf_type[0:4])
 
 
 def get_list(endpoint: platform.Platform) -> dict[str, DevopsPlatform]:
@@ -213,12 +212,12 @@ def get_list(endpoint: platform.Platform) -> dict[str, DevopsPlatform]:
     if endpoint.is_sonarcloud():
         raise exceptions.UnsupportedOperation("Can't get list of DevOps platforms on SonarCloud")
     if endpoint.edition() == "community":
-        return _OBJECTS
+        return DevopsPlatform._OBJECTS
     data = json.loads(endpoint.get(APIS["list"]).text)
     for alm_type in DEVOPS_PLATFORM_TYPES:
         for alm_data in data.get(alm_type, {}):
             DevopsPlatform.load(endpoint, alm_type, alm_data)
-    return _OBJECTS
+    return DevopsPlatform._OBJECTS
 
 
 def get_object(devops_platform_key: str, endpoint: platform.Platform) -> DevopsPlatform:
@@ -228,7 +227,7 @@ def get_object(devops_platform_key: str, endpoint: platform.Platform) -> DevopsP
     :return: The DevOps platforms corresponding to key, or None if not found
     :rtype: DevopsPlatform
     """
-    if len(_OBJECTS) == 0:
+    if len(DevopsPlatform._OBJECTS) == 0:
         get_list(endpoint)
     return DevopsPlatform.read(endpoint, devops_platform_key)
 
@@ -265,7 +264,7 @@ def import_config(endpoint: platform.Platform, config_data: types.ObjectJsonRepr
     if endpoint.is_sonarcloud():
         raise exceptions.UnsupportedOperation("Can't get import DevOps platforms in SonarCloud")
     log.info("Importing DevOps config %s", util.json_dump(devops_settings))
-    if len(_OBJECTS) == 0:
+    if len(DevopsPlatform._OBJECTS) == 0:
         get_list(endpoint)
     for name, data in devops_settings.items():
         try:

sonar/groups.py

@@ -40,15 +40,14 @@
 REMOVE_USER_API = "user_groups/remove_user"
 _UPDATE_API_V2 = "v2/authorizations/groups"
 
-_OBJECTS = {}
-
 
 class Group(sq.SqObject):
     """
     Abstraction of the SonarQube "group" concept.
     Objects of this class must be created with one of the 3 available class methods. Don't use __init__
     """
 
+    _OBJECTS = {}
     SEARCH_API = "user_groups/search"
     SEARCH_API_V2 = "v2/authorizations/groups"
     SEARCH_KEY_FIELD = "name"
@@ -63,7 +62,7 @@ def __init__(self, endpoint: pf.Platform, name: str, data: types.ApiPayload) ->
         self.__is_default = data.get("default", None)
         self._id = data.get("id", None)  #: SonarQube 10.4+ Group id
         self._json = data
-        _OBJECTS[self.uuid()] = self
+        Group._OBJECTS[self.uuid()] = self
         log.debug("Created %s object", str(self))
 
     @classmethod
@@ -76,15 +75,15 @@ def read(cls, endpoint: pf.Platform, name: str) -> Group:
         """
         log.debug("Reading group '%s'", name)
         uid = sq.uuid(name, endpoint.url)
-        if uid in _OBJECTS:
-            return _OBJECTS[uid]
+        if uid in Group._OBJECTS:
+            return Group._OBJECTS[uid]
         data = util.search_by_name(endpoint, name, Group.SEARCH_API, "groups")
         if data is None:
             raise exceptions.UnsupportedOperation(f"Group '{name}' not found.")
         # SonarQube 10 compatibility: "id" field is dropped, use "name" instead
         uid = sq.uuid(data.get("id", data["name"]), endpoint.url)
-        if uid in _OBJECTS:
-            return _OBJECTS[uid]
+        if uid in Group._OBJECTS:
+            return Group._OBJECTS[uid]
         return cls(endpoint, name, data=data)
 
     @classmethod
@@ -239,9 +238,9 @@ def set_name(self, name: str) -> bool:
         else:
             r = self.post(_UPDATE_API, params={"currentName": self.key, "name": name})
         if r.ok:
-            _OBJECTS.pop(self.uuid(), None)
+            Group._OBJECTS.pop(self.uuid(), None)
             self.name = name
-            _OBJECTS[self.uuid()] = self
+            Group._OBJECTS[self.uuid()] = self
         return r.ok
 
 
@@ -316,20 +315,20 @@ def get_object(endpoint: pf.Platform, name: str) -> Group:
     :return: The group
     """
     uid = sq.uuid(name, endpoint.url)
-    if len(_OBJECTS) == 0 or uid not in _OBJECTS:
+    if len(Group._OBJECTS) == 0 or uid not in Group._OBJECTS:
         get_list(endpoint)
-    if uid not in _OBJECTS:
+    if uid not in Group._OBJECTS:
         raise exceptions.ObjectNotFound(name, message=f"Group '{name}' not found")
-    return _OBJECTS[uid]
+    return Group._OBJECTS[uid]
 
 
 def get_object_from_id(endpoint: pf.Platform, id: str) -> Group:
     """Searches a Group object from its id - SonarQube 10.4+"""
     if endpoint.version() < (10, 4, 0):
         raise exceptions.UnsupportedOperation
-    if len(_OBJECTS) == 0:
+    if len(Group._OBJECTS) == 0:
         get_list(endpoint)
-    for o in _OBJECTS.values():
+    for o in Group._OBJECTS.values():
         if o._id == id:
             return o
     raise exceptions.ObjectNotFound(id, message=f"Group '{id}' not found")

sonar/hotspots.py

@@ -73,8 +73,6 @@
 # Filters for search of hotspots are different than for issues :-(
 _FILTERS_HOTSPOTS_REMAPPING = {"resolutions": "resolution", "statuses": "status", "componentsKey": PROJECT_FILTER, "components": PROJECT_FILTER}
 
-_OBJECTS = {}
-
 
 class TooManyHotspotsError(Exception):
     def __init__(self, nbr_issues, message):
@@ -86,6 +84,7 @@ def __init__(self, nbr_issues, message):
 class Hotspot(findings.Finding):
     """Abstraction of the Sonar hotspot concept"""
 
+    _OBJECTS = {}
     SEARCH_API = "hotspots/search"
     MAX_PAGE_SIZE = 500
     MAX_SEARCH = 10000
@@ -109,7 +108,7 @@ def __init__(self, endpoint: pf.Platform, key: str, data: types.ApiPayload = Non
         if m:
             self.projectKey = m.group(1)
             self.branch = m.group(2)
-        _OBJECTS[self.uuid()] = self
+        Hotspot._OBJECTS[self.uuid()] = self
         if self.rule is None and self.refresh():
             self.rule = self.__details["rule"]["key"]
 
@@ -437,9 +436,9 @@ def search(endpoint: pf.Platform, filters: types.ApiParams = None) -> dict[str,
 def get_object(endpoint: pf.Platform, key: str, data: dict[str] = None, from_export: bool = False) -> Hotspot:
     """Returns a hotspot from its key"""
     uid = uuid(key, endpoint.url)
-    if uid not in _OBJECTS:
+    if uid not in Hotspot._OBJECTS:
         _ = Hotspot(key=key, data=data, endpoint=endpoint, from_export=from_export)
-    return _OBJECTS[uid]
+    return Hotspot._OBJECTS[uid]
 
 
 def sanitize_search_filters(endpoint: pf.Platform, params: types.ApiParams) -> types.ApiParams: