Adjusted tests to account for individual changes diff

Author: andrecsilva

src/codemodder/codemods/test/utils.py

@@ -1,3 +1,4 @@
+import difflib
 import os
 from pathlib import Path
 from textwrap import dedent
@@ -58,6 +59,7 @@ def run_and_assert(
         tmpdir,
         input_code,
         expected,
+        expected_diff_per_change: list[str] = [],
         num_changes: int = 1,
         min_num_changes: int | None = None,
         root: Path | None = None,
@@ -99,13 +101,19 @@ def run_and_assert(
             tmp_file_path,
             input_code,
             expected,
-            changes[0],
+            expected_diff_per_change,
+            num_changes,
+            changes,
         )
 
     def assert_num_changes(self, changes, expected_num_changes, min_num_changes):
-        assert len(changes) == 1
+        print(len(changes))
+        print(changes)
+        for c in changes:
+            print(c.diff)
+        assert len(changes) == expected_num_changes
 
-        actual_num = len(changes[0].changes)
+        actual_num = len(changes)
 
         if min_num_changes is not None:
             assert (
@@ -116,25 +124,54 @@ def assert_num_changes(self, changes, expected_num_changes, min_num_changes):
                 actual_num == expected_num_changes
             ), f"Expected {expected_num_changes} changes but {actual_num} were created."
 
-    def assert_changes(self, root, file_path, input_code, expected, changes):
-        assert os.path.relpath(file_path, root) == changes.path
-        assert all(change.description for change in changes.changes)
-
-        expected_diff = create_diff(
-            dedent(input_code).splitlines(keepends=True),
-            dedent(expected).splitlines(keepends=True),
+    def assert_changes(
+        self,
+        root,
+        file_path,
+        input_code,
+        expected,
+        expected_diff_per_change,
+        num_changes,
+        changes,
+    ):
+        assert all(
+            os.path.relpath(file_path, root) == change.path for change in changes
         )
-        try:
-            assert expected_diff == changes.diff
-        except AssertionError:
-            raise DiffError(expected_diff, changes.diff)
-
-        output_code = file_path.read_bytes().decode("utf-8")
-
-        try:
-            assert output_code == (format_expected := dedent(expected))
-        except AssertionError:
-            raise DiffError(format_expected, output_code)
+        assert all(c.description for change in changes for c in change.changes)
+
+        # assert each change individually
+        if num_changes > 1:
+            assert num_changes == len(expected_diff_per_change)
+            for change, diff in zip(changes, expected_diff_per_change):
+                print(change.diff)
+                print("-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-")
+                print(diff)
+                print("+++++++++++++++++++++++++++++++")
+                print(
+                    "\n".join(
+                        difflib.ndiff(diff.splitlines(), change.diff.splitlines())
+                    )
+                    .replace(" ", "␣")
+                    .replace("\t", "→")
+                )
+                assert change.diff == diff
+        else:
+            # generate diff from expected code
+            expected_diff = create_diff(
+                dedent(input_code).splitlines(keepends=True),
+                dedent(expected).splitlines(keepends=True),
+            )
+            try:
+                assert expected_diff == changes.diff
+            except AssertionError:
+                raise DiffError(expected_diff, changes.diff)
+
+            output_code = file_path.read_bytes().decode("utf-8")
+
+            try:
+                assert output_code == (format_expected := dedent(expected))
+            except AssertionError:
+                raise DiffError(format_expected, output_code)
 
     def run_and_assert_filepath(
         self,
@@ -171,6 +208,7 @@ def run_and_assert(
         tmpdir,
         input_code,
         expected,
+        expected_diff_per_change: list[str] | None = None,
         num_changes: int = 1,
         min_num_changes: int | None = None,
         root: Path | None = None,
@@ -217,7 +255,9 @@ def run_and_assert(
             tmp_file_path,
             input_code,
             expected,
-            changes[0],
+            expected_diff_per_change,
+            num_changes,
+            changes,
         )
 
         return changes

tests/codemods/sonar/test_sonar_jwt_decode_verify.py

@@ -38,6 +38,31 @@ def test_simple(self, tmpdir):
         decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], verify=True)
         decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], options={"verify_signature": True})
         """
+
+        expected_diff_per_change = [
+            """\
+--- 
++++ 
+@@ -8,5 +8,5 @@
+ }
+ 
+ encoded_jwt = jwt.encode(payload, SECRET_KEY, algorithm="HS256")
+-decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], verify=False)
++decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], verify=True)
+ decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], options={"verify_signature": False})
+""",
+            """\
+--- 
++++ 
+@@ -9,4 +9,4 @@
+ 
+ encoded_jwt = jwt.encode(payload, SECRET_KEY, algorithm="HS256")
+ decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], verify=False)
+-decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], options={"verify_signature": False})
++decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], options={"verify_signature": True})
+""",
+        ]
+
         issues = {
             "issues": [
                 {
@@ -65,5 +90,10 @@ def test_simple(self, tmpdir):
             ]
         }
         self.run_and_assert(
-            tmpdir, input_code, expected, results=json.dumps(issues), num_changes=2
+            tmpdir,
+            input_code,
+            expected,
+            expected_diff_per_change,
+            results=json.dumps(issues),
+            num_changes=2,
         )