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): cdk deploy -R does not disable rollback #32514

Merged
merged 6 commits into from
Dec 13, 2024

Conversation

mrgrain
Copy link
Contributor

@mrgrain mrgrain commented Dec 13, 2024

Issue

cdk deploy -R should be the same as cdk deploy --no-rollback or cdk deploy --rollback=false, but has no effect

Reason for this change

PR #31850 introduced this bug by accidentally flipping the order of arguments passed to the yargsNegativeAlias helper.
This caused the helper to have no effect.

Description of changes

  • Changed the codegen to fully generate negative aliases for the user
  • Fixed the generate code to use the correct argument order again for yargsNegativeAlias
  • Renamed the parameters to make it easier to understand.
  • Made nargs: 1 and requiresArg: true implied for all array options. Some options did miss one or both of these. This was an oversight.

Description of how you validated changes

Added an explicit test case for -R.

Checklist


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

imply `nargs: 1` and `requiresArg: true` for all arrays
@mrgrain mrgrain requested a review from a team as a code owner December 13, 2024 16:13
@github-actions github-actions bot added the p2 label Dec 13, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team December 13, 2024 16:14
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Dec 13, 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 Dec 13, 2024
@@ -527,18 +528,6 @@ function arrayFromYargs(xs: string[]): string[] | undefined {
return xs.filter((x) => x !== '');
}

function yargsNegativeAlias<T extends { [x in S | L]: boolean | undefined }, S extends string, L extends string>(
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Moved to a separate file so it can be used in tests.

@@ -436,7 +424,7 @@ export class DynamicValue {
public static fromInline(f: () => any): DynamicResult {
return {
dynamicType: 'function',
dynamicValue: f,
dynamicValue: f.toString(),
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This makes the config object structuredClone-able. Previously toString() was just called a little later.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

All removals in this file are now codgened instead.

@@ -39,6 +39,7 @@ export function parseCommandLineArguments(
alias: 'p',
desc: 'Name or path of a node package that extend the CDK features. Can be specified multiple times',
nargs: 1,
requiresArg: true,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is fixing a previous oversight.

Comment on lines +152 to +153
nargs: 1,
requiresArg: true,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is fixing a previous oversight.

desc: 'Do not rebuild asset with the given ID. Can be specified multiple times',
default: [],
nargs: 1,
requiresArg: true,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is fixing a previous oversight.

desc: 'Do not rebuild asset with the given ID. Can be specified multiple times',
default: [],
nargs: 1,
requiresArg: true,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is fixing a previous oversight.

Comment on lines +736 to +737
nargs: 1,
requiresArg: true,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is fixing a previous oversight.

@@ -34,6 +26,9 @@ export interface YargsOption {
requiresArg?: boolean;
hidden?: boolean;
count?: boolean;
}

export interface CliOption extends Omit<YargsOption, 'nargs' | 'hidden'> {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not every YargsOption property is directly available to the CliConfig.

Comment on lines -18 to -19
nargs: 1,
requiresArg: true,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed here, but snapshot is unchanged.

@mrgrain mrgrain force-pushed the mrgrain/chore/cleanup-cli-options branch from f1912cd to 5b0881d Compare December 13, 2024 16:25
@mrgrain mrgrain added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Dec 13, 2024
@mrgrain
Copy link
Contributor Author

mrgrain commented Dec 13, 2024

Covered by existing CLI integ tests. The actual fix was verified through a unit test.

Copy link

codecov bot commented Dec 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.77%. Comparing base (f937d30) to head (789c769).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #32514      +/-   ##
==========================================
+ Coverage   78.66%   78.77%   +0.11%     
==========================================
  Files         107      108       +1     
  Lines        7161     7162       +1     
  Branches     1320     1320              
==========================================
+ Hits         5633     5642       +9     
+ Misses       1343     1335       -8     
  Partials      185      185              
Flag Coverage Δ
suite.unit 78.77% <100.00%> (+0.11%) ⬆️

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

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

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

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@mrgrain mrgrain removed the pr/needs-cli-test-run This PR needs CLI tests run against it. label Dec 13, 2024
@@ -1,6 +1,6 @@
#!/usr/bin/env node
// source maps must be enabled before importing files
process.setSourceMapsEnabled(true);
const { cli } = require("../lib/cli");
const { cli } = require("../lib");
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This fixed the failing build introduced by #32476

@aws-cdk-automation aws-cdk-automation dismissed their stale review December 13, 2024 22:08

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

Copy link
Contributor

mergify bot commented Dec 13, 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 2e75924 into main Dec 13, 2024
23 of 25 checks passed
@mergify mergify bot deleted the mrgrain/chore/cleanup-cli-options branch December 13, 2024 22:08
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 Dec 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
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 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.

3 participants