feat(aws-fargate-stepfunctions): new construct #677

mickychetta · 2022-05-02T23:14:30Z

Issue #676 , if available:

Description of changes:
Should create a VPC or accept an existing VPC
Should create a Fargate Service or accept an existing service
Should create a new step function or accept an existing step function
Should grant the service IAM permission to read/write to the function
Should set up environment variables in the service that identify the function in the construct code so the container can read/write from the function

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

fixes #676

aws-solutions-constructs-team · 2022-05-02T23:21:17Z

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v1
Commit ID: 784c72f
Result: FAILED
Build Logs (available for 30 days)

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

aws-solutions-constructs-team · 2022-05-02T23:22:15Z

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 784c72f
Result: FAILED
Build Logs (available for 30 days)

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

source/patterns/@aws-solutions-constructs/aws-fargate-stepfunctions/README.md

aws-solutions-constructs-team · 2022-05-03T21:02:47Z

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v1
Commit ID: 499666c
Result: FAILED
Build Logs (available for 30 days)

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

aws-solutions-constructs-team · 2022-05-03T21:03:37Z

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 499666c
Result: FAILED
Build Logs (available for 30 days)

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

aws-solutions-constructs-team · 2022-05-03T21:06:49Z

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v1
Commit ID: 66b6390
Result: FAILED
Build Logs (available for 30 days)

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

aws-solutions-constructs-team · 2022-05-03T21:08:27Z

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 66b6390
Result: FAILED
Build Logs (available for 30 days)

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

DESIGN_GUIDELINES.md

aws-solutions-constructs-team · 2022-05-05T19:24:17Z

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: febfed8
Result: SUCCEEDED
Build Logs (available for 30 days)

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

aws-solutions-constructs-team · 2022-05-05T19:25:27Z

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v1
Commit ID: febfed8
Result: SUCCEEDED
Build Logs (available for 30 days)

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

aws-solutions-constructs-team · 2022-05-05T19:34:00Z

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 573f7ee
Result: SUCCEEDED
Build Logs (available for 30 days)

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

aws-solutions-constructs-team · 2022-05-05T19:34:35Z

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v1
Commit ID: 573f7ee
Result: SUCCEEDED
Build Logs (available for 30 days)

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

…nstructs into 676

aws-solutions-constructs-team · 2022-05-05T21:47:45Z

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 91e0b15
Result: SUCCEEDED
Build Logs (available for 30 days)

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

aws-solutions-constructs-team · 2022-05-05T21:48:50Z

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v1
Commit ID: 91e0b15
Result: SUCCEEDED
Build Logs (available for 30 days)

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

source/patterns/@aws-solutions-constructs/aws-fargate-stepfunctions/lib/index.ts

biffgaut · 2022-05-06T21:22:21Z

...terns/@aws-solutions-constructs/aws-fargate-stepfunctions/test/fargate-stepfunctions.test.ts

+  expect(stack).toCountResources('AWS::ECS::Service', 1);
+}
+
+function checkForBaseResources(stack: cdk.Stack) {


Not a fan of this - makes it difficult to see what each test is looking for. Let's not do this here, and going forward - our new style of checking 1 thing in each test should eliminate our need to have lots of checks duplicated between tests.

If you'd rather change to the new testing style here rather than replacing all these statements, that's fine (although I think replacing the statements would be quicker, even if it annoys... :-) )

biffgaut · 2022-05-06T21:25:35Z

...terns/@aws-solutions-constructs/aws-fargate-stepfunctions/test/fargate-stepfunctions.test.ts

