refactor test code

Author: reverbc

tests/base_tester.py

@@ -9,27 +9,16 @@
 class BasePytestFixtureChecker(CheckerTestCase):
     CHECKER_CLASS = VariablesChecker
     MSG_ID = None
+    MESSAGES = None
 
-    def _verify(self, module, msg_count, msg_id=None):
-        self.walk(module)  # run all checkers
-        messages = self.linter.release_messages()
-        msg_id = msg_id or self.MSG_ID
-
-        matched_count = 0
-        for message in messages:
-            print(message)
-            # only care about ID and count, not the content
-            if message.msg_id == msg_id:
-                matched_count += 1
-
-        assert matched_count == msg_count
-
-    def run_test(self, msg_count, enable_plugin, msg_id=None):
+    def run_linter(self, enable_plugin, file_path=None):
         # pylint: disable=protected-access
-        file = sys._getframe(1).f_code.co_name.replace('test_', '', 1) + '.py'
-        full_file_path = os.path.join(
-            os.getcwd(), 'tests', 'input', self.MSG_ID, file)
-        with open(full_file_path) as fin:
+        if file_path is None:
+            module = sys._getframe(1).f_code.co_name.replace('test_', '', 1)
+            file_path = os.path.join(
+                os.getcwd(), 'tests', 'input', self.MSG_ID, module + '.py')
+
+        with open(file_path) as fin:
             content = fin.read()
             module = astroid.parse(content)
             module.file = fin.name
@@ -38,11 +27,20 @@ def run_test(self, msg_count, enable_plugin, msg_id=None):
                 register(None)
 
             try:
-                self._verify(
-                    module=module,
-                    msg_count=msg_count,
-                    msg_id=msg_id,
-                )
+                self.walk(module)  # run all checkers
+                self.MESSAGES = self.linter.release_messages()
             finally:
                 if enable_plugin:
                     unregister()
+
+    def verify_messages(self, msg_count, msg_id=None):
+        msg_id = msg_id or self.MSG_ID
+
+        matched_count = 0
+        for message in self.MESSAGES:
+            print(message)
+            # only care about ID and count, not the content
+            if message.msg_id == msg_id:
+                matched_count += 1
+
+        assert matched_count == msg_count

tests/test_redefined_outer_name.py

@@ -7,28 +7,20 @@ class TestRedefinedOuterName(BasePytestFixtureChecker):
 
     @pytest.mark.parametrize('enable_plugin', [True, False])
     def test_smoke(self, enable_plugin):
-        self.run_test(
-            enable_plugin=enable_plugin,
-            msg_count=0 if enable_plugin else 1,
-        )
+        self.run_linter(enable_plugin)
+        self.verify_messages(0 if enable_plugin else 1)
 
     @pytest.mark.parametrize('enable_plugin', [True, False])
     def test_caller_yield_fixture(self, enable_plugin):
-        self.run_test(
-            enable_plugin=enable_plugin,
-            msg_count=0 if enable_plugin else 1,
-        )
+        self.run_linter(enable_plugin)
+        self.verify_messages(0 if enable_plugin else 1)
 
     @pytest.mark.parametrize('enable_plugin', [True, False])
     def test_caller_not_a_test_func(self, enable_plugin):
-        self.run_test(
-            enable_plugin=enable_plugin,
-            msg_count=1,
-        )
+        self.run_linter(enable_plugin)
+        self.verify_messages(1)
 
     @pytest.mark.parametrize('enable_plugin', [True, False])
     def test_args_and_kwargs(self, enable_plugin):
-        self.run_test(
-            enable_plugin=enable_plugin,
-            msg_count=2,
-        )
+        self.run_linter(enable_plugin)
+        self.verify_messages(2)

tests/test_regression.py

@@ -9,14 +9,6 @@ class TestRegression(BasePytestFixtureChecker):
     @pytest.mark.parametrize('enable_plugin', [True, False])
     def test_import_twice(self, enable_plugin):
         '''catch a coding error when using fixture + if + inline import'''
-        self.run_test(
-            enable_plugin=enable_plugin,
-            msg_count=2,
-            msg_id='unused-import'
-        )
-
-        self.run_test(
-            enable_plugin=enable_plugin,
-            msg_count=1,
-            msg_id='redefined-outer-name'
-        )
+        self.run_linter(enable_plugin)
+        self.verify_messages(2, msg_id='unused-import')
+        self.verify_messages(1, msg_id='redefined-outer-name')

tests/test_unused_argument.py

@@ -7,28 +7,20 @@ class TestUnusedArgument(BasePytestFixtureChecker):
 
     @pytest.mark.parametrize('enable_plugin', [True, False])
     def test_smoke(self, enable_plugin):
-        self.run_test(
-            enable_plugin=enable_plugin,
-            msg_count=0 if enable_plugin else 2,
-        )
+        self.run_linter(enable_plugin)
+        self.verify_messages(0 if enable_plugin else 2)
 
     @pytest.mark.parametrize('enable_plugin', [True, False])
     def test_caller_yield_fixture(self, enable_plugin):
-        self.run_test(
-            enable_plugin=enable_plugin,
-            msg_count=0 if enable_plugin else 1,
-        )
+        self.run_linter(enable_plugin)
+        self.verify_messages(0 if enable_plugin else 1)
 
     @pytest.mark.parametrize('enable_plugin', [True, False])
     def test_caller_not_a_test_func(self, enable_plugin):
-        self.run_test(
-            enable_plugin=enable_plugin,
-            msg_count=1,
-        )
+        self.run_linter(enable_plugin)
+        self.verify_messages(1)
 
     @pytest.mark.parametrize('enable_plugin', [True, False])
     def test_args_and_kwargs(self, enable_plugin):
-        self.run_test(
-            enable_plugin=enable_plugin,
-            msg_count=2,
-        )
+        self.run_linter(enable_plugin)
+        self.verify_messages(2)

tests/test_unused_import.py

@@ -7,32 +7,24 @@ class TestUnusedImport(BasePytestFixtureChecker):
 
     @pytest.mark.parametrize('enable_plugin', [True, False])
     def test_smoke(self, enable_plugin):
-        self.run_test(
-            enable_plugin=enable_plugin,
-            msg_count=0 if enable_plugin else 1,
-        )
+        self.run_linter(enable_plugin)
+        self.verify_messages(0 if enable_plugin else 1)
 
     @pytest.mark.parametrize('enable_plugin', [True, False])
     def test_caller_yield_fixture(self, enable_plugin):
-        self.run_test(
-            enable_plugin=enable_plugin,
-            msg_count=0 if enable_plugin else 1,
-        )
+        self.run_linter(enable_plugin)
+        self.verify_messages(0 if enable_plugin else 1)
 
     @pytest.mark.parametrize('enable_plugin', [True, False])
     def test_same_name_arg(self, enable_plugin):
         '''an unused import (not a fixture) just happened to have the same
         name as fixture - should still raise unused-import warning'''
-        self.run_test(
-            enable_plugin=enable_plugin,
-            msg_count=1,
-        )
+        self.run_linter(enable_plugin)
+        self.verify_messages(1)
 
     @pytest.mark.parametrize('enable_plugin', [True, False])
     def test_same_name_decorator(self, enable_plugin):
         '''an unused import (not a fixture) just happened to have the same
         name as fixture - should still raise unused-import warning'''
-        self.run_test(
-            enable_plugin=enable_plugin,
-            msg_count=1,
-        )
+        self.run_linter(enable_plugin)
+        self.verify_messages(1)