implement finding msg for codeql

src/codemodder/codeql.py

@@ -43,12 +43,11 @@ class CodeQLResult(SarifResult):
     def from_sarif(
         cls, sarif_result, sarif_run, truncate_rule_id: bool = False
     ) -> Self:
+        rule_id = cls.extract_rule_id(sarif_result, sarif_run, truncate_rule_id)
+        text_for_rule = get_text_for_rule(rule_id, sarif_run)
+        finding_msg = f"{sarif_result['message']['text']}\n{text_for_rule}"
         return cls(
-            rule_id=(
-                rule_id := cls.extract_rule_id(
-                    sarif_result, sarif_run, truncate_rule_id
-                )
-            ),
+            rule_id=rule_id,
             locations=cls.extract_locations(sarif_result),
             codeflows=cls.extract_code_flows(sarif_result),
             related_locations=cls.extract_related_locations(sarif_result),
@@ -62,6 +61,7 @@ def from_sarif(
                     # url=,
                 ),
             ),
+            finding_msg=finding_msg,
         )
 
 
@@ -80,3 +80,12 @@ def from_sarif(cls, sarif_file: str | Path, truncate_rule_id: bool = False) -> S
                     )
                     result_set.add_result(codeql_result)
         return result_set
+
+
+# TODO: cache, make hashable
+def get_text_for_rule(rule_id: str, sarif_run: dict) -> str:
+    for ext in sarif_run["tool"]["extensions"]:
+        for rule in ext.get("rules", []):
+            if rule["id"] == rule_id:
+                return f"{rule.get('fullDescription', {}).get('text', '')}\n{rule.get('help', {}).get('text', '')}"
+    return ""

src/codemodder/result.py

@@ -76,6 +76,7 @@ def __hash__(self):
 @dataclass(frozen=True, kw_only=True)
 class SASTResult(Result):
     finding_id: str
+    finding_msg: str | None
 
 
 @dataclass(frozen=True, kw_only=True)

src/codemodder/semgrep.py

@@ -72,6 +72,7 @@ def from_sarif(
                     url=semgrep_url_from_id(rule_id),
                 ),
             ),
+            finding_msg="TODO",
         )
 
 

src/core_codemods/defectdojo/results.py

@@ -37,6 +37,7 @@ def from_result(cls, result: dict) -> Self:
                     url=None,
                 ),
             ),
+            finding_msg="TODO",
         )
 
     @override

src/core_codemods/sonar/results.py

@@ -76,6 +76,7 @@ def from_result(cls, result: dict) -> Self:
                     url=sonar_url_from_id(rule_id),
                 ),
             ),
+            finding_msg="TODO",
         )
 
     def match_location(self, pos, node):

tests/test_codeql.py

@@ -209,11 +209,18 @@ def test_from_sarif(self):
                 "driver": {"name": "CodeQL"},
                 "extensions": [
                     {
+                        "name": "codeql/python-queries",
                         "rules": [
-                            {"id": "python/sql-injection"},
+                            {
+                                "id": "python/sql-injection",
+                                "fullDescription": {
+                                    "text": "Some lengthy description."
+                                },
+                                "help": {"text": "Description\n"},
+                            },
                             {"id": "cs/web/missing-x-frame-options"},
                             {"id": "cs/web/xss"},
-                        ]
+                        ],
                     },
                 ],
             },