Support auxiliary GDB with target parameters/connectCommands (#454)

* Support auxiliary GDB with target parameters/connectCommands.
Before it only worked with target host and port settings.

Signed-off-by: Jens Reinecke <[email protected]>

* Another log message after connected to aux GDB.
Fix test based on that.

Signed-off-by: Jens Reinecke <[email protected]>

* Skip new tests instead of accepting failure to save execution time.
Skip aux GDB config tests if not remote, mode only supported for gdbtarget type.

Signed-off-by: Jens Reinecke <[email protected]>

---------

Signed-off-by: Jens Reinecke <[email protected]>

Author: jreineckearm

src/desktop/GDBTargetDebugSession.ts

@@ -642,13 +642,13 @@ export class GDBTargetDebugSession extends GDBDebugSession {
             const targetString = targetHost
                 ? `${targetHost}:${targetPort}`
                 : undefined;
+            const defaultTarget = targetString ? [targetString] : [];
+            const targetParameters = target.parameters ?? defaultTarget;
+            const targetType = target.type ?? 'remote';
 
             // Connect to remote server
             if (target.connectCommands === undefined) {
-                this.targetType =
-                    target.type !== undefined ? target.type : 'remote';
-                const defaultTarget = targetString ? [targetString] : [];
-                const targetParameters = target.parameters ?? defaultTarget;
+                this.targetType = targetType;
                 await this.executeOrAbort(mi.sendTargetSelectRequest.bind(mi))(
                     this.gdb,
                     {
@@ -676,16 +676,23 @@ export class GDBTargetDebugSession extends GDBDebugSession {
             }
 
             if (args.auxiliaryGdb && this.auxGdb) {
+                this.logGDBRemote('connect auxiliary GDB to target');
                 // Use connect commands to connect auxiliary GDB.
-                this.logGDBRemote('connect to auxiliary GDB');
-                const connectCommands: string[] = [
-                    ...AuxiliaryConnectCommands,
-                    `target remote ${targetString}`,
-                ];
+                const connectCommands: string[] = [...AuxiliaryConnectCommands];
+                if (target.connectCommands) {
+                    connectCommands.push(...target.connectCommands);
+                } else {
+                    connectCommands.push(
+                        `target ${targetType} ${targetParameters.join(' ')}`
+                    );
+                }
                 await this.executeOrAbort(
                     this.auxGdb.sendCommands.bind(this.auxGdb)
                 )(connectCommands);
-                this.sendEvent(new OutputEvent('connected to auxiliary GDB'));
+                this.sendEvent(
+                    new OutputEvent('connected auxiliary GDB to target')
+                );
+                this.logGDBRemote('connected auxiliary GDB to target');
             }
 
             await this.setSessionState(SessionState.CONNECTED);

src/integration-tests/auxiliaryGdb.spec.ts

@@ -48,14 +48,12 @@ describe('auxiliary gdb configuration', function () {
         }
     });
 
-    it('correctly validates if auxiliary gdb mode can work with other settings', async function () {
-        const expectToFail = gdbNonStop || gdbAsync === false;
-
-        const launchArgs = fillDefaults(this.test, {
-            program,
-            auxiliaryGdb: true,
-        } as TargetLaunchRequestArguments);
+    const auxUnsupported = gdbNonStop || gdbAsync === false || !isRemoteTest;
 
+    const testConnect = async (
+        launchArgs: TargetLaunchRequestArguments,
+        expectToFail: boolean
+    ) => {
         if (expectToFail) {
             // Expecting launch to fail, check for correct error message
             const expectedErrorMessage = gdbNonStop
@@ -72,6 +70,57 @@ describe('auxiliary gdb configuration', function () {
             )) as DebugProtocol.LaunchResponse;
             expect(launchResponse.success).to.be.true;
         }
+    };
+
+    it('correctly validates if auxiliary gdb mode can work with other settings', async function () {
+        if (!isRemoteTest) {
+            this.skip();
+        }
+
+        const expectToFail = gdbNonStop || gdbAsync === false;
+
+        const launchArgs = fillDefaults(this.test, {
+            program,
+            auxiliaryGdb: true,
+        } as TargetLaunchRequestArguments);
+
+        await testConnect(launchArgs, expectToFail);
+    });
+
+    it('can establish auxiliary gdb connection with target parameters', async function () {
+        if (auxUnsupported) {
+            this.skip();
+        }
+
+        const launchArgs = fillDefaults(this.test, {
+            program,
+            auxiliaryGdb: true,
+            target: {
+                parameters: ['localhost:3333'],
+                serverPortRegExp: 'Listening on port',
+                serverParameters: ['--once', ':3333', program],
+            },
+        } as TargetLaunchRequestArguments);
+
+        await testConnect(launchArgs, false);
+    });
+
+    it('can establish auxiliary gdb connection with target connect commands', async function () {
+        if (auxUnsupported) {
+            this.skip();
+        }
+
+        const launchArgs = fillDefaults(this.test, {
+            program,
+            auxiliaryGdb: true,
+            target: {
+                connectCommands: ['-target-select remote localhost:3333'],
+                serverPortRegExp: 'Listening on port',
+                serverParameters: ['--once', ':3333', program],
+            },
+        } as TargetLaunchRequestArguments);
+
+        await testConnect(launchArgs, false);
     });
 });
 
@@ -159,7 +208,9 @@ describe('auxiliary gdb', function () {
         );
         // Test if relevant output events came during 'beforeEach'
         expect(
-            stdOutputContains('GDB Remote session: connect to auxiliary GDB')
+            stdOutputContains(
+                'GDB Remote session: connected auxiliary GDB to target'
+            )
         ).to.be.true;
         expect(
             stdOutputContains(