feat(ec2): add menu actions on explorer nodes #3644

Hweinstock · web-flow · commit c94acfd13ed3 · 2023-07-28T08:34:51.000-07:00
* Add copy ARN, copy Name, copy instanceId actions to EC2 menu.
* generalize copyName/copyArn/etc to one copyText() function.
diff --git a/package.json b/package.json
@@ -1414,6 +1414,11 @@
                     "when": "!config.aws.samcli.legacyDeploy && view == aws.explorer && viewItem =~ /^(awsLambdaNode|awsRegionNode|awsCloudFormationRootNode)$/",
                     "group": "1@2"
                 },
+                {
+                    "command": "aws.ec2.copyInstanceId",
+                    "when": "view == aws.explorer && viewItem == awsEc2Node",
+                    "group": "2@0"
+                },
                 {
                     "command": "aws.ecr.copyTagUri",
                     "when": "view == aws.explorer && viewItem == awsEcrTagNode",
@@ -1601,12 +1606,12 @@
                 },
                 {
                     "command": "aws.copyName",
-                    "when": "view == aws.explorer && viewItem =~ /^(awsRegionFunctionNode|awsRegionFunctionNodeDownloadable|awsCloudFormationFunctionNode|awsStateMachineNode|awsCloudFormationNode|awsS3BucketNode|awsS3FolderNode|awsS3FileNode|awsApiGatewayNode|awsIotThingNode)$|^(awsAppRunnerServiceNode|awsIotCertificateNode|awsIotPolicyNode|awsIotPolicyVersionNode)/",
+                    "when": "view == aws.explorer && viewItem =~ /^(awsRegionFunctionNode|awsRegionFunctionNodeDownloadable|awsCloudFormationFunctionNode|awsStateMachineNode|awsCloudFormationNode|awsS3BucketNode|awsS3FolderNode|awsS3FileNode|awsApiGatewayNode|awsIotThingNode)$|^(awsAppRunnerServiceNode|awsIotCertificateNode|awsIotPolicyNode|awsIotPolicyVersionNode|awsEc2Node)/",
                     "group": "2@1"
                 },
                 {
                     "command": "aws.copyArn",
-                    "when": "view == aws.explorer && viewItem =~ /^(awsRegionFunctionNode|awsRegionFunctionNodeDownloadable|awsCloudFormationFunctionNode|awsStateMachineNode|awsCloudFormationNode|awsCloudWatchLogNode|awsS3BucketNode|awsS3FolderNode|awsS3FileNode|awsApiGatewayNode|awsEcrRepositoryNode|awsIotThingNode)$|^(awsAppRunnerServiceNode|awsEcsServiceNode|awsIotCertificateNode|awsIotPolicyNode|awsIotPolicyVersionNode|awsMdeInstanceNode)/",
+                    "when": "view == aws.explorer && viewItem =~ /^(awsRegionFunctionNode|awsRegionFunctionNodeDownloadable|awsCloudFormationFunctionNode|awsStateMachineNode|awsCloudFormationNode|awsCloudWatchLogNode|awsS3BucketNode|awsS3FolderNode|awsS3FileNode|awsApiGatewayNode|awsEcrRepositoryNode|awsIotThingNode)$|^(awsAppRunnerServiceNode|awsEcsServiceNode|awsIotCertificateNode|awsIotPolicyNode|awsIotPolicyVersionNode|awsMdeInstanceNode|awsEc2Node)/",
                     "group": "2@2"
                 },
                 {
@@ -2087,6 +2092,16 @@
                     }
                 }
             },
