feat(robotcode): introduce plugin spec for configuration classes

d-biehl · d-biehl · commit 582e3608f452 · 2023-10-03T15:23:27.000+02:00
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -42,9 +42,9 @@
 				// "toml",
 				// "--no-color",
 				// "--no-pager",
-				//"config", "info", "desc",
-				"discover",
-				"all"
+				"config", "info", "list",
+				// "analyze",
+				// "."
 			]
 		},
 		{
diff --git a/packages/analyze/src/robotcode/analyze/cli.py b/packages/analyze/src/robotcode/analyze/cli.py
@@ -0,0 +1,57 @@
+# ruff: noqa: RUF009
+from dataclasses import dataclass
+from typing import List, Optional, Tuple, Union
+
+import click
+from robotcode.plugin import Application, pass_application
+from robotcode.robot.config.loader import load_config_from_path
+from robotcode.robot.config.model import BaseOptions, field
+from robotcode.robot.config.utils import get_config_files
+
+from .__version__ import __version__
+
+
+@dataclass
+class Dummy:
+    some_field: Optional[str] = field(default="some value", description="Some field")
+
+
+@dataclass
+class AnalyzerConfig(BaseOptions):
+    select: Optional[List[Union[str, Dummy]]] = field(description="Selects which rules are run.")
+    extra_select: Optional[List[Union[str, Dummy]]] = field(description="Selects which rules are run.")
+    ignore: Optional[List[str]] = field(description="Ignores which rules are run.")
+    extra_ignore: Optional[List[str]] = field(description="Ignores which rules are run.")
+
+
+@click.command(
+    context_settings={
+        "allow_extra_args": True,
+        "ignore_unknown_options": True,
+    },
+    add_help_option=True,
+)
+@click.version_option(
+    version=__version__,
+    package_name="robotcode.analyze",
+    prog_name="RobotCode Analyze",
+)
+@click.argument("paths", nargs=-1, type=click.Path(exists=True, dir_okay=True))
+@pass_application
+def analyze(
+    app: Application,
+    paths: Tuple[str],
+) -> Union[str, int, None]:
+    """TODO: Analyzes a Robot Framework project."""
+
+    config_files, root_folder, _ = get_config_files(paths, app.config.config_files, verbose_callback=app.verbose)
+
+    try:
+        robot_profile = load_config_from_path(
+            AnalyzerConfig, *config_files, tool_name="robotcode-analyze", robot_toml_tool_name="robotcode-analyze"
+        ).evaluated()
+    except (TypeError, ValueError) as e:
+        raise click.ClickException(str(e)) from e
+
+    app.print_data(robot_profile)
+    return 0
diff --git a/packages/analyze/src/robotcode/analyze/cli/__init__.py b/packages/analyze/src/robotcode/analyze/cli/__init__.py
diff --git a/packages/analyze/src/robotcode/analyze/hooks.py b/packages/analyze/src/robotcode/analyze/hooks.py
@@ -1,11 +1,16 @@
-from typing import List
+from typing import Any, List, Tuple, Type
 
 import click
 from robotcode.plugin import hookimpl
 
-from .cli import analyze
+from .cli import AnalyzerConfig, analyze
 
 
 @hookimpl
-def hatch_register_cli_commands() -> List[click.Command]:
+def register_cli_commands() -> List[click.Command]:
     return [analyze]
+
+
+@hookimpl
+def register_config_classes() -> List[Tuple[str, Type[Any]]]:
+    return [("tool.robotcode-analyze", AnalyzerConfig)]
diff --git a/packages/debugger/src/robotcode/debugger/hooks.py b/packages/debugger/src/robotcode/debugger/hooks.py
@@ -8,5 +8,5 @@
 
 
 @hookimpl
-def hatch_register_cli_commands() -> List[click.Command]:
+def register_cli_commands() -> List[click.Command]:
     return [debug, debug_launch]
diff --git a/packages/language_server/src/robotcode/language_server/cli.py b/packages/language_server/src/robotcode/language_server/cli.py
@@ -10,7 +10,7 @@
     AddressesPort,
     add_options,
 )
-from robotcode.robot.config.loader import load_config_from_path
+from robotcode.robot.config.loader import load_robot_config_from_path
 from robotcode.robot.config.model import RobotBaseProfile
 from robotcode.robot.config.utils import get_config_files
 
