Check node location attributes in unittests and update tests (#5383)

* Allow checking of `end_col_offset` and `end_lineno` in unittests

* Allow checking of `col_offset` in unittests

* Allow checking of `lineno` in unittests

* Update tests for ``TestVariablesChecker``

* Fix ``TestMultiNamingStyle``

* Update tests for ``TestImportsChecker``

* Add location attributes to messages of ``TestTypeChecker``

* Add location params to ``TestMessage``'s of ``TestDeprecatedChecker``

* Add location params to ``TestMessage``'s of ``TestTypeCheckerOnDecorators``

* Add changelog and ``DeprecationWarning``

Author: DanielNoord

ChangeLog

@@ -67,6 +67,9 @@ Release date: TBA
 
   Closes #5371
 
+* The ``testutils`` for unittests now accept ``end_lineno`` and ``end_column``. Tests
+  without these will trigger a ``DeprecationWarning``.
+
 ..
   Insert your changelog randomly, it will reduce merge conflicts
   (Ie. not necessarily at the end)

doc/whatsnew/2.13.rst

@@ -70,3 +70,6 @@ Other Changes
 
 * The ``PyLinter`` class will now be initialiazed with a ``TextReporter``
   as its reporter if none is provided.
+
+* The ``testutils`` for unittests now accept ``end_lineno`` and ``end_column``. Tests
+  without these will trigger a ``DeprecationWarning``.

pylint/testutils/checker_test_case.py

@@ -2,9 +2,12 @@
 # For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
 
 import contextlib
-from typing import Dict, Optional, Type
+import warnings
+from typing import Dict, Generator, Optional, Type
 
+from pylint.constants import PY38_PLUS
 from pylint.testutils.global_test_linter import linter
+from pylint.testutils.output_line import MessageTest
 from pylint.testutils.unittest_linter import UnittestLinter
 from pylint.utils import ASTWalker
 
@@ -29,7 +32,7 @@ def assertNoMessages(self):
             yield
 
     @contextlib.contextmanager
-    def assertAddsMessages(self, *messages):
+    def assertAddsMessages(self, *messages: MessageTest) -> Generator[None, None, None]:
         """Assert that exactly the given method adds the given messages.
 
         The list of messages must exactly match *all* the messages added by the
@@ -45,7 +48,33 @@ def assertAddsMessages(self, *messages):
             "Expected messages did not match actual.\n"
             f"\nExpected:\n{expected}\n\nGot:\n{got_str}\n"
         )
-        assert got == list(messages), msg
+
+        assert len(messages) == len(got), msg
+
+        for expected_msg, gotten_msg in zip(messages, got):
+            assert expected_msg.msg_id == gotten_msg.msg_id, msg
+            assert expected_msg.line == gotten_msg.line, msg
+            assert expected_msg.node == gotten_msg.node, msg
+            assert expected_msg.args == gotten_msg.args, msg
+            assert expected_msg.confidence == gotten_msg.confidence, msg
+            assert expected_msg.col_offset == gotten_msg.col_offset, msg
+            if PY38_PLUS:
+                # pylint: disable=fixme
+                # TODO: Require end_line and end_col_offset and remove the warning
+                if not expected_msg.end_line == gotten_msg.end_line:
+                    warnings.warn(
+                        f"The end_line attribute of {gotten_msg} does not match "
+                        f"the expected value in {expected_msg}. In pylint 3.0 correct end_line "
+                        "attributes will be required for MessageTest.",
+                        DeprecationWarning,
+                    )
+                if not expected_msg.end_col_offset == gotten_msg.end_col_offset:
+                    warnings.warn(
+                        f"The end_col_offset attribute of {gotten_msg} does not match "
+                        f"the expected value in {expected_msg}. In pylint 3.0 correct end_col_offset "
+                        "attributes will be required for MessageTest.",
+                        DeprecationWarning,
+                    )
 
     def walk(self, node):
         """recursive walk on the given node"""

pylint/testutils/output_line.py

@@ -21,6 +21,8 @@ class MessageTest(NamedTuple):
     args: Optional[Any] = None
     confidence: Optional[Confidence] = UNDEFINED
     col_offset: Optional[int] = None
+    end_line: Optional[int] = None
+    end_col_offset: Optional[int] = None
     """Used to test messages produced by pylint. Class name cannot start with Test as pytest doesn't allow constructors in test classes."""
 
 

pylint/testutils/unittest_linter.py

@@ -30,6 +30,8 @@ def add_message(
         self,
         msg_id: str,
         line: Optional[int] = None,
+        # pylint: disable=fixme
+        # TODO: Make node non optional
         node: Optional[nodes.NodeNG] = None,
         args: Any = None,
         confidence: Optional[Confidence] = None,
@@ -41,16 +43,28 @@ def add_message(
         # If confidence is None we set it to UNDEFINED as well in PyLinter
         if confidence is None:
             confidence = UNDEFINED
+        if not line and node:
+            line = node.fromlineno
         # pylint: disable=fixme
-        # TODO: Test col_offset
-        # pylint: disable=fixme
-        # TODO: Initialize col_offset on every node (can be None) -> astroid
-        # if col_offset is None and hasattr(node, "col_offset"):
-        #     col_offset = node.col_offset
-        # pylint: disable=fixme
-        # TODO: Test end_lineno and end_col_offset :)
+        # TODO: Initialize col_offset, end_lineno and end_col_offset on every node -> astroid
+        # See https://github.com/PyCQA/astroid/issues/1273
+        if col_offset is None and node and hasattr(node, "col_offset"):
+            col_offset = node.col_offset
+        if not end_lineno and node and hasattr(node, "end_lineno"):
+            end_lineno = node.end_lineno
+        if not end_col_offset and node and hasattr(node, "end_col_offset"):
+            end_col_offset = node.end_col_offset
         self._messages.append(
-            MessageTest(msg_id, line, node, args, confidence, col_offset)
+            MessageTest(
+                msg_id,
+                line,
+                node,
+                args,
+                confidence,
+                col_offset,
+                end_lineno,
+                end_col_offset,
+            )
         )
 
     @staticmethod

tests/checkers/unittest_base.py

@@ -64,6 +64,10 @@ class CLASSC(object): #@
                 "the `UP` group in the '(?:(?P<UP>[A-Z]+)|(?P<down>[a-z]+))$' pattern",
             ),
             confidence=HIGH,
+            line=2,
+            col_offset=0,
+            end_line=3,
+            end_col_offset=8,
         )
         with self.assertAddsMessages(message):
             cls = None
@@ -94,6 +98,10 @@ class CLASSC(object): #@
                     "'(?:(?P<UP>[A-Z]+)|(?P<down>[a-z]+))$' pattern",
                 ),
                 confidence=HIGH,
