Update Change.findings => fixedFindings to conform to spec

Author: drdavella

src/codemodder/codemods/imported_call_modifier.py

@@ -81,7 +81,7 @@ def leave_Call(self, original_node: cst.Call, updated_node: cst.Call):
                     Change(
                         lineNumber=line_number,
                         description=self.change_description,
-                        findings=self.file_context.get_findings_for_location(
+                        fixedFindings=self.file_context.get_findings_for_location(
                             line_number
                         ),
                     )

src/codemodder/codemods/libcst_transformer.py

@@ -126,7 +126,7 @@ def report_change_for_line(
             Change(
                 lineNumber=line_number,
                 description=description or self.change_description,
-                findings=findings
+                fixedFindings=findings
                 or self.file_context.get_findings_for_location(line_number),
             )
         )

src/codemodder/codemods/regex_transformer.py

@@ -40,7 +40,7 @@ def _apply(self, original_lines, file_context, results):
                     Change(
                         lineNumber=lineno + 1,
                         description=self.change_description,
-                        findings=file_context.get_findings_for_location(lineno),
+                        fixedFindings=file_context.get_findings_for_location(lineno),
                     )
                 )
         return changes, updated_lines
@@ -110,7 +110,7 @@ def _apply(self, original_lines, file_context, results):
                     Change(
                         lineNumber=lineno + 1,
                         description=self.change_description,
-                        findings=file_context.get_findings_for_location(lineno),
+                        fixedFindings=file_context.get_findings_for_location(lineno),
                     )
                 )
 

src/codemodder/codemods/test/utils.py

@@ -224,5 +224,5 @@ def run_and_assert(
 
     def assert_findings(self, changes: list[Change]):
         assert all(
-            x.findings for x in changes
+            x.fixedFindings for x in changes
         ), f"Expected all changes to have findings: {changes}"

src/codemodder/codemods/xml_transformer.py

@@ -96,7 +96,7 @@ def add_change(self, line):
             Change(
                 lineNumber=line,
                 description=self.change_description or None,
-                findings=self.file_context.get_findings_for_location(line),
+                fixedFindings=self.file_context.get_findings_for_location(line),
             )
         )
 

src/codemodder/codetf.py

@@ -62,7 +62,7 @@ class Change(BaseModel):
     diffSide: DiffSide = DiffSide.RIGHT
     properties: Optional[dict] = None
     packageActions: Optional[list[PackageAction]] = None
-    findings: Optional[list[Finding]] = None
+    fixedFindings: Optional[list[Finding]] = None
 
     @model_validator(mode="after")
     def validate_lineNumber(self):
@@ -83,7 +83,7 @@ def with_findings(self, findings: list[Finding] | None) -> Change:
             diffSide=self.diffSide,
             properties=self.properties,
             packageActions=self.packageActions,
-            findings=findings,
+            fixedFindings=findings,
         )
 
 

src/codemodder/utils/update_finding_metadata.py

@@ -27,7 +27,7 @@ def update_finding_metadata(
                             if finding.rule.id in tool_rule_map
                             else finding
                         )
-                        for finding in change.findings or []
+                        for finding in change.fixedFindings or []
                     ]
                     or None
                 )

src/core_codemods/file_resource_leak.py

@@ -229,7 +229,7 @@ def _handle_block(
                     Change(
                         lineNumber=line_number,
                         description=FileResourceLeakTransformer.change_description,
-                        findings=self.file_context.get_findings_for_location(
+                        fixedFindings=self.file_context.get_findings_for_location(
                             line_number
                         ),
                     )

tests/codemods/defectdojo/semgrep/test_avoid_insecure_deserialization.py

@@ -46,9 +46,9 @@ def test_yaml_load(self, tmpdir):
         )
 
         assert changes is not None
-        assert changes[0].changes[0].findings is not None
-        assert changes[0].changes[0].findings[0].id == "1"
-        assert changes[0].changes[0].findings[0].rule.id == RULE_ID
+        assert changes[0].changes[0].fixedFindings is not None
+        assert changes[0].changes[0].fixedFindings[0].id == "1"
+        assert changes[0].changes[0].fixedFindings[0].rule.id == RULE_ID
 
     @mock.patch("codemodder.codemods.api.FileContext.add_dependency")
     def test_pickle_load(self, adds_dependency, tmpdir):
@@ -80,9 +80,9 @@ def test_pickle_load(self, adds_dependency, tmpdir):
         adds_dependency.assert_called_once_with(Fickling)
 
         assert changes is not None
-        assert changes[0].changes[0].findings is not None
-        assert changes[0].changes[0].findings[0].id == "2"
-        assert changes[0].changes[0].findings[0].rule.id == RULE_ID
+        assert changes[0].changes[0].fixedFindings is not None
+        assert changes[0].changes[0].fixedFindings[0].id == "2"
+        assert changes[0].changes[0].fixedFindings[0].rule.id == RULE_ID
 
     @mock.patch("codemodder.codemods.api.FileContext.add_dependency")
     def test_pickle_and_yaml(self, adds_dependency, tmpdir):
@@ -128,12 +128,12 @@ def test_pickle_and_yaml(self, adds_dependency, tmpdir):
         adds_dependency.assert_called_once_with(Fickling)
 
         assert changes is not None
-        assert changes[0].changes[0].findings is not None
-        assert changes[0].changes[0].findings[0].id == "4"
-        assert changes[0].changes[0].findings[0].rule.id == RULE_ID
-        assert changes[0].changes[1].findings is not None
-        assert changes[0].changes[1].findings[0].id == "3"
-        assert changes[0].changes[1].findings[0].rule.id == RULE_ID
+        assert changes[0].changes[0].fixedFindings is not None
+        assert changes[0].changes[0].fixedFindings[0].id == "4"
+        assert changes[0].changes[0].fixedFindings[0].rule.id == RULE_ID
+        assert changes[0].changes[1].fixedFindings is not None
+        assert changes[0].changes[1].fixedFindings[0].id == "3"
+        assert changes[0].changes[1].fixedFindings[0].rule.id == RULE_ID
 
     @mock.patch("codemodder.codemods.api.FileContext.add_dependency")
     def test_pickle_loads(self, adds_dependency, tmpdir):

tests/codemods/defectdojo/semgrep/test_django_secure_set_cookie.py

@@ -37,9 +37,9 @@ def test_simple(self, tmpdir):
         )
 
         assert changes is not None
-        assert changes[0].changes[0].findings is not None
-        assert changes[0].changes[0].findings[0].id == "1"
+        assert changes[0].changes[0].fixedFindings is not None
+        assert changes[0].changes[0].fixedFindings[0].id == "1"
         assert (
-            changes[0].changes[0].findings[0].rule.id
+            changes[0].changes[0].fixedFindings[0].rule.id
             == "python.django.security.audit.secure-cookies.django-secure-set-cookie"
         )