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

d/aws_ami: warn when most_recent is true and filters are missing #40211

Merged
merged 2 commits into from
Nov 21, 2024

Conversation

jar-b
Copy link
Member

@jar-b jar-b commented Nov 20, 2024

Description

When most_recent is set to true and certain filtering criteria are missing, it's possible for this data source to return an image published by a third party. To bring visibility to this possibility in a non-breaking way, the provider will now append a warning diagnostic when an affected combination of arguments is detected.

For practitioners, the resulting diagnostic will look similar to the following:

image

Relations

Closes #40197

Output from Acceptance Testing

% make testacc PKG=ec2 TESTS=TestAccEC2AMIDataSource_
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.23.2 test ./internal/service/ec2/... -v -count 1 -parallel 20 -run='TestAccEC2AMIDataSource_'  -timeout 360m

--- PASS: TestAccEC2AMIDataSource_linuxInstance (11.17s)
--- PASS: TestAccEC2AMIDataSource_localNameFilter (11.37s)
--- PASS: TestAccEC2AMIDataSource_instanceStore (11.40s)
--- PASS: TestAccEC2AMIDataSource_productCode (11.55s)
--- PASS: TestAccEC2AMIDataSource_windowsInstance (12.23s)
--- PASS: TestAccEC2AMIDataSource_gp3BlockDevice (111.44s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/ec2        116.580s

Copy link

Community Note

Voting for Prioritization

  • Please vote on this pull request by adding a 👍 reaction to the original post to help the community and maintainers prioritize this pull request.
  • Please see our prioritization guide for information on how we prioritize.
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

For Submitters

  • Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
  • For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
  • Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

@github-actions github-actions bot added tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure. service/ec2 Issues and PRs that pertain to the ec2 service. prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. labels Nov 20, 2024
When `most_recent` is set to `true` and certain filtering criteria are missing, it's possible for this data source to return an image published by a third party. To bring visibility to this possibility in a non-breaking way, the provider will now append a warning diagnostic when an affected combination of arguments is detected.

```console
% make testacc PKG=ec2 TESTS=TestAccEC2AMIDataSource_
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.23.2 test ./internal/service/ec2/... -v -count 1 -parallel 20 -run='TestAccEC2AMIDataSource_'  -timeout 360m

--- PASS: TestAccEC2AMIDataSource_linuxInstance (11.17s)
--- PASS: TestAccEC2AMIDataSource_localNameFilter (11.37s)
--- PASS: TestAccEC2AMIDataSource_instanceStore (11.40s)
--- PASS: TestAccEC2AMIDataSource_productCode (11.55s)
--- PASS: TestAccEC2AMIDataSource_windowsInstance (12.23s)
--- PASS: TestAccEC2AMIDataSource_gp3BlockDevice (111.44s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/ec2        116.580s
```
@jar-b jar-b marked this pull request as ready for review November 20, 2024 18:13
@jar-b jar-b requested a review from a team as a code owner November 20, 2024 18:13
Copy link
Contributor

@johnsonaj johnsonaj left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

@jar-b jar-b merged commit 764e2e7 into main Nov 21, 2024
40 of 41 checks passed
@jar-b jar-b deleted the f-ami-ds-warning branch November 21, 2024 14:17
@github-actions github-actions bot added this to the v5.77.0 milestone Nov 21, 2024
terraform-aws-provider bot pushed a commit that referenced this pull request Nov 21, 2024
Copy link

This functionality has been released in v5.77.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

@github-actions github-actions bot removed the prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. label Nov 21, 2024
Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
service/ec2 Issues and PRs that pertain to the ec2 service. tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Enhancement]: d/aws_ami: Warn when most_recent is true and certain filters are missing
2 participants