implement running and debugging testcases from testcontroller

Author: d-biehl

package.json

@@ -10,7 +10,7 @@
     "url": "https://github.com/d-biehl/robotcode.git"
   },
   "engines": {
-    "vscode": "^1.59.0"
+    "vscode": "^1.60.0"
   },
   "categories": [
     "Programming Languages",
@@ -395,19 +395,19 @@
   "devDependencies": {
     "@types/glob": "^7.1.4",
     "@types/mocha": "^9.0.0",
-    "@types/node": "^16.7.6",
-    "@types/vscode": "^1.59.0",
-    "@typescript-eslint/eslint-plugin": "^4.29.3",
-    "@typescript-eslint/parser": "^4.29.3",
+    "@types/node": "^16.7.10",
+    "@types/vscode": "^1.60.0",
+    "@typescript-eslint/eslint-plugin": "^4.30.0",
+    "@typescript-eslint/parser": "^4.30.0",
     "eslint": "^7.32.0",
     "eslint-config-airbnb": "^18.2.1",
     "eslint-config-prettier": "^8.3.0",
     "eslint-config-standard": "^16.0.3",
-    "eslint-config-standard-with-typescript": "20.0.0",
+    "eslint-config-standard-with-typescript": "21.0.1",
     "eslint-plugin-import": "^2.24.2",
     "eslint-plugin-jsx-a11y": "^6.4.1",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.4.1",
+    "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-promise": "^5.1.0",
     "eslint-plugin-react": "^7.25.1",
     "eslint-plugin-react-hooks": "^4.2.0",
@@ -416,10 +416,10 @@
     "prettier": "^2.3.2",
     "ts-loader": "^9.2.5",
     "typescript": "^4.4.2",
-    "vsce": "^1.96.2",
+    "vsce": "^1.96.3",
     "vscode-debugadapter-testsupport": "^1.49.0",
     "vscode-test": "^1.6.1",
-    "webpack": "^5.51.1",
+    "webpack": "^5.51.2",
     "webpack-cli": "^4.8.0"
   }
 }

robotcode/debugger/__main__.py

@@ -188,6 +188,8 @@ async def start_debugpy_async() -> None:
         args = [
             "--listener",
             f"robotcode.debugger.listeners.ListenerV2:no_debug={repr(no_debug)}",
+            "--listener",
+            "robotcode.debugger.listeners.ListenerV3",
             *args,
         ]
 

robotcode/debugger/listeners.py

@@ -1,6 +1,7 @@
-from typing import Any, Dict
+from typing import Any, Dict, Iterator, Union, cast
 
 from .debugger import Debugger
+from .types import Event
 
 
 class ListenerV2:
@@ -11,6 +12,14 @@ def __init__(self, no_debug: bool = False) -> None:
         self.debug = not no_debug
 
     def start_suite(self, name: str, attributes: Dict[str, Any]) -> None:
+        Debugger.instance().send_event(
+            self,
+            Event(
+                event="robotStarted",
+                body=dict(attributes),
+            ),
+        )
+
         Debugger.instance().start_output_group(name, attributes, "SUITE")
 
         if self.debug:
@@ -22,7 +31,23 @@ def end_suite(self, name: str, attributes: Dict[str, Any]) -> None:
 
         Debugger.instance().end_output_group(name, attributes)
 
+        Debugger.instance().send_event(
+            self,
+            Event(
+                event="robotEnded",
+                body=dict(attributes),
+            ),
+        )
+
     def start_test(self, name: str, attributes: Dict[str, Any]) -> None:
+        Debugger.instance().send_event(
+            self,
+            Event(
+                event="robotStarted",
+                body=dict(attributes),
+            ),
+        )
+
         Debugger.instance().start_output_group(name, attributes, "TEST")
 
         if self.debug:
@@ -34,6 +59,14 @@ def end_test(self, name: str, attributes: Dict[str, Any]) -> None:
 
         Debugger.instance().end_output_group(name, attributes)
 