+                line=2,
+                col_offset=0,
+                end_line=3,
+                end_col_offset=8,
             ),
             MessageTest(
                 "invalid-name",
@@ -104,6 +112,10 @@ class CLASSC(object): #@
                     "the `down` group in the '(?:(?P<UP>[A-Z]+)|(?P<down>[a-z]+))$' pattern",
                 ),
                 confidence=HIGH,
+                line=6,
+                col_offset=0,
+                end_line=7,
+                end_col_offset=8,
             ),
         ]
         with self.assertAddsMessages(*messages):
@@ -139,6 +151,10 @@ def FUNC(): #@
                 "the `down` group in the '(?:(?P<UP>[A-Z]+)|(?P<down>[a-z]+))$' pattern",
             ),
             confidence=HIGH,
+            line=6,
+            col_offset=0,
+            end_line=7,
+            end_col_offset=8,
         )
         with self.assertAddsMessages(message):
             func = None
@@ -172,6 +188,10 @@ def UPPER(): #@
                 "the `down` group in the '(?:(?P<ignore>FOO)|(?P<UP>[A-Z]+)|(?P<down>[a-z]+))$' pattern",
             ),
             confidence=HIGH,
+            line=8,
+            col_offset=0,
+            end_line=9,
+            end_col_offset=8,
         )
         with self.assertAddsMessages(message):
             func = None