feat(cdk): adding tags parameter option to cdk deploy command

packages/@aws-cdk/cdk/lib/cfn-resource.ts

@@ -2,7 +2,7 @@ import cxapi = require('@aws-cdk/cx-api');
 import { CfnCondition } from './cfn-condition';
 import { Construct, IConstruct } from './construct';
 import { CreationPolicy, DeletionPolicy, UpdatePolicy } from './resource-policy';
-import { TagManager } from './tag-manager';
+import { ITaggable } from './tag-manager';
 import { capitalizePropertyNames, ignoreEmpty, PostResolveToken } from './util';
 // import required to be here, otherwise causes a cycle when running the generated JavaScript
 // tslint:disable-next-line:ordered-imports
@@ -21,12 +21,6 @@ export interface CfnResourceProps {
   readonly properties?: any;
 }
 
-export interface ITaggable {
-  /**
-   * TagManager to set, remove and format tags
-   */
-  readonly tags: TagManager;
-}
 /**
  * Represents a CloudFormation resource.
  */
@@ -264,6 +258,7 @@ export enum TagType {
   Standard = 'StandardTag',
   AutoScalingGroup = 'AutoScalingGroupTag',
   Map = 'StringToStringMap',
+  KeyValue = 'KeyValue',
   NotTaggable = 'NotTaggable',
 }
 

packages/@aws-cdk/cdk/lib/stack.ts

@@ -6,7 +6,6 @@ import { Environment } from './environment';
 import { HashedAddressingScheme, IAddressingScheme, LogicalIDs } from './logical-id';
 import { ISynthesisSession } from './synthesis';
 import { makeUniqueId } from './uniqueid';
-
 export interface StackProps {
   /**
    * The AWS environment (account/region) where this stack will be deployed.
@@ -40,6 +39,8 @@ export interface StackProps {
    * @default true
    */
   readonly autoDeploy?: boolean;
+
+  readonly tags?: { [key: string]: string };
 }
 
 const STACK_SYMBOL = Symbol.for('@aws-cdk/cdk.Stack');
