feat(cli): adding new option to cdk deploy to indicate whether Chan…

…geSet should be executed (#4852) * feat(aws-cdk): adding new option to `cdk deploy` I created the option to *NOT* execute the ChangeSet via `cdk deploy`. The flag is called **execute** and by default is set to true. By not providing this flag, the workflow of `cdk deploy` will be the same. If anyone wants to *NOT* execute the ChangeSet, providing the flag `--no-execute` will pass the execution of the ChangeSet. You will be able to see the ChangeSet in AWS CloudFormation Console, validate the resources and discard or execute the ChangeSet. closes #4739 * feat(cli): adding new option to `cdk deploy` to indicate whether ChangeSet should be executed I created the option to *NOT* execute the ChangeSet via `cdk deploy`. The flag is called **execute** and by default is set to true. By not providing this flag, the workflow of `cdk deploy` will be the same. If anyone wants to *NOT* execute the ChangeSet, providing the flag `--no-execute` will pass the execution of the ChangeSet. You will be able to see the ChangeSet in AWS CloudFormation Console, validate the resources and discard or execute the ChangeSet. closes #4739 * feat(cli): adding new option to `cdk deploy` to indicate whether ChangeSet should be executed I created the option to *NOT* execute the ChangeSet via `cdk deploy`. The flag is called **execute** and by default is set to true. By not providing this flag, the workflow of `cdk deploy` will be the same. If anyone wants to *NOT* execute the ChangeSet, providing the flag `--no-execute` will pass the execution of the ChangeSet. You will be able to see the ChangeSet in AWS CloudFormation Console, validate the resources and discard or execute the ChangeSet. closes #4739 * feat(cli): adding new option to `cdk deploy` to indicate whether ChangeSet should be executed I created the option to *NOT* execute the ChangeSet via `cdk deploy`. The flag is called **execute** and by default is set to true. By not providing this flag, the workflow of `cdk deploy` will be the same. If anyone wants to *NOT* execute the ChangeSet, providing the flag `--no-execute` will pass the execution of the ChangeSet. You will be able to see the ChangeSet in AWS CloudFormation Console, validate the resources and discard or execute the ChangeSet. closes #4739 * feat(cli): adding new option to `cdk deploy` to indicate whether ChangeSet should be executed I created the option to *NOT* execute the ChangeSet via `cdk deploy`. The flag is called **execute** and by default is set to true. By not providing this flag, the workflow of `cdk deploy` will be the same. If anyone wants to *NOT* execute the ChangeSet, providing the flag `--no-execute` will pass the execution of the ChangeSet. You will be able to see the ChangeSet in AWS CloudFormation Console, validate the resources and discard or execute the ChangeSet. closes #4739 * feat(cli): adding new option to `cdk deploy` to indicate whether ChangeSet should be executed I created the option to *NOT* execute the ChangeSet via `cdk deploy`. The flag is called **execute** and by default is set to true. By not providing this flag, the workflow of `cdk deploy` will be the same. If anyone wants to *NOT* execute the ChangeSet, providing the flag `--no-execute` will pass the execution of the ChangeSet. You will be able to see the ChangeSet in AWS CloudFormation Console, validate the resources and discard or execute the ChangeSet. closes #4739
aws · Nov 13, 2019 · c02c9e5 · c02c9e5
1 parent 0a6f921
commit c02c9e5
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 10 deletions.
diff --git a/packages/aws-cdk/bin/cdk.ts b/packages/aws-cdk/bin/cdk.ts
@@ -59,6 +59,7 @@ async function parseCommandLineArguments() {
       .option('ci', { type: 'boolean', desc: 'Force CI detection. Use --no-ci to disable CI autodetection.', default: process.env.CI !== undefined })
       .option('notification-arns', {type: 'array', desc: 'ARNs of SNS topics that CloudFormation will notify with stack related events', nargs: 1, requiresArg: true})
       .option('tags', { type: 'array', alias: 't', desc: 'Tags to add to the stack (KEY=VALUE)', nargs: 1, requiresArg: true }))
+      .option('execute', {type: 'boolean', desc: 'Whether to execute ChangeSet (--no-execute will NOT execute the ChangeSet)', default: true})
     .command('destroy [STACKS..]', 'Destroy the stack(s) named STACKS', yargs => yargs
       .option('exclusively', { type: 'boolean', alias: 'e', 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' }))
@@ -207,6 +208,7 @@ async function initCommandLine() {
           reuseAssets: args['build-exclude'],
           tags: configuration.settings.get(['tags']),
           sdk: aws,
+          execute: args.execute
         });
 
       case 'destroy':

diff --git a/packages/aws-cdk/lib/api/deploy-stack.ts b/packages/aws-cdk/lib/api/deploy-stack.ts
@@ -37,6 +37,7 @@ export interface DeployStackOptions {
   ci?: boolean;
   reuseAssets?: string[];
   tags?: Tag[];
+  execute?: boolean;
 }
 
 const LARGE_TEMPLATE_SIZE_KB = 50;
@@ -92,14 +93,21 @@ export async function deployStack(options: DeployStackOptions): Promise<DeploySt
     return { noOp: true, outputs: await getStackOutputs(cfn, deployName), stackArn: changeSet.StackId! };
   }
 
-  debug('Initiating execution of changeset %s on stack %s', changeSetName, deployName);
-  await cfn.executeChangeSet({ StackName: deployName, ChangeSetName: changeSetName }).promise();
-  // tslint:disable-next-line:max-line-length
-  const monitor = options.quiet ? undefined : new StackActivityMonitor(cfn, deployName, options.stack, (changeSetDescription.Changes || []).length).start();
-  debug('Execution of changeset %s on stack %s has started; waiting for the update to complete...', changeSetName, deployName);
-  await waitForStack(cfn, deployName);
-  if (monitor) { await monitor.stop(); }
-  debug('Stack %s has completed updating', deployName);
+  if (options.execute) {
+    debug('Initiating execution of changeset %s on stack %s', changeSetName, deployName);
+    await cfn.executeChangeSet({StackName: deployName, ChangeSetName: changeSetName}).promise();
+    // tslint:disable-next-line:max-line-length
+    const monitor = options.quiet ? undefined : new StackActivityMonitor(cfn, deployName, options.stack, (changeSetDescription.Changes || []).length).start();
+    debug('Execution of changeset %s on stack %s has started; waiting for the update to complete...', changeSetName, deployName);
+    await waitForStack(cfn, deployName);
+    if (monitor) {
+      await monitor.stop();
+    }
+    debug('Stack %s has completed updating', deployName);
+  } else {
+    debug('Entering no-execute workflow for ChangeSet %s on stack %s', changeSetName, deployName);
+    cfn.executeChangeSet();
+  }
   return { noOp: false, outputs: await getStackOutputs(cfn, deployName), stackArn: changeSet.StackId! };
 }
 

diff --git a/packages/aws-cdk/lib/api/deployment-target.ts b/packages/aws-cdk/lib/api/deployment-target.ts
@@ -31,6 +31,7 @@ export interface DeployStackOptions {
   toolkitStackName?: string;
   reuseAssets?: string[];
   tags?: Tag[];
+  execute?: boolean;
 }
 
 export interface ProvisionerProps {
@@ -75,7 +76,8 @@ export class CloudFormationDeploymentTarget implements IDeploymentTarget {
       ci: options.ci,
       reuseAssets: options.reuseAssets,
       toolkitInfo,
-      tags: options.tags
+      tags: options.tags,
+      execute: options.execute
     });
   }
 }