+        Debugger.instance().send_event(
+            self,
+            Event(
+                event="robotEnded",
+                body=dict(attributes),
+            ),
+        )
+
     def start_keyword(self, name: str, attributes: Dict[str, Any]) -> None:
         Debugger.instance().start_output_group(
             f"{name}({', '.join(repr(v) for v in attributes.get('args', []))})",
@@ -82,3 +115,29 @@ def debug_file(self, path: str) -> None:
 
     def close(self) -> None:
         pass
+
+
+class ListenerV3:
+    ROBOT_LISTENER_API_VERSION = "3"
+
+    def start_suite(self, data: Any, result: Any) -> None:
+        from robot.running import TestCase, TestSuite
+
+        def enqueue(item: Union[TestSuite, TestCase]) -> Iterator[str]:
+            if isinstance(item, TestSuite):
+                for s in item.suites:
+                    yield from enqueue(s)
+                for s in item.tests:
+                    yield from enqueue(s)
+
+            yield item.longname
+
+        items = [i for i in enqueue(cast(TestSuite, data))]
+
+        Debugger.instance().send_event(
+            self,
+            Event(
+                event="robotEnqueued",
+                body={"items": items},
+            ),
+        )

robotcode/language_server/robotframework/parts/discovering.py

@@ -162,7 +162,7 @@ async def get_tests_from_document(self, text_document: TextDocumentIdentifier, i
             return [
                 TestItem(
                     type="test",
-                    id=f"{id}.{v.longname}" if id else v.longname,
+                    id=f"{id}.{v.name}" if id else v.longname,
                     label=v.name,
                     uri=str(Uri.from_path(v.source)),
                     range=Range(

vscode-client/debugmanager.ts

@@ -188,49 +188,40 @@ export class DebugManager {
     this._disposables.dispose();
   }
 
-  static async debugSuiteOrTestcase(
-    resource: string | vscode.Uri | undefined,
-    testcases?: string | string[],
+  static async runTests(
+    folder: vscode.WorkspaceFolder,
+    tests: string[],
+    runId?: string,
     options?: vscode.DebugSessionOptions
   ): Promise<void> {
-    if (resource === undefined) return;
+    if (tests.length) {
+      const config = vscode.workspace.getConfiguration(CONFIG_SECTION, folder);
 
-    const uri = resource instanceof vscode.Uri ? resource : vscode.Uri.parse(resource);
+      const args = [];
+      args.push("--prerunmodifier");
 
-    const folder = vscode.workspace.getWorkspaceFolder(uri);
+      args.push(`robotcode.debugger.modifiers.ByLongName:${tests.join(":")}`);
 
-    const config = vscode.workspace.getConfiguration(CONFIG_SECTION, folder);
-
-    const args = [];
-
-    if (testcases) {
-      if (!(testcases instanceof Array)) {
-        testcases = [testcases];
-      }
-      for (const testcase of testcases) {
-        args.push("-t");
-        args.push(testcase.toString());
-      }
-    }
-
-    const template = config.get("debug.defaultConfiguration", {});
+      const template = config.get("debug.defaultConfiguration", {});
 
-    vscode.debug.startDebugging(
-      folder,
-      {
-        ...template,
-        ...{
-          type: "robotcode",
-          name: `robotcode: Suite: ${resource}${testcases ? ` Testcase: ${testcases}` : ""}`,
-          request: "launch",
-          cwd: folder?.uri.fsPath,
-          target: uri.fsPath,
-          args,
-          console: config.get("debug.defaultConsole", "integratedTerminal"),
+      await vscode.debug.startDebugging(
+        folder,
+        {
+          ...template,
+          ...{
+            type: "robotcode",
+            name: "robotcode: Run Tests",
+            request: "launch",
+            cwd: folder?.uri.fsPath,
+            target: ".",
+            args: args,
+            console: config.get("debug.defaultConsole", "integratedTerminal"),
+            runId: runId,
+          },
         },
-      },
-      options
-    );
+        options
+      );
+    }
   }
 
   static async attachPython(session: vscode.DebugSession, event: string, options?: { port: number }): Promise<void> {
@@ -264,7 +255,7 @@ export class DebugManager {
     }
   }
 
-  static async onRobotExited(
+  private static async onRobotExited(
     session: vscode.DebugSession,
     outputFile?: string,
     logFile?: string,

vscode-client/extension.ts

@@ -21,7 +21,7 @@ export async function activateAsync(context: vscode.ExtensionContext): Promise<v
 
   const debugManager = new DebugManager(context, pythonManager, languageClientManger, outputChannel);
 
-  const testControllerManger = new TestControllerManager(context, languageClientManger, outputChannel);
+  const testControllerManger = new TestControllerManager(context, languageClientManger, debugManager, outputChannel);
 
   context.subscriptions.push(
     pythonManager,