+            {
+                "command": "aws.ec2.copyInstanceId",
+                "title": "%AWS.command.ec2.copyInstanceId%",
+                "category": "%AWS.title",
+                "cloud9": {
+                    "cn": {
+                        "category": "%AWS.title.cn%"
+                    }
+                }
+            },
             {
                 "command": "aws.ecr.copyTagUri",
                 "title": "%AWS.command.ecr.copyTagUri%",
diff --git a/package.nls.json b/package.nls.json
@@ -110,6 +110,7 @@
     "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.copyInstanceId": "Copy Instance Id",
     "AWS.command.ecr.copyTagUri": "Copy Tag URI",
     "AWS.command.ecr.copyRepositoryUri": "Copy Repository URI",
     "AWS.command.ecr.createRepository": "Create Repository...",
diff --git a/src/awsexplorer/activation.ts b/src/awsexplorer/activation.ts
@@ -19,8 +19,7 @@ import { downloadStateMachineDefinition } from '../stepFunctions/commands/downlo
 import { executeStateMachine } from '../stepFunctions/vue/executeStateMachine/executeStateMachine'
 import { StateMachineNode } from '../stepFunctions/explorer/stepFunctionsNodes'
 import { AwsExplorer } from './awsExplorer'
-import { copyArnCommand } from './commands/copyArn'
-import { copyNameCommand } from './commands/copyName'
+import { copyTextCommand } from './commands/copyText'
 import { loadMoreChildrenCommand } from './commands/loadMoreChildren'
 import { checkExplorerForDefaultRegion } from './defaultRegion'
 import { createLocalExplorerView } from './localExplorer'
@@ -156,8 +155,8 @@ async function registerAwsExplorerCommands(
                     isPreviewAndRender: true,
                 })
         ),
-        Commands.register('aws.copyArn', async (node: AWSResourceNode) => await copyArnCommand(node)),
-        Commands.register('aws.copyName', async (node: AWSResourceNode) => await copyNameCommand(node)),
+        Commands.register('aws.copyArn', async (node: AWSResourceNode) => await copyTextCommand(node, 'ARN')),
+        Commands.register('aws.copyName', async (node: AWSResourceNode) => await copyTextCommand(node, 'name')),
         Commands.register('aws.refreshAwsExplorerNode', async (element: AWSTreeNodeBase | undefined) => {
             awsExplorer.refresh(element)
         }),
diff --git a/src/awsexplorer/commands/copyArn.ts b/src/awsexplorer/commands/copyArn.ts
diff --git a/src/awsexplorer/commands/copyText.ts b/src/awsexplorer/commands/copyText.ts
@@ -8,14 +8,23 @@ import { copyToClipboard } from '../../shared/utilities/messages'
 import { AWSResourceNode } from '../../shared/treeview/nodes/awsResourceNode'
 import { TreeShim } from '../../shared/treeview/utils'
 
-/**
- * Copies the name of the resource represented by the given node.
- */
-export async function copyNameCommand(
+export type copyableText = 'ARN' | 'name' | 'id'
+
+export async function copyTextCommand(
     node: AWSResourceNode | TreeShim<AWSResourceNode>,
+    text: copyableText,
     env = Env.vscode()
 ): Promise<void> {
     node = node instanceof TreeShim ? node.node.resource : node
-
-    await copyToClipboard(node.name, 'name', env)
+    switch (text) {
+        case 'ARN':
+            await copyToClipboard(node.arn, text, env)
+            break
+        case 'name':
+            await copyToClipboard(node.name, text, env)
+            break
+        case 'id':
+            await copyToClipboard(node.id!, text, env)
+            break
+    }
 }
diff --git a/src/ec2/activation.ts b/src/ec2/activation.ts
@@ -5,6 +5,8 @@
 import { ExtContext } from '../shared/extensions'
 import { Commands } from '../shared/vscode/commands2'
 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'
 
@@ -17,6 +19,9 @@ export async function activate(ctx: ExtContext): Promise<void> {
             })
         }),
 
+        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))
         })
diff --git a/src/ec2/commands.ts b/src/ec2/commands.ts
@@ -6,6 +6,7 @@
 import { Ec2InstanceNode } from './explorer/ec2InstanceNode'
 import { Ec2Node } from './explorer/ec2ParentNode'
 import { Ec2ConnectionManager } from './model'
