Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(cli): improve error message for cdk migrate #29392

Merged
merged 9 commits into from Mar 8, 2024

Conversation

colifran
Copy link
Contributor

@colifran colifran commented Mar 7, 2024

Reason for this change

This change is a follow-up to a PR that improved the error message thrown by cdk-from-cfn when an invalid resource property was used in a CloudFormation template. This PR further improves the error message on the cli side.

Description of changes

Primarily, this PR is a verbiage change. The base error message now states that the <stack-name> could not be generated because <error-message>. The error message itself is checked against unreachable because any use of panic!, unreachable!, or unimplemented! will cause the cdk-from-cfn source code to panic in-place. In the resulting wasm binary, this produces a RuntimeError that has an error message of unreachable. I've improved this slightly by stating template and/or language inputs caused the source code to panic. If the error message is not unreachable, then the error message is taken as is with TransmuteError: replaced.

Note that we should still continue to improve our error messages in cdk-from-cfn by by replacing panic!, unreachable!, and unimplemented! with more detailed error messages.

Description of how you validated changes

An existing unit test was changed based on the error message verbiage change. Additionally, a new unit test was added to validate that the expected error message would be thrown by the cli when an invalid resource property was used in a CloudFormation template.

Checklist


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

Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
@github-actions github-actions bot added the p2 label Mar 7, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team March 7, 2024 00:58
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Mar 7, 2024
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@aws-cdk-automation aws-cdk-automation added the pr/needs-cli-test-run This PR needs CLI tests run against it. label Mar 7, 2024
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
@aws-cdk-automation
Copy link
Collaborator

➡️ PR build request submitted to test-main-pipeline ⬅️

A maintainer must now check the pipeline and add the pr-linter/cli-integ-tested label once the pipeline succeeds.

@TheRealAmazonKendra
Copy link
Contributor

@Mergifyio update

Copy link
Contributor

mergify bot commented Mar 8, 2024

update

✅ Branch has been successfully updated

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@TheRealAmazonKendra TheRealAmazonKendra added the pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested label Mar 8, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review March 8, 2024 16:25

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

@aws-cdk-automation aws-cdk-automation removed the pr/needs-cli-test-run This PR needs CLI tests run against it. label Mar 8, 2024
Copy link
Contributor

mergify bot commented Mar 8, 2024

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).

@mergify mergify bot merged commit 110c79f into main Mar 8, 2024
17 of 19 checks passed
@mergify mergify bot deleted the colifran/improve-error-message branch March 8, 2024 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS. p2 pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants