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

fix(cli): warns about missing --no-rollback flag that is present #32309

Merged
merged 5 commits into from
Nov 28, 2024

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Nov 27, 2024

The logic on rollback and !rollback was inverted in a couple of places, causing the check to be the wrong way around and making reasoning about these options harder.

Revert the logic and do a more comprehensive test suite around these options.

Also remove a stray debug() statement that was left in from a previous PR, and show the stack status in the error message.

Closes #32295.


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

@rix0rrr rix0rrr requested a review from a team as a code owner November 27, 2024 14:02
@github-actions github-actions bot added bug This issue is a bug. p2 labels Nov 27, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team November 27, 2024 14:02
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Nov 27, 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 Nov 27, 2024
Copy link

codecov bot commented Nov 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.36%. Comparing base (512cf95) to head (01dfa6b).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #32309      +/-   ##
==========================================
+ Coverage   78.34%   78.36%   +0.02%     
==========================================
  Files         105      105              
  Lines        7170     7170              
  Branches     1315     1315              
==========================================
+ Hits         5617     5619       +2     
+ Misses       1365     1364       -1     
+ Partials      188      187       -1     
Flag Coverage Δ
suite.unit 78.36% <100.00%> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
packages/aws-cdk 78.36% <100.00%> (+0.02%) ⬆️

[StackStatus.UPDATE_FAILED, 'no-rollback', 'no-replacement', 'did-deploy-stack'],
[StackStatus.UPDATE_FAILED, 'no-rollback', 'replacement', 'failpaused-need-rollback-first'],
[StackStatus.UPDATE_FAILED, 'rollback', 'replacement', 'failpaused-need-rollback-first'],
[StackStatus.UPDATE_COMPLETE, 'no-rollback', 'replacement', 'replacement-requires-rollback'],

Choose a reason for hiding this comment

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

I haven't traced through the code fully, but this seems to read that replacement-requires-rollback, will successfully complete when a replacement is needed but we passed in no-rollback.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When the stack is in a stable state (UPDATE_COMPLETE), the user passes --no-rollback, and there is a replacement to do, the deployStack function will say: replacement-requires-rollback.

That is to say, the combination of replacement and no-rollback is not possible. This is a CloudFormation limitation.

What will happen in practice is that our CLI will catch this return code and ask "Do you want to perform a regular (--rollback) deployment (y/n)?"

@rix0rrr rix0rrr added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Nov 28, 2024
@rix0rrr rix0rrr changed the title fix: CLI warns about missing --no-rollback flag that is present fix(cli): warns about missing --no-rollback flag that is present Nov 28, 2024
@github-actions github-actions bot added the effort/small Small work item – less than a day of effort label Nov 28, 2024
@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.

@@ -951,7 +951,6 @@ export class SDK {
});
const command = new GetCallerIdentityCommand({});
const result = await client.send(command);
debug(result.Account!, result.Arn, result.UserId);
Copy link
Contributor

Choose a reason for hiding this comment

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

Why remove?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Pretty sure this is a debug line left by Otavio :).

In any case, I don't want just the account number, ARN and userId printed to the log without text.

@rix0rrr rix0rrr added the pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested label Nov 28, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review November 28, 2024 16:54

✅ 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 Nov 28, 2024
Copy link
Contributor

mergify bot commented Nov 28, 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).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@mergify mergify bot merged commit 559d676 into main Nov 28, 2024
16 of 17 checks passed
@mergify mergify bot deleted the huijbers/inverted-logic branch November 28, 2024 17:27
Copy link
Contributor

mergify bot commented Nov 28, 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).

Copy link

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug This issue is a bug. contribution/core This is a PR that came from AWS. effort/small Small work item – less than a day of effort p2 pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested pr-linter/exempt-integ-test The PR linter will not require integ test changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

AwsCdkCli: cdk deploy tries automatic rollback even when --no-rollback specified
4 participants