+  return defaults.consolidateProps(defaultTestProp, userProps);
+}
+
+function serviceTest() {


Saw all these after i saw CheckForBaseResources() below. Same principle applies - if we don't want to replicate this extensive code/json, then let's rearrange the tests so it only appears once. For these especially, at some point a change in a single test will cause that test to start to fail and we'll have to unwind this change for that test.

aws-solutions-constructs-team · 2022-05-09T20:00:58Z

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 2bd711e
Result: SUCCEEDED
Build Logs (available for 30 days)

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

aws-solutions-constructs-team · 2022-05-09T20:01:50Z

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v1
Commit ID: 2bd711e
Result: SUCCEEDED
Build Logs (available for 30 days)

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

aws-solutions-constructs-team · 2022-05-09T20:03:36Z

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 2841828
Result: SUCCEEDED
Build Logs (available for 30 days)

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

aws-solutions-constructs-team · 2022-05-09T20:04:35Z

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v1
Commit ID: 2841828
Result: SUCCEEDED
Build Logs (available for 30 days)

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

aws-solutions-constructs-team · 2022-05-09T20:14:50Z

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v1
Commit ID: 493e45b
Result: SUCCEEDED
Build Logs (available for 30 days)

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

aws-solutions-constructs-team · 2022-05-09T20:15:06Z

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 493e45b
Result: SUCCEEDED
Build Logs (available for 30 days)

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

biffgaut · 2022-05-10T12:30:46Z

...terns/@aws-solutions-constructs/aws-fargate-stepfunctions/test/fargate-stepfunctions.test.ts

  expect(stack).toHaveResourceLike("AWS::Logs::LogGroup", {
    LogGroupName: logGroupName
  });
 });

