Functional tests for pyreverse (#6449)

Co-authored-by: Daniël van Noord <[email protected]>

Author: DudeNr33

.pre-commit-config.yaml

@@ -25,7 +25,7 @@ repos:
     hooks:
       - id: copyright-notice
         args: ["--notice=script/copyright.txt", "--enforce-all"]
-        exclude: tests/functional/|tests/input|doc/data/messages|examples/|setup.py|tests(/\w*)*data/
+        exclude: tests(/\w*)*/functional/|tests/input|doc/data/messages|examples/|setup.py|tests(/\w*)*data/
         types: [python]
   - repo: https://github.com/asottile/pyupgrade
     rev: v2.32.0

pylint/testutils/pyreverse.py

@@ -5,6 +5,16 @@
 from __future__ import annotations
 
 import argparse
+import configparser
+import shlex
+import sys
+from pathlib import Path
+from typing import NamedTuple
+
+if sys.version_info >= (3, 8):
+    from typing import TypedDict
+else:
+    from typing_extensions import TypedDict
 
 
 # This class could and should be replaced with a simple dataclass when support for Python < 3.7 is dropped.
@@ -54,3 +64,51 @@ def __init__(
         self.ignore_list = ignore_list
         self.project = project
         self.output_directory = output_directory
+
+
+class TestFileOptions(TypedDict):
+    output_formats: list[str]
+    command_line_args: list[str]
+
+
+class FunctionalPyreverseTestfile(NamedTuple):
+    """Named tuple containing the test file and the expected output."""
+
+    source: Path
+    options: TestFileOptions
+
+
+def get_functional_test_files(
+    root_directory: Path,
+) -> list[FunctionalPyreverseTestfile]:
+    """Get all functional test files from the given directory."""
+    test_files = []
+    for path in root_directory.rglob("*.py"):
+        config_file = path.with_suffix(".rc")
+        if config_file.exists():
+            test_files.append(
+                FunctionalPyreverseTestfile(
+                    source=path, options=_read_config(config_file)
+                )
+            )
+        else:
+            test_files.append(
+                FunctionalPyreverseTestfile(
+                    source=path,
+                    options={"output_formats": ["mmd"], "command_line_args": []},
+                )
+            )
+    return test_files
+
+
+def _read_config(config_file: Path) -> TestFileOptions:
+    config = configparser.ConfigParser()
+    config.read(str(config_file))
+    return {
+        "output_formats": config.get(
+            "testoptions", "output_formats", fallback="mmd"
+        ).split(","),
+        "command_line_args": shlex.split(
+            config.get("testoptions", "command_line_args", fallback="")
+        ),
+    }

tests/pyreverse/functional/class_diagrams/attributes/instance_attributes.mmd

@@ -0,0 +1,6 @@
+classDiagram
+  class InstanceAttributes {
+    my_int_with_type_hint : int
+    my_int_without_type_hint : int
+    my_optional_int : Optional[int]
+  }

tests/pyreverse/functional/class_diagrams/attributes/instance_attributes.py

@@ -0,0 +1,5 @@
+class InstanceAttributes:
+    def __init__(self):
+        self.my_int_without_type_hint = 1
+        self.my_int_with_type_hint: int = 2
+        self.my_optional_int: int = None

tests/pyreverse/functional/class_diagrams/colorized_output/colorized.puml

@@ -0,0 +1,42 @@
+@startuml classes
+set namespaceSeparator none
+class "CheckerCollector" as colorized.CheckerCollector #aliceblue {
+  checker1
+  checker2
+  checker3
+}
+class "ElseifUsedChecker" as pylint.extensions.check_elif.ElseifUsedChecker #antiquewhite {
+  msgs : dict
+  name : str
+  leave_module(_: nodes.Module) -> None
+  process_tokens(tokens: list[TokenInfo]) -> None
+  visit_if(node: nodes.If) -> None
+}
+class "ExceptionsChecker" as pylint.checkers.exceptions.ExceptionsChecker #aquamarine {
+  msgs : dict
+  name : str
+  options : tuple
+  open()
+  visit_binop(node: nodes.BinOp) -> None
+  visit_compare(node: nodes.Compare) -> None
+  visit_raise(node: nodes.Raise) -> None
+  visit_tryexcept(node: nodes.TryExcept) -> None
+}
+class "StdlibChecker" as pylint.checkers.stdlib.StdlibChecker #aquamarine {
+  msgs : dict
+  name : str
+  deprecated_arguments(method: str)
+  deprecated_classes(module: str)
+  deprecated_decorators() -> Iterable
+  deprecated_methods()
+  visit_boolop(node: nodes.BoolOp) -> None
+  visit_call(node: nodes.Call) -> None
+  visit_functiondef(node: nodes.FunctionDef) -> None
+  visit_if(node: nodes.If) -> None
+  visit_ifexp(node: nodes.IfExp) -> None
+  visit_unaryop(node: nodes.UnaryOp) -> None
+}
+pylint.checkers.exceptions.ExceptionsChecker --* colorized.CheckerCollector : checker1
+pylint.checkers.stdlib.StdlibChecker --* colorized.CheckerCollector : checker3
+pylint.extensions.check_elif.ElseifUsedChecker --* colorized.CheckerCollector : checker2
+@enduml

