Ruff: Add and fix RUF015

Author: kiblik

dojo/reports/widgets.py

@@ -19,7 +19,7 @@
 )
 from dojo.forms import CustomReportOptionsForm
 from dojo.models import Endpoint, Finding
-from dojo.utils import get_page_items, get_system_setting, get_words_for_field
+from dojo.utils import first_elem, get_page_items, get_system_setting, get_words_for_field
 
 """
 Widgets are content sections that can be included on reports.  The report builder will allow any number of widgets
@@ -369,10 +369,12 @@ def report_widget_factory(json_data=None, request=None, user=None, finding_notes
     widgets = json.loads(json_data)
 
     for idx, widget in enumerate(widgets):
-        if list(widget.keys())[0] == "page-break":
-            selected_widgets[list(widget.keys())[0] + "-" + str(idx)] = PageBreak()
+        first_widget_keys = first_elem(widget.keys())
 
-        if list(widget.keys())[0] == "endpoint-list":
+        if first_widget_keys == "page-break":
+            selected_widgets[first_widget_keys + "-" + str(idx)] = PageBreak()
+
+        if first_widget_keys == "endpoint-list":
             endpoints = Endpoint.objects.filter(finding__active=True,
                                                 finding__false_p=False,
                                                 finding__duplicate=False,
@@ -384,7 +386,7 @@ def report_widget_factory(json_data=None, request=None, user=None, finding_notes
             endpoints = endpoints.distinct()
 
             d = QueryDict(mutable=True)
-            for item in widget.get(list(widget.keys())[0]):
+            for item in widget.get(first_widget_keys):
                 if item["name"] in d:
                     d.appendlist(item["name"], item["value"])
                 else:
@@ -398,12 +400,12 @@ def report_widget_factory(json_data=None, request=None, user=None, finding_notes
             endpoints = EndpointList(request=request, endpoints=endpoints, finding_notes=finding_notes,
                                      finding_images=finding_images, host=host, user_id=user_id)
 
-            selected_widgets[list(widget.keys())[0] + "-" + str(idx)] = endpoints
+            selected_widgets[first_widget_keys + "-" + str(idx)] = endpoints
 
-        if list(widget.keys())[0] == "finding-list":
+        if first_widget_keys == "finding-list":
             findings = Finding.objects.all()
             d = QueryDict(mutable=True)
-            for item in widget.get(list(widget.keys())[0]):
+            for item in widget.get(first_widget_keys):
                 if item["name"] in d:
                     d.appendlist(item["name"], item["value"])
                 else:
@@ -412,47 +414,47 @@ def report_widget_factory(json_data=None, request=None, user=None, finding_notes
             filter_class = ReportFindingFilterWithoutObjectLookups if filter_string_matching else ReportFindingFilter
             findings = filter_class(d, queryset=findings)
             user_id = user.id if user is not None else None
-            selected_widgets[list(widget.keys())[0] + "-" + str(idx)] = FindingList(request=request, findings=findings,
+            selected_widgets[first_widget_keys + "-" + str(idx)] = FindingList(request=request, findings=findings,
                                                                               finding_notes=finding_notes,
                                                                               finding_images=finding_images,
                                                                               host=host, user_id=user_id)
 
-        if list(widget.keys())[0] == "custom-content":
+        if first_widget_keys == "custom-content":
             wysiwyg_content = WYSIWYGContent(request=request)
             wysiwyg_content.heading = \
-                next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == "heading"), None)["value"]
+                next((item for item in widget.get(first_widget_keys) if item["name"] == "heading"), None)["value"]
             wysiwyg_content.content = \
-                next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == "hidden_content"), None)["value"]
+                next((item for item in widget.get(first_widget_keys) if item["name"] == "hidden_content"), None)["value"]
             wysiwyg_content.page_break_after = \
-                next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == "page_break_after"),
+                next((item for item in widget.get(first_widget_keys) if item["name"] == "page_break_after"),
                      {"value": False})["value"]
-            selected_widgets[list(widget.keys())[0] + "-" + str(idx)] = wysiwyg_content
-        if list(widget.keys())[0] == "report-options":
+            selected_widgets[first_widget_keys + "-" + str(idx)] = wysiwyg_content
+        if first_widget_keys == "report-options":
             options = ReportOptions(request=request)
             options.include_finding_notes = \
-                next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == "include_finding_notes"), None)[
+                next((item for item in widget.get(first_widget_keys) if item["name"] == "include_finding_notes"), None)[
                     "value"]
             options.include_finding_images = \
-                next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == "include_finding_images"), None)[
+                next((item for item in widget.get(first_widget_keys) if item["name"] == "include_finding_images"), None)[
                     "value"]
             options.report_type = \
-                next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == "report_type"), None)["value"]
+                next((item for item in widget.get(first_widget_keys) if item["name"] == "report_type"), None)["value"]
             options.report_name = \
-                next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == "report_name"), None)["value"]
-            selected_widgets[list(widget.keys())[0]] = options
-        if list(widget.keys())[0] == "table-of-contents":
+                next((item for item in widget.get(first_widget_keys) if item["name"] == "report_name"), None)["value"]
+            selected_widgets[first_widget_keys] = options
+        if first_widget_keys == "table-of-contents":
             toc = TableOfContents(request=request)
-            toc.heading = next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == "heading"), None)[
+            toc.heading = next((item for item in widget.get(first_widget_keys) if item["name"] == "heading"), None)[
                 "value"]
-            selected_widgets[list(widget.keys())[0]] = toc
-        if list(widget.keys())[0] == "cover-page":
+            selected_widgets[first_widget_keys] = toc
+        if first_widget_keys == "cover-page":
             cover_page = CoverPage(request=request)
-            cover_page.heading = next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == "heading"), None)[
+            cover_page.heading = next((item for item in widget.get(first_widget_keys) if item["name"] == "heading"), None)[
                 "value"]
             cover_page.sub_heading = \
-                next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == "sub_heading"), None)["value"]
+                next((item for item in widget.get(first_widget_keys) if item["name"] == "sub_heading"), None)["value"]
             cover_page.meta_info = \
-                next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == "meta_info"), None)["value"]
-            selected_widgets[list(widget.keys())[0]] = cover_page
+                next((item for item in widget.get(first_widget_keys) if item["name"] == "meta_info"), None)["value"]
+            selected_widgets[first_widget_keys] = cover_page
 
     return selected_widgets

dojo/tools/api_cobalt/api_client.py

@@ -1,6 +1,8 @@
 import requests
 from django.conf import settings
 
+from dojo.utils import first_elem
+
 
 class CobaltAPI:
 
@@ -90,7 +92,7 @@ def test_connection(self):
             orgs = filter(
                 lambda org: org["resource"]["token"] == self.org_token, data,
             )
-            org = list(orgs)[0]
+            org = first_elem(orgs)
             org_name = org["resource"]["name"]
             return f'You have access to the "{org_name}" organization'
         msg = (

dojo/tools/burp_enterprise/parser.py

@@ -4,6 +4,7 @@
 from lxml import etree, html
 
 from dojo.models import Endpoint, Finding
+from dojo.utils import first_elem
 
 logger = logging.getLogger(__name__)
 
@@ -117,7 +118,7 @@ def _get_content(self, container: etree.Element):
                         if stripped_text is not None:
                             value += stripped_text + "\n"
                     elif stripped_text.isspace():
-                        value = list(elem.itertext())[0]
+                        value = first_elem(elem.itertext())
                     elif elem.tag == "div" or elem.tag == "span":
                         value = elem.text_content().strip().replace("\n", "") + "\n"
                     else:

dojo/tools/harbor_vulnerability/parser.py

@@ -2,6 +2,7 @@
 import json
 
 from dojo.models import Finding
+from dojo.utils import first_elem
 
 
 class HarborVulnerabilityParser:
@@ -32,7 +33,7 @@ def get_findings(self, filename, test):
             vulnerability = data["vulnerabilities"]
         # To be compatible with update in version
         with contextlib.suppress(KeyError, StopIteration, TypeError):
-            vulnerability = data[next(iter(data.keys()))]["vulnerabilities"]
+            vulnerability = data[first_elem(data.keys())]["vulnerabilities"]
 
         # Early exit if empty
         if "vulnerability" not in locals() or vulnerability is None:

dojo/tools/sarif/parser.py

@@ -8,6 +8,7 @@
 
 from dojo.models import Finding
 from dojo.tools.parser_test import ParserTest
+from dojo.utils import first_elem
 
 logger = logging.getLogger(__name__)
 
@@ -465,7 +466,7 @@ def get_items_from_result(result, rules, artifacts, run_date):
         # compare it
         if result.get("fingerprints"):
             hashes = get_fingerprints_hashes(result["fingerprints"])
-            first_item = next(iter(hashes.items()))
+            first_item = first_elem(hashes.items())
             finding.unique_id_from_tool = first_item[1]["value"]
         elif result.get("partialFingerprints"):
             # for this one we keep an order to have id that could be compared

dojo/tools/sonarqube/soprasteria_html.py

@@ -1,6 +1,7 @@
 import logging
 
 from dojo.tools.sonarqube.soprasteria_helper import SonarQubeSoprasteriaHelper
+from dojo.utils import first_elem
 
 logger = logging.getLogger(__name__)
 
@@ -23,13 +24,13 @@ def get_items(self, tree, test, mode):
             rulesDic = {}
             for rule in rules_table:
                 rule_properties = list(rule.iter("td"))
-                rule_name = list(rule_properties[0].iter("a"))[0].text.strip()
-                rule_details = list(rule_properties[1].iter("details"))[0]
+                rule_name = first_elem(rule_properties[0].iter("a")).text.strip()
+                rule_details = first_elem(rule_properties[1].iter("details"))
                 rulesDic[rule_name] = rule_details
 
             for vuln in vulnerabilities_table:
                 vuln_properties = list(vuln.iter("td"))
-                rule_key = list(vuln_properties[0].iter("a"))[0].text
+                rule_key = first_elem(vuln_properties[0].iter("a")).text
                 vuln_rule_name = rule_key and rule_key.strip()
                 vuln_severity = SonarQubeSoprasteriaHelper().convert_sonar_severity(
                     vuln_properties[1].text and vuln_properties[1].text.strip(),

dojo/tools/trufflehog/parser.py

@@ -2,6 +2,7 @@
 import json
 
 from dojo.models import Finding
+from dojo.utils import first_elem
 
 
 class TruffleHogParser:
@@ -112,7 +113,7 @@ def get_findings_v3(self, data, test):
             source = {}
             source_data = {}
             if metadata:
-                source = list(metadata.keys())[0]
+                source = first_elem(metadata.keys())
                 source_data = metadata.get(source)
 
             file = source_data.get("file", "")

dojo/tools/veracode_sca/parser.py

@@ -9,6 +9,7 @@
 from django.utils import timezone
 
 from dojo.models import Finding
+from dojo.utils import first_elem
 
 
 class VeracodeScaParser:
@@ -159,7 +160,7 @@ def get_findings_csv(self, file, test):
             issueId = row.get("Issue ID", None)
             if not issueId:
                 # Workaround for possible encoding issue
-                issueId = list(row.values())[0]
+                issueId = first_elem(row.values())
             library = row.get("Library", None)
             if row.get("Package manager") == "MAVEN" and row.get(
                 "Coordinate 2",

dojo/utils.py

@@ -173,7 +173,7 @@ def match_finding_to_existing_findings(finding, product=None, engagement=None, t
 
     deduplicationLogger.debug(
         "Matching finding %i:%s to existing findings in %s %s using %s as deduplication algorithm.",
-        finding.id, finding.title, custom_filter_type, list(custom_filter.values())[0], deduplication_algorithm,
+        finding.id, finding.title, custom_filter_type, first_elem(custom_filter.values()), deduplication_algorithm,
     )
 
     if deduplication_algorithm == "hash_code":
@@ -2709,3 +2709,9 @@ def generate_file_response_from_file_path(
     response["Content-Disposition"] = f'attachment; filename="{full_file_name}"'
     response["Content-Length"] = file_size
     return response
+
+
+def first_elem(x):
+    # This function is workaround for using of `list(...)[0]`.
+    # RUF015 recommends to use `next(iter(x))` but it is harder for reading in regular code
+    return next(iter(x))

ruff.toml

@@ -94,7 +94,6 @@ ignore = [
     "SIM115",
     "SIM117",
     "RUF012",
-    "RUF015",
     "D205",
     "D211",  # `one-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible.
     "D212",  # `multi-line-summary-first-line` (D212) and `multi-line-summary-second-line` (D213) are incompatible.