feat(cdk-cli-wrapper): add progress argument for cdk deploy (#21762)

Adding the ability to specify `--progress` when using cdk `deploy`. I'm
setting the default to `events` as opposed to the default of `bar` in
the CLI. Since this library is currently only used in the integ-runner,
and if published will most likely be used in automation I think it makes
more sense to set progress to `events`.

This is really useful when running multiple integration tests in
parallel. If set to `bar` (CLI default) the logs will overlap/overwrite
each other which makes it difficult to troubleshoot.


----

### All Submissions:

* [ ] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md)

### Adding new Unconventional Dependencies:

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

### New Features

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)?
	* [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Author: corymhall

packages/cdk-cli-wrapper/lib/cdk-wrapper.ts

@@ -1,4 +1,4 @@
-import { DefaultCdkOptions, DeployOptions, DestroyOptions, SynthOptions, ListOptions } from './commands';
+import { DefaultCdkOptions, DeployOptions, DestroyOptions, SynthOptions, ListOptions, StackActivityProgress } from './commands';
 import { exec } from './utils';
 
 /**
@@ -161,6 +161,7 @@ export class CdkCliWrapper implements ICdk {
       ...options.requireApproval ? ['--require-approval', options.requireApproval] : [],
       ...options.changeSetName ? ['--change-set-name', options.changeSetName] : [],
       ...options.toolkitStackName ? ['--toolkit-stack-name', options.toolkitStackName] : [],
+      ...options.progress ? ['--progress', options.progress] : ['--progress', StackActivityProgress.EVENTS],
       ...this.createDefaultArguments(options),
     ];
 

packages/cdk-cli-wrapper/lib/commands/deploy.ts

@@ -94,4 +94,30 @@ export interface DeployOptions extends DefaultCdkOptions {
    * @default false
    */
   readonly ci?: boolean;
+
+  /**
+   * Display mode for stack activity events
+   *
+   * The default in the CLI is StackActivityProgress.BAR, but
+   * since the cli-wrapper will most likely be run in automation it makes
+   * more sense to set the default to StackActivityProgress.EVENTS
+   *
+   * @default StackActivityProgress.EVENTS
+   */
+  readonly progress?: StackActivityProgress;
+}
+
+/**
+ * Supported display modes for stack deployment activity
+ */
+export enum StackActivityProgress {
+  /**
+   * Displays a progress bar with only the events for the resource currently being deployed
+   */
+  BAR = 'bar',
+
+  /**
+   * Displays complete history with all CloudFormation stack events
+   */
+  EVENTS = 'events',
 }

packages/cdk-cli-wrapper/test/cdk-wrapper.test.ts

@@ -1,6 +1,6 @@
 import * as child_process from 'child_process';
 import { CdkCliWrapper } from '../lib/cdk-wrapper';
-import { RequireApproval } from '../lib/commands';
+import { RequireApproval, StackActivityProgress } from '../lib/commands';
 let spawnSyncMock: jest.SpyInstance;
 
 beforeEach(() => {
@@ -33,7 +33,7 @@ test('default deploy', () => {
   // THEN
   expect(spawnSyncMock).toHaveBeenCalledWith(
     expect.stringMatching(/cdk/),
-    ['deploy', '--app', 'node bin/my-app.js', 'test-stack1'],
+    ['deploy', '--progress', 'events', '--app', 'node bin/my-app.js', 'test-stack1'],
     expect.objectContaining({
       env: expect.anything(),
       cwd: '/project',
@@ -82,6 +82,7 @@ test('deploy with all arguments', () => {
     toolkitStackName: 'Toolkit',
     versionReporting: true,
     usePreviousParameters: true,
+    progress: StackActivityProgress.BAR,
   });
 
   // THEN
@@ -120,6 +121,7 @@ test('deploy with all arguments', () => {
       '--change-set-name', 'my-change-set',
       '--toolkit-stack-name', 'Toolkit',
       '--previous-parameters',
+      '--progress', 'bar',
       '--app',
       'node bin/my-app.js',
       'test-stack1',
@@ -149,6 +151,7 @@ test('can parse boolean arguments', () => {
     expect.stringMatching(/cdk/),
     [
       'deploy',
+      '--progress', 'events',
       '--app',
       'node bin/my-app.js',
       '--json',
@@ -184,6 +187,7 @@ test('can parse parameters', () => {
       'deploy',
       '--parameters', 'myparam=test',
       '--parameters', 'test-stack1:myotherparam=test',
+      '--progress', 'events',
       '--app',
       'node bin/my-app.js',
       'test-stack1',
@@ -214,6 +218,7 @@ test('can parse context', () => {
     expect.stringMatching(/cdk/),
     [
       'deploy',
+      '--progress', 'events',
       '--app',
       'node bin/my-app.js',
       '--context', 'myContext=value',
@@ -248,6 +253,7 @@ test('can parse array arguments', () => {
       'deploy',
       '--notification-arns', 'arn:aws:us-east-1:1111111111:some:resource',
       '--notification-arns', 'arn:aws:us-east-1:1111111111:some:other-resource',
+      '--progress', 'events',
       '--app',
       'node bin/my-app.js',
       'test-stack1',
@@ -275,7 +281,7 @@ test('can provide additional environment', () => {
   // THEN
   expect(spawnSyncMock).toHaveBeenCalledWith(
     expect.stringMatching(/cdk/),
-    ['deploy', '--app', 'node bin/my-app.js', 'test-stack1'],
+    ['deploy', '--progress', 'events', '--app', 'node bin/my-app.js', 'test-stack1'],
     expect.objectContaining({
       env: expect.objectContaining({
         KEY: 'value',