+function createFargateConstructWithNewResources(stack: cdk.Stack, publicApi: boolean) {
+  return new FargateToStepfunctions(stack, 'test-construct', {


This is the actual setup that's being tested - I don't think saving 10 lines of code in a test at the expense of hiding the the target of the test is a good tradeoff.

Let's leave it like this for now - but let's discuss the idea with the Clean Code group next week to see what a larger audience thinks going forward.

biffgaut · 2022-05-10T12:31:57Z

...terns/@aws-solutions-constructs/aws-fargate-stepfunctions/test/fargate-stepfunctions.test.ts

+    containerDefinitionProps: { containerName },
+    fargateTaskDefinitionProps: { family: familyName },
+    fargateServiceProps: { serviceName },
+    stateMachineProps: testStateMachineProps(stack),


This I like (testStateMachineProps).

* chore(release): 2.7.0 * chore(changelog): Updated CHANGELOG.v2.md * feat(aws-fargate-stepfunctions): new construct (#677) * created README.md * removed arn env var prop and fixed state machine doc comments * made createCloudWatchAlarms prop optional * created new construct * fixed README typo * refactored test to single concept design * updated default for vpcProps * Update copyright year to 2022 (#693) Skipping review, only copyright messages have been changed. * fix(Test Coverage): Improve test coverage of 2 core files (#691) * Added additional tests * More coverage based on review * chore(Improve documentation): Environment Variable descriptions (#692) * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update Environment Variable documenation/comments * Results of self-review * Response to review * Review 2 * Review 3 * Update DESIGN_GUIDELINES.md * Pin @types/prettier 2.6.0 til 2.6.1 issue resolved (#698) No one is available to review and this is time sensitive. The nature of the change makes any review rather perfunctory as it a single line added to the package.json file * chore(release): 1.155.0 * chore(changelog): Updated CHANGELOG.md * chore(changelog): Updated CHANGELOG.md * Refresh to accomodate CDK changes * Align CDK V2 version * Align CDK Versions * Align CDK Versions Co-authored-by: biffgaut <[email protected]> Co-authored-by: mickychetta <[email protected]>

* chore(release): 2.7.0 * chore(changelog): Updated CHANGELOG.v2.md * feat(aws-fargate-stepfunctions): new construct (#677) * created README.md * removed arn env var prop and fixed state machine doc comments * made createCloudWatchAlarms prop optional * created new construct * fixed README typo * refactored test to single concept design * updated default for vpcProps * Update copyright year to 2022 (#693) Skipping review, only copyright messages have been changed. * fix(Test Coverage): Improve test coverage of 2 core files (#691) * Added additional tests * More coverage based on review * chore(Improve documentation): Environment Variable descriptions (#692) * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update Environment Variable documenation/comments * Results of self-review * Response to review * Review 2 * Review 3 * Update DESIGN_GUIDELINES.md * Pin @types/prettier 2.6.0 til 2.6.1 issue resolved (#698) No one is available to review and this is time sensitive. The nature of the change makes any review rather perfunctory as it a single line added to the package.json file * chore(release): 1.155.0 * chore(changelog): Updated CHANGELOG.md * chore(changelog): Updated CHANGELOG.md * Refresh to accomodate CDK changes * Align CDK V2 version * Align CDK Versions * Align CDK Versions Co-authored-by: biffgaut <[email protected]> Co-authored-by: mickychetta <[email protected]> Co-authored-by: biffgaut <[email protected]> Co-authored-by: mickychetta <[email protected]>

* chore(release): 2.7.0 * chore(changelog): Updated CHANGELOG.v2.md * feat(aws-fargate-stepfunctions): new construct (#677) * created README.md * removed arn env var prop and fixed state machine doc comments * made createCloudWatchAlarms prop optional * created new construct * fixed README typo * refactored test to single concept design * updated default for vpcProps * Update copyright year to 2022 (#693) Skipping review, only copyright messages have been changed. * fix(Test Coverage): Improve test coverage of 2 core files (#691) * Added additional tests * More coverage based on review * chore(Improve documentation): Environment Variable descriptions (#692) * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update Environment Variable documenation/comments * Results of self-review * Response to review * Review 2 * Review 3 * Update DESIGN_GUIDELINES.md * Pin @types/prettier 2.6.0 til 2.6.1 issue resolved (#698) No one is available to review and this is time sensitive. The nature of the change makes any review rather perfunctory as it a single line added to the package.json file * chore(release): 1.155.0 (#699) (#701) * chore(release): 2.7.0 * chore(changelog): Updated CHANGELOG.v2.md * feat(aws-fargate-stepfunctions): new construct (#677) * created README.md * removed arn env var prop and fixed state machine doc comments * made createCloudWatchAlarms prop optional * created new construct * fixed README typo * refactored test to single concept design * updated default for vpcProps * Update copyright year to 2022 (#693) Skipping review, only copyright messages have been changed. * fix(Test Coverage): Improve test coverage of 2 core files (#691) * Added additional tests * More coverage based on review * chore(Improve documentation): Environment Variable descriptions (#692) * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update Environment Variable documenation/comments * Results of self-review * Response to review * Review 2 * Review 3 * Update DESIGN_GUIDELINES.md * Pin @types/prettier 2.6.0 til 2.6.1 issue resolved (#698) No one is available to review and this is time sensitive. The nature of the change makes any review rather perfunctory as it a single line added to the package.json file * chore(release): 1.155.0 * chore(changelog): Updated CHANGELOG.md * chore(changelog): Updated CHANGELOG.md * Refresh to accomodate CDK changes * Align CDK V2 version * Align CDK Versions * Align CDK Versions Co-authored-by: biffgaut <[email protected]> Co-authored-by: mickychetta <[email protected]> Co-authored-by: biffgaut <[email protected]> Co-authored-by: mickychetta <[email protected]> * Expedited update to address @types/prettier versioning issue. * chore(release): 1.156.0 * chore(changelog): Updated CHANGELOG.md Co-authored-by: biffgaut <[email protected]> Co-authored-by: mickychetta <[email protected]>

* chore(release): 1.155.0 (#699) * chore(release): 2.7.0 * chore(changelog): Updated CHANGELOG.v2.md * feat(aws-fargate-stepfunctions): new construct (#677) * created README.md * removed arn env var prop and fixed state machine doc comments * made createCloudWatchAlarms prop optional * created new construct * fixed README typo * refactored test to single concept design * updated default for vpcProps * Update copyright year to 2022 (#693) Skipping review, only copyright messages have been changed. * fix(Test Coverage): Improve test coverage of 2 core files (#691) * Added additional tests * More coverage based on review * chore(Improve documentation): Environment Variable descriptions (#692) * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update Environment Variable documenation/comments * Results of self-review * Response to review * Review 2 * Review 3 * Update DESIGN_GUIDELINES.md * Pin @types/prettier 2.6.0 til 2.6.1 issue resolved (#698) No one is available to review and this is time sensitive. The nature of the change makes any review rather perfunctory as it a single line added to the package.json file * chore(release): 1.155.0 * chore(changelog): Updated CHANGELOG.md * chore(changelog): Updated CHANGELOG.md * Refresh to accomodate CDK changes * Align CDK V2 version * Align CDK Versions * Align CDK Versions Co-authored-by: biffgaut <[email protected]> Co-authored-by: mickychetta <[email protected]> * chore(release): 1.156.0 (#704) * chore(release): 2.7.0 * chore(changelog): Updated CHANGELOG.v2.md * feat(aws-fargate-stepfunctions): new construct (#677) * created README.md * removed arn env var prop and fixed state machine doc comments * made createCloudWatchAlarms prop optional * created new construct * fixed README typo * refactored test to single concept design * updated default for vpcProps * Update copyright year to 2022 (#693) Skipping review, only copyright messages have been changed. * fix(Test Coverage): Improve test coverage of 2 core files (#691) * Added additional tests * More coverage based on review * chore(Improve documentation): Environment Variable descriptions (#692) * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update Environment Variable documenation/comments * Results of self-review * Response to review * Review 2 * Review 3 * Update DESIGN_GUIDELINES.md * Pin @types/prettier 2.6.0 til 2.6.1 issue resolved (#698) No one is available to review and this is time sensitive. The nature of the change makes any review rather perfunctory as it a single line added to the package.json file * chore(release): 1.155.0 (#699) (#701) * chore(release): 2.7.0 * chore(changelog): Updated CHANGELOG.v2.md * feat(aws-fargate-stepfunctions): new construct (#677) * created README.md * removed arn env var prop and fixed state machine doc comments * made createCloudWatchAlarms prop optional * created new construct * fixed README typo * refactored test to single concept design * updated default for vpcProps * Update copyright year to 2022 (#693) Skipping review, only copyright messages have been changed. * fix(Test Coverage): Improve test coverage of 2 core files (#691) * Added additional tests * More coverage based on review * chore(Improve documentation): Environment Variable descriptions (#692) * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update Environment Variable documenation/comments * Results of self-review * Response to review * Review 2 * Review 3 * Update DESIGN_GUIDELINES.md * Pin @types/prettier 2.6.0 til 2.6.1 issue resolved (#698) No one is available to review and this is time sensitive. The nature of the change makes any review rather perfunctory as it a single line added to the package.json file * chore(release): 1.155.0 * chore(changelog): Updated CHANGELOG.md * chore(changelog): Updated CHANGELOG.md * Refresh to accomodate CDK changes * Align CDK V2 version * Align CDK Versions * Align CDK Versions Co-authored-by: biffgaut <[email protected]> Co-authored-by: mickychetta <[email protected]> Co-authored-by: biffgaut <[email protected]> Co-authored-by: mickychetta <[email protected]> * Expedited update to address @types/prettier versioning issue. * chore(release): 1.156.0 * chore(changelog): Updated CHANGELOG.md Co-authored-by: biffgaut <[email protected]> Co-authored-by: mickychetta <[email protected]> Co-authored-by: biffgaut <[email protected]> Co-authored-by: mickychetta <[email protected]>

created README.md

784c72f

mickychetta self-assigned this May 2, 2022

mickychetta requested review from biffgaut, hayesry, mobri2a and emcfins as code owners May 2, 2022 23:14

biffgaut requested changes May 3, 2022

View reviewed changes

mickychetta added 2 commits May 3, 2022 20:56

removed arn env var prop and fixed state machine doc comments

499666c

made createCloudWatchAlarms prop optional

66b6390

biffgaut previously approved these changes May 4, 2022

View reviewed changes

DESIGN_GUIDELINES.md Show resolved Hide resolved

created new construct

febfed8

mickychetta dismissed biffgaut’s stale review via febfed8 May 5, 2022 19:16

Merge branch 'main' into 676

573f7ee

mickychetta added 2 commits May 5, 2022 21:39

fixed README typo

e4bfd85

Merge branch '676' of https://github.com/mickychetta/aws-solutions-co…

91e0b15

…nstructs into 676

biffgaut requested changes May 6, 2022

View reviewed changes

mickychetta added 2 commits May 9, 2022 19:53

refactored test to single concept design

2bd711e

updated default for vpcProps

2841828

Merge branch 'main' into 676

493e45b

biffgaut approved these changes May 10, 2022

View reviewed changes

biffgaut merged commit f4829ba into awslabs:main May 10, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(aws-fargate-stepfunctions): new construct #677

feat(aws-fargate-stepfunctions): new construct #677

mickychetta commented May 2, 2022 •

edited

Loading

aws-solutions-constructs-team commented May 2, 2022

aws-solutions-constructs-team commented May 2, 2022

aws-solutions-constructs-team commented May 3, 2022

aws-solutions-constructs-team commented May 3, 2022

aws-solutions-constructs-team commented May 3, 2022

aws-solutions-constructs-team commented May 3, 2022

aws-solutions-constructs-team commented May 5, 2022

aws-solutions-constructs-team commented May 5, 2022

aws-solutions-constructs-team commented May 5, 2022

aws-solutions-constructs-team commented May 5, 2022

aws-solutions-constructs-team commented May 5, 2022

aws-solutions-constructs-team commented May 5, 2022

biffgaut May 6, 2022

biffgaut May 6, 2022

biffgaut May 6, 2022

aws-solutions-constructs-team commented May 9, 2022

aws-solutions-constructs-team commented May 9, 2022

aws-solutions-constructs-team commented May 9, 2022

aws-solutions-constructs-team commented May 9, 2022

aws-solutions-constructs-team commented May 9, 2022

aws-solutions-constructs-team commented May 9, 2022

biffgaut May 10, 2022

biffgaut May 10, 2022

feat(aws-fargate-stepfunctions): new construct #677

feat(aws-fargate-stepfunctions): new construct #677

Conversation

mickychetta commented May 2, 2022 • edited Loading

aws-solutions-constructs-team commented May 2, 2022

AWS CodeBuild CI Report

aws-solutions-constructs-team commented May 2, 2022

AWS CodeBuild CI Report

aws-solutions-constructs-team commented May 3, 2022

AWS CodeBuild CI Report

aws-solutions-constructs-team commented May 3, 2022

AWS CodeBuild CI Report

aws-solutions-constructs-team commented May 3, 2022

AWS CodeBuild CI Report

aws-solutions-constructs-team commented May 3, 2022

AWS CodeBuild CI Report

aws-solutions-constructs-team commented May 5, 2022

AWS CodeBuild CI Report

aws-solutions-constructs-team commented May 5, 2022

AWS CodeBuild CI Report

aws-solutions-constructs-team commented May 5, 2022

AWS CodeBuild CI Report

aws-solutions-constructs-team commented May 5, 2022

AWS CodeBuild CI Report

aws-solutions-constructs-team commented May 5, 2022

AWS CodeBuild CI Report

aws-solutions-constructs-team commented May 5, 2022

AWS CodeBuild CI Report

biffgaut May 6, 2022

Choose a reason for hiding this comment

biffgaut May 6, 2022

Choose a reason for hiding this comment

biffgaut May 6, 2022

Choose a reason for hiding this comment

aws-solutions-constructs-team commented May 9, 2022

AWS CodeBuild CI Report

aws-solutions-constructs-team commented May 9, 2022

AWS CodeBuild CI Report

aws-solutions-constructs-team commented May 9, 2022

AWS CodeBuild CI Report

aws-solutions-constructs-team commented May 9, 2022

AWS CodeBuild CI Report

aws-solutions-constructs-team commented May 9, 2022

AWS CodeBuild CI Report

aws-solutions-constructs-team commented May 9, 2022

AWS CodeBuild CI Report

biffgaut May 10, 2022

Choose a reason for hiding this comment

biffgaut May 10, 2022

Choose a reason for hiding this comment

mickychetta commented May 2, 2022 •

edited

Loading