rework debugger termination

Author: d-biehl

CHANGELOG.md

@@ -8,6 +8,11 @@ All notable changes to the "robotcode" extension will be documented in this file
   - Specifies the paths where robot/robotcode should discover test suites. Corresponds to the 'paths' option of robot
 - Introduce setting `robotcode.robot.variableFiles` and correspondend launch config property `variableFiles`
   - Specifies the variable files for robotframework. Corresponds to the '--variablefile' option of robot.
+- Rework debugger termination
+  - if you want to stop the current run
+    - first click on stop tries to break the run like if you press <kbd>CTRL</kbd>+<kbd>c</kbd> to give the chance that logs and reports are written
+    - second click stops/kill execution
+- 'None' values are now shown correctly in debugger
 
 ##  0.9.2
 

robotcode/debugger/debugger.py

@@ -231,6 +231,7 @@ def __init__(self) -> None:
         self.last_fail_message: Optional[str] = None
         self.stop_on_entry = False
         self.no_debug = False
+        self.terminated = False
 
     @property
     def debug(self) -> bool:
@@ -260,6 +261,10 @@ def robot_output_file(self) -> Optional[str]:
     def robot_output_file(self, value: Optional[str]) -> None:
         self._robot_output_file = value
 
+    @_logger.call
+    def terminate(self) -> None:
+        self.terminated = True
+
     @_logger.call
     def start(self) -> None:
         with self.condition:
@@ -524,10 +529,14 @@ def process_start_state(self, source: str, line_no: int, type: str, status: str)
                             )
 
     def process_end_state(self, status: str, filter_id: str, description: str, text: Optional[str]) -> None:
-        if status == "FAIL" and any(
-            v
-            for v in self.exception_breakpoints
-            if v.filter_options is not None and any(o for o in v.filter_options if o.filter_id == filter_id)
+        if (
+            not self.terminated
+            and status == "FAIL"
+            and any(
+                v
+                for v in self.exception_breakpoints
+                if v.filter_options is not None and any(o for o in v.filter_options if o.filter_id == filter_id)
+            )
         ):
             self.state = State.Paused
             self.send_event(

robotcode/debugger/launcher/server.py

@@ -15,6 +15,7 @@
     ConfigurationDoneRequest,
     DisconnectArguments,
     DisconnectRequest,
+    Event,
     ExceptionBreakpointsFilter,
     InitializeRequestArguments,
     LaunchRequestArguments,
@@ -81,7 +82,7 @@ async def _initialize(self, arguments: InitializeRequestArguments, *args: Any, *
             supports_conditional_breakpoints=True,
             supports_hit_conditional_breakpoints=True,
             support_terminate_debuggee=True,
-            support_suspend_debuggee=True,
+            # support_suspend_debuggee=True,
             supports_evaluate_for_hovers=True,
             supports_terminate_request=True,
             supports_log_points=True,
@@ -216,6 +217,9 @@ async def _launch(
         if target:
             run_args.append(target)
 
+        if not paths and not target:
+            run_args.append(".")
+
         env = {k: ("" if v is None else str(v)) for k, v in env.items()} if env else {}
 
         if console in ["integratedTerminal", "externalTerminal"]:
@@ -273,6 +277,8 @@ async def _disconnect(self, arguments: Optional[DisconnectArguments] = None, *ar
     @rpc_method(name="terminate", param_type=TerminateArguments)
     async def _terminate(self, arguments: Optional[TerminateArguments] = None, *args: Any, **kwargs: Any) -> None:
         if self.client.connected:
+            self.send_event(Event("terminateRequested"))
+
             return await self.client.protocol.send_request_async(TerminateRequest(arguments=arguments))
         else:
             await self.send_event_async(TerminatedEvent())

robotcode/debugger/server.py

@@ -137,6 +137,8 @@ async def terminate(self) -> None:
     async def _terminate(self, arguments: Optional[TerminateArguments] = None, *args: Any, **kwargs: Any) -> None:
         import signal
 
+        Debugger.instance().terminate()
+
         if not self._sigint_signaled:
             self._logger.info("Send SIGINT to process")
             signal.raise_signal(signal.SIGINT)
@@ -145,8 +147,6 @@ async def _terminate(self, arguments: Optional[TerminateArguments] = None, *args
             self._logger.info("Send SIGTERM to process")
             signal.raise_signal(signal.SIGTERM)
 
-        Debugger.instance().stop()
-
     @rpc_method(name="disconnect", param_type=DisconnectArguments)
     async def _disconnect(self, arguments: Optional[DisconnectArguments] = None, *args: Any, **kwargs: Any) -> None:
         if (

vscode-client/debugmanager.ts

@@ -247,6 +247,14 @@ export class DebugManager {
               await DebugManager.OnDebugpyStarted(event.session, event.event, event.body);
               break;
             }
+            case "terminateRequested": {
+              for (const s of this._attachedSessions) {
+                if (s.parentSession == event.session) {
+                  await vscode.debug.stopDebugging(s);
+                }
+              }
+              break;
+            }
             case "robotExited": {
               await DebugManager.OnRobotExited(
                 event.session,
@@ -266,14 +274,7 @@ export class DebugManager {
         }
       }),
 
-      vscode.debug.onDidTerminateDebugSession(async (session) => {
-        if (session.type === "robotcode") {
-          for (const s of this._attachedSessions) {
-            if (s.parentSession === session) {
-              await vscode.debug.stopDebugging(s);
-            }
-          }
-        }
+      vscode.debug.onDidTerminateDebugSession((session) => {
         if (this._attachedSessions.has(session)) {
           this._attachedSessions.delete(session);
         }
@@ -423,8 +424,8 @@ export class DebugManager {
         {
           parentSession: session,
           compact: true,
-          lifecycleManagedByParent: true,
-          consoleMode: vscode.DebugConsoleMode.Separate,
+          lifecycleManagedByParent: false,
+          consoleMode: vscode.DebugConsoleMode.MergeWithParent,
         }
       );
     }

vscode-client/testcontrollermanager.ts

@@ -625,7 +625,9 @@ export class TestControllerManager {
     } else {
       this.testController.items.forEach((test) => {
         const robotTest = this.findRobotItem(test);
-        if (robotTest?.type === "workspace") {
+        if (robotTest?.type === "error") {
+          return;
+        } else if (robotTest?.type === "workspace") {
           test.children.forEach((v) => includedItems.push(v));
         } else {
           includedItems.push(test);
@@ -636,6 +638,8 @@ export class TestControllerManager {
     const included = this.mapTestItemsToWorkspace(includedItems);
     const excluded = this.mapTestItemsToWorkspace(request.exclude ? Array.from(request.exclude) : []);
 
+    if (included.size === 0) return;
+
     const run = this.testController.createTestRun(request);
 
     token.onCancellationRequested(async (_) => {