tests/pyreverse/functional/class_diagrams/colorized_output/colorized.py

@@ -0,0 +1,10 @@
+from pylint.checkers.exceptions import ExceptionsChecker
+from pylint.checkers.stdlib import StdlibChecker
+from pylint.extensions.check_elif import ElseifUsedChecker
+
+
+class CheckerCollector:
+    def __init__(self):
+        self.checker1 = ExceptionsChecker(None)
+        self.checker2 = ElseifUsedChecker(None)
+        self.checker3 = StdlibChecker(None)

tests/pyreverse/functional/class_diagrams/colorized_output/colorized.rc

@@ -0,0 +1,3 @@
+[testoptions]
+output_formats=puml
+command_line_args=-S --colorized --max-color-depth=2

tests/pyreverse/functional/class_diagrams/inheritance/simple_inheritance.mmd

@@ -0,0 +1,6 @@
+classDiagram
+  class Child {
+  }
+  class Parent {
+  }
+  Child --|> Parent

tests/pyreverse/functional/class_diagrams/inheritance/simple_inheritance.py

@@ -0,0 +1,6 @@
+class Parent:
+    """parent class"""
+
+
+class Child(Parent):
+    """child class"""

tests/pyreverse/test_pyreverse_functional.py

@@ -0,0 +1,39 @@
+# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
+# Copyright (c) https://github.com/PyCQA/pylint/blob/main/CONTRIBUTORS.txt
+
+from pathlib import Path
+
+import pytest
+from py._path.local import LocalPath  # type: ignore[import]
+
+from pylint.pyreverse.main import Run
+from pylint.testutils.pyreverse import (
+    FunctionalPyreverseTestfile,
+    get_functional_test_files,
+)
+
+FUNCTIONAL_DIR = Path(__file__).parent / "functional"
+CLASS_DIAGRAM_TESTS = get_functional_test_files(FUNCTIONAL_DIR / "class_diagrams")
+CLASS_DIAGRAM_TEST_IDS = [testfile.source.stem for testfile in CLASS_DIAGRAM_TESTS]
+
+
+@pytest.mark.parametrize(
+    "testfile",
+    CLASS_DIAGRAM_TESTS,
+    ids=CLASS_DIAGRAM_TEST_IDS,
+)
+def test_class_diagrams(
+    testfile: FunctionalPyreverseTestfile, tmpdir: LocalPath
+) -> None:
+    input_file = testfile.source
+    for output_format in testfile.options["output_formats"]:
+        with pytest.raises(SystemExit) as sys_exit:
+            args = ["-o", f"{output_format}", "-d", str(tmpdir)]
+            args.extend(testfile.options["command_line_args"])
+            args += [str(input_file)]
+            Run(args)
+        assert sys_exit.value.code == 0
+        assert testfile.source.with_suffix(f".{output_format}").read_text(
+            encoding="utf8"
+        ) == Path(tmpdir / f"classes.{output_format}").read_text(encoding="utf8")