Refactoring issue filters per search

Author: okorach

sonar/issues.py

@@ -43,6 +43,12 @@
 COMPONENT_FILTER_OLD = "componentKeys"
 COMPONENT_FILTER = "components"
 
+OLD_STATUS = "resolutions"
+NEW_STATUS = "issueStatuses"
+
+OLD_FP = "FALSE-POSITIVE"
+NEW_FP = "FALSE_POSITIVE"
+
 _SEARCH_CRITERIAS = (
     COMPONENT_FILTER_OLD,
     COMPONENT_FILTER,
@@ -77,18 +83,17 @@
     "author",
     "issues",
     "languages",
-    "resolutions",
+    OLD_STATUS,
     "resolved",
     "rules",
     "scopes",
     # 10.2 new filter
     "impactSeverities",
     # 10.4 new filter
-    "issueStatuses",
+    NEW_STATUS,
 )
 
 _FILTERS_10_2_REMAPPING = {"severities": "impactSeverities"}
-_FILTERS_10_4_REMAPPING = {"statuses": "issueStatuses"}
 
 TYPES = ("BUG", "VULNERABILITY", "CODE_SMELL")
 SEVERITIES = ("BLOCKER", "CRITICAL", "MAJOR", "MINOR", "INFO")
@@ -102,7 +107,7 @@
     "impactSoftwareQualities": IMPACT_SOFTWARE_QUALITIES,
     "impactSeverities": IMPACT_SEVERITIES,
     "statuses": STATUSES,
-    "resolutions": RESOLUTIONS,
+    OLD_STATUS: RESOLUTIONS,
 }
 
 _TOO_MANY_ISSUES_MSG = "Too many issues, recursing..."
@@ -336,7 +341,7 @@ def is_wont_fix(self) -> bool:
         :return: Whether the issue is won't fix
         :rtype: bool
         """
-        return self.resolution == "WONT-FIX"
+        return self.resolution == "WONTFIX"
 
     def is_accepted(self) -> bool:
         """
@@ -350,7 +355,7 @@ def is_false_positive(self) -> bool:
         :return: Whether the issue is a false positive
         :rtype: bool
         """
-        return self.resolution == "FALSE-POSITIVE"
+        return self.resolution in ("FALSE-POSITIVE", "FALSE_POSITIVE")
 
     def strictly_identical_to(self, another_finding: Issue, ignore_component: bool = False) -> bool:
         """
@@ -447,7 +452,7 @@ def __apply_event(self, event: str, settings: ConfigSettings) -> bool:
             else:
                 self.reopen()
             # self.add_comment(f"Issue re-open {origin}", settings[SYNC_ADD_COMMENTS])
-        elif event_type == "FALSE-POSITIVE":
+        elif event_type in ("FALSE-POSITIVE", "FALSE_POSITIVE"):
             self.mark_as_false_positive()
             # self.add_comment(f"False positive {origin}", settings[SYNC_ADD_COMMENTS])
         elif event_type == "WONT-FIX":
