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: add aws-sdk as dev dependency for unit tests and satisfy AwsSdkCall in unit tests #29860

Merged
merged 3 commits into from
Apr 17, 2024

Conversation

colifran
Copy link
Contributor

@colifran colifran commented Apr 17, 2024

Reason for this change

#29648 introduced a change to the AwsSdkCall representation used in the v2 and v3 handler code. Our handler unit tests use satisfies to validate that the event object satisfies AwsSdkCall. All unit tests and the build still pass, but the linter calls out that the event object doesn't actually satisfy AwsSdkCall.

#29845 removed the dependency @aws-cdk/custom-resource-handlers had on aws-sdk. We should add this as devDependency since we're using aws-sdk in v2 handler mocks.

Description of changes

I added logApiResponseData property to the event objects being tested to make the event satisfy AwsSdkCall. I added aws-sdk as a dev dependency. We will remove this as part of the v2 handler removal.

Checklist


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

@github-actions github-actions bot added the p2 label Apr 17, 2024
@colifran colifran changed the title chore: add back aws-sdk dependency for unit tests and satisfy AwsSdkCall in unit tests chore: add back aws-sdk dependency for unit tests and satisfy AwsSdkCall in unit tests Apr 17, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team April 17, 2024 03:18
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Apr 17, 2024
@colifran colifran marked this pull request as ready for review April 17, 2024 04:52
@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Apr 17, 2024
@colifran colifran changed the title chore: add back aws-sdk dependency for unit tests and satisfy AwsSdkCall in unit tests chore: add aws-sdk as dev dependency for unit tests and satisfy AwsSdkCall in unit tests Apr 17, 2024
Copy link
Contributor

@piradeepk piradeepk left a comment

Choose a reason for hiding this comment

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

Lgtm! 🚀

Copy link
Contributor

mergify bot commented Apr 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).

@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Apr 17, 2024
Copy link
Contributor

mergify bot commented Apr 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).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: b070dd2
  • 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 41d2c52 into main Apr 17, 2024
13 checks passed
@mergify mergify bot deleted the colifran/fix-forward branch April 17, 2024 12:33
Copy link
Contributor

mergify bot commented Apr 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).

@aws-cdk-automation
Copy link
Collaborator

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.

@aws aws locked as resolved and limited conversation to collaborators Jul 25, 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants