Fixed some integration tests

Author: andrecsilva

integration_tests/sonar/test_sonar_jinja2_autoescape.py

@@ -1,18 +1,18 @@
-from codemodder.codemods.test import SonarIntegrationTest
+from codemodder.codemods.test.integration_utils import SonarRemediationIntegrationTest
 from core_codemods.enable_jinja2_autoescape import EnableJinja2AutoescapeTransformer
 from core_codemods.sonar.sonar_enable_jinja2_autoescape import (
     SonarEnableJinja2Autoescape,
 )
 
 
-class TestSonarEnableJinja2Autoescape(SonarIntegrationTest):
+class TestSonarEnableJinja2Autoescape(SonarRemediationIntegrationTest):
     codemod = SonarEnableJinja2Autoescape
     code_path = "tests/samples/jinja2_autoescape.py"
-    replacement_lines = [
-        (3, "env = Environment(autoescape=True)\n"),
-        (4, "env = Environment(autoescape=True)\n"),
+    expected_diff_per_change = [
+        "--- \n+++ \n@@ -1,4 +1,4 @@\n from jinja2 import Environment\n \n-env = Environment()\n+env = Environment(autoescape=True)\n env = Environment(autoescape=False)\n",
+        "--- \n+++ \n@@ -1,4 +1,4 @@\n from jinja2 import Environment\n \n env = Environment()\n-env = Environment(autoescape=False)\n+env = Environment(autoescape=True)\n",
     ]
-    expected_diff = "--- \n+++ \n@@ -1,4 +1,4 @@\n from jinja2 import Environment\n \n-env = Environment()\n-env = Environment(autoescape=False)\n+env = Environment(autoescape=True)\n+env = Environment(autoescape=True)\n"
-    expected_line_change = "3"
+
+    expected_lines_changed = [3, 4]
     num_changes = 2
     change_description = EnableJinja2AutoescapeTransformer.change_description

integration_tests/test_add_requests_timeout.py

@@ -1,13 +1,13 @@
 from requests.exceptions import ConnectionError
 
-from codemodder.codemods.test import BaseIntegrationTest
+from codemodder.codemods.test.integration_utils import BaseRemediationIntegrationTest
 from core_codemods.add_requests_timeouts import (
     AddRequestsTimeouts,
     TransformAddRequestsTimeouts,
 )
 
 
-class TestAddRequestsTimeouts(BaseIntegrationTest):
+class TestAddRequestsTimeouts(BaseRemediationIntegrationTest):
     codemod = AddRequestsTimeouts
     original_code = """
     import requests
@@ -18,27 +18,13 @@ class TestAddRequestsTimeouts(BaseIntegrationTest):
     requests.post("https://example.com", verify=False)
     """
 
-    replacement_lines = [
-        (3, 'requests.get("https://example.com", timeout=60)\n'),
-        (6, 'requests.post("https://example.com", verify=False, timeout=60)\n'),
+    expected_diff_per_change = [
+        '--- \n+++ \n@@ -1,6 +1,6 @@\n import requests\n \n-requests.get("https://example.com")\n+requests.get("https://example.com", timeout=60)\n requests.get("https://example.com", timeout=1)\n requests.get("https://example.com", timeout=(1, 10), verify=False)\n requests.post("https://example.com", verify=False)',
+        '--- \n+++ \n@@ -3,4 +3,4 @@\n requests.get("https://example.com")\n requests.get("https://example.com", timeout=1)\n requests.get("https://example.com", timeout=(1, 10), verify=False)\n-requests.post("https://example.com", verify=False)\n+requests.post("https://example.com", verify=False, timeout=60)',
     ]
 
-    expected_diff = """\
---- 
-+++ 
-@@ -1,6 +1,6 @@
- import requests
- 
--requests.get("https://example.com")
-+requests.get("https://example.com", timeout=60)
- requests.get("https://example.com", timeout=1)
- requests.get("https://example.com", timeout=(1, 10), verify=False)
--requests.post("https://example.com", verify=False)
-+requests.post("https://example.com", verify=False, timeout=60)
-"""
-
     num_changes = 2
-    expected_line_change = "3"
+    expected_lines_changed = [3, 6]
     change_description = TransformAddRequestsTimeouts.change_description
     # expected because requests are made
     allowed_exceptions = (ConnectionError,)

integration_tests/test_jwt_decode_verify.py

@@ -1,8 +1,8 @@
-from codemodder.codemods.test import BaseIntegrationTest
+from codemodder.codemods.test.integration_utils import BaseRemediationIntegrationTest
 from core_codemods.jwt_decode_verify import JwtDecodeVerify, JwtDecodeVerifyTransformer
 
 
-class TestJwtDecodeVerify(BaseIntegrationTest):
+class TestJwtDecodeVerify(BaseRemediationIntegrationTest):
     codemod = JwtDecodeVerify
     original_code = """
     import jwt
@@ -20,17 +20,11 @@ class TestJwtDecodeVerify(BaseIntegrationTest):
     
     var = "something"
     """
-    replacement_lines = [
-        (
-            11,
-            """decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], verify=True)\n""",
-        ),
-        (
-            12,
-            """decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], options={"verify_signature": True})\n""",
-        ),
+    expected_diff_per_change = [
+        '--- \n+++ \n@@ -8,7 +8,7 @@\n \n encoded_jwt = jwt.encode(payload, SECRET_KEY, algorithm="HS256")\n \n-decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], verify=False)\n+decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], verify=True)\n decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], options={"verify_signature": False})\n \n var = "something"',
+        '--- \n+++ \n@@ -9,6 +9,6 @@\n encoded_jwt = jwt.encode(payload, SECRET_KEY, algorithm="HS256")\n \n decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], verify=False)\n-decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], options={"verify_signature": False})\n+decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], options={"verify_signature": True})\n \n var = "something"',
     ]
-    expected_diff = '--- \n+++ \n@@ -8,7 +8,7 @@\n \n encoded_jwt = jwt.encode(payload, SECRET_KEY, algorithm="HS256")\n \n-decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], verify=False)\n-decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], options={"verify_signature": False})\n+decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], verify=True)\n+decoded_payload = jwt.decode(encoded_jwt, SECRET_KEY, algorithms=["HS256"], options={"verify_signature": True})\n \n var = "something"\n'
-    expected_line_change = "11"
+
+    expected_lines_changed = [11, 12]
     num_changes = 2
     change_description = JwtDecodeVerifyTransformer.change_description

integration_tests/test_request_verify.py

@@ -1,10 +1,10 @@
 from requests import exceptions
 
-from codemodder.codemods.test import BaseIntegrationTest
+from codemodder.codemods.test.integration_utils import BaseRemediationIntegrationTest
 from core_codemods.requests_verify import RequestsVerify
 
 
-class TestRequestsVerify(BaseIntegrationTest):
+class TestRequestsVerify(BaseRemediationIntegrationTest):
     codemod = RequestsVerify
     original_code = """
     import requests
@@ -14,15 +14,12 @@ class TestRequestsVerify(BaseIntegrationTest):
     var = "hello"
     """
 
-    replacement_lines = [
-        (3, """requests.get("https://www.google.com", verify=True)\n"""),
-        (
-            4,
-            """requests.post("https://some-api/", json={"id": 1234, "price": 18}, verify=True)\n""",
-        ),
+    expected_diff_per_change = [
+        '--- \n+++ \n@@ -1,5 +1,5 @@\n import requests\n \n-requests.get("https://www.google.com", verify=False)\n+requests.get("https://www.google.com", verify=True)\n requests.post("https://some-api/", json={"id": 1234, "price": 18}, verify=False)\n var = "hello"',
+        '--- \n+++ \n@@ -1,5 +1,5 @@\n import requests\n \n requests.get("https://www.google.com", verify=False)\n-requests.post("https://some-api/", json={"id": 1234, "price": 18}, verify=False)\n+requests.post("https://some-api/", json={"id": 1234, "price": 18}, verify=True)\n var = "hello"',
     ]
-    expected_diff = '--- \n+++ \n@@ -1,5 +1,5 @@\n import requests\n \n-requests.get("https://www.google.com", verify=False)\n-requests.post("https://some-api/", json={"id": 1234, "price": 18}, verify=False)\n+requests.get("https://www.google.com", verify=True)\n+requests.post("https://some-api/", json={"id": 1234, "price": 18}, verify=True)\n var = "hello"\n'
-    expected_line_change = "3"
+
+    expected_lines_changed = [3, 4]
     num_changes = 2
     change_description = RequestsVerify.change_description
     # expected because when executing the output code it will make a request which fails, which is OK.

src/codemodder/codemods/test/integration_utils.py

@@ -69,6 +69,14 @@ def setup_class(cls):
             manage_py_path = parent_dir / "manage.py"
             manage_py_path.touch()
 
+        if cls.original_code is not NotImplementedError:
+            # Some tests are easier to understand with the expected new code provided
+            # instead of calculated
+            cls.original_code = dedent(cls.original_code).strip("\n")
+        else:
+            with open(cls.code_path, "r", encoding="utf-8") as f:  # type: ignore
+                cls.original_code = f.read()
+
     def _assert_run_fields(self, run, output_path):
         assert run["vendor"] == "pixee"
         assert run["tool"] == "codemodder-python"
@@ -152,14 +160,15 @@ def _assert_codetf_output(self, codetf_schema):
         # CodeTf2 spec requires relative paths
         self._assert_results_fields(results, self.code_filename)
 
+    def write_original_code(self):
+        with open(self.code_path, "w", encoding="utf-8") as f:
+            f.write(self.original_code)
+
     def test_codetf_output(self, codetf_schema):
         """
         Tests correct codetf output.
         """
 
-        with open(self.code_path, "r", encoding="utf-8") as f:  # type: ignore
-            original_code = f.read()
-
         command = [
             "codemodder",
             self.code_dir,
@@ -175,6 +184,8 @@ def test_codetf_output(self, codetf_schema):
         if self.sonar_hotspots_json:
             command.append(f"--sonar-hotspots-json={self.sonar_hotspots_json}")
 
+        self.write_original_code()
+
         completed_process = subprocess.run(
             command,
             check=False,
@@ -189,7 +200,7 @@ def test_codetf_output(self, codetf_schema):
         # check that the original file is not rewritten
         with open(self.code_path, "r", encoding="utf-8") as f:
             original_file_code = f.read()
-            assert original_file_code == original_code
+            assert original_file_code == self.original_code
 
     def apply_hunk_to_lines(self, lines, hunk):
         # The hunk target line numbers are 1-indexed.
@@ -266,7 +277,7 @@ def apply_diff(self, diff_str, original_str):
         return "".join(patched_lines)
 
     def _get_patched_code_for_each_change(self) -> list[str]:
-        with open(self.output_path, "r", encoding="utf-8") as f:
+        with open(self.output_path, "r", encoding="utf-8") as f:  # type: ignore
             codetf = json.load(f)
         changes = codetf["results"][0]["changeset"]
         patched_codes = []
@@ -349,7 +360,7 @@ def _assert_run_fields(self, run, output_path):
         assert run["elapsed"] != ""
         assert run[
             "commandLine"
-        ] == f'codemodder {self.code_dir} --output {output_path} --codemod-include={self.codemod_instance.id} --path-include={self.code_filename} --path-exclude=""' + (
+        ] == f'codemodder_hardening {self.code_dir} --output {output_path} --codemod-include={self.codemod_instance.id} --path-include={self.code_filename} --path-exclude=""' + (
             f" --sonar-issues-json={self.sonar_issues_json}"
             if self.sonar_issues_json
             else ""
@@ -438,7 +449,7 @@ def test_file_rewritten(self, codetf_schema):
         output files
         """
         command = [
-            "codemodder",
+            "codemodder_hardening",
             self.code_dir,
             "--output",
             self.output_path,
@@ -510,6 +521,15 @@ def setup_class(cls):
         cls.code_dir = SAMPLES_DIR
         cls.code_filename = os.path.relpath(cls.code_path, SAMPLES_DIR)
 
+        if cls.original_code is not NotImplementedError:
+            # Some tests are easier to understand with the expected new code provided
+            # instead of calculated
+            cls.original_code = dedent(cls.original_code).strip("\n")
+        else:
+            with open(cls.code_path, "r", encoding="utf-8") as f:  # type: ignore
+                cls.original_code = f.read()
+            print(cls.original_code)
+
         # TODO: support sonar integration tests that add a dependency to
         # `requirements_file_name`. These tests would not be able to run
         # in parallel at this time since they would all override the same