@@ -747,8 +752,6 @@ def search(endpoint: pf.Platform, params: ApiParams = None, raise_error: bool =
     filters = pre_search_filters(endpoint=endpoint, params=params)
     # if endpoint.version() >= (10, 2, 0):
     #     new_params = util.dict_remap_and_stringify(new_params, _FILTERS_10_2_REMAPPING)
-    if endpoint.version() >= (10, 4, 0):
-        filters = _change_filters_for_10_4(filters)
 
     log.debug("Search filters = %s", str(filters))
     if not filters:
@@ -822,11 +825,10 @@ def count(endpoint: pf.Platform, **kwargs) -> int:
     params = {} if not kwargs else kwargs.copy()
     params["ps"] = 1
     try:
-        log.debug("Count params = %s", str(params))
         nbr_issues = len(search(endpoint=endpoint, params=params))
     except TooManyIssuesError as e:
         nbr_issues = e.nbr_issues
-    log.debug("Issue search %s would return %d issues", str(kwargs), nbr_issues)
+    log.debug("Count issues with filters %s returned %d issues", str(kwargs), nbr_issues)
     return nbr_issues
 
 
@@ -852,7 +854,7 @@ def count_by_rule(endpoint: pf.Platform, **kwargs) -> dict[str, int]:
             if d["val"] not in rulecount:
                 rulecount[d["val"]] = 0
             rulecount[d["val"]] += d["count"]
-    log.debug("Rule counts = %s", util.json_dump(rulecount))
+    # log.debug("Rule counts = %s", util.json_dump(rulecount))
     return rulecount
 
 
@@ -868,42 +870,36 @@ def pre_search_filters(endpoint: pf.Platform, params: ApiParams) -> ApiParams:
     """Returns the filtered list of params that are allowed for api/issue/search"""
     if not params:
         return {}
-    filters = util.dict_subset(util.remove_nones(params.copy()), _SEARCH_CRITERIAS)
-    if endpoint.version() >= (10, 2, 0):
-        if COMPONENT_FILTER_OLD in filters:
-            filters[COMPONENT_FILTER] = filters.pop(COMPONENT_FILTER_OLD)
-        if "types" in filters:
-            __MAP = {"BUG": "RELIABILITY", "CODE_SMELL": "MAINTAINABILITY", "VULNERABILITY": "SECURITY", "SECURITY_HOTSPOT": "SECURITY"}
-            filters["impactSoftwareQualities"] = [__MAP[t] for t in filters.pop("types")]
-            if len(filters["impactSoftwareQualities"]) == 0:
-                filters.pop("impactSoftwareQualities")
-        if "severities" in filters:
-            __MAP = {"BLOCKER": "HIGH", "CRITICAL": "HIGH", "MAJOR": "MEDIUM", "MINOR": "LOW", "INFO": "LOW"}
-            filters["impactSeverities"] = [__MAP[t] for t in filters.pop("severities")]
-            if len(filters["impactSeverities"]) == 0:
-                filters.pop("impactSeverities")
-    for k, v in FILTERS_MAP.items():
-        if k in filters:
-            filters[k] = util.allowed_values_string(filters[k], v)
-    if filters.get("languages", None) is not None:
-        filters["languages"] = util.list_to_csv(filters["languages"])
-
+    log.debug("Sanitizing issue search filters %s", str(params))
+    version = endpoint.version()
+    filters = util.dict_remap(original_dict=params.copy(), remapping={"project": COMPONENT_FILTER})
+    filters = util.dict_subset(util.remove_nones(filters), _SEARCH_CRITERIAS)
+    if version < (10, 2, 0):
+        # Starting from 10.2 - "componentKeys" was renamed "components"
+        filters = util.dict_remap(original_dict=filters, remapping={COMPONENT_FILTER: COMPONENT_FILTER_OLD})
+    else:
+        # Starting from 10.2 - Issue types were replaced by software qualities, and severities replaced by impacts
+        __MAP = {"BUG": "RELIABILITY", "CODE_SMELL": "MAINTAINABILITY", "VULNERABILITY": "SECURITY", "SECURITY_HOTSPOT": "SECURITY"}
+        filters["impactSoftwareQualities"] = util.list_re_value(filters.pop("types", None), __MAP)
+        if len(filters["impactSoftwareQualities"]) == 0:
+            filters.pop("impactSoftwareQualities")
+        __MAP = {"BLOCKER": "HIGH", "CRITICAL": "HIGH", "MAJOR": "MEDIUM", "MINOR": "LOW", "INFO": "LOW"}
+        filters["impactSeverities"] = util.list_re_value(filters.pop("severities", None), __MAP)
+        if len(filters["impactSeverities"]) == 0:
+            filters.pop("impactSeverities")
+
+    if version < (10, 4, 0):
+        log.debug("Sanitizing issue search filters - fixing resolutions")
+        filters = util.dict_remap(original_dict=filters, remapping={NEW_STATUS: OLD_STATUS})
+        if OLD_STATUS in filters:
+            filters[OLD_STATUS] = util.list_re_value(filters[OLD_STATUS], mapping={NEW_FP: OLD_FP})
+    else:
+        # Starting from 10.4 - "resolutions" was renamed "issuesStatuses", "FALSE-POSITIVE" was renamed "FALSE_POSITIVE"
+        filters = util.dict_remap(original_dict=filters, remapping={OLD_STATUS: NEW_STATUS})
+        if NEW_STATUS in filters:
+            filters[NEW_STATUS] = util.list_re_value(filters[NEW_STATUS], mapping={OLD_FP: NEW_FP})
+
+    filters = {k: util.allowed_values_string(v, FILTERS_MAP[k]) if k in FILTERS_MAP else v for k, v in filters.items()}
+    filters = {k: util.list_to_csv(v) for k, v in filters.items() if v}
+    log.debug("Sanitized issue search filters %s", str(filters))
     return filters
-
-
-def _change_filters_for_10_4(filters: ApiParams) -> ApiParams:
-    """Adjust filters for new 10.4 issues/search API parameters"""
-    if not filters:
-        return None
-    new_filters = util.dict_remap(filters.copy(), _FILTERS_10_4_REMAPPING)
-    statuses = []
-    for f in "resolutions", "issueStatuses":
-        if f in new_filters:
-            statuses += util.csv_to_list(new_filters[f])
-    new_filters.pop("resolutions", None)
-    if len(statuses) > 0:
-        if "FALSE-POSITIVE" in statuses:
-            statuses.remove("FALSE-POSITIVE")
-            statuses.append("FALSE_POSITIVE")
-        new_filters["issueStatuses"] = util.list_to_csv(statuses)
-    return new_filters