start support for remote debugging

d-biehl · d-biehl · commit 58b97a8b868d · 2022-10-07T13:10:55.000+02:00
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -103,6 +103,10 @@
 			"args": [
 				"-p",
 				"6612",
+				"-b",
+				"localhost",
+				"-b",
+				"192.168.178.83",
 				"-w",
 				"--",
 				"-d",
@@ -237,6 +241,22 @@
 			],
 			"console": "integratedTerminal",
 			"justMyCode": false
+		},
+		{
+			"name": "Python: Remote-Attach",
+			"type": "python",
+			"request": "attach",
+			"connect": {
+				"host": "localhost",
+				"port": 5678
+			},
+			"pathMappings": [
+				{
+					"localRoot": "${workspaceFolder}",
+					"remoteRoot": "."
+				}
+			],
+			"justMyCode": true
 		}
 	],
 	"inputs": [
@@ -247,4 +267,4 @@
 			"default": "5678",
 		}
 	]
-}
+}
diff --git a/package.json b/package.json
@@ -618,6 +618,75 @@
           "robotframework"
         ],
         "configurationAttributes": {
+          "attach": {
+            "properties": {
+              "connect": {
+                "label": "Attach by connecting to debugpy over a socket.",
+                "properties": {
+                  "host": {
+                    "default": "127.0.0.1",
+                    "description": "Hostname or IP address to connect to.",
+                    "type": "string"
+                  },
+                  "port": {
+                    "description": "Port to connect to.",
+                    "type": "number"
+                  }
+                },
+                "required": [
+                  "port"
+                ],
+                "type": "object"
+              },
+              "host": {
+                "default": "127.0.0.1",
+                "description": "Hostname or IP address to connect to.",
+                "type": "string"
+              },
+              "pathMappings": {
+                "default": [],
+                "items": {
+                  "label": "Path mapping",
+                  "properties": {
+                    "localRoot": {
+                      "default": "${workspaceFolder}",
+                      "label": "Local source root.",
+                      "type": "string"
+                    },
+                    "remoteRoot": {
+                      "default": "",
+                      "label": "Remote source root.",
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "localRoot",
+                    "remoteRoot"
+                  ],
+                  "type": "object"
+                },
+                "label": "Path mappings.",
+                "type": "array"
+              },
+              "port": {
+                "description": "Port to connect to.",
+                "type": "number"
+              },
+              "attachPython": {
+                "type": "boolean",
+                "description": "Attach also the python debugger if a robot test starts.",
+                "default": false
+              },
+              "pythonConfiguration": {
+                "type": [
+                  "object",
+                  "string"
+                ],
+                "description": "Defines a template for the python launch configuration.",
+                "default": {}
+              }
+            }
+          },
           "launch": {
             "properties": {
               "target": {
@@ -893,6 +962,38 @@
               },
               "purpose": "default"
             }
+          },
+          {
+            "label": "RobotCode: Default",
+            "description": "Default configuration.",
+            "body": {
+              "name": "RobotCode: Default",
+              "type": "robotcode",
+              "request": "launch",
+              "presentation": {
+                "hidden": true
+              },
+              "purpose": "default"
+            }
+          },
+          {
+            "label": "RobotCode: Remote-Attach",
+            "description": "Attach to a running remote debug server.",
+            "body": {
+              "name": "RobotCode: Remote-Attach",
+              "type": "robotcode",
+              "request": "attach",
+              "connect": {
+                "host": "localhost",
+                "port": 6612
+              },
+              "pathMappings": [
+                {
+                  "localRoot": "^\"\\${workspaceFolder}\"",
+                  "remoteRoot": "."
+                }
+              ]
+            }
           }
         ]
       }
@@ -950,4 +1051,4 @@
     "webpack": "^5.74.0",
     "webpack-cli": "^4.10.0"
   }
-}
+}
diff --git a/robotcode/debugger/__main__.py b/robotcode/debugger/__main__.py
@@ -7,7 +7,7 @@
 import threading
 from logging.handlers import RotatingFileHandler
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, List, Optional, cast
+from typing import TYPE_CHECKING, Any, List, Optional, Sequence, Union, cast
 
 __file__ = os.path.abspath(__file__)
 if __file__.endswith((".pyc", ".pyo")):
@@ -74,7 +74,7 @@ async def _debug_adapter_server_(host: str, port: int) -> None:
         await server.serve()
 
 
-DEFAULT_TIMEOUT = 5.0
+DEFAULT_TIMEOUT = 10.0
 
 
 @_logger.call
