feat(codepipeline): add support for a StepFunctions invoke action #8931

madhumitranrl · 2020-07-07T22:10:22Z

this feature enables developers using the cdk
to create stepfunction invoke action in their stacks.

verified the changes using unit tests.

Reviewed by: sainsbm

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

this feature enables developers using the cdk to create stepfunction invoke action in their stacks. verified the changes using unit tests. Reviewed by: sainsbm

Fixed lint issues and verified the changes using unit tests

packages/@aws-cdk/aws-codepipeline-actions/lib/stepfunctions/invoke-action.ts

...es/@aws-cdk/aws-codepipeline-actions/test/stepfunctions/test.stepfunctions-invoke-actions.ts

Added validations for input and output artifacts. Stringified StateMachineInput when the input type is literal Tested the changes using unit tests. Modified StateMachineInputType FilePath test to verify based on exception messages. This specific test was previously verifying only if an exception was thrown. Added Integration tests and verified with yarn integ. README file has also been added which explains how to invoke a step function from a pipeline. Reviewed by: sainsbm

skinny85

Thanks for the contribution @madhumitranrl !

I like it, but I'd like to have one major change done before I give my approval 🙂.

skinny85 · 2020-07-15T19:48:46Z

packages/@aws-cdk/aws-codepipeline-actions/README.md

+    definition: startState,
+    });


Wrong indentation:

Suggested change

definition: startState,

});

definition: startState,

});

skinny85 · 2020-07-15T19:49:20Z

packages/@aws-cdk/aws-codepipeline-actions/README.md

+    definition: startState,
+    });


Wrong indentation:

Suggested change

definition: startState,

});

definition: startState,

});

skinny85 · 2020-07-15T19:49:55Z

packages/@aws-cdk/aws-codepipeline-actions/README.md

