fix(runner): --by-longname and --exclude-by-longname now take into account whether a name for the run was set via --name command line argument or in the name setting robot.toml

closes #248

Author: d-biehl

packages/modifiers/src/robotcode/modifiers/longname_modifiers.py

@@ -1,23 +1,44 @@
-from typing import Union
+from typing import Optional, Union
 
 from robot.api import SuiteVisitor
 from robot.running import TestCase, TestSuite
 
 
-class ByLongName(SuiteVisitor):
-    def __init__(self, *included: str) -> None:
+class _BaseSuiteVisitor(SuiteVisitor):
+    def __init__(self, *included: str, root_name: Optional[str] = None) -> None:
         super().__init__()
-        self.included = included
+        self.included = list(included)
+
+        self.root_name = root_name
+        self.real_root_name: Optional[str] = None
 
     def start_suite(self, suite: TestSuite) -> None:
-        suite.tests = [t for t in suite.tests if self._is_included(t)]
+        if self.real_root_name is None and self.root_name is not None:
+            self.real_root_name = suite.longname
+            new_included = []
+            for i in self.included:
+                if "." in i:
+                    root_name, rest = c if len(c := i.split(".", 1)) > 1 else (c, None)
+                    if root_name == self.root_name:
+                        if rest is not None:
+                            new_included.append(f"{self.real_root_name}.{rest}")
+                        else:
+                            new_included.append(f"{self.real_root_name}'")
+                    else:
+                        new_included.append(i)
+                else:
+                    new_included.append(i)
+            self.included = new_included
 
     def _is_included(self, test: Union[TestCase, TestSuite]) -> bool:
         names = []
         names.append(test.longname)
         current = test.parent
         while current:
-            names.append(current.longname)
+            if current.parent is None:
+                names.append(self.root_name if self.root_name is not None else current.longname)
+            else:
+                names.append(current.longname)
             current = current.parent
 
         return any((s in names) for s in self.included)
@@ -26,23 +47,15 @@ def end_suite(self, suite: TestSuite) -> None:
         suite.suites = [s for s in suite.suites if s.test_count > 0]
 
 
-class ExcludedByLongName(SuiteVisitor):
-    def __init__(self, *included: str) -> None:
-        super().__init__()
-        self.included = included
-
+class ByLongName(_BaseSuiteVisitor):
     def start_suite(self, suite: TestSuite) -> None:
-        suite.tests = [t for t in suite.tests if not self._is_included(t)]
+        super().start_suite(suite)
 
-    def _is_included(self, test: Union[TestCase, TestSuite]) -> bool:
-        names = []
-        names.append(test.longname)
-        current = test.parent
-        while current:
-            names.append(current.longname)
-            current = current.parent
+        suite.tests = [t for t in suite.tests if self._is_included(t)]
 
-        return any((s in names) for s in self.included)
 
-    def end_suite(self, suite: TestSuite) -> None:
-        suite.suites = [s for s in suite.suites if s.test_count > 0]
+class ExcludedByLongName(_BaseSuiteVisitor):
+    def start_suite(self, suite: TestSuite) -> None:
+        super().start_suite(suite)
+
+        suite.tests = [t for t in suite.tests if not self._is_included(t)]

packages/runner/src/robotcode/runner/cli/discover/discover.py

@@ -462,9 +462,7 @@ def handle_options(
     exclude_by_longname: Tuple[str, ...],
     robot_options_and_args: Tuple[str, ...],
 ) -> Tuple[TestSuite, Collector, Optional[Dict[str, List[Diagnostic]]]]:
-    root_folder, profile, cmd_options = handle_robot_options(
-        app, by_longname, exclude_by_longname, robot_options_and_args
-    )
+    root_folder, profile, cmd_options = handle_robot_options(app, robot_options_and_args)
 
     diagnostics_logger = DiagnosticsLogger()
     try:
@@ -479,6 +477,8 @@ def handle_options(
             ),
             app.config.dry,
             root_folder,
