Rework handling of launching and debugging tests fixes #54

Author: d-biehl

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to the "robotcode" extension will be documented in this file
 ## [Unreleased]
 
 - Support for Robocop >= 2.4
+- Rework handling of launching and debugging tests
+  - fixes [#54](https://github.com/d-biehl/robotcode/issues/54)
+  - a launch configuration can now have a `purpose`:
+    - `test`: Use this configuration when running or debugging tests.
+    - `default`: Use this configuration as default for all other configurations.
 
 ##  0.13.7
 

package.json

@@ -51,7 +51,7 @@
   "capabilities": {
     "untrustedWorkspaces": {
       "supported": "limited",
-      "description": "Only Partial IntelliSense with RobotCode is supported. Cannot execute Python with untrusted files."
+      "description": "Only Partial IntelliSense is supported."
     },
     "virtualWorkspaces": {
       "supported": "limited",
@@ -611,6 +611,9 @@
                 "default": "${workspaceFolder}"
               },
               "env": {
+                "additionalProperties": {
+                  "type": "string"
+                },
                 "type": "object",
                 "description": "Environment variables defined as a key value pair.",
                 "default": []
@@ -654,7 +657,10 @@
                 "default": false
               },
               "pythonConfiguration": {
-                "type": "object",
+                "type": [
+                  "object",
+                  "string"
+                ],
                 "description": "Defines a template for the python launch configuration.",
                 "default": {}
               },
@@ -723,6 +729,32 @@
                 ],
                 "description": "Specifies robot execution mode.",
                 "default": "default"
+              },
+              "purpose": {
+                "type": [
+                  "array",
+                  "string"
+                ],
+                "enum": [
+                  "default",
+                  "test"
+                ],
+                "enumDescriptions": [
+                  "Use this configuration as default for all other configurations.",
+                  "Use this configuration when running or debugging tests."
+                ],
+                "default": [],
+                "description": "Defines what purpose this configuration has.",
+                "items": {
+                  "enum": [
+                    "default",
+                    "test"
+                  ],
+                  "enumDescriptions": [
+                    "Use this configuration as default for all other configurations.",
+                    "Use this configuration when running or debugging tests."
+                  ]
+                }
               }
             }
           }
@@ -741,6 +773,25 @@
             "request": "launch",
             "cwd": "${workspaceFolder}",
             "target": "."
+          },
+          {
+            "name": "RobotCode: Default",
+            "type": "robotcode",
+            "request": "launch",
+            "purpose": "default",
+            "presentation": {
+              "hidden": true
+            },
+            "pythonConfiguration": "RobotCode: Debug"
+          },
+          {
+            "name": "RobotCode: Python",
+            "type": "python",
+            "request": "attach",
+            "presentation": {
+              "hidden": true
+            },
+            "justMyCode": false
           }
         ],
         "configurationSnippets": [
@@ -765,6 +816,32 @@
               "cwd": "^\"\\${workspaceFolder}\"",
               "target": "."
             }
+          },
+          {
+            "label": "RobotCode: Test",
+            "description": "Run or debug tests from test explorer.",
+            "body": {
+              "name": "RobotCode: Test",
+              "type": "robotcode",
+              "request": "launch",
+              "presentation": {
+                "hidden": true
+              },
+              "purpose": "test"
+            }
+          },
+          {
+            "label": "RobotCode: Default",
+            "description": "Default configuration.",
+            "body": {
+              "name": "RobotCode: Default",
+              "type": "robotcode",
+              "request": "launch",
+              "presentation": {
+                "hidden": true
+              },
+              "purpose": "default"
+            }
           }
         ]
       }

vscode-client/debugmanager.ts

@@ -49,7 +49,7 @@ class RobotCodeDebugConfigurationProvider implements vscode.DebugConfigurationPr
 
   // eslint-disable-next-line class-methods-use-this
   async _resolveDebugConfiguration(
-    _folder: vscode.WorkspaceFolder | undefined,
+    folder: vscode.WorkspaceFolder | undefined,
     debugConfiguration: vscode.DebugConfiguration,
     token?: vscode.CancellationToken
   ): Promise<vscode.DebugConfiguration> {
@@ -71,23 +71,23 @@ class RobotCodeDebugConfigurationProvider implements vscode.DebugConfigurationPr
       }
     }
 
-    return debugConfiguration;
-  }
+    const config = vscode.workspace.getConfiguration(CONFIG_SECTION, folder);
 
-  resolveDebugConfigurationWithSubstitutedVariables(
-    folder: vscode.WorkspaceFolder | undefined,
-    debugConfiguration: vscode.DebugConfiguration,
-    _token?: vscode.CancellationToken
-  ): vscode.ProviderResult<vscode.DebugConfiguration> {
-    return this._resolveDebugConfigurationWithSubstitutedVariablesAsync(folder, debugConfiguration, _token);
-  }
+    const template = config.get("debug.defaultConfiguration", {});
 
