feat(debugger): refactored robotcode debugger to support debugging/running tests with robotcode's configurations and profiles, also command line tool changes.

The command line `robotcode.debugger` is deprectated and do not support configs and profiles, to use the full feature set use `robotcode debug` to start the debug server.

By default `robotcode debug` starts a debug session and waits for incoming connections.

Author: d-biehl

.vscode/launch.json

@@ -52,27 +52,33 @@
 			},
 			"args": [
 				"--verbose",
-				// "--dry",
-				// "-p",
-				// "firefox",
-				// "--dry",
-				// "robot",
-				// "--",
-				// "--help"
-				// "tests1"
-				// "profiles",
-				// "show",
-				// "list",
-				// "--format",
-				// "toml"
-				"robot",
-				"-t", "first",
-				"-ZLN", "Data.Tests.Playground.first",
-				"--name", "blahblah",
-				"-ZLN", "Data.Tests.Playground.second",
-				"--doc", "uchda",
-				"-ZEL", "Data.Tests.Playground.third",
-				"."
+				// "robot"
+				// "debug-launch",
+				// "--pipe-server",
+				// "\\\\.\\pipe\\926ab05cd224ef08dc3aec29eda1ba61"
+				"debug",
+				"--",
+				"--help"
+			]
+		},
+		{
+			"name": "Python: RobotCode Tool",
+			"type": "python",
+			"request": "launch",
+			"program": "${workspaceFolder}/bundled/tool/robotcode",
+			"justMyCode": false,
+			"cwd": "${workspaceFolder}/tests/robotcode/language_server/robotframework/parts/data",
+			// "env": {
+			// 	"ROBOTCODE_COLOR": "1",
+			// },
+			"env": {
+				"CMD_VAR_LONG": "long",
+			},
+			"args": [
+				"--verbose",
+				"debug-launch",
+				"--pipe-server",
+				"\\\\.\\pipe\\926ab05cd224ef08dc3aec29eda1ba61"
 			]
 		},
 		{

bundled/tool/debugger/__main__.py

@@ -24,4 +24,7 @@ def update_sys_path(path_to_add: str, strategy: str) -> None:
 
     from robotcode.cli import robotcode
 
-    sys.exit(robotcode(windows_expand_args=False))
+    robotcode(
+        windows_expand_args=False,
+        default_map={"launcher_script": str(pathlib.Path(__file__).parent)},
+    )

bundled/tool/debugger/launcher/__init__.py

@@ -324,6 +324,15 @@
         "title": "RobotCode",
         "type": "object",
         "properties": {
+          "robotcode.extraArgs": {
+            "type": "array",
+            "default": [],
+            "items": {
+              "type": "string"
+            },
+            "markdownDescription": "Specifies the arguments to be passed to the `robotcode` command line tool (i.e.: [`--log`, `--log-level=TRACE`, `--log-calls`]). Requires a VSCode restart to take effect.",
+            "scope": "resource"
+          },
           "robotcode.python": {
             "type": "string",
             "default": "",
@@ -362,35 +371,36 @@
             "markdownDescription": "Specifies the arguments to be passed to the language server (i.e.: [`--log`, `--log-file=~/robotcode.log`]). Requires a VSCode restart to take effect.",
             "scope": "resource"
           },
-          "robotcode.debugAdapter.mode": {
+          "robotcode.debugLauncher.mode": {
             "type": "string",
-            "default": "stdio",
+            "default": "pipe-server",
             "description": "Specifies the mode the debug adapter is started. Requires a VSCode restart to take effect.",
             "enum": [
               "stdio",
-              "tcp"
+              "tcp",
+              "pipe-server"
             ],
             "scope": "resource"
           },
-          "robotcode.debugAdapter.tcpPort": {
+          "robotcode.debugLauncher.tcpPort": {
             "type": "number",
             "default": 0,
             "description": "If the port is specified, connect to the debug adapter previously started at the given port. Requires a VSCode restart to take effect.",
             "scope": "resource"
           },
-          "robotcode.debugAdapter.host": {
+          "robotcode.debugLauncher.host": {
             "type": "string",
             "default": null,
             "description": "If the host is specified, connect to the debug adapter previously started at the given host. Requires a VSCode restart to take effect.",
             "scope": "resource"
           },
-          "robotcode.debugAdapter.args": {
+          "robotcode.debugLauncher.args": {
             "type": "array",
             "default": [],
             "items": {
               "type": "string"
             },
-            "markdownDescription": "Specifies the arguments to be passed to the debug adapter (i.e.: [`--log`, `--log-file=~/debug-adapter.log`]). Requires a VSCode restart to take effect.",
+            "markdownDescription": "Specifies the arguments to be passed to the debug adapter. Requires a VSCode restart to take effect.",
             "scope": "resource"
           },
           "robotcode.robot.args": {
@@ -849,6 +859,11 @@
                 "description": "Attach also the python debugger if a robot test starts.",
                 "default": false
               },
+              "attachPythonPort": {
+                "type": "number",
+                "description": "The port the python debugger (debugpy) should use.",
+                "default": 5678
+              },
               "pythonConfiguration": {
                 "type": [
                   "object",
@@ -869,13 +884,21 @@
                 "markdownDescription": "The `.robot` file or a folder containing `.robot` files to be launched.",
                 "default": "${file}"
               },
+              "profiles": {
+                "type": "array",
+                "default": [],
+                "items": {
+                  "type": "string"
+                },
+                "markdownDescription": "Specifies the profiles to be used for execution. Corresponds to the '--profile' option of __robotcode__."
+              },
               "paths": {
                 "type": "array",
                 "default": [],
                 "items": {
                   "type": "string"
                 },
-                "markdownDescription": "Specifies the paths where robot should discover tests. Corresponds to the 'paths' option of __robot__."
+                "markdownDescription": "Specifies the paths where robot should discover tests. Corresponds to the 'paths' argument of __robot__."
               },
               "args": {
                 "type": "array",
@@ -933,6 +956,11 @@
                 "description": "Attach also the python debugger if a robot test starts.",
                 "default": false
               },
+              "attachPythonPort": {
+                "type": "number",
+                "description": "The port the python debugger (debugpy) should use.",
+                "default": 5678
+              },
               "pythonConfiguration": {
                 "type": [
                   "object",
@@ -1001,6 +1029,11 @@
                 "description": "Timeout the debugger waits for a client connection.",
                 "default": 10
               },
+              "robotCodeArgs": {
+                "type": "array",
+                "description": "Extra command line arguments passed to robotcode.",
+                "default": []
+              },
               "outputDir": {
                 "type": "string",
                 "default": null,
@@ -1222,7 +1255,6 @@
     "ms-python.python"
   ],
   "dependencies": {
-    "@vscode/debugadapter": "^1.59.0",
     "ansi-colors": "^4.1.3",
     "vscode-languageclient": "^8.1.0"
   },
@@ -1231,7 +1263,6 @@
     "@types/vscode": "^1.74.0",
     "@typescript-eslint/eslint-plugin": "^5.58.0",
     "@typescript-eslint/parser": "^5.58.0",
-    "@vscode/debugadapter-testsupport": "^1.59.0",
     "@vscode/test-electron": "^2.3.0",
     "eslint": "^8.38.0",
     "eslint-config-prettier": "^8.8.0",

bundled/tool/debugger/launcher/__main__.py

@@ -21,7 +21,7 @@
 def analyze(
     ctx: click.Context,
 ) -> Union[str, int, None]:
-    """Analyzes a Robot Framework project.
+    """TODO: Analyzes a Robot Framework project.
 
     TODO: This is not implemented yet.
     """

bundled/tool/robotcode/__main__.py

@@ -0,0 +1,22 @@
+from enum import Enum, unique
+from typing import NamedTuple, Sequence, Union
+
+
+@unique
+class ServerMode(str, Enum):
+    STDIO = "stdio"
+    TCP = "tcp"
+    SOCKET = "socket"
+    PIPE = "pipe"
+    PIPE_SERVER = "pipe-server"
+
+    def __str__(self) -> str:
+        return self.value
+
+    def __repr__(self) -> str:
+        return repr(self.value)
+
+
+class TcpParams(NamedTuple):
+    host: Union[str, Sequence[str], None] = None
+    port: int = 0

package-lock.json

@@ -25,12 +25,19 @@ classifiers = [
   "Framework :: Robot Framework",
   "Framework :: Robot Framework :: Tool",
 ]
-dependencies = ["robotcode-jsonrpc2", "robotframework>=4.1.0"]
 dynamic = ["version"]
+dependencies = [
+  "robotframework>=4.1.0",
+  "robotcode-jsonrpc2",
+  "robotcode-runner",
+]
 
 [project.optional-dependencies]
 debugpy = ["debugpy"]
 
+[project.entry-points.robotcode]
+debugger = "robotcode.debugger.hooks"
+
 [project.scripts]
 'robotcode.debugger' = 'robotcode.debugger.__main__:main'