chore(app-staging-synthesizer-alpha): app staging stack description

[blimmer]

This PR adds a small improvement for the experimental AppStagingSynthesizer. Currently, there is no description on the app support stack:

However, the default bootstrap stack does have a helpful description:

So, this PR adds a description to support stacks so people know what they are.

---

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

[blimmer]

Feedback on this description is welcome.

I based this on the default CDKToolkit stack description:

This stack includes resources needed to deploy AWS CDK apps into this environment

Do we want to include the term AppStagingSynthesizer?

[paulhcsun]

I think the current description is probably fine as is. Users will be able to easily check that resources are being created by checking the Resources tab anyway.

[kaizencc]

One thing that we're not considering. The support stack (since it cannot be bootstrapped) must be uploaded to CFN directly, and CFN supports a max size of 51,200 bytes. The app support stack is dynamic because it entirely depends on how many ECR/S3 resources you want. So the description cuts into that.

Somewhere we are promising a number of ECR resources allowed per staging stack. That number could go down as a result of this.

That being said, we probably are ok with this.

[aws-cdk-automation]

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

[blimmer]

Renaming to docs - adding a test for this feels like overkill, but I can if people feel strongly.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

[paulhcsun]

Looks like one of the snapshots changed causing the app-staging-synthesizer-alpha/test/integ.synth-default-resources.js integ test to fail. Should be fixed if you run the integ test and include the updated snapshot.

Pull request has been modified.

[blimmer]

Fixed!

[paulhcsun]

I think you'll need to run the integ test with the --update-on-failed flag and then add all of the snapshot files to the PR @blimmer

[blimmer]

I tried doing that, but it's giving me an error, like it wants to connect to my actual AWS account:

 yarn integ --update-on-failed
yarn run v1.22.21
$ integ-runner --update-on-failed

Verifying integration test snapshots...

  CHANGED    integ.synth-default-resources 7.81s
      Template
[+] Description Description: This stack includes resources needed to deploy the AWS CDK app default-resourcesmax into this environment



Snapshot Results:

Tests:    1 failed, 1 total
Failed: /Users/blimmer/code/aws-cdk/packages/@aws-cdk/app-staging-synthesizer-alpha/test/integ.synth-default-resources.ts

Running integration tests for failed tests...

Running in parallel across regions: us-east-1, us-east-2, us-west-2
Running test /Users/blimmer/code/aws-cdk/packages/@aws-cdk/app-staging-synthesizer-alpha/test/integ.synth-default-resources.ts in us-east-1

✨  Synthesis time: 0.01s


 ❌ Deployment failed: Error: Unable to resolve AWS account to use. It must be either configured when you define your CDK Stack, or through the environment
    at SdkProvider.resolveEnvironment (/Users/blimmer/code/aws-cdk/packages/aws-cdk/lib/api/aws-auth/sdk-provider.js:159:19)

Unable to resolve AWS account to use. It must be either configured when you define your CDK Stack, or through the environment
  FAILED     integ.synth-default-resources-integ-tests/DefaultTest (undefined/us-east-1) 10.509s
      Integration test failed: Error: Command exited with status 1

Test Results:

Tests:    1 failed, 1 total
Error: Some integration tests failed!
    at main (/Users/blimmer/code/aws-cdk/packages/@aws-cdk/integ-runner/lib/cli.js:165:23)
integ-tests/DefaultTest/DeployAssert: destroying... [1/3]

 ❌  integ-tests/DefaultTest/DeployAssert: destroy failed Error: Unable to resolve AWS account to use. It must be either configured when you define your CDK Stack, or through the environment
    at SdkProvider.resolveEnvironment (/Users/blimmer/code/aws-cdk/packages/aws-cdk/lib/api/aws-auth/sdk-provider.js:159:19)

Unable to resolve AWS account to use. It must be either configured when you define your CDK Stack, or through the environment
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

So I tried to cheat and just surgically update the single file. Clearly I missed something - let me run through the docs again and try to figure out how to get integration test updates working locally.

Or I'll surgically update the .js flavor too 😄

[paulhcsun]

If you already have an AWS account then you may just need to run aws configure and get that set up so that the integ test and run the deployment: https://cdkworkshop.com/15-prerequisites/200-account.html#configure-your-credentials. I don't think the integ tests will pass unless you're able to submit those snapshots. Give that a try if let me know if it helps. If not I can probably go in and run that integ test for you on your branch.

[blimmer]

Thanks for the detailed instructions! I was able to get it working.

[mergify]

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

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: ef73f8c
• Result: SUCCEEDED
• Build Logs (available for 30 days)

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

[mergify]

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