@@ -48,6 +49,7 @@ const STACK_SYMBOL = Symbol.for('@aws-cdk/cdk.Stack');
  * A root construct which represents a single CloudFormation stack.
  */
 export class Stack extends Construct {
+
   /**
    * Adds a metadata annotation "aws:cdk:physical-name" to the construct if physicalName
    * is non-null. This can be used later by tools and aspects to determine if resources
@@ -72,6 +74,8 @@ export class Stack extends Construct {
 
   private static readonly VALID_STACK_NAME_REGEX = /^[A-Za-z][A-Za-z0-9-]*$/;
 
+  public readonly tags: TagManager;
+
   /**
    * Lists all missing contextual information.
    * This is returned when the stack is synthesized under the 'missing' attribute
@@ -153,6 +157,8 @@ export class Stack extends Construct {
     this.logicalIds = new LogicalIDs(props && props.namingScheme ? props.namingScheme : new HashedAddressingScheme());
     this.name = props.stackName !== undefined ? props.stackName : this.calculateStackName();
     this.autoDeploy = props && props.autoDeploy === false ? false : true;
+    const tags = props === undefined ? undefined : props.tags;
+    this.tags = new TagManager(TagType.KeyValue, "AWS:Cloudformation::Stack", tags);
   }
 
   /**
@@ -190,6 +196,9 @@ export class Stack extends Construct {
   public _toCloudFormation() {
     // before we begin synthesis, we shall lock this stack, so children cannot be added
     this.node.lock();
+    if (this.tags.hasTags()) {
+      this.node.addMetadata(cxapi.TAGS_METADATA_KEY, this.tags.renderTags());
+    }
 
     try {
       const template: any = {
@@ -548,13 +557,15 @@ export class Stack extends Construct {
     visit(this);
 
     const app = this.parentApp();
+
     if (app && app.node.metadata.length > 0) {
       output[PATH_SEP] = app.node.metadata;
     }
 
     return output;
 
     function visit(node: IConstruct) {
+
       if (node.node.metadata.length > 0) {
         // Make the path absolute
         output[PATH_SEP + node.node.path] = node.node.metadata.map(md => node.node.resolve(md) as cxapi.MetadataEntry);
@@ -660,8 +671,9 @@ function cfnElements(node: IConstruct, into: CfnElement[] = []): CfnElement[] {
 import { ArnComponents, arnFromComponents, parseArn } from './arn';
 import { CfnElement } from './cfn-element';
 import { CfnReference } from './cfn-reference';
-import { CfnResource } from './cfn-resource';
+import { CfnResource, TagType } from './cfn-resource';
 import { Aws, ScopedAws } from './pseudo';
+import { TagManager } from './tag-manager';
 
 /**
  * Find all resources in a set of constructs

packages/@aws-cdk/cdk/lib/tag-aspect.ts

@@ -1,6 +1,9 @@
+// import cxapi = require('@aws-cdk/cx-api');
 import { IAspect } from './aspect';
-import { CfnResource, ITaggable } from './cfn-resource';
+import { CfnResource} from './cfn-resource';
 import { IConstruct } from './construct';
+import { Stack } from './stack';
+import { ITaggable } from './tag-manager';
 
 /**
  * Properties for a tag
@@ -71,12 +74,14 @@ export abstract class TagBase implements IAspect {
   }
 
   public visit(construct: IConstruct): void {
-    if (!CfnResource.isCfnResource(construct)) {
+    const isCfnResource = CfnResource.isCfnResource(construct);
+    const isStack = Stack.isStack(construct);
+    if (!isCfnResource && !isStack) {
       return;
     }
-    const resource = construct as CfnResource;
+    const resource = isCfnResource ? construct as CfnResource : construct as Stack;
     if (CfnResource.isTaggable(resource)) {
-      this.applyTag(resource);
+        this.applyTag(resource);
     }
   }
 
@@ -104,7 +109,7 @@ export class Tag extends TagBase {
   }
 
   protected applyTag(resource: ITaggable) {
-    if (resource.tags.applyTagAspectHere(this.props.includeResourceTypes, this.props.excludeResourceTypes)) {
+    if (resource.tags.applyTagAspectHere(this.props.includeResourceTypes, this.props.excludeResourceTypes) || Stack.isStack(resource)) {
       resource.tags.setTag(
         this.key,
         this.value,
@@ -127,7 +132,7 @@ export class RemoveTag extends TagBase {
   }
 
   protected applyTag(resource: ITaggable): void {
-    if (resource.tags.applyTagAspectHere(this.props.includeResourceTypes, this.props.excludeResourceTypes)) {
+    if (resource.tags.applyTagAspectHere(this.props.includeResourceTypes, this.props.excludeResourceTypes) || Stack.isStack(resource)) {
       resource.tags.removeTag(this.key, this.props.priority !== undefined ? this.props.priority : this.defaultPriority);
     }
   }

packages/@aws-cdk/cdk/lib/tag-manager.ts

@@ -18,6 +18,10 @@ interface CfnAsgTag {
   propagateAtLaunch: boolean;
 }
 
+interface StackTag {
+  Key: string;
+  Value: string;
+}
 /**
  * Interface for converter between CloudFormation and internal tag representations
  */
@@ -142,6 +146,33 @@ class MapFormatter implements ITagFormatter {
   }
 }
 
