feat(ec2): connect to EC2 instance #3671

* add new command for ec2 instance remote-connect
* automatic key setup, ssh config, and connection
* split up verify ssh host into pieces

Author: Hweinstock

package.json

@@ -1120,10 +1120,6 @@
                     "command": "aws.ec2.openTerminal",
                     "when": "aws.isDevMode"
                 },
-                {
-                    "command": "aws.ec2.openTerminal",
-                    "when": "aws.isDevMode"
-                },
                 {
                     "command": "aws.ec2.startInstance",
                     "when": "aws.isDevMode"

resources/ec2_connect

@@ -0,0 +1,58 @@
+#!/usr/bin/env bash
+
+# Usage:
+#   When connecting to a dev environment
+#       AWS_REGION=… AWS_SSM_CLI=… STREAM_URL=… TOKEN=… LOG_FILE_LOCATION==… ./ec2_connect
+
+set -e
+set -u
+
+_DATE_CMD=true
+
+if command > /dev/null 2>&1 -v date; then
+    _DATE_CMD=date
+elif command > /dev/null 2>&1 -v /bin/date; then
+    _DATE_CMD=/bin/date
+fi
+
+_log() {
+    echo "$("$_DATE_CMD" '+%Y/%m/%d %H:%M:%S')" "$@" >> "${LOG_FILE_LOCATION}" 2>&1
+}
+
+_require_nolog() {
+    if [ -z "${1:-}" ] || [ -z "${2:-}" ]; then
+        _log "error: missing required arg: $1"
+        exit 1
+    fi
+}
+
+_require() {
+    _require_nolog "$@"
+    _log "$1=$2"
+}
+
+_ec2() {
+    # Function inputs
+    local AWS_SSM_CLI=$1
+    local AWS_REGION=$2
+    local STREAM_URL=$3
+    local TOKEN=$4
+    local SESSION_ID=$4
+
+    exec "$AWS_SSM_CLI" "{\"streamUrl\":\"$STREAM_URL\",\"tokenValue\":\"$TOKEN\",\"sessionId\":\"$SESSION_ID\"}" "$AWS_REGION" "StartSession"
+}
+
+_main() {
+    _log "=============================================================================="
+
+    _require AWS_SSM_CLI "${AWS_SSM_CLI:-}"
+    _require AWS_REGION "${AWS_REGION:-}"
+    _require STREAM_URL "${STREAM_URL:-}"
+    _require TOKEN "${TOKEN:-}"
+    _require SESSION_ID "${SESSION_ID:-}"
+    _require LOG_FILE_LOCATION "${LOG_FILE_LOCATION:-}"
+
+    _ec2 "$AWS_SSM_CLI" "$AWS_REGION" "$STREAM_URL" "$TOKEN" "$SESSION_ID"
+}
+
+_main

src/codecatalyst/model.ts

@@ -21,7 +21,6 @@ import { getCodeCatalystSpaceName, getCodeCatalystProjectName, getCodeCatalystDe
 import { writeFile } from 'fs-extra'
 import { sshAgentSocketVariable, startSshAgent, startVscodeRemote } from '../shared/extensions/ssh'
 import { ChildProcess } from '../shared/utilities/childProcess'
-import { ensureDependencies, hostNamePrefix } from './tools'
 import { isDevenvVscode } from './utils'
 import { Timeout } from '../shared/utilities/timeoutUtils'
 import { Commands } from '../shared/vscode/commands2'
@@ -30,8 +29,11 @@ import { fileExists } from '../shared/filesystemUtilities'
 import { CodeCatalystAuthenticationProvider } from './auth'
 import { ToolkitError } from '../shared/errors'
 import { Result } from '../shared/utilities/result'
+import { VscodeRemoteConnection, ensureDependencies } from '../shared/remoteSession'
+import { SshConfig, sshLogFileLocation } from '../shared/sshConfig'
 
 export type DevEnvironmentId = Pick<DevEnvironment, 'id' | 'org' | 'project'>
+export const connectScriptPrefix = 'codecatalyst_connect'
 
 export const docs = {
     vscode: {
@@ -86,7 +88,7 @@ export function getCodeCatalystSsmEnv(region: string, ssmPath: string, devenv: D
             AWS_SSM_CLI: ssmPath,
             CODECATALYST_ENDPOINT: getCodeCatalystConfig().endpoint,
             BEARER_TOKEN_LOCATION: bearerTokenCacheLocation(devenv.id),
-            LOG_FILE_LOCATION: sshLogFileLocation(devenv.id),
+            LOG_FILE_LOCATION: sshLogFileLocation('codecatalyst', devenv.id),
             SPACE_NAME: devenv.org.name,
             PROJECT_NAME: devenv.project.name,
             DEVENV_ID: devenv.id,
@@ -139,14 +141,6 @@ export function bearerTokenCacheLocation(devenvId: string): string {
     return path.join(globals.context.globalStorageUri.fsPath, `codecatalyst.${devenvId}.token`)
 }
 
-export function sshLogFileLocation(devenvId: string): string {
-    return path.join(globals.context.globalStorageUri.fsPath, `codecatalyst.${devenvId}.log`)
-}
-
-export function getHostNameFromEnv(env: DevEnvironmentId): string {
-    return `${hostNamePrefix}${env.id}`
-}
-
 export interface ConnectedDevEnv {
     readonly summary: DevEnvironment
     readonly devenvClient: DevEnvClient
@@ -200,12 +194,7 @@ export async function getThisDevEnv(authProvider: CodeCatalystAuthenticationProv
 /**
  * Everything needed to connect to a dev environment via VS Code or `ssh`
  */
-interface DevEnvConnection {
-    readonly sshPath: string
-    readonly vscPath: string
-    readonly hostname: string
-    readonly envProvider: EnvProvider
-    readonly SessionProcess: typeof ChildProcess
+interface DevEnvConnection extends VscodeRemoteConnection {
     readonly devenv: DevEnvironment
 }
 
@@ -215,13 +204,24 @@ export async function prepareDevEnvConnection(
     { topic, timeout }: { topic?: string; timeout?: Timeout } = {}
 ): Promise<DevEnvConnection> {
     const { ssm, vsc, ssh } = (await ensureDependencies()).unwrap()
+    const hostNamePrefix = 'aws-devenv-'
+    const sshConfig = new SshConfig(ssh, hostNamePrefix, connectScriptPrefix)
+    const config = await sshConfig.ensureValid()
+
+    if (config.isErr()) {
+        const err = config.err()
+        getLogger().error(`codecatalyst: failed to add ssh config section: ${err.message}`)
+
+        throw err
+    }
+
     const runningDevEnv = await client.startDevEnvironmentWithProgress({
         id,
         spaceName: org.name,
         projectName: project.name,
     })
 
-    const hostname = getHostNameFromEnv({ id, org, project })
+    const hostname = `${hostNamePrefix}${id}`
     const logPrefix = topic ? `codecatalyst ${topic} (${id})` : `codecatalyst (${id})`
     const logger = (data: string) => getLogger().verbose(`${logPrefix}: ${data}`)
     const envProvider = createCodeCatalystEnvProvider(client, ssm, runningDevEnv)
@@ -259,7 +259,7 @@ export async function openDevEnv(
         const repo = env.devenv.repositories.length == 1 ? env.devenv.repositories[0].repositoryName : undefined
         targetPath = repo ? `/projects/${repo}` : '/projects'
     }
-    await startVscodeRemote(env.SessionProcess, getHostNameFromEnv(env.devenv), targetPath, env.vscPath)
+    await startVscodeRemote(env.SessionProcess, env.hostname, targetPath, env.vscPath)
 }
 
 // The "codecatalyst_connect" metric should really be splt into two parts: