implement some more configuration settings for debugging, use debugpy from python extension

Author: d-biehl

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to the "robotcode" extension will be documented in this file
 
 ## [Unreleased]
 
+### added
+
+- update readme
+- add some more configuration options for show log and messages at running test in debug console
+- debug console now shows source and line number from log message
+- use debugpy coming from vscode python extension, no need to install debugpy separately
+
 ##  0.2.7
 
 ### added

README.md

@@ -66,7 +66,8 @@ To speedup things you can install the platform dependent versions of the followi
 
 Example:
 
+```bash
 python -m pipenv install --dev pydantic orjson
-
+```
 
 

package.json

@@ -290,6 +290,36 @@
             "description": "Specifies the default configuration to run or debug robot tests.",
             "scope": "resource"
           },
+          "robotcode.debug.attachPython": {
+            "type": "boolean",
+            "description": "Attach also the python debugger if a robot test starts.",
+            "default": false,
+            "scope": "resource"
+          },
+          "robotcode.debug.outputMessages": {
+            "type": "boolean",
+            "description": "Output messages from robotframework in debug console.",
+            "default": false,
+            "scope": "resource"
+          },
+          "robotcode.debug.outputLog": {
+            "type": "boolean",
+            "description": "Output log messages from robotframework in debug console.",
+            "default": true,
+            "scope": "resource"
+          },
+          "robotcode.debug.groupOutput": {
+            "type": "boolean",
+            "description": "Group start and stop suite/test/keyword messages in debug console.",
+            "default": false,
+            "scope": "resource"
+          },
+          "robotcode.debug.useExternalDebugpy": {
+            "type": "boolean",
+            "description": "Use the debugpy in python environment, not from the python extension.",
+            "default": false,
+            "scope": "resource"
+          },
           "robotcode.debug.defaultConsole": {
             "type": "string",
             "enum": [
@@ -500,7 +530,7 @@
               "outputLog": {
                 "type": "boolean",
                 "description": "Output log messages from robotframework in debug console.",
-                "default": false
+                "default": true
               },
               "groupOutput": {
                 "type": "boolean",
@@ -558,8 +588,8 @@
     "@types/mocha": "^9.0.0",
     "@types/node": "^16.10.2",
     "@types/vscode": "^1.60.0",
-    "@typescript-eslint/eslint-plugin": "^4.32.0",
-    "@typescript-eslint/parser": "^4.32.0",
+    "@typescript-eslint/eslint-plugin": "^4.33.0",
+    "@typescript-eslint/parser": "^4.33.0",
     "eslint": "^7.32.0",
     "eslint-config-airbnb": "^18.2.1",
     "eslint-config-prettier": "^8.3.0",
@@ -582,7 +612,7 @@
     "vscode-debugadapter-testsupport": "^1.49.0",
     "vscode-dts": "^0.3.1",
     "vscode-test": "^1.6.1",
-    "webpack": "^5.56.0",
+    "webpack": "^5.56.1",
     "webpack-cli": "^4.8.0"
   }
 }

vscode-client/debugmanager.ts

@@ -11,11 +11,19 @@ const DEBUG_ADAPTER_DEFAULT_HOST = "127.0.0.1";
 class RobotCodeDebugConfigurationProvider implements vscode.DebugConfigurationProvider {
   constructor(private readonly pythonManager: PythonManager) {}
 
-  resolveDebugConfigurationWithSubstitutedVariables?(
+  resolveDebugConfigurationWithSubstitutedVariables(
     folder: vscode.WorkspaceFolder | undefined,
     debugConfiguration: vscode.DebugConfiguration,
     _token?: vscode.CancellationToken
   ): vscode.ProviderResult<vscode.DebugConfiguration> {
+    return this._resolveDebugConfigurationWithSubstitutedVariablesAsync(folder, debugConfiguration, _token);
+  }
+
+  async _resolveDebugConfigurationWithSubstitutedVariablesAsync(
+    folder: vscode.WorkspaceFolder | undefined,
+    debugConfiguration: vscode.DebugConfiguration,
+    _token?: vscode.CancellationToken
+  ): Promise<vscode.DebugConfiguration> {
     const config = vscode.workspace.getConfiguration(CONFIG_SECTION, folder);
 
     try {
@@ -46,14 +54,34 @@ class RobotCodeDebugConfigurationProvider implements vscode.DebugConfigurationPr
     debugConfiguration.outputDir =
       debugConfiguration?.outputDir ?? config.get<string | undefined>("robot.outputDir", undefined);
 
-    // if (pythonDebugpyPath) {
-    //     debugConfiguration.env = { PYTHONPATH: path.dirname(pythonDebugpyPath), ...debugConfiguration.env };
-    // }
+    debugConfiguration.attachPython = debugConfiguration?.attachPython ?? config.get<boolean>("debug.attachPython");
+
+    debugConfiguration.outputMessages =
+      debugConfiguration?.outputMessages ?? config.get<boolean>("debug.outputMessages");
+
+    debugConfiguration.outputLog = debugConfiguration?.outputLog ?? config.get<boolean>("debug.outputLog");
+
+    debugConfiguration.groupOutput = debugConfiguration?.groupOutput ?? config.get<boolean>("debug.groupOutput");
 
     if (!debugConfiguration.attachPython || debugConfiguration.noDebug) {
       debugConfiguration.attachPython = false;
     }
 
+    if (debugConfiguration.attachPython && !config.get<boolean>("debug.useExternalDebugpy")) {
+      const debugpyPath = await this.pythonManager.pythonExtension?.exports.debug.getDebuggerPackagePath();
+
+      if (debugpyPath) {
+        const env = debugConfiguration.env ?? {};
+        const envPythonPath: string = env.PYTHONPATH || "";
+
+        env.PYTHONPATH = [
+          path.dirname(debugpyPath),
+          ...(envPythonPath ? envPythonPath.split(path.delimiter) : []),
+        ].join(path.delimiter);
+        debugConfiguration.env = env;
+      }
+    }
+
     const template = config.get("debug.defaultConfiguration", {});
 
     return { ...template, ...debugConfiguration };