feat(ec2): start, stop, reboot #3658

Problem:
Missing useful actions on EC2 items in AWS Explorer.

Solution:
- Add new commands: `aws.ec2.startInstance`, `aws.ec2.stopInstance`, and `aws.ec2.rebootInstance`. 
- QuickPick only lists valid commands for action. Ex. doesn't show stopped containers for `aws.ec2.stopinstance`. 
- Commands will throw error if status already achieved. (Ex: stopping an already stopped instance). Can only be achieved on right-click of node. 
- Accessible from both command palette and the explorer.  
- Loading bar w/ cancel for all operations. 
- Also refactor the `prompter` code into its own object, to promote flexibility and testability (the prompter now has tests as well). 
- Does not show feedback on successful start/stop/reboot, only on failure. 
- Does not throw error if user runs reboot on stopped instance, just start it. 

TODO:
- Add a way to check the status of an instance before starting/stopping.

Author: Hweinstock

package.json

@@ -1120,6 +1120,18 @@
                     "command": "aws.ec2.openTerminal",
                     "when": "aws.isDevMode"
                 },
+                {
+                    "command": "aws.ec2.startInstance",
+                    "when": "aws.isDevMode"
+                },
+                {
+                    "command": "aws.ec2.stopInstance",
+                    "whem": "aws.isDevMode"
+                },
+                {
+                    "command": "aws.ec2.rebootInstance",
+                    "whem": "aws.isDevMode"
+                },
                 {
                     "command": "aws.dev.openMenu",
                     "when": "aws.isDevMode || isCloud9"
@@ -1324,6 +1336,21 @@
                     "group": "inline@1",
                     "when": "viewItem == awsEc2Node"
                 },
+                {
+                    "command": "aws.ec2.startInstance",
+                    "group": "0@1",
+                    "when": "viewItem == awsEc2Node"
+                },
+                {
+                    "command": "aws.ec2.stopInstance",
+                    "group": "0@1",
+                    "when": "viewItem == awsEc2Node"
+                },
+                {
+                    "command": "aws.ec2.rebootInstance",
+                    "group": "0@1",
+                    "when": "viewItem == awsEc2Node"
+                },
                 {
                     "command": "aws.ecr.createRepository",
                     "when": "view == aws.explorer && viewItem == awsEcrNode",
@@ -2092,6 +2119,36 @@
                     }
                 }
             },
