robotcode-debugger 2.8.0.dev548__tar.gz → 2.8.0.dev631__tar.gz

{robotcode_debugger-2.8.0.dev548 → robotcode_debugger-2.8.0.dev631}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: robotcode-debugger
-Version: 2.8.0-dev.548
+Version: 2.8.0-dev.631
 Summary: RobotCode Debugger for Robot Framework
 Project-URL: Homepage, https://robotcode.io
 Project-URL: Donate, https://opencollective.com/robotcode
@@ -26,8 +26,8 @@ Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
-Requires-Dist: robotcode-jsonrpc2==2.8.0-dev.548
-Requires-Dist: robotcode-runner==2.8.0-dev.548
+Requires-Dist: robotcode-jsonrpc2==2.8.0-dev.631
+Requires-Dist: robotcode-runner==2.8.0-dev.631
 Requires-Dist: robotframework>=5.0.0
 Provides-Extra: debugpy
 Requires-Dist: debugpy; extra == 'debugpy'

{robotcode_debugger-2.8.0.dev548 → robotcode_debugger-2.8.0.dev631}/pyproject.toml

@@ -30,8 +30,8 @@ classifiers = [
 dynamic = ["version"]
 dependencies = [
   "robotframework>=5.0.0",
-  "robotcode-jsonrpc2==2.8.0-dev.548",
-  "robotcode-runner==2.8.0-dev.548",
+  "robotcode-jsonrpc2==2.8.0-dev.631",
+  "robotcode-runner==2.8.0-dev.631",
 ]
 
 [project.optional-dependencies]

robotcode_debugger-2.8.0.dev631/src/robotcode/debugger/__version__.py

@@ -0,0 +1 @@
+__version__ = "2.8.0-dev.631"

{robotcode_debugger-2.8.0.dev548 → robotcode_debugger-2.8.0.dev631}/src/robotcode/debugger/launcher/server.py

@@ -6,7 +6,7 @@ import os
 import shlex
 import sys
 from pathlib import Path
-from typing import Any, Dict, List, Literal, Optional
+from typing import Any, Dict, List, Literal, Mapping, Optional
 
 from robotcode.core.types import ServerMode, TcpParams
 from robotcode.core.utils.logging import LoggingDescriptor
@@ -70,6 +70,30 @@ def _build_robotcode_run_args(
     ]
 
 
+Console = Literal["robotcodeTerminal", "internalConsole", "integratedTerminal", "externalTerminal"]
+
+
+def _console_for_client(console: Optional[Console], client_id: Optional[str]) -> Optional[Console]:
+    """The console a run uses: RobotCode's own run terminal is part of its VS Code extension, so any other client
+    gets the integrated terminal instead."""
+    if console == "robotcodeTerminal" and client_id != "vscode":
+        return "integratedTerminal"
+    return console
+
+
+def _merged_environment(
+    base: Mapping[str, str], env: Mapping[str, Optional[str]], windows: bool
+) -> Dict[str, Optional[str]]:
+    """The environment of a run: ``base`` with the variables of ``env``. On Windows, where a name means the same
+    variable in any case, a variable of ``env`` replaces the one of ``base`` whose name differs only in case, and of
+    two names in ``env`` that differ only in case, the last one stays."""
+    if windows:
+        last = {name.upper(): name for name in env}
+        env = {name: value for name, value in env.items() if last[name.upper()] == name}
+        base = {name: value for name, value in base.items() if name.upper() not in last}
+    return {**base, **env}
+
+
 class OutputProtocol(asyncio.SubprocessProtocol):
     def __init__(self, parent: LauncherDebugAdapterProtocol) -> None:
         super().__init__()
@@ -136,7 +160,7 @@ class LauncherDebugAdapterProtocol(DebugAdapterProtocol):
         paths: Optional[List[str]] = None,
         args: Optional[List[str]] = None,
         env: Optional[Dict[str, Optional[Any]]] = None,
-        console: Optional[Literal["internalConsole", "integratedTerminal", "externalTerminal"]] = "integratedTerminal",
+        console: Optional[Console] = "integratedTerminal",
         name: Optional[str] = None,
         no_debug: Optional[bool] = None,
         robotPythonPath: Optional[List[str]] = None,  # noqa: N803
@@ -263,7 +287,19 @@ class LauncherDebugAdapterProtocol(DebugAdapterProtocol):
 
         env = {k: ("" if v is None else str(v)) for k, v in env.items()} if env else {}
 
-        if console in ["integratedTerminal", "externalTerminal"]:
+        console = _console_for_client(
+            console, self._initialize_arguments.client_id if self._initialize_arguments is not None else None
+        )
+
+        if console == "robotcodeTerminal":
+            # RobotCode's VS Code extension runs it as the process of a terminal of its own, without a shell
+            await self.send_event_async(
+                Event(
+                    event="runInRobotCodeTerminal",
+                    body={"cwd": cwd, "args": [*robotcode_run_args, *run_args], "env": env, "title": name},
+                )
+            )
+        elif console in ["integratedTerminal", "externalTerminal"]:
             await self.send_request_async(
                 RunInTerminalRequest(
                     arguments=RunInTerminalRequestArguments(
@@ -284,8 +320,7 @@ class LauncherDebugAdapterProtocol(DebugAdapterProtocol):
             )
             # time.sleep(1)  # Give some time for the terminal to start
         elif console is None or console == "internalConsole":
-            run_env: Dict[str, Optional[str]] = dict(os.environ)
-            run_env.update(env)
+            run_env = _merged_environment(os.environ, env, sys.platform == "win32")
 
             await asyncio.get_event_loop().subprocess_exec(
                 lambda: OutputProtocol(self), *robotcode_run_args, *run_args, cwd=cwd, env=run_env

{robotcode_debugger-2.8.0.dev548 → robotcode_debugger-2.8.0.dev631}/src/robotcode/debugger/listeners.py

@@ -66,6 +66,15 @@ def source_from_attributes(attributes: Dict[str, Any]) -> str:
     return s or ""
 
 
+def without_empty_lineno(attributes: Dict[str, Any]) -> Dict[str, Any]:
+    """A copy of listener attributes with an empty line number as None. Up to Robot Framework 6.1, listeners get ""
+    for a test or keyword without one, as a custom parser or a pre-run modifier creates them."""
+    result = dict(attributes)
+    if result.get("lineno") == "":
+        result["lineno"] = None
+    return result
+
+
 class ListenerV2:
     ROBOT_LISTENER_API_VERSION = "2"
 
@@ -146,11 +155,11 @@ class ListenerV2:
                     type="test",
                     name=name,
                     id=f"{source_from_attributes(attributes)};{attributes.get('longname', '')};"
-                    f"{attributes.get('lineno', 0)}",
+                    f"{attributes.get('lineno') or 0}",
                     parent_id=self.suite_id_stack[-1] if self.suite_id_stack else None,
-                    attributes=dict(attributes),
+                    attributes=without_empty_lineno(attributes),
                     source=source_from_attributes(attributes) or None,
-                    lineno=attributes.get("lineno", None),
+                    lineno=attributes.get("lineno") or None,
                 ),
             ),
         )
@@ -172,13 +181,13 @@ class ListenerV2:
                     type="test",
                     name=name,
                     id=f"{source_from_attributes(attributes)};{attributes.get('longname', '')};"
-                    f"{attributes.get('lineno', 0)}",
+                    f"{attributes.get('lineno') or 0}",
                     parent_id=self.suite_id_stack[-1] if self.suite_id_stack else None,
-                    attributes=dict(attributes),
+                    attributes=without_empty_lineno(attributes),
                     failed_keywords=self.failed_keywords,
                     failures=self._failures(),
                     source=source_from_attributes(attributes) or None,
-                    lineno=attributes.get("lineno", None),
+                    lineno=attributes.get("lineno") or None,
                 ),
             ),
         )
@@ -310,7 +319,7 @@ class ListenerV2:
                 if self.failed_keywords is None:
                     self.failed_keywords = []
 
-                keyword = {"message": self.last_fail_message, **attributes}
+                keyword = {"message": self.last_fail_message, **without_empty_lineno(attributes)}
                 # it is the nearest failed keyword around those that ended since it started and have none yet
                 for inner in self.failed_keywords[: max(0, len(self.failed_keywords) - mark)]:
                     self.failed_keyword_parents.setdefault(id(inner), keyword)
@@ -356,7 +365,7 @@ class ListenerV2:
                     self.failure_logged[-1] = True
 
             source = current_frame.source if current_frame else None
-            line = current_frame.line if current_frame else None
+            line = (current_frame.line or None) if current_frame else None
             column = current_frame.column if current_frame else None
 
             item_id = next(
@@ -365,7 +374,7 @@ class ListenerV2:
                         f"{normalized_path(Path(item.source)) if item.source is not None else ''};{item.longname}"
                         if item.type == "SUITE"
                         else f"{normalized_path(Path(item.source)) if item.source is not None else ''};"
-                        f"{item.longname};{item.line}"
+                        f"{item.longname};{item.line or 0}"
                     )
                     for item in Debugger.instance.full_stack_frames
                     if item.type in ["SUITE", "TEST"]
