Update tests to use .name() and rely on wrapper id (#51)

* use name classmethod * remove codemod id to use wrapper id
pixee · Sep 28, 2023 · 4bcf73d · 4bcf73d
1 parent 9978745
commit 4bcf73d
Show file tree

Hide file tree

Showing 13 changed files with 38 additions and 31 deletions.
diff --git a/integration_tests/base_test.py b/integration_tests/base_test.py
@@ -1,11 +1,12 @@
-# pylint: disable=no-member
+# pylint: disable=no-member, protected-access, attribute-defined-outside-init
 import git
 import json
 import os
 import pathlib
 import subprocess
 
 from codemodder import __VERSION__
+from codemodder import registry
 
 
 SAMPLES_DIR = "tests/samples"
@@ -51,22 +52,33 @@ class BaseIntegrationTest(DependencyTestMixin, CleanRepoMixin):
     _lines = []
     num_changed_files = 1
 
+    @classmethod
+    def setup_class(cls):
+        cls.codemod_registry = registry.load_registered_codemods()
+
+    def setup_method(self):
+        self.codemod_wrapper = [
+            cmod
+            for cmod in self.codemod_registry._codemods
+            if cmod.codemod == self.codemod
+        ][0]
+
     def _assert_run_fields(self, run, output_path):
         assert run["vendor"] == "pixee"
         assert run["tool"] == "codemodder-python"
         assert run["version"] == __VERSION__
         assert run["elapsed"] != ""
         assert (
             run["commandLine"]
-            == f"codemodder {SAMPLES_DIR} --output {output_path} --codemod-include={self.codemod.name()}"
+            == f"codemodder {SAMPLES_DIR} --output {output_path} --codemod-include={self.codemod_wrapper.name}"
         )
         assert run["directory"] == os.path.abspath(SAMPLES_DIR)
         assert run["sarifs"] == []
 
     def _assert_results_fields(self, results, output_path):
         assert len(results) == 1
         result = results[0]
-        assert result["codemod"] == self.codemod.id()
+        assert result["codemod"] == self.codemod_wrapper.id
         assert len(result["changeset"]) == self.num_changed_files
 
         # A codemod may change multiple files. For now we will
@@ -123,7 +135,7 @@ def test_file_rewritten(self):
             SAMPLES_DIR,
             "--output",
             self.output_path,
-            f"--codemod-include={self.codemod.name()}",
+            f"--codemod-include={self.codemod_wrapper.name}",
         ]
 
         self.check_code_before()

diff --git a/src/codemodder/codemods/base_codemod.py b/src/codemodder/codemods/base_codemod.py
@@ -40,11 +40,6 @@ def name(cls):
         # pylint: disable=no-member
         return cls.METADATA.NAME
 
-    @classmethod
-    def id(cls):
-        # pylint: disable=no-member
-        return f"pixee:python/{cls.name()}"
-
     @property
     def should_transform(self):
         return True

diff --git a/tests/codemods/test_django_debug_flag_on.py b/tests/codemods/test_django_debug_flag_on.py
@@ -5,8 +5,8 @@
 class TestDjangoDebugFlagOn(BaseDjangoCodemodTest):
     codemod = DjangoDebugFlagOn
 
-    def test_rule_ids(self):
-        assert self.codemod.METADATA.NAME == "django-debug-flag-on"
+    def test_name(self):
+        assert self.codemod.name() == "django-debug-flag-on"
 
     def test_settings_dot_py(self, tmpdir):
         django_root, settings_folder = self.create_dir_structure(tmpdir)

diff --git a/tests/codemods/test_django_session_cookie_secure_off.py b/tests/codemods/test_django_session_cookie_secure_off.py
@@ -8,8 +8,8 @@
 class TestDjangoSessionSecureCookieOff(BaseDjangoCodemodTest):
     codemod = DjangoSessionCookieSecureOff
 
-    def test_rule_ids(self):
-        assert self.codemod.METADATA.NAME == "django-session-cookie-secure-off"
+    def test_name(self):
+        assert self.codemod.name() == "django-session-cookie-secure-off"
 
     def test_not_settings_dot_py(self, tmpdir):
         django_root, settings_folder = self.create_dir_structure(tmpdir)

diff --git a/tests/codemods/test_harden_pyyaml.py b/tests/codemods/test_harden_pyyaml.py
@@ -10,8 +10,8 @@
 class TestHardenPyyaml(BaseSemgrepCodemodTest):
     codemod = HardenPyyaml
 