+import { copyToClipboard } from '../shared/utilities/messages'
 import { promptUserForEc2Selection } from './prompter'
 
 export async function openTerminal(node?: Ec2Node) {
@@ -20,3 +21,7 @@ export async function openRemoteConnection(node?: Ec2Node) {
     //const connectionManager = new Ec2ConnectionManager(selection.region)
     console.log(selection)
 }
+
+export async function copyInstanceId(instanceId: string): Promise<void> {
+    await copyToClipboard(instanceId, 'Id')
+}
diff --git a/src/ec2/explorer/ec2InstanceNode.ts b/src/ec2/explorer/ec2InstanceNode.ts
@@ -19,6 +19,7 @@ export class Ec2InstanceNode extends AWSTreeNodeBase implements AWSResourceNode
     ) {
         super('')
         this.update(instance)
+        this.id = this.InstanceId
     }
 
     public update(newInstance: Ec2Instance) {
diff --git a/src/shared/treeview/nodes/awsResourceNode.ts b/src/shared/treeview/nodes/awsResourceNode.ts
@@ -13,4 +13,7 @@ export interface AWSResourceNode {
      * Returns the name of the AWS resource.
      */
     readonly name: string
+
+    /** Service-defined idenifier, e.g. for EC2 this is the "Instance Id". */
+    readonly id?: string
 }
diff --git a/src/test/awsExplorer/commands/copyArn.test.ts b/src/test/awsExplorer/commands/copyArn.test.ts
diff --git a/src/test/awsExplorer/commands/copyText.test.ts b/src/test/awsExplorer/commands/copyText.test.ts
@@ -5,20 +5,20 @@
 
 import * as assert from 'assert'
 import { TreeItem } from 'vscode'
-import { copyNameCommand } from '../../../awsexplorer/commands/copyName'
+import { copyTextCommand } from '../../../awsexplorer/commands/copyText'
 import { AWSResourceNode } from '../../../shared/treeview/nodes/awsResourceNode'
 import { TreeShim } from '../../../shared/treeview/utils'
 import { FakeEnv } from '../../shared/vscode/fakeEnv'
 
-describe('copyNameCommand', function () {
+describe('copyTextCommand', function () {
     it('copies name to clipboard and shows status bar confirmation', async function () {
         const node: AWSResourceNode = {
             arn: 'arn',
             name: 'name',
         }
 
         const env = new FakeEnv()
-        await copyNameCommand(node, env)
+        await copyTextCommand(node, 'name', env)
 
         assert.strictEqual(env.clipboard.text, 'name')
     })
@@ -31,7 +31,32 @@ describe('copyNameCommand', function () {
         })
 
         const env = new FakeEnv()
-        await copyNameCommand(node, env)
+        await copyTextCommand(node, 'name', env)
         assert.strictEqual(env.clipboard.text, 'resource')
     })
+
+    it('copies arn to clipboard and shows status bar confirmation', async function () {
+        const node: AWSResourceNode = {
+            arn: 'arn',
+            name: 'name',
+        }
+
+        const env = new FakeEnv()
+        await copyTextCommand(node, 'ARN', env)
+
+        assert.strictEqual(env.clipboard.text, 'arn')
+    })
+
+    it('copies id to clipboard and shows status bar confirmation', async function () {
+        const node: AWSResourceNode = {
+            arn: 'arn',
+            name: 'name',
+            id: 'id',
+        }
+
+        const env = new FakeEnv()
+        await copyTextCommand(node, 'id', env)
+
+        assert.strictEqual(env.clipboard.text, 'id')
+    })
 })

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ export class Ec2InstanceNode extends AWSTreeNodeBase implements AWSResourceNode`
`19`	`19`	`) {`
`20`	`20`	`super('')`
`21`	`21`	`this.update(instance)`
	`22`	`+ this.id = this.InstanceId`
`22`	`23`	`}`
`23`	`24`
`24`	`25`	`public update(newInstance: Ec2Instance) {`
Original file line number	Diff line number	Diff line change
`@@ -13,4 +13,7 @@ export interface AWSResourceNode {`
`13`	`13`	`* Returns the name of the AWS resource.`
`14`	`14`	`*/`
`15`	`15`	`readonly name: string`
	`16`	`+`
	`17`	`+ /** Service-defined idenifier, e.g. for EC2 this is the "Instance Id". */`
	`18`	`+ readonly id?: string`
`16`	`19`	`}`