@@ -76,7 +76,7 @@ def language_server(
 
     try:
         profile = (
-            load_config_from_path(*config_files)
+            load_robot_config_from_path(*config_files)
             .combine_profiles(*(app.config.profiles or []), verbose_callback=app.verbose)
             .evaluated()
         )
diff --git a/packages/language_server/src/robotcode/language_server/common/parts/workspace.py b/packages/language_server/src/robotcode/language_server/common/parts/workspace.py
@@ -370,7 +370,6 @@ async def get_configuration_raw(
                 raise
             except JsonRPCErrorException as e:
                 self._logger.warning(str(e))
-                pass
 
         result = self.settings
         for sub_key in str(section).split("."):
diff --git a/packages/language_server/src/robotcode/language_server/hooks.py b/packages/language_server/src/robotcode/language_server/hooks.py
@@ -7,5 +7,5 @@
 
 
 @hookimpl
-def hatch_register_cli_commands() -> List[click.Command]:
+def register_cli_commands() -> List[click.Command]:
     return [language_server]
diff --git a/packages/language_server/src/robotcode/language_server/robotframework/diagnostics/library_doc.py b/packages/language_server/src/robotcode/language_server/robotframework/diagnostics/library_doc.py
@@ -1630,7 +1630,6 @@ def get_test_library(
                     raise
                 except BaseException:
                     lib = None
-                    pass
 
         real_source = lib.source if lib is not None else source
 
diff --git a/packages/plugin/src/robotcode/plugin/manager.py b/packages/plugin/src/robotcode/plugin/manager.py
@@ -1,4 +1,4 @@
-from typing import List, cast
+from typing import List, Tuple, Type, cast
 
 import click
 import pluggy
@@ -16,5 +16,12 @@ def __init__(self) -> None:
     def cli_commands(self) -> List[List[click.Command]]:
         return cast(
             List[List[click.Command]],
-            self._plugin_manager.hook.hatch_register_cli_commands(),
+            self._plugin_manager.hook.register_cli_commands(),
+        )
+
+    @property
+    def config_classes(self) -> List[List[Tuple[str, Type[specs.TConfigClass]]]]:
+        return cast(
+            List[List[Tuple[str, Type[specs.TConfigClass]]]],
+            self._plugin_manager.hook.register_config_classes(),
         )
diff --git a/packages/plugin/src/robotcode/plugin/specs.py b/packages/plugin/src/robotcode/plugin/specs.py
@@ -1,4 +1,4 @@
-from typing import Any, Callable, List, TypeVar, cast
+from typing import Any, Callable, List, Tuple, Type, TypeVar, cast
 
 import click
 import pluggy
@@ -8,5 +8,13 @@
 
 
 @hookspec
-def hatch_register_cli_commands() -> List[click.Command]:  # type: ignore
+def register_cli_commands() -> List[click.Command]:  # type: ignore
     """Register new command for the commandline."""
+
+
+TConfigClass = TypeVar("TConfigClass")
+
+
+@hookspec
+def register_config_classes() -> List[Tuple[str, Type[TConfigClass]]]:  # type: ignore
+    """Registers a class that gives information about a configuration."""
diff --git a/packages/robot/src/robotcode/robot/config/loader.py b/packages/robot/src/robotcode/robot/config/loader.py
@@ -1,7 +1,7 @@
 import sys
 from enum import Enum
 from pathlib import Path
-from typing import Any, Optional, Sequence, Tuple, Union
+from typing import Any, Optional, Sequence, Tuple, Type, TypeVar, Union
 
 from robotcode.core.dataclasses import from_dict
 
@@ -11,7 +11,7 @@
     import tomli as tomllib
 
 
-from .model import RobotConfig
+from .model import BaseOptions, RobotConfig
 
 PYPROJECT_TOML = "pyproject.toml"
 ROBOT_TOML = "robot.toml"
@@ -49,24 +49,46 @@ def __init__(self, path: Path, *args: Any, **kwargs: Any) -> None:
         self.path = path
 
 
-def loads_config_from_robot_toml(__s: str) -> RobotConfig:
+_ConfigType = TypeVar("_ConfigType", bound=BaseOptions)
+
+
+def load_robot_config_from_robot_toml_str(__s: str) -> RobotConfig:
+    return load_config_from_robot_toml_str(RobotConfig, __s)
+
+
+def load_config_from_robot_toml_str(
+    config_type: Type[_ConfigType], __s: str, tool_name: Optional[str] = None
+) -> _ConfigType:
     dict_data = tomllib.loads(__s)
-    return from_dict(dict_data, RobotConfig)
 
+    if tool_name:
+        try:
+            return from_dict(dict_data.get("tool", {}).get(tool_name, {}), config_type)
+        except ValueError as e:
+            raise ValueError(f"Reading [tool.{tool_name}] failed: {e}") from e
+        except TypeError as e:
+            raise TypeError(f"Reading [tool.{tool_name}] failed: {e}") from e
+
+    return from_dict(dict_data, config_type)
 
-def loads_config_from_pyproject_toml(__s: str) -> RobotConfig:
+
+def load_config_from_pyproject_toml_str(config_type: Type[_ConfigType], tool_name: str, __s: str) -> _ConfigType:
     dict_data = tomllib.loads(__s)
 
-    return from_dict(dict_data.get("tool", {}).get("robot", {}), RobotConfig)
+    return from_dict(dict_data.get("tool", {}).get(tool_name, {}), config_type)
 
 
-def _load_config_data_from_path(__path: Path) -> RobotConfig:
+def _load_config_data_from_path(
+    config_type: Type[_ConfigType], tool_name: str, robot_toml_tool_name: Optional[str], __path: Path
+) -> _ConfigType:
     try:
         if __path.name == PYPROJECT_TOML:
-            return loads_config_from_pyproject_toml(__path.read_text("utf-8"))
+            return load_config_from_pyproject_toml_str(config_type, tool_name, __path.read_text("utf-8"))
 
         if __path.name == ROBOT_TOML or __path.name == LOCAL_ROBOT_TOML or __path.suffix == ".toml":
-            return loads_config_from_robot_toml(__path.read_text("utf-8"))
+            return load_config_from_robot_toml_str(
+                config_type, __path.read_text("utf-8"), tool_name=robot_toml_tool_name
+            )
         raise TypeError("Unknown config file type.")
 
     except ValueError as e:
@@ -82,15 +104,28 @@ def get_default_config() -> RobotConfig:
     return result
 
 
-def load_config_from_path(*__paths: Union[Path, Tuple[Path, ConfigType]]) -> RobotConfig:
-    result = RobotConfig()
+def load_config_from_path(
+    config_type: Type[_ConfigType],
+    *__paths: Union[Path, Tuple[Path, ConfigType]],
+    tool_name: str,
+    robot_toml_tool_name: Optional[str] = None,
+) -> _ConfigType:
+    result = config_type()
 
     for __path in __paths:
-        result.add_options(_load_config_data_from_path(__path if isinstance(__path, Path) else __path[0]))
+        result.add_options(
+            _load_config_data_from_path(
+                config_type, tool_name, robot_toml_tool_name, __path if isinstance(__path, Path) else __path[0]
+            )
+        )
 
     return result
 
 
+def load_robot_config_from_path(*__paths: Union[Path, Tuple[Path, ConfigType]]) -> RobotConfig:
+    return load_config_from_path(RobotConfig, *__paths, tool_name="robot")
+
+
 def find_project_root(*sources: Union[str, Path]) -> Tuple[Optional[Path], DiscoverdBy]:
     if not sources:
         sources = (str(Path.cwd().resolve()),)
diff --git a/packages/runner/src/robotcode/runner/cli/libdoc.py b/packages/runner/src/robotcode/runner/cli/libdoc.py
@@ -7,7 +7,7 @@
 from robot.libdoc import USAGE, LibDoc
 from robot.version import get_full_version
 from robotcode.plugin import Application, pass_application
-from robotcode.robot.config.loader import load_config_from_path
+from robotcode.robot.config.loader import load_robot_config_from_path
 from robotcode.robot.config.model import LibDocProfile
 from robotcode.robot.config.utils import get_config_files
 
@@ -76,7 +76,7 @@ def libdoc(
     )
     try:
         profile = (
-            load_config_from_path(*config_files)
+            load_robot_config_from_path(*config_files)
             .combine_profiles(*(app.config.profiles or []), verbose_callback=app.verbose)
             .evaluated()
         )
diff --git a/packages/runner/src/robotcode/runner/cli/rebot.py b/packages/runner/src/robotcode/runner/cli/rebot.py
@@ -7,7 +7,7 @@
 from robot.rebot import USAGE, Rebot
 from robot.version import get_full_version
 from robotcode.plugin import Application, pass_application
-from robotcode.robot.config.loader import load_config_from_path
+from robotcode.robot.config.loader import load_robot_config_from_path
 from robotcode.robot.config.model import RebotProfile
 from robotcode.robot.config.utils import get_config_files
 
@@ -77,7 +77,7 @@ def rebot(
 
     try:
         profile = (
-            load_config_from_path(*config_files)
+            load_robot_config_from_path(*config_files)
             .combine_profiles(*(app.config.profiles or []), verbose_callback=app.verbose)
             .evaluated()
         )
diff --git a/packages/runner/src/robotcode/runner/cli/robot.py b/packages/runner/src/robotcode/runner/cli/robot.py
@@ -10,7 +10,7 @@
 from robotcode.plugin import Application, pass_application
 from robotcode.plugin.click_helper.aliases import AliasedCommand
 from robotcode.plugin.click_helper.types import add_options
-from robotcode.robot.config.loader import load_config_from_path
+from robotcode.robot.config.loader import load_robot_config_from_path
 from robotcode.robot.config.model import RobotBaseProfile
 from robotcode.robot.config.utils import get_config_files
 
@@ -97,7 +97,7 @@ def handle_robot_options(
     )
     try:
         profile = (
-            load_config_from_path(*config_files)
+            load_robot_config_from_path(*config_files)
             .combine_profiles(*(app.config.profiles or []), verbose_callback=app.verbose)
             .evaluated()
         )
diff --git a/packages/runner/src/robotcode/runner/cli/testdoc.py b/packages/runner/src/robotcode/runner/cli/testdoc.py
@@ -7,7 +7,7 @@
 from robot.testdoc import USAGE, TestDoc
 from robot.version import get_full_version
 from robotcode.plugin import Application, pass_application
-from robotcode.robot.config.loader import load_config_from_path
+from robotcode.robot.config.loader import load_robot_config_from_path
 from robotcode.robot.config.model import TestDocProfile
 from robotcode.robot.config.utils import get_config_files
 
@@ -77,7 +77,7 @@ def testdoc(
 
     try:
         profile = (
-            load_config_from_path(*config_files)
+            load_robot_config_from_path(*config_files)
             .combine_profiles(*(app.config.profiles or []), verbose_callback=app.verbose)
             .evaluated()
         )
diff --git a/packages/runner/src/robotcode/runner/hooks.py b/packages/runner/src/robotcode/runner/hooks.py
@@ -7,5 +7,5 @@
 
 
 @hookimpl
-def hatch_register_cli_commands() -> List[click.Command]:
+def register_cli_commands() -> List[click.Command]:
     return [robot, rebot, libdoc, testdoc, discover]
diff --git a/scripts/publish.py b/scripts/publish.py
diff --git a/src/robotcode/cli/commands/config.py b/src/robotcode/cli/commands/config.py
diff --git a/src/robotcode/cli/commands/profiles.py b/src/robotcode/cli/commands/profiles.py
diff --git a/tests/robotcode/language_server/robotframework/parts/data/.robot.toml b/tests/robotcode/language_server/robotframework/parts/data/.robot.toml
diff --git a/tests/robotcode/language_server/robotframework/parts/data/robot.toml b/tests/robotcode/language_server/robotframework/parts/data/robot.toml
diff --git a/tests/robotcode/robot/config/test_profile.py b/tests/robotcode/robot/config/test_profile.py
diff --git a/tests/robotcode/robot/config/test_toml.py b/tests/robotcode/robot/config/test_toml.py

Original file line number	Diff line number	Diff line change
`@@ -42,9 +42,9 @@`
`42`	`42`	`// "toml",`
`43`	`43`	`// "--no-color",`
`44`	`44`	`// "--no-pager",`
`45`		`- //"config", "info", "desc",`
`46`		`- "discover",`
`47`		`- "all"`
	`45`	`+ "config", "info", "list",`
	`46`	`+ // "analyze",`
	`47`	`+ // "."`
`48`	`48`	`]`
`49`	`49`	`},`
`50`	`50`	`{`