+            by_longname,
+            exclude_by_longname,
         ).parse_arguments((*cmd_options, "--runemptysuite", *robot_options_and_args))
 
         settings = RobotSettings(options)

packages/runner/src/robotcode/runner/cli/robot.py

@@ -8,6 +8,7 @@
 from robot.run import USAGE, RobotFramework
 from robot.version import get_full_version
 
+import robotcode.modifiers
 from robotcode.plugin import Application, pass_application
 from robotcode.plugin.click_helper.aliases import AliasedCommand
 from robotcode.plugin.click_helper.types import add_options
@@ -25,13 +26,17 @@ def __init__(
         paths: List[str],
         dry: bool,
         root_folder: Optional[Path],
+        by_longname: Tuple[str, ...] = (),
+        exclude_by_longname: Tuple[str, ...] = (),
     ) -> None:
         super().__init__()
         self.app = app
         self.paths = paths
         self.dry = dry
         self.root_folder = root_folder
         self._orig_cwd = Path.cwd()
+        self.by_longname = by_longname
+        self.exclude_by_longname = exclude_by_longname
 
     def parse_arguments(self, cli_args: Any) -> Any:
         if self.root_folder is not None and Path.cwd() != self.root_folder:
@@ -61,6 +66,18 @@ def parse_arguments(self, cli_args: Any) -> Any:
                 f'{line_end.join((*(f"{k} = {v!r}" for k, v in options.items()), *arguments))}'
             )
 
+        modifiers = []
+        root_name = options.get("name", None)
+
+        if self.by_longname:
+            modifiers.append(robotcode.modifiers.ByLongName(*self.by_longname, root_name=root_name))
+
+        if self.exclude_by_longname:
+            modifiers.append(robotcode.modifiers.ExcludedByLongName(*self.exclude_by_longname, root_name=root_name))
+
+        if modifiers:
+            options["prerunmodifier"] = options.get("prerunmodifier", []) + modifiers
+
         return options, arguments
 
 
@@ -90,10 +107,7 @@ def parse_arguments(self, cli_args: Any) -> Any:
 
 
 def handle_robot_options(
-    app: Application,
-    by_longname: Tuple[str, ...],
-    exclude_by_longname: Tuple[str, ...],
-    robot_options_and_args: Tuple[str, ...],
+    app: Application, robot_options_and_args: Tuple[str, ...]
 ) -> Tuple[Optional[Path], RobotBaseProfile, List[str]]:
     robot_arguments: Optional[List[Union[str, Path]]] = None
     old_sys_path = sys.path.copy()
@@ -118,20 +132,6 @@ def handle_robot_options(
 
     cmd_options = profile.build_command_line()
 
-    if by_longname:
-        sep = ";" if any(True for l in by_longname if ":" in l) else ":"
-        cmd_options += (
-            "--prerunmodifier",
-            f"robotcode.modifiers.ByLongName{sep}{sep.join(by_longname)}",
-        )
-
-    if exclude_by_longname:
-        sep = ";" if any(True for l in exclude_by_longname if ":" in l) else ":"
-        cmd_options += (
-            "--prerunmodifier",
-            f"robotcode.modifiers.ExcludedByLongName{sep}{sep.join(exclude_by_longname)}",
-        )
-
     app.verbose(
         lambda: "Executing robot with following options:\n    "
         + " ".join(f'"{o}"' for o in (cmd_options + list(robot_options_and_args)))
@@ -170,9 +170,7 @@ def robot(
     ```
     """
 
-    root_folder, profile, cmd_options = handle_robot_options(
-        app, by_longname, exclude_by_longname, robot_options_and_args
-    )
+    root_folder, profile, cmd_options = handle_robot_options(app, robot_options_and_args)
 
     app.exit(
         cast(
@@ -186,6 +184,8 @@ def robot(
                 ),
                 app.config.dry,
                 root_folder,
+                by_longname,
+                exclude_by_longname,
             ).execute_cli((*cmd_options, *robot_options_and_args), exit=False),
         )
     )