feat(cli): add tags to CDKToolkit stack through bootstrap cli command (#4320)

* feat(cli): add tags to bootstrap cli(#4227)

* feat(cli): add unit test and integration test and default value for tags in bootstrap cli(#4227)

* feat(cli): reverted test case(#4227)

* feat(cli): fix review comments on toolkit stack tags,removed unwanted test scenarios(#4227)

* feat(cli): fix test cases for bootstrap cli tags(#4227)

* feat(cli): add integration test for tags based on peer review(#4227)

* feat(cli): change toolkit tag integration test message and condition(#4227)

Author: selvathiruarul

packages/aws-cdk/bin/cdk.ts

@@ -50,7 +50,8 @@ async function parseCommandLineArguments() {
       .option('exclusively', { type: 'boolean', alias: 'e', desc: 'Only deploy requested stacks, don\'t include dependencies' }))
     .command('bootstrap [ENVIRONMENTS..]', 'Deploys the CDK toolkit stack into an AWS environment', yargs => yargs
       .option('bootstrap-bucket-name', { type: 'string', alias: ['b', 'toolkit-bucket-name'], desc: 'The name of the CDK toolkit bucket', default: undefined })
-      .option('bootstrap-kms-key-id', { type: 'string', desc: 'AWS KMS master key ID used for the SSE-KMS encryption', default: undefined }))
+      .option('bootstrap-kms-key-id', { type: 'string', desc: 'AWS KMS master key ID used for the SSE-KMS encryption', default: undefined })
+      .option('tags', { type: 'array', alias: 't', desc: 'Tags to add for the stack (KEY=VALUE)', nargs: 1, requiresArg: true, default: undefined }))
     .command('deploy [STACKS..]', 'Deploys the stack(s) named STACKS into your AWS account', yargs => yargs
       .option('build-exclude', { type: 'array', alias: 'E', nargs: 1, desc: 'Do not rebuild asset with the given ID. Can be specified multiple times.', default: [] })
       .option('exclusively', { type: 'boolean', alias: 'e', desc: 'Only deploy requested stacks, don\'t include dependencies' })
@@ -188,6 +189,7 @@ async function initCommandLine() {
         return await cliBootstrap(args.ENVIRONMENTS, toolkitStackName, args.roleArn, {
           bucketName: configuration.settings.get(['toolkitBucket', 'bucketName']),
           kmsKeyId: configuration.settings.get(['toolkitBucket', 'kmsKeyId']),
+          tags: configuration.settings.get(['tags'])
         });
 
       case 'deploy':

packages/aws-cdk/lib/api/bootstrap-environment.ts

@@ -2,6 +2,7 @@ import cxapi = require('@aws-cdk/cx-api');
 import fs = require('fs-extra');
 import os = require('os');
 import path = require('path');
+import {Tag} from "./cxapp/stacks";
 import { deployStack, DeployStackResult } from './deploy-stack';
 import { ISDK } from './util/sdk';
 
@@ -26,6 +27,12 @@ export interface BootstrapEnvironmentProps {
    * @default - the default KMS key for S3 will be used.
    */
   readonly kmsKeyId?: string;
+  /**
+   * Tags for cdktoolkit stack.
+   *
+   * @default - None.
+   */
+  tags?: Tag[];
 }
 
 /** @experimental */
@@ -83,5 +90,5 @@ export async function bootstrapEnvironment(environment: cxapi.Environment, aws:
   });
 
   const assembly = builder.buildAssembly();
-  return await deployStack({ stack: assembly.getStack(toolkitStackName), sdk: aws, roleArn });
+  return await deployStack({ stack: assembly.getStack(toolkitStackName), sdk: aws, roleArn, tags: props.tags });
 }

packages/aws-cdk/test/api/test.bootstrap.ts

@@ -151,6 +151,56 @@ export = {
     test.equals(ret.noOp, false);
     test.equals(executed, true);
 
+    test.done();
+  },
+  async 'do bootstrap with custom tags for toolkit stack'(test: Test) {
+    // GIVEN
+    const sdk = new MockSDK();
+
+    let executed = false;
+
+    sdk.stubCloudFormation({
+      describeStacks() {
+        return {
+          Stacks: []
+        };
+      },
+
+      createChangeSet(info: CreateChangeSetInput) {
+        const template = fromYAML(info.TemplateBody as string);
+        const bucketProperties = template.Resources.StagingBucket.Properties;
+        test.equals(bucketProperties.BucketName, undefined, 'Expected BucketName to be undefined');
+        test.equals(bucketProperties.BucketEncryption.ServerSideEncryptionConfiguration[0].ServerSideEncryptionByDefault.KMSMasterKeyID,
+            undefined, 'Expected KMSMasterKeyID to be undefined');
+        return {};
+      },
+
+      describeChangeSet() {
+        return {
+          Status: 'CREATE_COMPLETE',
+          Changes: [],
+        };
+      },
+
+      executeChangeSet() {
+        executed = true;
+        return {};
+      }
+    });
+
+    // WHEN
+    const ret = await bootstrapEnvironment({
+      account: '123456789012',
+      region: 'us-east-1',
+      name: 'mock',
+    }, sdk, 'mockStack', undefined, {
+      tags: [{ Key: 'Foo', Value: 'Bar' }]
+    });
+
+    // THEN
+    test.equals(ret.noOp, false);
+    test.equals(executed, true);
+
     test.done();
   },
 };

packages/aws-cdk/test/integ/cli/test-cdk-multiple-toolkit-stacks.sh

@@ -10,13 +10,22 @@ toolkit_stack_name_1="toolkit-stack-1-${RANDOM}"
 toolkit_stack_name_2="toolkit-stack-2-${RANDOM}"
 
 # deploy two toolkit stacks into the same environment (see #1416)
-cdk bootstrap --toolkit-stack-name ${toolkit_stack_name_1}
-cdk bootstrap --toolkit-stack-name ${toolkit_stack_name_2}
+cdk bootstrap --toolkit-stack-name ${toolkit_stack_name_1} --tags Foo=Bar
+cdk bootstrap --toolkit-stack-name ${toolkit_stack_name_2} --tags Foo=Bar
 
 # just check that the new stack exists
 aws cloudformation describe-stack-resources --stack-name ${toolkit_stack_name_1}
 aws cloudformation describe-stack-resources --stack-name ${toolkit_stack_name_2}
 
+# get tags from the new stack
+tag_stack_1=$(aws cloudformation describe-stacks --stack-name ${toolkit_stack_name_1} --query "Stacks[0].Tags[?Key=='Foo'].Value" --output text)
+tag_stack_2=$(aws cloudformation describe-stacks --stack-name ${toolkit_stack_name_2} --query "Stacks[0].Tags[?Key=='Foo'].Value" --output text)
+
+# check if tag is not equal to bar
+if [ "${tag_stack_1}" != "Bar" ] || [ "${tag_stack_2}" != "Bar" ]; then
+    fail "toolkit tags test expect Bar but got ${tag_stack_1} and ${tag_stack_2}"
+fi
+
 # clean up
 aws cloudformation delete-stack --stack-name ${toolkit_stack_name_1}
 aws cloudformation delete-stack --stack-name ${toolkit_stack_name_2}