+class KeyValueFormatter implements ITagFormatter {
+  public parseTags(keyValueTags: any, priority: number): Tag[] {
+    const tags: Tag[] = [];
+    for (const key in keyValueTags.tags) {
+      if (keyValueTags.tags.hasOwnProperty(key)) {
+        const value = keyValueTags.tags[key];
+        tags.push({
+          key,
+          value,
+          priority
+        });
+      }
+    }
+    return tags;
+  }
+  public formatTags(unformattedTags: Tag[]): any {
+    const tags: StackTag[] = [];
+    unformattedTags.forEach(tag => {
+      tags.push({
+        Key: tag.key,
+        Value: tag.value
+      });
+    });
+    return tags;
+  }
+}
+
 class NoFormat implements ITagFormatter {
   public parseTags(_cfnPropertyTags: any): Tag[] {
     return [];
@@ -155,9 +186,17 @@ const TAG_FORMATTERS: {[key: string]: ITagFormatter} = {
   [TagType.AutoScalingGroup]: new AsgFormatter(),
   [TagType.Standard]: new StandardFormatter(),
   [TagType.Map]: new MapFormatter(),
+  [TagType.KeyValue]: new KeyValueFormatter(),
   [TagType.NotTaggable]: new NoFormat(),
 };
 
+export interface ITaggable {
+  /**
+   * TagManager to set, remove and format tags
+   */
+  readonly tags: TagManager;
+}
+
 /**
  * TagManager facilitates a common implementation of tagging for Constructs.
  */
@@ -217,6 +256,10 @@ export class TagManager {
     return true;
   }
 
+  public hasTags(): boolean {
+    return this.tags.size > 0;
+  }
+
   private _setTag(...tags: Tag[]) {
     for (const tag of tags) {
       if (tag.priority >= (this.priorities.get(tag.key) || 0)) {

packages/@aws-cdk/cdk/test/test.tag-manager.ts

@@ -44,14 +44,21 @@ export = {
       test.deepEqual(mgr.renderTags(), undefined );
       test.done();
     },
+    '#hasTags() returns false'(test: Test) {
+      const mgr = new TagManager(TagType.Standard, 'AWS::Resource::Type');
+      test.equal(mgr.hasTags(), false );
+      test.done();
+    }
   },
-  '#renderTags() handles standard, map, and ASG tag formats'(test: Test) {
+  '#renderTags() handles standard, map, keyValue, and ASG tag formats'(test: Test) {
     const tagged: TagManager[] = [];
     const standard = new TagManager(TagType.Standard, 'AWS::Resource::Type');
     const asg = new TagManager(TagType.AutoScalingGroup, 'AWS::Resource::Type');
+    const keyValue = new TagManager(TagType.KeyValue, 'AWS::Resource::Type');
     const mapper = new TagManager(TagType.Map, 'AWS::Resource::Type');
     tagged.push(standard);
     tagged.push(asg);
+    tagged.push(keyValue);
     tagged.push(mapper);
     for (const res of tagged) {
       res.setTag('foo', 'bar');
@@ -65,12 +72,23 @@ export = {
       {key: 'foo', value: 'bar', propagateAtLaunch: true},
       {key: 'asg', value: 'only', propagateAtLaunch: false},
     ]);
+    test.deepEqual(keyValue.renderTags(), [
+      { Key: 'foo', Value : 'bar' },
+      { Key: 'asg', Value : 'only' }
+    ]);
     test.deepEqual(mapper.renderTags(), {
       foo: 'bar',
       asg: 'only',
     });
     test.done();
   },
+  'when there are tags it hasTags returns true'(test: Test) {
+    const mgr = new TagManager(TagType.Standard, 'AWS::Resource::Type');
+    mgr.setTag('key', 'myVal', 2);
+    mgr.setTag('key', 'newVal', 1);
+    test.equal(mgr.hasTags(), true);
+    test.done();
+  },
   'tags with higher or equal priority always take precedence'(test: Test) {
     const mgr = new TagManager(TagType.Standard, 'AWS::Resource::Type');
     mgr.setTag('key', 'myVal', 2);

packages/@aws-cdk/cx-api/lib/cxapi.ts

@@ -178,6 +178,11 @@ export const OUTFILE_NAME = 'cdk.out';
  */
 export const DISABLE_VERSION_REPORTING = 'aws:cdk:disable-version-reporting';
 
+/**
+ * Tag metadata key.
+ */
+export const TAGS_METADATA_KEY = 'aws:cdk:tags';
+
 /**
  * If this context key is set, the CDK will stage assets under the specified
  * directory. Otherwise, assets will not be staged.

packages/aws-cdk/bin/cdk.ts

@@ -62,6 +62,7 @@ async function parseCommandLineArguments() {
       .option('exclusively', { type: 'boolean', alias: 'e', desc: 'only deploy requested stacks, don\'t include dependencies' })
       .option('require-approval', { type: 'string', choices: [RequireApproval.Never, RequireApproval.AnyChange, RequireApproval.Broadening], desc: 'what security-sensitive changes need manual approval' }))
       .option('ci', { type: 'boolean', desc: 'Force CI detection. Use --no-ci to disable CI autodetection.', default: process.env.CI !== undefined })
+      .option('tags', { type: 'array', alias: 't', desc: 'tags to add to the stack (KEY=VALUE)', nargs: 1, requiresArg: true })
     .command('destroy [STACKS..]', 'Destroy the stack(s) named STACKS', yargs => yargs
       .option('exclusively', { type: 'boolean', alias: 'x', desc: 'only deploy requested stacks, don\'t include dependees' })
       .option('force', { type: 'boolean', alias: 'f', desc: 'Do not ask for confirmation before destroying the stacks' }))
@@ -104,7 +105,6 @@ async function initCommandLine() {
     proxyAddress: argv.proxy,
     ec2creds: argv.ec2creds,
   });
-
   const configuration = new Configuration(argv);
   await configuration.load();
 
@@ -199,7 +199,8 @@ async function initCommandLine() {
           roleArn: args.roleArn,
           requireApproval: configuration.settings.get(['requireApproval']),
           ci: args.ci,
-          reuseAssets: args['build-exclude']
+          reuseAssets: args['build-exclude'],
+          tags: configuration.settings.get(['tags'])
         });
 
       case 'destroy':

packages/aws-cdk/lib/api/cxapp/stacks.ts

@@ -61,6 +61,7 @@ export interface AppStacksProps {
  * In a class because it shares some global state
  */
 export class AppStacks {
+
   /**
    * Since app execution basically always synthesizes all the stacks,
    * we can invoke it once and cache the response for subsequent calls.
@@ -227,6 +228,18 @@ export class AppStacks {
     }
   }
 
+  public getTagsFromStackMetadata(stack: SelectedStack): Tag[] | undefined {
+    for (const id of Object.keys(stack.metadata)) {
+      const metadata = stack.metadata[id];
+      for (const entry of metadata) {
+        if (entry.type === cxapi.TAGS_METADATA_KEY) {
+          return entry.data;
+        }
+      }
+    }
+    return;
+  }
+
   /**
    * Extracts 'aws:cdk:warning|info|error' metadata entries from the stack synthesis
    */
@@ -375,3 +388,8 @@ export interface SelectedStack extends cxapi.SynthesizedStack {
    */
   originalName: string;
 }
+
+export interface Tag {
+  readonly Key: string;
+  readonly Value: string;
+}

packages/aws-cdk/lib/api/deploy-stack.ts

@@ -2,6 +2,7 @@ import cxapi = require('@aws-cdk/cx-api');
 import aws = require('aws-sdk');
 import colors = require('colors/safe');
 import uuid = require('uuid');
+import { Tag } from "../api/cxapp/stacks";
 import { prepareAssets } from '../assets';
 import { debug, error, print } from '../logging';
 import { toYAML } from '../serialize';
@@ -32,6 +33,7 @@ export interface DeployStackOptions {
   quiet?: boolean;
   ci?: boolean;
   reuseAssets?: string[];
+  tags?: Tag[];
 }
 
 const LARGE_TEMPLATE_SIZE_KB = 50;
@@ -73,7 +75,8 @@ export async function deployStack(options: DeployStackOptions): Promise<DeploySt
     TemplateURL: bodyParameter.TemplateURL,
     Parameters: params,
     RoleARN: options.roleArn,
-    Capabilities: [ 'CAPABILITY_IAM', 'CAPABILITY_NAMED_IAM', 'CAPABILITY_AUTO_EXPAND' ]
+    Capabilities: [ 'CAPABILITY_IAM', 'CAPABILITY_NAMED_IAM', 'CAPABILITY_AUTO_EXPAND' ],
+    Tags: options.tags
   }).promise();
   debug('Initiated creation of changeset: %s; waiting for it to finish creating...', changeSet.Id);
   const changeSetDescription = await waitForChangeSet(cfn, deployName, changeSetName);