[doc testing] Add a mechanism to be able to test example for old names

Author: Pierre-Sassoulas

doc/test_messages_documentation.py

@@ -6,6 +6,8 @@
 
 import sys
 
+from pylint.exceptions import UnknownMessageError
+
 if sys.version_info[:2] > (3, 9):
     from collections import Counter
 else:
@@ -71,7 +73,6 @@ def get_functional_test_files_from_directory(input_dir: Path) -> List[Tuple[str,
 class LintModuleTest:
     def __init__(self, test_file: Tuple[str, Path]) -> None:
         self._test_file = test_file
-
         _test_reporter = FunctionalTestReporter()
 
         self._linter = PyLinter()
@@ -81,22 +82,36 @@ def __init__(self, test_file: Tuple[str, Path]) -> None:
         # Check if this message has a custom configuration file (e.g. for enabling optional checkers).
         # If not, use the default configuration.
         config_file: Optional[Path]
-        if (test_file[1].parent / "pylintrc").exists():
-            config_file = test_file[1].parent / "pylintrc"
+        msgid, full_path = test_file
+        pylintrc = full_path.parent / "pylintrc"
+        if pylintrc.exists():
+            config_file = pylintrc
         else:
             config_file = next(config.find_default_config_files(), None)
-
+        args = [
+            str(full_path),
+            "--disable=all",
+            self._get_actives_message_to_enable(msgid),
+        ]
+        print(f"Command used:\npylint {' '.join(args)}")
         _config_initialization(
             self._linter,
-            args_list=[
-                str(test_file[1]),
-                "--disable=all",
-                f"--enable={test_file[0]},astroid-error,fatal,syntax-error",
-            ],
+            args_list=args,
             reporter=_test_reporter,
             config_file=config_file,
         )
 
+    def _get_actives_message_to_enable(self, msgid):
+        """We need to do that in order to be able to handle examples for old names if
+        their new names are not activated the example won't work."""
+        try:
+            msg_definitions = self._linter.msgs_store.get_message_definitions(msgid)
+            msgids = ",".join(m.symbol for m in msg_definitions)
+        except UnknownMessageError:
+            # We're testing an extension, the messages are not registered (TODO?)
+            msgids = msgid
+        return f"--enable={msgids},astroid-error,fatal,syntax-error"
+
     def runTest(self) -> None:
         self._runTest()