-    def test_rule_ids(self):
-        assert self.codemod.NAME == "harden-pyyaml"
+    def test_name(self):
+        assert self.codemod.name() == "harden-pyyaml"
 
     def test_safe_loader(self, tmpdir):
         input_code = """import yaml

diff --git a/tests/codemods/test_harden_ruamel.py b/tests/codemods/test_harden_ruamel.py
@@ -6,8 +6,8 @@
 class TestHardenRuamel(BaseSemgrepCodemodTest):
     codemod = HardenRuamel
 
-    def test_rule_ids(self):
-        assert self.codemod.NAME == "harden-ruamel"
+    def test_name(self):
+        assert self.codemod.name() == "harden-ruamel"
 
     @pytest.mark.parametrize("loader", ["YAML()", "YAML(typ='rt')", "YAML(typ='safe')"])
     def test_safe(self, tmpdir, loader):

diff --git a/tests/codemods/test_jwt_decode_verify.py b/tests/codemods/test_jwt_decode_verify.py
@@ -6,8 +6,8 @@
 class TestJwtDecodeVerify(BaseSemgrepCodemodTest):
     codemod = JwtDecodeVerify
 
-    def test_rule_ids(self):
-        assert self.codemod.NAME == "jwt-decode-verify"
+    def test_name(self):
+        assert self.codemod.name() == "jwt-decode-verify"
 
     def test_import(self, tmpdir):
         input_code = """import jwt

diff --git a/tests/codemods/test_limit_readline.py b/tests/codemods/test_limit_readline.py
@@ -5,8 +5,8 @@
 class TestLimitReadline(BaseSemgrepCodemodTest):
     codemod = LimitReadline
 
-    def test_rule_ids(self):
-        assert self.codemod.NAME == "limit-readline"
+    def test_name(self):
+        assert self.codemod.name() == "limit-readline"
 
     def test_file_readline(self, tmpdir):
         input_code = """file = open('some_file.txt')

diff --git a/tests/codemods/test_process_creation_sandbox.py b/tests/codemods/test_process_creation_sandbox.py
@@ -6,8 +6,8 @@
 class TestProcessCreationSandbox(BaseSemgrepCodemodTest):
     codemod = ProcessSandbox
 
-    def test_rule_ids(self):
-        assert self.codemod.NAME == "sandbox-process-creation"
+    def test_name(self):
+        assert self.codemod.name() == "sandbox-process-creation"
 
     def test_import_subprocess(self, tmpdir):
         input_code = """import subprocess

diff --git a/tests/codemods/test_request_verify.py b/tests/codemods/test_request_verify.py
@@ -8,8 +8,8 @@
 class TestRequestsVerify(BaseSemgrepCodemodTest):
     codemod = RequestsVerify
 
-    def test_rule_ids(self):
-        assert self.codemod.NAME == "requests-verify"
+    def test_name(self):
+        assert self.codemod.name() == "requests-verify"
 
     @pytest.mark.parametrize("func", REQUEST_FUNCS)
     def test_default_verify(self, tmpdir, func):

diff --git a/tests/codemods/test_secure_random.py b/tests/codemods/test_secure_random.py
@@ -6,8 +6,8 @@
 class TestSecureRandom(BaseSemgrepCodemodTest):
     codemod = SecureRandom
 
-    def test_rule_ids(self):
-        assert self.codemod.NAME == "secure-random"
+    def test_name(self):
+        assert self.codemod.name() == "secure-random"
 
     def test_import_random(self, tmpdir):
         input_code = """import random

diff --git a/tests/codemods/test_tempfile_mktemp.py b/tests/codemods/test_tempfile_mktemp.py
@@ -6,8 +6,8 @@
 class TestTempfileMktemp(BaseSemgrepCodemodTest):
     codemod = TempfileMktemp
 
-    def test_rule_ids(self):
-        assert self.codemod.NAME == "secure-tempfile"
+    def test_name(self):
+        assert self.codemod.name() == "secure-tempfile"
 
     def test_import(self, tmpdir):
         input_code = """import tempfile

diff --git a/tests/codemods/test_url_sandbox.py b/tests/codemods/test_url_sandbox.py
@@ -6,8 +6,8 @@
 class TestUrlSandbox(BaseSemgrepCodemodTest):
     codemod = UrlSandbox
 
-    def test_rule_ids(self):
-        assert self.codemod.METADATA.NAME == "url-sandbox"
+    def test_name(self):
+        assert self.codemod.name() == "url-sandbox"
 
     def test_import_requests(self, tmpdir):
         input_code = """import requests