Preventing "Commands" Command and cleanup (#472)

* Adding a warning to users when they try the 'commands' command via the debug console.
* Changing tests infrastructure to have chai globally
* Test updates

Author: omarArm

.mocharc-windows-ci.json

@@ -1,4 +1,5 @@
 {
   "//": "This timeout should match what is in CdtDebugClient constructor",
-  "timeout": "25000"
+  "timeout": "25000",
+  "require": ["ts-node/register", "src/integration-tests/test/setup.ts"]
 }

.mocharc.json

@@ -1,4 +1,5 @@
 {
   "//": "This timeout should match what is in CdtDebugClient constructor",
-  "timeout": "5000"
+  "timeout": "5000",
+  "require": ["ts-node/register", "src/integration-tests/test/setup.ts"]
 }

src/gdb/GDBDebugSessionBase.ts

@@ -2258,14 +2258,17 @@ export abstract class GDBDebugSessionBase extends LoggingDebugSession {
 
             if (isCliCommand) {
                 const expressionNoPrefix = expression.slice(1).trim();
+                const regexCommands = new RegExp(
+                    '^\\s*(?:comm|comma|comman|command|commands)\\s*.*$'
+                );
                 const regexDisable = new RegExp(
-                    '^\\s*(?:dis|disa|disable)\\s*(?:(?:breakpoint|count|delete|once)\\d*)?\\s*\\d*\\s*$'
+                    '^\\s*(?:dis|disa|disab|disabl|disable)\\s*(?:(?:breakpoint|count|delete|once)\\d*)?\\s*\\d*\\s*$'
                 );
                 const regexEnable = new RegExp(
-                    '^\\s*(?:en|enable)\\s*(?:(?:breakpoint|count|delete|once)\\d*)?\\s*\\d*\\s*$'
+                    '^\\s*(?:en|ena|enab|enabl|enable)\\s*(?:(?:breakpoint|count|delete|once)\\d*)?\\s*\\d*\\s*$'
                 );
                 const regexDelete = new RegExp(
-                    '^\\s*(?:d|del|delete)\\s+(?:breakpoints\\s+)?(\\d+)?\\s*$'
+                    '^\\s*(?:d|de|del|dele|delet|delete)\\s+(?:breakpoints\\s+)?(\\d+)?\\s*$'
                 );
                 if (
                     expressionNoPrefix.search(regexDisable) != -1 ||
@@ -2291,6 +2294,21 @@ export abstract class GDBDebugSessionBase extends LoggingDebugSession {
                         );
                     }
                 }
+                if (expressionNoPrefix.search(regexCommands) != -1) {
+                    this.sendEvent(
+                        new OutputEvent(
+                            'warning: "commands" command is not supported via GDB/MI interface',
+                            'stdout'
+                        )
+                    );
+                    response.body = {
+                        result: '',
+                        variablesReference: 0,
+                    };
+                    this.sendResponse(response);
+                    // Avoid sending the command to GDB
+                    return;
+                }
                 return await this.evaluateRequestGdbCommand(
                     response,
                     expressionNoPrefix,

src/integration-tests/auxiliaryGdb.spec.ts

@@ -25,10 +25,7 @@ import {
 import { TargetLaunchRequestArguments } from '../types/session';
 import { DebugProtocol } from '@vscode/debugprotocol';
 import { hexToBase64 } from '../web';
-import * as chai from 'chai';
-import * as chaistring from 'chai-string';
 import { Runnable } from 'mocha';
-chai.use(chaistring);
 
 // This mock adapter creates a standard GDB backend and a stub auxiliary GDB backend
 const auxiliaryGdbAdapter =

src/integration-tests/evaluate.spec.ts

@@ -8,7 +8,6 @@
  * SPDX-License-Identifier: EPL-2.0
  *********************************************************************/
 
-import { expect } from 'chai';
 import * as path from 'path';
 import { CdtDebugClient } from './debugClient';
 import {
@@ -21,6 +20,7 @@ import {
     standardBeforeEach,
     testProgramsDir,
 } from './utils';
+import { expect } from 'chai';
 
 describe('evaluate request', function () {
     let dc: CdtDebugClient;
@@ -97,6 +97,19 @@ describe('evaluate request', function () {
         await event;
     });
 
+    it('should send a warning when the commands command is sent', async function () {
+        const event = dc.waitForOutputEvent(
+            'stdout',
+            'warning: "commands" command is not supported via GDB/MI interface'
+        );
+        await dc.evaluateRequest({
+            context: 'repl',
+            expression: '> commands',
+            frameId: scope.frame.id,
+        });
+        await event;
+    });
+
     it('should send a warning when evaluating a delete instruction breakpoint command is sent', async function () {
         // set instruction breakpoint
         await dc.setInstructionBreakpointsRequest({

src/integration-tests/launchRemoteUnexpectedExit.spec.ts

@@ -25,9 +25,6 @@ import {
 } from './utils';
 import { assert, expect } from 'chai';
 import { DebugProtocol } from '@vscode/debugprotocol';
-import * as chai from 'chai';
-import * as chaistring from 'chai-string';
-chai.use(chaistring);
 
 describe('launch remote unexpected session exit', function () {
     let dc: CdtDebugClient;

src/integration-tests/test/setup.ts

@@ -0,0 +1,14 @@
+/*********************************************************************
+ * Copyright (c) 2025 Arm Limited and others
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *********************************************************************/
+
+import * as chai from 'chai';
+import * as chaiString from 'chai-string';
+
+chai.use(chaiString);

src/integration-tests/var.spec.ts

@@ -21,9 +21,6 @@ import {
     verifyRegister,
     fillDefaults,
 } from './utils';
-import * as chai from 'chai';
-import * as chaistring from 'chai-string';
-chai.use(chaistring);
 
 describe('Variables Test Suite', function () {
     let dc: CdtDebugClient;