-  async _resolveDebugConfigurationWithSubstitutedVariablesAsync(
-    folder: vscode.WorkspaceFolder | undefined,
-    debugConfiguration: vscode.DebugConfiguration,
-    _token?: vscode.CancellationToken
-  ): Promise<vscode.DebugConfiguration> {
-    const config = vscode.workspace.getConfiguration(CONFIG_SECTION, folder);
+    const defaultLaunchConfig =
+      vscode.workspace
+        .getConfiguration("launch", folder)
+        ?.get<{ [Key: string]: unknown }[]>("configurations")
+        ?.find(
+          (v) =>
+            v?.type === "robotcode" &&
+            (v?.purpose === "default" || (Array.isArray(v?.purpose) && v?.purpose?.indexOf("default") > -1))
+        ) ?? {};
+
+    console.log(defaultLaunchConfig);
+
+    debugConfiguration = { ...template, ...defaultLaunchConfig, ...debugConfiguration };
 
     try {
       if (path.isAbsolute(debugConfiguration.target)) {
@@ -101,23 +101,27 @@ class RobotCodeDebugConfigurationProvider implements vscode.DebugConfigurationPr
 
     debugConfiguration.robotPythonPath = [
       ...config.get<string[]>("robot.pythonPath", []),
+      ...(Array.isArray(defaultLaunchConfig?.robotPythonPath) ? defaultLaunchConfig.robotPythonPath : []),
       ...(debugConfiguration.robotPythonPath ?? []),
     ];
 
     debugConfiguration.args = [...config.get<string[]>("robot.args", []), ...(debugConfiguration.args ?? [])];
 
     debugConfiguration.variableFiles = [
       ...config.get<string[]>("robot.variableFiles", []),
+      ...(Array.isArray(defaultLaunchConfig?.variableFiles) ? defaultLaunchConfig.variableFiles : []),
       ...(debugConfiguration.variableFiles ?? []),
     ];
 
     debugConfiguration.variables = {
       ...config.get<{ [Key: string]: unknown }>("robot.variables", {}),
+      ...(Array.isArray(defaultLaunchConfig?.variables) ? defaultLaunchConfig.variables : []),
       ...(debugConfiguration.variables ?? {}),
     };
 
     debugConfiguration.env = {
       ...config.get<{ [Key: string]: unknown }>("robot.env", {}),
+      ...(defaultLaunchConfig?.env ?? {}),
       ...(debugConfiguration.env ?? {}),
     };
 
@@ -157,9 +161,7 @@ class RobotCodeDebugConfigurationProvider implements vscode.DebugConfigurationPr
       }
     }
 
-    const template = config.get("debug.defaultConfiguration", {});
-
-    return { ...template, ...debugConfiguration };
+    return debugConfiguration;
   }
 }
 
@@ -344,13 +346,23 @@ export class DebugManager {
 
       args.push(`robotcode.debugger.modifiers.ExcludedByLongName${separator}${excluded.join(separator)}`);
     }
-    const template = config.get("debug.defaultConfiguration", {});
+
+    const testLaunchConfig =
+      vscode.workspace
+        .getConfiguration("launch", folder)
+        ?.get<{ [Key: string]: unknown }[]>("configurations")
+        ?.find(
+          (v) =>
+            v?.type === "robotcode" &&
+            (v?.purpose === "test" || (Array.isArray(v?.purpose) && v?.purpose?.indexOf("test") > -1))
+        ) ?? {};
+
     const paths = config.get("robot.paths", []);
 
     await vscode.debug.startDebugging(
       folder,
       {
-        ...template,
+        ...testLaunchConfig,
         ...{
           type: "robotcode",
           name: "RobotCode: Run Tests",
@@ -379,26 +391,34 @@ export class DebugManager {
       options &&
       options.port
     ) {
-      await vscode.debug.startDebugging(
-        session.workspaceFolder,
-        {
-          ...session.configuration.pythonConfiguration,
-          ...{
-            type: "python",
-            name: `Python ${session.name}`,
-            request: "attach",
-            connect: {
-              port: options.port,
-            },
+      let pythonConfiguration = session.configuration.pythonConfiguration ?? {};
+
+      if (typeof pythonConfiguration === "string" || pythonConfiguration instanceof String) {
+        pythonConfiguration =
+          vscode.workspace
+            .getConfiguration("launch", session.workspaceFolder)
+            ?.get<{ [Key: string]: unknown }[]>("configurations")
+            ?.find((v) => v?.type === "python" && v?.name === pythonConfiguration) ?? {};
+      }
+
+      const debugConfiguration = {
+        ...pythonConfiguration,
+        ...{
+          type: "python",
+          name: `Python ${session.name}`,
+          request: "attach",
+          connect: {
+            port: options.port,
           },
         },
-        {
-          parentSession: session,
-          compact: true,
-          lifecycleManagedByParent: false,
-          consoleMode: vscode.DebugConsoleMode.MergeWithParent,
-        }
-      );
+      };
+
+      await vscode.debug.startDebugging(session.workspaceFolder, debugConfiguration, {
+        parentSession: session,
+        compact: true,
+        lifecycleManagedByParent: false,
+        consoleMode: vscode.DebugConsoleMode.MergeWithParent,
+      });
     }
   }