robotcode-runner 2.7.0__py3-none-any.whl → 2.8.0.dev8__py3-none-any.whl

robotcode/runner/cli/robot.py

@@ -1,7 +1,8 @@
 import os
 import weakref
+from dataclasses import dataclass, field
 from pathlib import Path
-from typing import Any, Dict, List, Optional, Set, Tuple, Union, cast
+from typing import Any, Callable, Dict, List, Optional, Tuple, Union, cast
 
 import click
 from robot.errors import DataError, Information
@@ -12,16 +13,18 @@ from robot.version import get_full_version
 import robotcode.modifiers
 from robotcode.core.ignore_spec import DEFAULT_SPEC_RULES, GIT_IGNORE_FILE, ROBOT_IGNORE_FILE, IgnoreSpec
 from robotcode.core.utils.path import path_is_relative_to
+from robotcode.modifiers.metadata_modifiers import MetadataPattern
 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.plugin.click_helper.wrappable import wrappable
+from robotcode.plugin.click_helper.wrappable import invoked_command_is_wrappable, run_under_wrapper, wrappable
 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
 from robotcode.robot.utils import RF_VERSION
 
 from ..__version__ import __version__
+from ._robot_version import RobotVersionOption
 from ._search import SearchMatcher, SearchModifier
 
 _app: Optional[Application] = None
@@ -160,6 +163,8 @@ class RobotFrameworkEx(RobotFramework):
         by_longname: Tuple[str, ...] = (),
         exclude_by_longname: Tuple[str, ...] = (),
         search_matcher: Optional[SearchMatcher] = None,
+        by_test_metadata: Tuple[str, ...] = (),
+        exclude_by_test_metadata: Tuple[str, ...] = (),
     ) -> None:
         super().__init__()
         self.app = app
@@ -170,6 +175,8 @@ class RobotFrameworkEx(RobotFramework):
         self.by_longname = by_longname
         self.exclude_by_longname = exclude_by_longname
         self.search_matcher = search_matcher
+        self.by_test_metadata = by_test_metadata
+        self.exclude_by_test_metadata = exclude_by_test_metadata
 
     def parse_arguments(self, cli_args: Any) -> Any:
         try:
@@ -179,7 +186,13 @@ class RobotFrameworkEx(RobotFramework):
                     if Path(arg).is_absolute():
                         continue
 
-                    arguments[i] = str((self._orig_cwd / Path(arg)).absolute().relative_to(self.root_folder))
+                    absolute = (self._orig_cwd / Path(arg)).absolute()
+                    try:
+                        arguments[i] = str(absolute.relative_to(self.root_folder))
+                    except ValueError:
+                        # The path lies outside the project root, which the run changes into,
+                        # so it stays valid only as an absolute path.
+                        arguments[i] = str(absolute)
 
         except DataError:
             options, arguments = super().parse_arguments((*cli_args, *self.paths))
@@ -187,6 +200,11 @@ class RobotFrameworkEx(RobotFramework):
         if not arguments:
             arguments = self.paths
 