@@ -110,6 +110,7 @@ async def start_debugpy_async(
 async def run_robot(
     port: int,
     args: List[str],
+    bind: Union[Sequence[str], str, None] = None,
     no_debug: bool = False,
     wait_for_client: bool = False,
     wait_for_client_timeout: float = DEFAULT_TIMEOUT,
@@ -245,6 +246,13 @@ def main() -> None:
 
     parser.add_argument("--version", action="store_true", help="shows the version and exits")
     parser.add_argument("-p", "--port", default=6612, help="server listen port (tcp)", type=int)
+    parser.add_argument(
+        "-b",
+        "--bind",
+        action="append",
+        help="Specify alternate bind address. If not specified '127.0.0.1' is used",
+        metavar="ADDRESS",
+    )
     parser.add_argument("-w", "--wait-for-client", action="store_true", help="waits for an debug client to connect")
     parser.add_argument(
         "-t",
@@ -277,7 +285,7 @@ def main() -> None:
     )
     parser.add_argument("-d", "--debugpy", action="store_true", help="starts a debugpy session")
     parser.add_argument(
-        "-dp", "--debugpy-port", default=6613, help="sets the port for debugpy session", type=int, metavar="PORT"
+        "-dp", "--debugpy-port", default=5678, help="sets the port for debugpy session", type=int, metavar="PORT"
     )
     parser.add_argument(
         "-dw", "--debugpy-wait-for-client", action="store_true", help="waits for debugpy client to connect"
@@ -366,6 +374,7 @@ def main() -> None:
         run_robot(
             args.port,
             robot_args,
+            args.bind,
             args.no_debug,
             args.wait_for_client,
             args.wait_for_client_timeout,
diff --git a/robotcode/debugger/dap_types.py b/robotcode/debugger/dap_types.py
@@ -318,6 +318,27 @@ class InitializeRequest(Request, _InitializeRequest):
     command: str = "initialize"
 
 
+@dataclass
+class AttachRequestArguments(Model):
+    restart: Optional[Any] = field(default=None, metadata={"alias": "__restart"})
+
+
+@dataclass
+class _AttachRequest(Model):
+    arguments: AttachRequestArguments
+
+
+@dataclass
+class AttachRequest(Request, _AttachRequest):
+    arguments: AttachRequestArguments = field()
+    command: str = "attach"
+
+
+@dataclass
+class AttachResponse(Response):
+    pass
+
+
 @dataclass
 class ExceptionBreakpointsFilter(Model):
     filter: str
diff --git a/robotcode/debugger/debugger.py b/robotcode/debugger/debugger.py
@@ -242,6 +242,7 @@ def __init__(self) -> None:
         self.stop_on_entry = False
         self.no_debug = False
         self.terminated = False
+        self.attached = False
 
     @property
     def debug(self) -> bool:
@@ -549,6 +550,7 @@ def process_end_state(self, status: str, filter_id: Set[str], description: str,
             )
         ):
             self.state = State.Paused
+
             self.send_event(
                 self,
                 StoppedEvent(
@@ -565,8 +567,9 @@ def process_end_state(self, status: str, filter_id: Set[str], description: str,
 
     @_logger.call
     def wait_for_running(self) -> None:
-        with self.condition:
-            self.condition.wait_for(lambda: self.state in [State.Running, State.Stopped])
+        if self.attached:
+            with self.condition:
+                self.condition.wait_for(lambda: self.state in [State.Running, State.Stopped])
 
     def start_output_group(self, name: str, attributes: Dict[str, Any], type: Optional[str] = None) -> None:
         if self.group_output:
diff --git a/robotcode/debugger/server.py b/robotcode/debugger/server.py
@@ -8,6 +8,8 @@
 from ..utils.async_tools import run_coroutine_from_thread
 from ..utils.logging import LoggingDescriptor
 from .dap_types import (
+    AttachRequestArguments,
+    Capabilities,
     ConfigurationDoneArguments,
     ContinueArguments,
     ContinueResponseBody,
@@ -16,9 +18,11 @@
     EvaluateArguments,
     EvaluateResponseBody,
     Event,
+    ExceptionBreakpointsFilter,
     ExitedEvent,
     ExitedEventBody,
     InitializedEvent,
+    InitializeRequestArguments,
     NextArguments,
     PauseArguments,
     ScopesArguments,
@@ -117,6 +121,56 @@ async def wait_for_disconnected(self, timeout: float = 60) -> bool:
 
         return self._connected
 
+    @rpc_method(name="initialize", param_type=InitializeRequestArguments)
+    async def _initialize(self, arguments: InitializeRequestArguments, *args: Any, **kwargs: Any) -> Capabilities:
+        self._initialized = True
+
+        return Capabilities(
+            supports_configuration_done_request=True,
+            supports_conditional_breakpoints=True,
+            supports_hit_conditional_breakpoints=True,
+            support_terminate_debuggee=True,
+            # support_suspend_debuggee=True,
+            supports_evaluate_for_hovers=True,
+            supports_terminate_request=True,
+            supports_log_points=True,
+            supports_set_expression=True,
+            supports_set_variable=True,
+            supports_value_formatting_options=True,
+            exception_breakpoint_filters=[
+                ExceptionBreakpointsFilter(
+                    filter="failed_keyword",
+                    label="Failed Keywords",
+                    description="Breaks on failed keywords",
+                    default=False,
+                ),
+                ExceptionBreakpointsFilter(
+                    filter="uncaught_failed_keyword",
+                    label="Uncaught Failed Keywords",
+                    description="Breaks on uncaught failed keywords",
+                    default=True,
+                ),
+                ExceptionBreakpointsFilter(
+                    filter="failed_test",
+                    label="Failed Test",
+                    description="Breaks on failed tests",
+                    default=False,
+                ),
+                ExceptionBreakpointsFilter(
+                    filter="failed_suite",
+                    label="Failed Suite",
+                    description="Breaks on failed suite",
+                    default=False,
+                ),
+            ],
+            supports_exception_options=True,
+            supports_exception_filter_options=True,
+        )
+
+    @rpc_method(name="attach", param_type=AttachRequestArguments)
+    async def _attach(self, arguments: AttachRequestArguments, *args: Any, **kwargs: Any) -> None:
+        pass
+
     @_logger.call
     async def initialized(self) -> None:
         await self.send_event_async(InitializedEvent())
@@ -173,6 +227,7 @@ async def _configuration_done(
     ) -> None:
         self._received_configuration_done = True
         self._received_configuration_done_event.set()
+        Debugger.instance().attached = True
 
     @_logger.call
     async def wait_for_configuration_done(self, timeout: float = 5) -> bool:
diff --git a/vscode-client/debugmanager.ts b/vscode-client/debugmanager.ts
