fix: write only user defined step outputs (#53)

Document creation fails when synthesizing documents with step outputs that match the documentation. Only user defined outputs should be used for document creation.
cdklabs · Nov 15, 2022 · f6be096 · f6be096
1 parent d25df44
commit f6be096
Show file tree

Hide file tree

Showing 11 changed files with 213 additions and 95 deletions.
diff --git a/API.md b/API.md
diff --git a/src/parent-steps/automation-step.ts b/src/parent-steps/automation-step.ts
@@ -96,8 +96,8 @@ export abstract class AutomationStep extends Step implements IAutomationComponen
     ssmDef.set('action', this.action);
     ssmDef.set('inputs', inputs);
 
-    const formattedOutputs = this.listOutputs().map(output => this.formatOutput(output));
-    if (this.listOutputs().length > 0) {
+    if (this.listUserOutputs().length > 0) {
+      const formattedOutputs = this.listUserOutputs().map(this.formatOutput);
       ssmDef.set('outputs', formattedOutputs);
     }
     if (this.isEnd) {
@@ -140,4 +140,15 @@ export abstract class AutomationStep extends Step implements IAutomationComponen
     return Object.assign({}, ...this.listOutputs()
       .map(out => ({ [out.name]: new StringVariable(`${this.name}.${out.name}`) })));
   }
+
+  /**
+   * Lists the outputs defined by the user for this step.
+   */
+  public listUserOutputs(): Output[] {
+    return [];
+  }
+
+  public listOutputs(): Output[] {
+    return this.listUserOutputs();
+  }
 }
diff --git a/src/parent-steps/automation/aws-api-step.ts b/src/parent-steps/automation/aws-api-step.ts
@@ -71,7 +71,7 @@ export class AwsApiStep extends AutomationStep {
   /**
      * @returns Outputs as specified in params
      */
-  public listOutputs(): Output[] {
+  public listUserOutputs(): Output[] {
     return this.outputs;
   }
 

diff --git a/src/parent-steps/automation/execute-script-step.ts b/src/parent-steps/automation/execute-script-step.ts
@@ -252,7 +252,7 @@ export class ExecuteScriptStep extends AutomationStep {
     }
   }
 
-  public listOutputs(): Output[] {
+  public listUserOutputs(): Output[] {
     return this.outputs;
   }
 

diff --git a/test/parent-steps/automation/copy-image-step.test.ts b/test/parent-steps/automation/copy-image-step.test.ts
@@ -130,15 +130,6 @@ describe('CopyImageStep', () => {
           ClientToken: 'token',
         },
         name: 'id2',
-        outputs: [{
-          Type: 'String',
-          Name: 'ImageId',
-          Selector: '$.ImageId',
-        }, {
-          Type: 'String',
-          Name: 'ImageState',
-          Selector: '$.ImageState',
-        }],
       });
     });
   });

diff --git a/test/parent-steps/automation/create-image-step.test.ts b/test/parent-steps/automation/create-image-step.test.ts
@@ -119,15 +119,6 @@ describe('CreateImageStep', () => {
           BlockDeviceMappings: { a: 1 },
         },
         name: 'id2',
-        outputs: [{
-          Type: 'String',
-          Name: 'ImageId',
-          Selector: '$.ImageId',
-        }, {
-          Type: 'String',
-          Name: 'ImageState',
-          Selector: '$.ImageState',
-        }],
       });
     });
   });

diff --git a/test/parent-steps/automation/create-stack-step.test.ts b/test/parent-steps/automation/create-stack-step.test.ts
@@ -116,19 +116,6 @@ describe('CreateStackStep', () => {
           TimeoutInMinutes: 5,
         },
         name: 'createStack',
-        outputs: [{
-          Type: 'String',
-          Name: 'StackId',
-          Selector: '$.StackId',
-        }, {
-          Type: 'String',
-          Name: 'StackStatus',
-          Selector: '$.StackStatus',
-        }, {
-          Type: 'String',
-          Name: 'StackStatusReason',
-          Selector: '$.StackStatusReason',
-        }],
       });
     });
   });

diff --git a/test/parent-steps/automation/invoke-lambda-function-step.test.ts b/test/parent-steps/automation/invoke-lambda-function-step.test.ts
@@ -115,23 +115,6 @@ describe('InvokeLambdaFunctionStep', () => {
           Payload: { a: 1 },
         },
         name: 'id2',
-        outputs: [{
-          Type: 'Integer',
-          Name: 'StatusCode',
-          Selector: '$.StatusCode',
-        }, {
-          Type: 'String',
-          Name: 'FunctionError',
-          Selector: '$.FunctionError',
-        }, {
-          Type: 'String',
-          Name: 'LogResult',
-          Selector: '$.LogResult',
-        }, {
-          Type: 'String',
-          Name: 'Payload',
-          Selector: '$.Payload',
-        }],
       });
     });
   });

diff --git a/test/parent-steps/automation/invoke-webhook-step.test.ts b/test/parent-steps/automation/invoke-webhook-step.test.ts
@@ -54,15 +54,6 @@ describe('InvokeWebhookStep', () => {
           Body: 'body',
         },
         name: 'id2',
-        outputs: [{
-          Type: 'String',
-          Name: 'Response',
-          Selector: '$.Response',
-        }, {
-          Type: 'Integer',
-          Name: 'ResponseCode',
-          Selector: '$.ResponseCode',
-        }],
       });
     });
   });

diff --git a/test/parent-steps/automation/run-command-step.test.ts b/test/parent-steps/automation/run-command-step.test.ts
@@ -102,28 +102,6 @@ describe('RunCommandStep', () => {
           MaxErrors: 5,
         },
         name: 'runCommand',
-        outputs: [
-          {
-            Name: 'CommandId',
-            Selector: '$.CommandId',
-            Type: 'String',
-          },
-          {
-            Name: 'Status',
-            Selector: '$.Status',
-            Type: 'String',
-          },
-          {
-            Name: 'ResponseCode',
-            Selector: '$.ResponseCode',
-            Type: 'Integer',
-          },
-          {
-            Name: 'Output',
-            Selector: '$.Output',
-            Type: 'String',
-          },
-        ],
       });
     });
   });

diff --git a/test/parent-steps/automation/run-instance-step.test.ts b/test/parent-steps/automation/run-instance-step.test.ts
@@ -238,18 +238,6 @@ describe('RunInstanceStep', function() {
           UserData: 'string',
         },
         name: 'id2',
-        outputs: [
-          {
-            Name: 'InstanceIds',
-            Selector: '$.InstanceIds',
-            Type: 'StringList',
-          },
-          {
-            Name: 'InstanceStates',
-            Selector: '$.InstanceStates',
-            Type: 'StringList',
-          },
-        ],
       });
     });
   });