@@ -405,7 +414,7 @@ class ListenerV2:
             current_frame = Debugger.instance.full_stack_frames[0] if Debugger.instance.full_stack_frames else None
 
             source = current_frame.source if current_frame else None
-            line = current_frame.line if current_frame else None
+            line = (current_frame.line or None) if current_frame else None
             column = current_frame.column if current_frame else None
 
             item_id = next(
@@ -414,7 +423,7 @@ class ListenerV2:
                         f"{normalized_path(Path(item.source)) if item.source is not None else ''};{item.longname}"
                         if item.type == "SUITE"
                         else f"{normalized_path(Path(item.source)) if item.source is not None else ''};"
-                        f"{item.longname};{item.line}"
+                        f"{item.longname};{item.line or 0}"
                     )
                     for item in Debugger.instance.full_stack_frames
                     if item.type in ["SUITE", "TEST"]
@@ -498,7 +507,9 @@ class ListenerV3:
                     yield from enqueue(s)
                 return
 
-            yield (f"{normalized_path(item.source) if item.source is not None else ''};{item.longname};{item.lineno}")
+            yield (
+                f"{normalized_path(item.source) if item.source is not None else ''};{item.longname};{item.lineno or 0}"
+            )
 
         if self._event_sended:
             return
@@ -534,7 +545,7 @@ class ListenerV3:
                             id=f"{normalized_path(Path(result_item.source)) if result_item.source else ''};"
                             f"{result_item.longname or ''}"
                             + (
-                                f";{data_item.lineno if data_item is not None else 0}"
+                                f";{(data_item.lineno if data_item is not None else None) or 0}"
                                 if isinstance(result_item, result.TestCase)
                                 else ""
                             ),

{robotcode_debugger-2.8.0.dev548 → robotcode_debugger-2.8.0.dev631}/src/robotcode/debugger/server.py

@@ -210,6 +210,11 @@ class DebugAdapterServerProtocol(DebugAdapterProtocol):
         *args: Any,
         **kwargs: Any,
     ) -> None:
+        if self.exited:
+            # The run has ended and the process only waits for the client to disconnect. A signal would end it with
+            # the exit code of an interrupt and skip its exit handlers, such as those that close a library's browsers.
+            return
+
         Debugger.instance.terminate()
 
         if not restart and not self._sigint_signaled:

robotcode_debugger-2.8.0.dev548/src/robotcode/debugger/__version__.py

@@ -1 +0,0 @@
-__version__ = "2.8.0-dev.548"