diff --git a/packages/aws-cdk/lib/cdk-toolkit.ts b/packages/aws-cdk/lib/cdk-toolkit.ts
@@ -144,7 +144,8 @@ export class CdkToolkit {
           toolkitStackName: options.toolkitStackName,
           reuseAssets: options.reuseAssets,
           notificationArns: options.notificationArns,
-          tags
+          tags,
+          execute: options.execute
         });
 
         const message = result.noOp
@@ -303,6 +304,13 @@ export interface DeployOptions {
    * AWS SDK
    */
   sdk: ISDK;
+
+  /**
+   * Whether to execute the ChangeSet
+   * Not providing `execute` parameter will result in execution of ChangeSet
+   * @default true
+   */
+  execute?: boolean;
 }
 
 export interface DestroyOptions {

diff --git a/packages/aws-cdk/test/integ/cli/test-cdk-deploy-no-execute.sh b/packages/aws-cdk/test/integ/cli/test-cdk-deploy-no-execute.sh
@@ -0,0 +1,27 @@
+#!/bin/bash
+set -euo pipefail
+scriptdir=$(cd $(dirname $0) && pwd)
+source ${scriptdir}/common.bash
+# ----------------------------------------------------------
+
+setup
+
+stack_arn=$(cdk deploy -v ${STACK_NAME_PREFIX}-test-2 --no-execute)
+echo "Stack deployed successfully"
+
+# verify that we only deployed a single stack (there's a single ARN in the output)
+assert_lines "${stack_arn}" 1
+
+# verify the number of resources in the stack
+response_json=$(mktemp).json
+aws cloudformation describe-stacks --stack-name ${stack_arn} > ${response_json}
+
+stack_status=$(node -e "console.log(require('${response_json}').Stacks[0].StackStatus)")
+if [ "${stack_status}" -ne "REVIEW_IN_PROGRESS" ]; then
+    fail "Expected stack to be in status REVIEW_IN_PROGRESS but got ${stack_status}"
+fi
+
+# destroy
+cdk destroy -f ${STACK_NAME_PREFIX}-test-2
+
+echo "✅  success"