fix(cli): cdk deploy output hook failure reason if cloudformation failed by hook (#24444)

new feature for issue: #21674

Reopen this PR, #21675 it's approved before, but nobody helps to proceed.


----

### All Submissions:

* [x] 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: btan-godaddy

packages/aws-cdk/lib/api/util/cloudformation/stack-activity-monitor.ts

@@ -398,6 +398,9 @@ abstract class ActivityPrinterBase implements IActivityPrinter {
 
   protected readonly failures = new Array<StackActivity>();
 
+
+  protected hookFailureMap = new Map<string, Map<string, string>>();
+
   protected readonly stream: NodeJS.WriteStream;
 
   constructor(protected readonly props: PrinterProps) {
@@ -411,8 +414,25 @@ abstract class ActivityPrinterBase implements IActivityPrinter {
     this.stream = props.stream;
   }
 
+  public failureReason(activity: StackActivity) {
+    const resourceStatusReason = activity.event.ResourceStatusReason ?? '';
+    const logicalResourceId = activity.event.LogicalResourceId ?? '';
+    const hookFailureReasonMap = this.hookFailureMap.get(logicalResourceId);
+
+    if (hookFailureReasonMap !== undefined) {
+      for (const hookType of hookFailureReasonMap.keys()) {
+        if (resourceStatusReason.includes(hookType)) {
+          return resourceStatusReason + ' : ' + hookFailureReasonMap.get(hookType);
+        }
+      }
+    }
+    return resourceStatusReason;
+  }
+
   public addActivity(activity: StackActivity) {
     const status = activity.event.ResourceStatus;
+    const hookStatus = activity.event.HookStatus;
+    const hookType = activity.event.HookType;
     if (!status || !activity.event.LogicalResourceId) { return; }
 
     if (status === 'ROLLBACK_IN_PROGRESS' || status === 'UPDATE_ROLLBACK_IN_PROGRESS') {
@@ -455,6 +475,16 @@ abstract class ActivityPrinterBase implements IActivityPrinter {
       }
       this.resourcesPrevCompleteState[activity.event.LogicalResourceId] = status;
     }
+
+    if (hookStatus!== undefined && hookStatus.endsWith('_COMPLETE_FAILED') && activity.event.LogicalResourceId !== undefined && hookType !== undefined) {
+
+      if (this.hookFailureMap.has(activity.event.LogicalResourceId)) {
+        this.hookFailureMap.get(activity.event.LogicalResourceId)?.set(hookType, activity.event.HookStatusReason ?? '');
+      } else {
+        this.hookFailureMap.set(activity.event.LogicalResourceId, new Map<string, string>());
+        this.hookFailureMap.get(activity.event.LogicalResourceId)?.set(hookType, activity.event.HookStatusReason ?? '');
+      }
+    }
   }
 
   public abstract print(): void;
@@ -529,8 +559,15 @@ export class HistoryActivityPrinter extends ActivityPrinterBase {
 
     let stackTrace = '';
     const md = activity.metadata;
-    if (md && e.ResourceStatus && e.ResourceStatus.indexOf('FAILED') !== -1) {
-      stackTrace = md.entry.trace ? `\n\t${md.entry.trace.join('\n\t\\_ ')}` : '';
+
+    if (e.ResourceStatus && e.ResourceStatus.indexOf('FAILED') !== -1) {
+      if (progress == undefined || progress) {
+        e.ResourceStatusReason = e.ResourceStatusReason ? this.failureReason(activity) : '';
+      }
+      if (md) {
+        stackTrace = md.entry.trace ? `\n\t${md.entry.trace.join('\n\t\\_ ')}` : '';
+
+      }
       reasonColor = chalk.red;
     }
 
@@ -703,7 +740,7 @@ export class CurrentActivityPrinter extends ActivityPrinterBase {
 
   private failureReasonOnNextLine(activity: StackActivity) {
     return hasErrorMessage(activity.event.ResourceStatus ?? '')
-      ? `\n${' '.repeat(TIMESTAMP_WIDTH + STATUS_WIDTH + 6)}${chalk.red(activity.event.ResourceStatusReason ?? '')}`
+      ? `\n${' '.repeat(TIMESTAMP_WIDTH + STATUS_WIDTH + 6)}${chalk.red(this.failureReason(activity) ?? '')}`
       : '';
   }
 }
@@ -718,6 +755,7 @@ function hasErrorMessage(status: string) {
   return status.endsWith('_FAILED') || status === 'ROLLBACK_IN_PROGRESS' || status === 'UPDATE_ROLLBACK_IN_PROGRESS';
 }
 
+
 function colorFromStatusResult(status?: string) {
   if (!status) {
     return chalk.reset;
@@ -767,3 +805,5 @@ function shorten(maxWidth: number, p: string) {
 
 const TIMESTAMP_WIDTH = 12;
 const STATUS_WIDTH = 20;
+
+

packages/aws-cdk/test/api/stack-activity-monitor.test.ts

@@ -222,3 +222,48 @@ test('prints "Failed Resources:" list, when at least one deployment fails', () =
   expect(output[2].trim()).toStrictEqual('Failed resources:');
   expect(output[3].trim()).toStrictEqual(`stack-name | ${HUMAN_TIME} | ${red('UPDATE_FAILED       ')} | AWS::CloudFormation::Stack | ${red(bold('stack1'))}`);
 });
+
+test('print failed resources because of hook failures', () => {
+  const historyActivityPrinter = new HistoryActivityPrinter({
+    resourceTypeColumnWidth: 23,
+    resourcesTotal: 1,
+    stream: process.stderr,
+  });
+
+  const output = stderr.inspectSync(() => {
+    historyActivityPrinter.addActivity({
+      event: {
+        LogicalResourceId: 'stack1',
+        ResourceStatus: 'IN_PROGRESS',
+        Timestamp: new Date(TIMESTAMP),
+        ResourceType: 'AWS::CloudFormation::Stack',
+        StackId: '',
+        EventId: '',
+        StackName: 'stack-name',
+        HookStatus: 'HOOK_COMPLETE_FAILED',
+        HookType: 'hook1',
+        HookStatusReason: 'stack1 must obey certain rules',
+      },
+    });
+    historyActivityPrinter.addActivity({
+      event: {
+        LogicalResourceId: 'stack1',
+        ResourceStatus: 'UPDATE_FAILED',
+        Timestamp: new Date(TIMESTAMP),
+        ResourceType: 'AWS::CloudFormation::Stack',
+        StackId: '',
+        EventId: '',
+        StackName: 'stack-name',
+        ResourceStatusReason: 'The following hook(s) failed: hook1',
+      },
+    });
+    historyActivityPrinter.stop();
+  });
+
+  expect(output.length).toStrictEqual(4);
+  expect(output[0].trim()).toStrictEqual(`stack-name | 0/2 | ${HUMAN_TIME} | ${reset('IN_PROGRESS         ')} | AWS::CloudFormation::Stack | ${reset(bold('stack1'))}`);
+  expect(output[1].trim()).toStrictEqual(`stack-name | 0/2 | ${HUMAN_TIME} | ${red('UPDATE_FAILED       ')} | AWS::CloudFormation::Stack | ${red(bold('stack1 The following hook(s) failed: hook1 : stack1 must obey certain rules'))}`);
+  expect(output[2].trim()).toStrictEqual('Failed resources:');
+  expect(output[3].trim()).toStrictEqual(`stack-name | ${HUMAN_TIME} | ${red('UPDATE_FAILED       ')} | AWS::CloudFormation::Stack | ${red(bold('stack1 The following hook(s) failed: hook1 : stack1 must obey certain rules'))}`);
+});
+