test: add error code to test connection failure

Author: Hweinstock

packages/core/src/awsService/ec2/model.ts

@@ -26,7 +26,7 @@ import {
     SshError,
     startSshAgent,
     startVscodeRemote,
-    testSshConnection,
+    testSsmConnection,
 } from '../../shared/extensions/ssh'
 import { getLogger } from '../../shared/logger/logger'
 import { CancellationError, Timeout } from '../../shared/utilities/timeoutUtils'
@@ -36,7 +36,7 @@ import { SshKeyPair } from './sshKeyPair'
 import { Ec2SessionTracker } from './remoteSessionManager'
 import { getEc2SsmEnv } from './utils'
 
-export type Ec2ConnectErrorCode = 'EC2SSMStatus' | 'EC2SSMPermission' | 'EC2SSMConnect' | 'EC2SSMAgentStatus'
+export type Ec2ConnectErrorCode = 'EC2SSMStatus' | 'EC2SSMPermission' | 'EC2SSMTestConnect' | 'EC2SSMAgentStatus'
 
 export interface Ec2RemoteEnv extends VscodeRemoteConnection {
     selection: Ec2Selection
@@ -200,7 +200,7 @@ export class Ec2Connecter implements vscode.Disposable {
         const remoteEnv = await this.prepareEc2RemoteEnvWithProgress(selection, remoteUser)
         const testSession = await this.ssmClient.startSession(selection.instanceId, 'AWS-StartSSHSession')
         try {
-            await testSshConnection(
+            await testSsmConnection(
                 remoteEnv.SessionProcess,
                 remoteEnv.hostname,
                 remoteEnv.sshPath,
@@ -216,7 +216,7 @@ export class Ec2Connecter implements vscode.Disposable {
             )
         } catch (err) {
             const message = err instanceof SshError ? 'Testing SSH connection to instance failed' : ''
-            this.throwConnectionError(message, selection, err as Error)
+            this.throwConnectionError(message, selection, { ...(err as Error), code: 'EC2SSMTestConnect' })
         } finally {
             await this.ssmClient.terminateSession(testSession)
         }

packages/core/src/shared/extensions/ssh.ts

@@ -130,7 +130,7 @@ export class RemoteSshSettings extends Settings.define('remote.SSH', remoteSshTy
     }
 }
 
-export async function testSshConnection(
+export async function testSsmConnection(
     ProcessClass: typeof ChildProcess,
     hostname: string,
     sshPath: string,
@@ -150,7 +150,7 @@ export async function testSshConnection(
         })
         return result
     } catch (error) {
-        throw new SshError('SSH connection test failed', { cause: error as Error })
+        throw new SshError('SSH connection test failed', { cause: error as Error, code: 'SSMTestConnectionFailed' })
     }
 }
 

packages/core/src/test/shared/extensions/ssh.test.ts

@@ -4,7 +4,7 @@
  */
 import * as assert from 'assert'
 import { ChildProcess } from '../../../shared/utilities/processUtils'
-import { startSshAgent, testSshConnection } from '../../../shared/extensions/ssh'
+import { startSshAgent, testSsmConnection } from '../../../shared/extensions/ssh'
 import { createBoundProcess } from '../../../shared/remoteSession'
 import { createExecutableFile, createTestWorkspaceFolder } from '../../testUtil'
 import { WorkspaceFolder } from 'vscode'
@@ -74,7 +74,7 @@ describe('testSshConnection', function () {
         } as SSM.StartSessionResponse
 
         await createExecutableFile(sshPath, echoEnvVarsCmd(['MY_VAR']))
-        const r = await testSshConnection(process, 'localhost', sshPath, 'test-user', session)
+        const r = await testSsmConnection(process, 'localhost', sshPath, 'test-user', session)
         assertOutputContains(r.stdout, 'yes')
     })
 
@@ -97,15 +97,15 @@ describe('testSshConnection', function () {
         const process = createBoundProcess(envProvider)
 
         await createExecutableFile(sshPath, echoEnvVarsCmd(['SESSION_ID', 'STREAM_URL', 'TOKEN']))
-        const r = await testSshConnection(process, 'localhost', sshPath, 'test-user', newSession)
+        const r = await testSsmConnection(process, 'localhost', sshPath, 'test-user', newSession)
         assertOutputContains(r.stdout, `${newSession.SessionId} ${newSession.StreamUrl} ${newSession.TokenValue}`)
     })
 
     it('passes proper args to the ssh invoke', async function () {
         const executableFileContent = isWin() ? `echo "%1 %2"` : `echo "$1 $2"`
         const process = createBoundProcess(async () => ({}))
         await createExecutableFile(sshPath, executableFileContent)
-        const r = await testSshConnection(process, 'localhost', sshPath, 'test-user', {} as SSM.StartSessionResponse)
+        const r = await testSsmConnection(process, 'localhost', sshPath, 'test-user', {} as SSM.StartSessionResponse)
         assertOutputContains(r.stdout, '-T')
         assertOutputContains(r.stdout, 'test-user@localhost')
     })