+        # Parsed before anything runs: an invalid pattern raises `DataError`,
+        # which Robot reports like an invalid option.
+        test_metadata_patterns = [MetadataPattern(p) for p in self.by_test_metadata]
+        excluded_test_metadata_patterns = [MetadataPattern(p) for p in self.exclude_by_test_metadata]
+
         if self.dry:
             line_end = "\n"
             raise Information(
@@ -204,6 +222,12 @@ class RobotFrameworkEx(RobotFramework):
         if self.exclude_by_longname:
             modifiers.append(robotcode.modifiers.ExcludedByLongName(*self.exclude_by_longname, root_name=root_name))
 
+        if test_metadata_patterns:
+            modifiers.append(robotcode.modifiers.ByTestMetadata(*test_metadata_patterns))
+
+        if excluded_test_metadata_patterns:
+            modifiers.append(robotcode.modifiers.ExcludedByTestMetadata(*excluded_test_metadata_patterns))
+
         if self.search_matcher is not None:
             modifiers.append(SearchModifier(self.search_matcher))
 
@@ -214,21 +238,21 @@ class RobotFrameworkEx(RobotFramework):
 
 
 # mypy: disable-error-code="arg-type"
-ROBOT_VERSION_OPTIONS = {
+ROBOT_VERSION_OPTIONS = [
     click.version_option(
         version=__version__,
         package_name="robotcode.runner",
         prog_name="RobotCode Runner",
         message=f"%(prog)s %(version)s\n{USAGE.splitlines()[0].split(' -- ')[0].strip()} {get_full_version()}",
     ),
-}
+]
 
-ROBOT_SIMPLE_OPTIONS: Set[click.Command] = {
+ROBOT_SIMPLE_OPTIONS = [
     *ROBOT_VERSION_OPTIONS,
     click.argument("robot_options_and_args", nargs=-1, type=click.Path()),
-}
+]
 
-ROBOT_OPTIONS: Set[click.Command] = {
+ROBOT_OPTIONS = [
     click.option(
         "--by-longname",
         "-bl",
@@ -243,18 +267,61 @@ ROBOT_OPTIONS: Set[click.Command] = {
         multiple=True,
         help="Excludes tests/tasks or suites by longname.",
     ),
+    # test metadata exists since Robot Framework 7.5
+    click.option(
+        "--by-test-metadata",
+        "-btm",
+        cls=RobotVersionOption,
+        since=(7, 5),
+        type=str,
+        multiple=True,
+        metavar="PATTERN",
+        help="Select tests/tasks by their metadata, for example `Issue:4409 AND Author:Hans*`.",
+    ),
+    click.option(
+        "--exclude-by-test-metadata",
+        "-ebtm",
+        cls=RobotVersionOption,
+        since=(7, 5),
+        type=str,
+        multiple=True,
+        metavar="PATTERN",
+        help="Excludes tests/tasks by their metadata. Same patterns as `--by-test-metadata`.",
+    ),
     *ROBOT_SIMPLE_OPTIONS,
-}
+]
 
 
-def handle_robot_options(
-    app: Application, robot_options_and_args: Tuple[str, ...]
-) -> Tuple[Optional[Path], RobotBaseProfile, List[str]]:
-    global _app
-    _app = app
+_LOADED_PROFILES = "robotcode.runner.loaded_profiles"
+
+_Message = Union[str, Callable[[], Any]]
+
+
+@dataclass
+class LoadedRobotProfile:
+    """The configuration of a command, loaded once, with what loading it reported."""
+
+    root_folder: Optional[Path] = None
+    profile: Optional[RobotBaseProfile] = None
+    error: Optional[Exception] = None
+    messages: List[Tuple[Callable[[_Message], None], _Message]] = field(default_factory=list)
+
+    def show_messages(self) -> None:
+        messages, self.messages = self.messages, []
+        for show, message in messages:
+            show(message)
 
-    _patch()
 
+def load_robot_profile(app: Application, robot_options_and_args: Tuple[str, ...]) -> LoadedRobotProfile:
+    """Load the configuration of a command once, from the paths among its arguments.
+
+    The result is kept for the whole command, with the messages and the error of the
+    loading, for later calls with the same paths, such as the one in `handle_robot_options`,
+    which shows them. A command that runs Robot Framework (`@wrappable`) is then started
+    again under its `wrapper`. Such a command calls this first, before it starts a server,
+    an interpreter or a debugger, so that they run under the `wrapper` too, while an error
+    of the configuration still appears where `handle_robot_options` raises it.
+    """
     robot_arguments: Optional[List[Union[str, Path]]] = None
 
     try:
@@ -263,21 +330,68 @@ def handle_robot_options(
     except (DataError, Information):
         pass
 
-    config_files, root_folder, _ = get_config_files(
-        robot_arguments,
-        app.config.config_files,
-        root_folder=app.config.root,
-        no_vcs=app.config.no_vcs,
-        verbose_callback=app.verbose,
+    ctx = click.get_current_context(silent=True)
+    loaded: Dict[Tuple[str, ...], LoadedRobotProfile] = (
+        ctx.find_root().meta.setdefault(_LOADED_PROFILES, {}) if ctx is not None else {}
     )
+    key = tuple(str(Path(a).absolute()) for a in robot_arguments or ())
+    if key in loaded:
+        return loaded[key]
+
+    result = LoadedRobotProfile()
+    loaded[key] = result
+
+    def verbose(message: _Message) -> None:
+        result.messages.append((app.verbose, message))
+
+    def error(message: _Message) -> None:
+        result.messages.append((app.error, message))
+
     try:
-        profile = (
-            load_robot_config_from_path(*config_files, verbose_callback=app.verbose)
-            .combine_profiles(*(app.config.profiles or []), verbose_callback=app.verbose, error_callback=app.error)
-            .evaluated_with_env(verbose_callback=app.verbose, error_callback=app.error)
+        config_files, result.root_folder, _ = get_config_files(
+            robot_arguments,
+            app.config.config_files,
+            root_folder=app.config.root,
+            no_vcs=app.config.no_vcs,
+            verbose_callback=verbose,
         )
-    except (TypeError, ValueError) as e:
-        raise click.ClickException(str(e)) from e
+        result.profile = (
+            load_robot_config_from_path(*config_files, verbose_callback=verbose)
+            .combine_profiles(*(app.config.profiles or []), verbose_callback=verbose, error_callback=error)
+            .evaluated_with_env(verbose_callback=verbose, error_callback=error)
+        )
+    except Exception as e:
+        result.error = e
+
+    if result.profile is not None and ctx is not None and invoked_command_is_wrappable(ctx):
+        try:
+            run_under_wrapper(app, result.profile.wrapper)
+        except click.ClickException:
+            # The wrapper did not start, so robotcode under it will not show them.
+            result.show_messages()
+            raise
+
+    return result
+
+
+def handle_robot_options(
+    app: Application, robot_options_and_args: Tuple[str, ...]
+) -> Tuple[Optional[Path], RobotBaseProfile, List[str]]:
+    global _app
+    _app = app
+
+    _patch()
+
+    loaded = load_robot_profile(app, robot_options_and_args)
+    loaded.show_messages()
+
+    if loaded.error is not None:
+        if isinstance(loaded.error, (TypeError, ValueError)):
+            raise click.ClickException(str(loaded.error)) from loaded.error
+        raise loaded.error
+
+    root_folder = loaded.root_folder
+    profile = cast(RobotBaseProfile, loaded.profile)
 
     cmd_options = profile.build_command_line()
 
@@ -308,6 +422,8 @@ def robot(
     app: Application,
     by_longname: Tuple[str, ...],
     exclude_by_longname: Tuple[str, ...],
+    by_test_metadata: Tuple[str, ...],
+    exclude_by_test_metadata: Tuple[str, ...],
     robot_options_and_args: Tuple[str, ...],
 ) -> None:
     """Runs `robot` with the selected configuration, profiles, options and arguments.
@@ -354,6 +470,8 @@ def robot(
                     orig_folder,
                     by_longname,
                     exclude_by_longname,
+                    by_test_metadata=by_test_metadata,
+                    exclude_by_test_metadata=exclude_by_test_metadata,
                 ).execute_cli((*cmd_options, *console_links_args, *robot_options_and_args), exit=False),
             )
         )

robotcode/runner/cli/testdoc.py

@@ -6,6 +6,7 @@ from robot.testdoc import USAGE, TestDoc
 from robot.version import get_full_version
 
 from robotcode.plugin import Application, pass_application
+from robotcode.plugin.click_helper.exit_codes import robot_exit_codes
 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
@@ -35,6 +36,7 @@ class TestDocEx(TestDoc):
         return super().main(arguments, **options)
 
 
+@robot_exit_codes
 @click.command(
     context_settings={"allow_extra_args": True, "ignore_unknown_options": True},
     add_help_option=True,
@@ -80,11 +82,12 @@ def testdoc(app: Application, robot_options_and_args: Tuple[str, ...]) -> None:
         except (TypeError, ValueError) as e:
             raise click.ClickException(str(e)) from e
 
-        testdoc_options = profile.testdoc
-        if testdoc_options is None:
-            testdoc_options = TestDocProfile()
-
+        # `testdoc` gets the settings outside of `[testdoc]` that it shares with `robot`. `[testdoc]` comes last, so
+        # it wins and its `extend-` settings add to them.
+        testdoc_options = TestDocProfile()
         testdoc_options.add_options(profile)
+        if profile.testdoc is not None:
+            testdoc_options.add_options(profile.testdoc)
 
         options = testdoc_options.build_command_line()
 

{robotcode_runner-2.7.0.dist-info → robotcode_runner-2.8.0.dev8.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: robotcode-runner
-Version: 2.7.0
+Version: 2.8.0-dev.8
 Summary: RobotCode runner for Robot Framework
 Project-URL: Homepage, https://robotcode.io
 Project-URL: Donate, https://opencollective.com/robotcode
@@ -20,18 +20,19 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
-Requires-Dist: robotcode-modifiers==2.7.0
-Requires-Dist: robotcode-plugin==2.7.0
-Requires-Dist: robotcode-robot==2.7.0
-Requires-Dist: robotcode==2.7.0
+Requires-Dist: robotcode-modifiers==2.8.0-dev.8
+Requires-Dist: robotcode-plugin==2.8.0-dev.8
+Requires-Dist: robotcode-robot==2.8.0-dev.8
+Requires-Dist: robotcode==2.8.0-dev.8
 Requires-Dist: robotframework>=5.0.0
 Provides-Extra: html
-Requires-Dist: html-to-markdown>=2.0; extra == 'html'
+Requires-Dist: html-to-markdown>=3.18; extra == 'html'
 Description-Content-Type: text/markdown
 
 # robotcode-runner

robotcode_runner-2.8.0.dev8.dist-info/RECORD

@@ -0,0 +1,25 @@
+robotcode/runner/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+robotcode/runner/__version__.py,sha256=JvoVcYcO_7K_aZkOPOeHH31iT5EQpvrGTx1sNBjoeYU,28
+robotcode/runner/hooks.py,sha256=MSqEHc3wQIBgCXf9U9B0sA_zE8vbiTdoAlfaWz_3uIo,270
+robotcode/runner/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
+robotcode/runner/cli/__init__.py,sha256=ozQtrMXxWIlJz3QKZhaGEIDjSCL0TPtF1XeP8WL8HrE,240
+robotcode/runner/cli/_markdown.py,sha256=4tHR4514XiHZiat-eMzxMclO_E7bwtdMTIo11rap80Q,12474
+robotcode/runner/cli/_robot_version.py,sha256=aXpMkrA4IHtCvqi_Dv9hr2D6UqBEI7j8PwsMgMJ0P-E,961
+robotcode/runner/cli/_search.py,sha256=JhKCDAdu_Mv89ug0p6nMumxdMAAwgbtdLt2CoJEZjsI,15874
+robotcode/runner/cli/libdoc.py,sha256=IanGjNOkm45VESVO_3pNoMpXtjpXMX9Li-J8lhPL2X8,3782
+robotcode/runner/cli/rebot.py,sha256=QIKYJD-4w7wquv46EygylNhBWXq1hj7-jV7vZvAHuHw,4922
+robotcode/runner/cli/robot.py,sha256=fxQz5zIdSafUalYivN7L-1di7YG4aJ7MJu2ffwiHbVw,16651
+robotcode/runner/cli/testdoc.py,sha256=UMpa1GOuyAIENGziepSprM4vHmR0QNfyBYWKN9cqd38,3756
+robotcode/runner/cli/discover/__init__.py,sha256=CRFSvVDlOX1avV3kx-d2QUOugDvgKPy8RBApsAUq15s,55
+robotcode/runner/cli/discover/_models.py,sha256=mkRwJTyQUWLVGbupCtYMVAHFhUouuMJ3TfR7_gz_lZI,2127
+robotcode/runner/cli/discover/_render.py,sha256=3GYv0bNPVOLDAabg6FYXmbCDLLztjeLFrEhj-1inUvY,20091
+robotcode/runner/cli/discover/discover.py,sha256=_YFeseR5pGPHIhltiwuNrxbHlk_uCcyB0cygyHPpOQM,46997
+robotcode/runner/cli/results/__init__.py,sha256=aEyNen0WWvq3kF_VTRLz99_B5CMChM0aelpzWKW6Rac,52
+robotcode/runner/cli/results/_html.py,sha256=VxfsMXeHA-CBpcHot-PRxoXXqNDvpJyPItofTRf-J3I,26353
+robotcode/runner/cli/results/_models.py,sha256=ESn9VKIF-mySCnE144wNoYMmYMKuniZKQW5O61lko5I,7458
+robotcode/runner/cli/results/_render.py,sha256=9DNk1d7F01bGQBCKBgtcqw_asvmnX1pJ02-kU02ptss,32471
+robotcode/runner/cli/results/results.py,sha256=FtSPgsHS4D-6Guvur0zn6f3lYsPZigZaMpRzNBrxAdw,75501
+robotcode_runner-2.8.0.dev8.dist-info/METADATA,sha256=ETbyZQyRGrplGbSZMZBO9iWmryQdtdRi6r8FBh06D2I,3050
+robotcode_runner-2.8.0.dev8.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+robotcode_runner-2.8.0.dev8.dist-info/entry_points.txt,sha256=igwjQYHlUfgCN-SohGVeQOnxOtqUzd2Jq94Ie8Se1Aw,44
+robotcode_runner-2.8.0.dev8.dist-info/RECORD,,

{robotcode_runner-2.7.0.dist-info → robotcode_runner-2.8.0.dev8.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.31.0
+Generator: hatchling 1.32.4
 Root-Is-Purelib: true
 Tag: py3-none-any

robotcode_runner-2.7.0.dist-info/RECORD

@@ -1,24 +0,0 @@
-robotcode/runner/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-robotcode/runner/__version__.py,sha256=EtKWW0Hnl5oWglRNH0HZigvcDT2FEs58ek8buJdwW1E,22
-robotcode/runner/hooks.py,sha256=MSqEHc3wQIBgCXf9U9B0sA_zE8vbiTdoAlfaWz_3uIo,270
-robotcode/runner/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
-robotcode/runner/cli/__init__.py,sha256=ozQtrMXxWIlJz3QKZhaGEIDjSCL0TPtF1XeP8WL8HrE,240
-robotcode/runner/cli/_markdown.py,sha256=6zXGB3wYngaKg5tu-GuwCuZvvRKSxfl97jUxjRSkfEU,12022
-robotcode/runner/cli/_search.py,sha256=r6Uh-0ftc8WnkNOfkIgNBgJ2tSRWzgO0M_bM6cPFnxY,14421
-robotcode/runner/cli/libdoc.py,sha256=VOKb0Xpct9mGgZkCdUng13o3ZpvxnPg_LqWNP13BEJU,3468
-robotcode/runner/cli/rebot.py,sha256=LhMvkn92PQBQaniA1vRlu9J_XJ9N_wj95v48sdIvlG4,3943
-robotcode/runner/cli/robot.py,sha256=syHOpewghJg0EjdYe4hZCfPCvSMa38dA2pa4qeIplZc,11868
-robotcode/runner/cli/testdoc.py,sha256=qc11KKwgGVXUydqsPS1M6x-j69wrtkFACeZEBeGXZBk,3479
-robotcode/runner/cli/discover/__init__.py,sha256=CRFSvVDlOX1avV3kx-d2QUOugDvgKPy8RBApsAUq15s,55
-robotcode/runner/cli/discover/_models.py,sha256=YsJ9zn5KZH9TmsocAS3IeioU8-K3KqEl63TQa4HVAuc,1768
-robotcode/runner/cli/discover/_render.py,sha256=C1tee_gitlS4JsF1NVIuYczzqnTTKXOnTiEAJfGtCW0,16523
-robotcode/runner/cli/discover/discover.py,sha256=q-XAMG1pz4emyKNZOe66bIWU6awa5PxUQPBI2KpcSl0,38673
-robotcode/runner/cli/results/__init__.py,sha256=aEyNen0WWvq3kF_VTRLz99_B5CMChM0aelpzWKW6Rac,52
-robotcode/runner/cli/results/_html.py,sha256=MD_6RZMeYNORFOINB8RJA8UhKEgXl6pldCToF51Y3qo,19422
-robotcode/runner/cli/results/_models.py,sha256=1zo-LoR-_lLIrnEwZh61qAryCgirQWkJNcZ5yzognKo,7271
-robotcode/runner/cli/results/_render.py,sha256=IVQiD_plufMyEU3WIDntGx_aqTiFc-Pg10jtS0dfXFk,32104
-robotcode/runner/cli/results/results.py,sha256=Vofh1RAYxM_uTJAjAyjYB7vJFROOHD6S9KkQzeGyzHI,67126
-robotcode_runner-2.7.0.dist-info/METADATA,sha256=_PxtY6zq5PTEwHaNQN9rh84nY0SG1Jq_rfrdNf40bW8,2968
-robotcode_runner-2.7.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
-robotcode_runner-2.7.0.dist-info/entry_points.txt,sha256=igwjQYHlUfgCN-SohGVeQOnxOtqUzd2Jq94Ie8Se1Aw,44
-robotcode_runner-2.7.0.dist-info/RECORD,,