+            {
+                "command": "aws.ec2.startInstance",
+                "title": "%AWS.command.ec2.startInstance%",
+                "category": "%AWS.title%",
+                "cloud9": {
+                    "cn": {
+                        "category": "%AWS.title.cn%"
+                    }
+                }
+            },
+            {
+                "command": "aws.ec2.stopInstance",
+                "title": "%AWS.command.ec2.stopInstance%",
+                "category": "%AWS.title%",
+                "cloud9": {
+                    "cn": {
+                        "category": "%AWS.title.cn%"
+                    }
+                }
+            },
+            {
+                "command": "aws.ec2.rebootInstance",
+                "title": "%AWS.command.ec2.rebootInstance%",
+                "category": "%AWS.title%",
+                "cloud9": {
+                    "cn": {
+                        "category": "%AWS.title.cn%"
+                    }
+                }
+            },
             {
                 "command": "aws.ec2.copyInstanceId",
                 "title": "%AWS.command.ec2.copyInstanceId%",

package.nls.json

@@ -110,6 +110,9 @@
     "AWS.command.cdk.help": "View CDK Documentation",
     "AWS.command.ec2.openTerminal": "Open terminal to EC2 instance...",
     "AWS.command.ec2.openRemoteConnection": "Connect to EC2 instance in New Window...",
+    "AWS.command.ec2.startInstance": "Start EC2 Instance",
+    "AWS.command.ec2.stopInstance": "Stop EC2 Instance",
+    "AWS.command.ec2.rebootInstance": "Reboot EC2 Instance",
     "AWS.command.ec2.copyInstanceId": "Copy Instance Id",
     "AWS.command.ecr.copyTagUri": "Copy Tag URI",
     "AWS.command.ecr.copyRepositoryUri": "Copy Repository URI",

src/ec2/activation.ts

@@ -8,22 +8,34 @@ import { telemetry } from '../shared/telemetry/telemetry'
 import { Ec2InstanceNode } from './explorer/ec2InstanceNode'
 import { copyTextCommand } from '../awsexplorer/commands/copyText'
 import { Ec2Node } from './explorer/ec2ParentNode'
-import { openRemoteConnection, openTerminal } from './commands'
+import { openRemoteConnection, openTerminal, rebootInstance, startInstance, stopInstance } from './commands'
 
 export async function activate(ctx: ExtContext): Promise<void> {
     ctx.extensionContext.subscriptions.push(
         Commands.register('aws.ec2.openTerminal', async (node?: Ec2Node) => {
             await telemetry.ec2_connectToInstance.run(async span => {
                 span.record({ ec2ConnectionType: 'ssm' })
-                await (node ? openTerminal(node) : openTerminal(node))
+                await openTerminal(node)
             })
         }),
 
         Commands.register('aws.ec2.copyInstanceId', async (node: Ec2InstanceNode) => {
             await copyTextCommand(node, 'id')
         }),
         Commands.register('aws.ec2.openRemoteConnection', async (node?: Ec2Node) => {
-            await (node ? openRemoteConnection(node) : openRemoteConnection(node))
+            await openRemoteConnection(node)
+        }),
+
+        Commands.register('aws.ec2.startInstance', async (node?: Ec2Node) => {
+            await startInstance(node)
+        }),
+
+        Commands.register('aws.ec2.stopInstance', async (node?: Ec2Node) => {
+            await stopInstance(node)
+        }),
+
+        Commands.register('aws.ec2.rebootInstance', async (node?: Ec2Node) => {
+            await rebootInstance(node)
         })
     )
 }

src/ec2/commands.ts

@@ -6,22 +6,50 @@
 import { Ec2InstanceNode } from './explorer/ec2InstanceNode'
 import { Ec2Node } from './explorer/ec2ParentNode'
 import { Ec2ConnectionManager } from './model'
+import { Ec2Prompter, instanceFilter } from './prompter'
+import { Ec2Selection } from './prompter'
+import { Ec2Client, Ec2Instance } from '../shared/clients/ec2Client'
 import { copyToClipboard } from '../shared/utilities/messages'
-import { promptUserForEc2Selection } from './prompter'
 
 export async function openTerminal(node?: Ec2Node) {
-    const selection = node instanceof Ec2InstanceNode ? node.toSelection() : await promptUserForEc2Selection()
+    const selection = await getSelection(node)
 
     const connectionManager = new Ec2ConnectionManager(selection.region)
     await connectionManager.attemptToOpenEc2Terminal(selection)
 }
 
 export async function openRemoteConnection(node?: Ec2Node) {
-    const selection = node instanceof Ec2InstanceNode ? node.toSelection() : await promptUserForEc2Selection()
+    const selection = await getSelection(node)
     //const connectionManager = new Ec2ConnectionManager(selection.region)
     console.log(selection)
 }
 
+export async function startInstance(node?: Ec2Node) {
+    const prompterFilter = (instance: Ec2Instance) => instance.status !== 'running'
+    const selection = await getSelection(node, prompterFilter)
+    const client = new Ec2Client(selection.region)
+    await client.startInstanceWithCancel(selection.instanceId)
+}
+
+export async function stopInstance(node?: Ec2Node) {
+    const prompterFilter = (instance: Ec2Instance) => instance.status !== 'stopped'
+    const selection = await getSelection(node, prompterFilter)
+    const client = new Ec2Client(selection.region)
+    await client.stopInstanceWithCancel(selection.instanceId)
+}
+
+export async function rebootInstance(node?: Ec2Node) {
+    const selection = await getSelection(node)
+    const client = new Ec2Client(selection.region)
+    await client.rebootInstanceWithCancel(selection.instanceId)
+}
+
+async function getSelection(node?: Ec2Node, filter?: instanceFilter): Promise<Ec2Selection> {
+    const prompter = new Ec2Prompter(filter)
+    const selection = node && node instanceof Ec2InstanceNode ? node.toSelection() : await prompter.promptUser()
+    return selection
+}
+
 export async function copyInstanceId(instanceId: string): Promise<void> {
     await copyToClipboard(instanceId, 'Id')
 }

src/ec2/explorer/ec2InstanceNode.ts

@@ -8,7 +8,7 @@ import { AWSResourceNode } from '../../shared/treeview/nodes/awsResourceNode'
 import { AWSTreeNodeBase } from '../../shared/treeview/nodes/awsTreeNodeBase'
 import { Ec2Instance } from '../../shared/clients/ec2Client'
 import globals from '../../shared/extensionGlobals'
-import { Ec2Selection } from '../utils'
+import { Ec2Selection } from '../prompter'
 
 export class Ec2InstanceNode extends AWSTreeNodeBase implements AWSResourceNode {
     public constructor(

src/ec2/model.ts

@@ -5,7 +5,7 @@
 import * as vscode from 'vscode'
 import { Session } from 'aws-sdk/clients/ssm'
 import { IAM } from 'aws-sdk'
-import { Ec2Selection } from './utils'
+import { Ec2Selection } from './prompter'
 import { getOrInstallCli } from '../shared/utilities/cliUtils'
 import { isCloud9 } from '../shared/extensionUtilities'
 import { ToolkitError } from '../shared/errors'

src/ec2/prompter.ts

@@ -4,43 +4,65 @@
  */
 
 import { RegionSubmenu, RegionSubmenuResponse } from '../shared/ui/common/regionSubmenu'
-import { Ec2Selection, getInstancesFromRegion } from './utils'
 import { DataQuickPickItem } from '../shared/ui/pickerPrompter'
-import { Ec2Instance } from '../shared/clients/ec2Client'
+import { Ec2Client, Ec2Instance } from '../shared/clients/ec2Client'
 import { isValidResponse } from '../shared/wizards/wizard'
 import { CancellationError } from '../shared/utilities/timeoutUtils'
+import { AsyncCollection } from '../shared/utilities/asyncCollection'
 
-function asQuickpickItem(instance: Ec2Instance): DataQuickPickItem<string> {
-    return {
-        label: '$(terminal) \t' + (instance.name ?? '(no name)'),
-        detail: instance.InstanceId,
-        data: instance.InstanceId,
-    }
+export type instanceFilter = (instance: Ec2Instance) => boolean
+export interface Ec2Selection {
+    instanceId: string
+    region: string
 }
 
-export async function promptUserForEc2Selection(): Promise<Ec2Selection> {
-    const prompter = createEc2ConnectPrompter()
-    const response = await prompter.prompt()
+export class Ec2Prompter {
+    public constructor(protected filter?: instanceFilter) {}
 
-    if (isValidResponse(response)) {
-        return handleEc2ConnectPrompterResponse(response)
-    } else {
-        throw new CancellationError('user')
+    protected static asQuickPickItem(instance: Ec2Instance): DataQuickPickItem<string> {
+        return {
+            label: '$(terminal) \t' + (instance.name ?? '(no name)'),
+            detail: instance.InstanceId,
+            data: instance.InstanceId,
+        }
     }
-}
 
-export function handleEc2ConnectPrompterResponse(response: RegionSubmenuResponse<string>): Ec2Selection {
-    return {
-        instanceId: response.data,
-        region: response.region,
+    protected static getSelectionFromResponse(response: RegionSubmenuResponse<string>): Ec2Selection {
+        return {
+            instanceId: response.data,
+            region: response.region,
+        }
+    }
+
+    public async promptUser(): Promise<Ec2Selection> {
+        const prompter = this.createEc2ConnectPrompter()
+        const response = await prompter.prompt()
+
+        if (isValidResponse(response)) {
+            return Ec2Prompter.getSelectionFromResponse(response)
+        } else {
+            throw new CancellationError('user')
+        }
     }
-}
 
-export function createEc2ConnectPrompter(): RegionSubmenu<string> {
-    return new RegionSubmenu(
-        async region => (await getInstancesFromRegion(region)).map(asQuickpickItem).promise(),
-        { title: 'Select EC2 Instance', matchOnDetail: true },
-        { title: 'Select Region for EC2 Instance' },
-        'Instances'
-    )
+    protected async getInstancesFromRegion(regionCode: string): Promise<AsyncCollection<Ec2Instance>> {
+        const client = new Ec2Client(regionCode)
+        return await client.getInstances()
+    }
+
+    protected async getInstancesAsQuickPickItems(region: string): Promise<DataQuickPickItem<string>[]> {
+        return (await this.getInstancesFromRegion(region))
+            .filter(this.filter ? instance => this.filter!(instance) : instance => true)
+            .map(instance => Ec2Prompter.asQuickPickItem(instance))
+            .promise()
+    }
+
+    private createEc2ConnectPrompter(): RegionSubmenu<string> {
+        return new RegionSubmenu(
+            async region => this.getInstancesAsQuickPickItems(region),
+            { title: 'Select EC2 Instance', matchOnDetail: true },
+            { title: 'Select Region for EC2 Instance' },
+            'Instances'
+        )
+    }
 }