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 diff always falls back to template only diff #32165

Merged
merged 1 commit into from
Nov 17, 2024

Conversation

iliapolo
Copy link
Contributor

@iliapolo iliapolo commented Nov 17, 2024

Closes #32160

Reason for this change

When running cdk deploy, it is supposed to (by default) create a read-only change set and incorporate it within the diff.
However, it currently fails creating the change-set and always falls back to template only diffs.

Description of changes

There was a wrong invocation of the makeBodyParameter parameter after the migration to sdk v3.

Description of how you validated changes

Added missing integration tests. Unit test for this code are tricky because they require too many mocks.

Checklist


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

@aws-cdk-automation aws-cdk-automation requested a review from a team November 17, 2024 18:15
@github-actions github-actions bot added bug This issue is a bug. p1 labels Nov 17, 2024
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Nov 17, 2024
@@ -1064,6 +1064,46 @@ integTest(
}),
);

integTest(
'cdk diff doesnt show resource metadata changes',
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not entirely sure why, but removing resource metadata changes is the expected behavior when performing diffs with change-sets (see #28336), so this is a solid way to make sure the diff actually creates the change set and uses it.

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 17, 2024
});

// Assert there are no changes
expect(diff).toContain('There were no differences');
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 ideal but better than asserting on a debug statement. I don't see us changing this specific output string any time soon.

@@ -400,7 +400,6 @@ async function uploadBodyParameterAndCreateChangeSet(
env.resolvedEnvironment,
new AssetManifestBuilder(),
env.resources,
env.sdk,
Copy link
Contributor Author

@iliapolo iliapolo Nov 17, 2024

Choose a reason for hiding this comment

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

It doesn't need the SDK anymore because:

// SDK v3 no longer allows for getting endpoints from only region.
// A command and client config must now be provided.
const s3 = new S3Client({ region });
const endpoint = await getEndpointFromInstructions({}, HeadObjectCommand, {
...s3.config,
});
endpoint.url.hostname;

Not removing it from the invocation resulted in it being passed as the overrideTemplate argument to the function (which is of type any), which later on is being passed to YAML for serialization. So...thats no good.

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

Copy link

codecov bot commented Nov 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.19%. Comparing base (740db43) to head (bec3406).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #32165   +/-   ##
=======================================
  Coverage   77.19%   77.19%           
=======================================
  Files         105      105           
  Lines        7164     7164           
  Branches     1311     1311           
=======================================
  Hits         5530     5530           
  Misses       1454     1454           
  Partials      180      180           
Flag Coverage Δ
suite.unit 77.19% <ø> (ø)

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

Components Coverage Δ
packages/aws-cdk 77.19% <ø> (ø)

@mrgrain mrgrain added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Nov 17, 2024
@mrgrain
Copy link
Contributor

mrgrain commented Nov 17, 2024

Build passed in CodeBuild. Not clear why status not reported back.

@mrgrain mrgrain added pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested and removed pr/needs-cli-test-run This PR needs CLI tests run against it. labels Nov 17, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review November 17, 2024 20:38

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

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

Copy link
Contributor

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

@mrgrain mrgrain merged commit 089e9d8 into main Nov 17, 2024
42 of 48 checks passed
@mrgrain mrgrain deleted the epolon/changeset-diff branch November 17, 2024 21:45
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 17, 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. p1 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.

CDK CLI: Tag not resolved for AsyncFunction value
3 participants