@@ -794,3 +794,56 @@ new codepipeline_actions.CodeBuildAction({

 See [the AWS documentation](https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-invoke-lambda-function.html)
 on how to write a Lambda function invoked from CodePipeline.
+
+#### AWS Step Functions


This has been changed to ### on current master, if you could update the PR with the latest.

skinny85 · 2020-07-15T19:51:44Z

packages/@aws-cdk/aws-codepipeline-actions/lib/stepfunctions/invoke-action.ts

+   * If InputType is set to FilePath, this artifact is required
+   * and is used to source the input for the state machine execution.
+   *
+   * @default the Action will not have any inputs


Suggested change

* @default the Action will not have any inputs

* @default - the Action will not have any inputs

packages/@aws-cdk/aws-codepipeline-actions/package.json

skinny85 · 2020-07-15T19:57:15Z

packages/@aws-cdk/aws-codepipeline-actions/lib/stepfunctions/invoke-action.ts

+   *
+   * @default - action execution ID
+   */
+  readonly executionPrefixName?: string;


Can we rename this to executionNamePrefix?

skinny85 · 2020-07-15T21:21:00Z

packages/@aws-cdk/aws-codepipeline-actions/lib/stepfunctions/invoke-action.ts

+   *
+   * @default - none
+   */
+  readonly stateMachineInput?: string | object;


Nice try, but we don't allow using union types in L2s, because they don't translate to other languages well 🙂.

Since this value is actually closely tied to the input property as well, can I offer an alternative design here?

export interface StepFunctionsInvokeActionProps extends codepipeline.CommonAwsActionProps { readonly output?: codepipeline.Artifact; readonly stateMachine: stepfunction.IStateMachine; readonly executionPrefixName?: string; readonly stateMachineInput?: StateMachineInput; } export class StateMachineInput { public static filePath(filePath: string, inputArtifact: codepipeline.Artifact): StateMachineInput { ... } public static literal(object: object): StateMachineInput { ... } private constructor(...) { ... } // all 3 are read in bind() public readonly inputArtifact?: codepipeline.Artifact; public readonly inputType?: string; public readonly input: any; }

Updated the design to include inputArtifact, inputType and input as a single StateMachineInput unit. Modified unit and integration tests based on the design change. Updated README as well.

Pull request has been modified.

skinny85

@madhumitranrl don't get mad at me, but I figured out an even nicer API for this Action. Sorry that I'm making you go through this, but I just forgot about the ArtifactPath class, which is a perfect fit for this use case.

If you had enough of my comments, let me know, and I'll try to take over the PR, and get it over the line 🤪.

Thanks!

skinny85 · 2020-07-16T22:58:05Z

packages/@aws-cdk/aws-codepipeline-actions/README.md

+const pipeline = new codepipeline.Pipeline(this, 'MyPipeline');
+const startState = new stepfunction.Pass(stack, 'StartState');
+const simpleStateMachine  = new stepfunction.StateMachine(stack, 'SimpleStateMachine', {
+    definition: startState,


2 spaces instead of 4:

Suggested change

definition: startState,

definition: startState,

skinny85 · 2020-07-16T22:59:18Z

packages/@aws-cdk/aws-codepipeline-actions/README.md

+const stepFunctionAction = new codepipeline_actions.StepFunctionsInvokeAction({
+  actionName: 'Invoke',
+  stateMachine: simpleStateMachine,
+  stateMachineInput: codepipeline_actions.StateMachineInput.literal({IsHelloWorldExample: true}),


Suggested change

stateMachineInput: codepipeline_actions.StateMachineInput.literal({IsHelloWorldExample: true}),

stateMachineInput: codepipeline_actions.StateMachineInput.literal({ IsHelloWorldExample: true }),

skinny85 · 2020-07-16T23:04:50Z

packages/@aws-cdk/aws-codepipeline-actions/README.md

+The StateMachineInputType can be a Literal or FilePath.
+Input artifact and StateMachineInputField are required when
+the StateMachineInputType is set as FilePath.


Suggested change

The StateMachineInputType can be a Literal or FilePath.

Input artifact and StateMachineInputField are required when

the StateMachineInputType is set as FilePath.

The `StateMachineInput` can be created with one of 2 static factory methods:

`literal`, which takes an arbitrary map as its only argument, or `filePath`:

skinny85 · 2020-07-16T23:05:13Z

packages/@aws-cdk/aws-codepipeline-actions/README.md

+const inputArtifact = new codepipeline.Artifact();
+const startState = new stepfunction.Pass(stack, 'StartState');
+const simpleStateMachine  = new stepfunction.StateMachine(stack, 'SimpleStateMachine', {
+    definition: startState,


Suggested change

definition: startState,

definition: startState,

skinny85 · 2020-07-16T23:09:36Z

packages/@aws-cdk/aws-codepipeline-actions/lib/stepfunctions/invoke-action.ts

+   * When the input type is FilePath, input artifact and
+   * filepath must be specified.
+   */
+  public static filePath(filePath: string, inputArtifact: codepipeline.Artifact): StateMachineInput {


Apologies @madhumitranrl , but I came up with an even better API :). We have a class in the CodePipeline library exactly for this (file in an artifact) purpose: ArtifactPath. So, you can change this function to:

public static filePath(inuputFile: codepipeline.ArtifactPath): StateMachineInput { return new StateMachineInput(inuputFile.location, inuputFile.artifact, 'FilePath'); }

And the customer uses it like this:

StateMachineInput .filePath(buildArtifact.atPath('path/to/my/file.json'));

This will be perfect!

Now, with this design, what do you think about getting rid of StateMachineInput class? We can change StepFunctionsInvokeActionProps to be just:

export interface StepFunctionInvokeActionProps { // these 3 same as now readonly output?: codepipeline.Artifact; readonly stateMachine: stepfunction.IStateMachine; readonly executionNamePrefix?: string; // only one of inputFile and inputObject can be provided - we check that in the StepFunctionsInvokeAction class readonly inputFile?: codepipeline.ArtifactPath; readonly inputObject?: object; }

Let me know which one you like better!

skinny85 · 2020-07-16T23:18:35Z

packages/@aws-cdk/aws-codepipeline-actions/lib/stepfunctions/invoke-action.ts

+/**
+ * StepFunction invoke Action that is provided by an AWS CodePipeline.
+ */
+export class StepFunctionsInvokeAction extends Action {


What do you think of calling it StepFunctionInvokeAction (not Functions)? It does invoke a single StepFunction...

skinny85 · 2020-07-16T23:25:08Z

packages/@aws-cdk/aws-codepipeline-actions/lib/stepfunctions/invoke-action.ts

+    // allow state machine executions to be inspected
+    options.role.addToPolicy(new iam.PolicyStatement({
+      actions: ['states:DescribeExecution'],
+      resources: [`arn:aws:states:*:*:execution:${this.props.stateMachine.stateMachineArn}:${this.props.executionNamePrefix ?? ''}*`],


We actually have a method for that in our standard library. This should be:

resources: [Stack.of(this.props.stateMachine).formatArn({ service: 'states', resource: 'execution', resourceName: `${this.props.stateMachine.stateMachineArn}:${this.props.executionNamePrefix ?? ''}*`, sep: ':', })],

skinny85 · 2020-07-16T23:26:20Z

packages/@aws-cdk/aws-codepipeline-actions/test/integ.pipeline-stepfunctions.ts

+    new cpactions.StepFunctionsInvokeAction({
+      actionName: 'Invoke',
+      stateMachine: simpleStateMachine,
+      stateMachineInput: cpactions.StateMachineInput.literal({IsHelloWorldExample: true}),


Suggested change

stateMachineInput: cpactions.StateMachineInput.literal({IsHelloWorldExample: true}),

stateMachineInput: cpactions.StateMachineInput.literal({ IsHelloWorldExample: true }),

Updated the design to include ArtifactPath class Modified unit, integration tests and README accordingly

Pull request has been modified.

Removed a typo from the unit test

skinny85

I have one more question before I ship this @madhumitranrl !

skinny85 · 2020-07-17T19:25:23Z

packages/@aws-cdk/aws-codepipeline-actions/lib/stepfunctions/invoke-action.ts

+    return {
+      configuration: {
+        StateMachineArn: this.props.stateMachine.stateMachineArn,
+        Input: (this.props.stateMachineInput) ? this.props.stateMachineInput.input : [],


Do we have to fill this out if stateMachineInput is undefined? We can't make it undefined as well?

skinny85 · 2020-07-17T19:25:58Z

packages/@aws-cdk/aws-codepipeline-actions/lib/stepfunctions/invoke-action.ts

+      configuration: {
+        StateMachineArn: this.props.stateMachine.stateMachineArn,
+        Input: (this.props.stateMachineInput) ? this.props.stateMachineInput.input : [],
+        InputType: (this.props.stateMachineInput) ? this.props.stateMachineInput.inputType : undefined,


Thanks to TypeScript's safe navigation operator, this can be simplified to:

Suggested change

InputType: (this.props.stateMachineInput) ? this.props.stateMachineInput.inputType : undefined,

InputType: this.props.stateMachineInput?.inputType,

packages/@aws-cdk/aws-codepipeline-actions/lib/stepfunctions/invoke-action.ts

Updated the ternary operator with typescript safe navigation operator Included the action statement Unit and integration tests pass

Pull request has been modified.

skinny85

Looks great! Thanks for the contribution, and for putting up with me @madhumitranrl 😃

mergify · 2020-07-18T00:05:39Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify · 2020-07-18T00:25:34Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2020-07-18T00:25:37Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 5ba3be4
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

madhumitranrl · 2020-07-18T02:02:25Z

Looks great! Thanks for the contribution, and for putting up with me @madhumitranrl 😃

Thank you!

…s#8931) this feature enables developers using the cdk to create stepfunction invoke action in their stacks. verified the changes using unit tests. Reviewed by: sainsbm ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

madhumitranrl added 2 commits July 7, 2020 14:58

feat: allow stepfunctions invoke action

4360d28

this feature enables developers using the cdk to create stepfunction invoke action in their stacks. verified the changes using unit tests. Reviewed by: sainsbm

feat: allow stepfunctions invoke action

63a1878

Fixed lint issues and verified the changes using unit tests

mattsains suggested changes Jul 7, 2020

View reviewed changes

SomayaB assigned skinny85 Jul 8, 2020

skinny85 changed the title ~~feat: allow stepfunctions invoke action~~ feat(codepipeline): add support for a StepFunctions invoke action Jul 8, 2020

madhumitranrl marked this pull request as ready for review July 10, 2020 22:25

skinny85 previously requested changes Jul 15, 2020

View reviewed changes

feat(codepipeline): add support for a StepFunctions invoke action

a620766

Updated the design to include inputArtifact, inputType and input as a single StateMachineInput unit. Modified unit and integration tests based on the design change. Updated README as well.

skinny85 previously requested changes Jul 16, 2020

View reviewed changes

feat(codepipeline): add support for a StepFunctions invoke action

222ba51

Updated the design to include ArtifactPath class Modified unit, integration tests and README accordingly

feat(codepipeline): add support for a StepFunctions invoke action

c69a47e

Removed a typo from the unit test

skinny85 reviewed Jul 17, 2020

View reviewed changes

skinny85 previously requested changes Jul 17, 2020

View reviewed changes

packages/@aws-cdk/aws-codepipeline-actions/lib/stepfunctions/invoke-action.ts Show resolved Hide resolved

feat: allow stepfunctions invoke action

e2adaf7

Updated the ternary operator with typescript safe navigation operator Included the action statement Unit and integration tests pass

skinny85 approved these changes Jul 17, 2020

View reviewed changes

Merge branch 'master' into madhulog/invoke-stepfunctions

c574977

Merge branch 'master' into madhulog/invoke-stepfunctions

5ba3be4

mergify bot merged commit 499776d into aws:master Jul 18, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(codepipeline): add support for a StepFunctions invoke action #8931

feat(codepipeline): add support for a StepFunctions invoke action #8931

madhumitranrl commented Jul 7, 2020

skinny85 left a comment

skinny85 Jul 15, 2020

skinny85 Jul 15, 2020

skinny85 Jul 15, 2020

skinny85 Jul 15, 2020

skinny85 Jul 15, 2020

skinny85 Jul 15, 2020

skinny85 left a comment

skinny85 Jul 16, 2020

skinny85 Jul 16, 2020

skinny85 Jul 16, 2020

skinny85 Jul 16, 2020

skinny85 Jul 16, 2020 •

edited

Loading

skinny85 Jul 16, 2020

skinny85 Jul 16, 2020

skinny85 Jul 16, 2020

skinny85 left a comment

skinny85 Jul 17, 2020

skinny85 Jul 17, 2020

skinny85 left a comment

mergify bot commented Jul 18, 2020

mergify bot commented Jul 18, 2020

aws-cdk-automation commented Jul 18, 2020

madhumitranrl commented Jul 18, 2020

	* @default the Action will not have any inputs
	* @default - the Action will not have any inputs

	stateMachineInput: codepipeline_actions.StateMachineInput.literal({IsHelloWorldExample: true}),
	stateMachineInput: codepipeline_actions.StateMachineInput.literal({ IsHelloWorldExample: true }),

	stateMachineInput: cpactions.StateMachineInput.literal({IsHelloWorldExample: true}),
	stateMachineInput: cpactions.StateMachineInput.literal({ IsHelloWorldExample: true }),

	InputType: (this.props.stateMachineInput) ? this.props.stateMachineInput.inputType : undefined,
	InputType: this.props.stateMachineInput?.inputType,

feat(codepipeline): add support for a StepFunctions invoke action #8931

feat(codepipeline): add support for a StepFunctions invoke action #8931

Conversation

madhumitranrl commented Jul 7, 2020

skinny85 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skinny85 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skinny85 Jul 16, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skinny85 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skinny85 left a comment

Choose a reason for hiding this comment

mergify bot commented Jul 18, 2020

mergify bot commented Jul 18, 2020

aws-cdk-automation commented Jul 18, 2020

AWS CodeBuild CI Report

madhumitranrl commented Jul 18, 2020

skinny85 Jul 16, 2020 •

edited

Loading