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: Return error when aws_cur_report_definition is not associated with us-east-1 region #36540

Merged

Conversation

acwwat
Copy link
Contributor

@acwwat acwwat commented Mar 23, 2024

Description

This PR is for adding a region check before each API operation and throw an error if the aws_cur_report_definition resource or data source is not associated with us-east-1, which is the only region the CUR service endpoint supports.

To maintainers: I need help to troubleshoot an issue with the testAccReportDefinition_disappears test case. It is constantly failing, and what I noticed in CloudTrail is that the test case is trying to delete the resource twice. The CUR API returns a ValidationError with no message in the 2nd delete, but I am fairly sure that it's because it is trying to delete an already-deleted resource. Please let me know how I can fix it if you have any ideas. Thanks.

Relations

Closes #36446.
Closes #36133.

References

n/a

Output from Acceptance Testing

$ export AWS_DEFAULT_REGION=us-east-1
$ make testacc TESTARGS="-run=TestAccCUR_serial" PKG=cur
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/cur/... -v -count 1 -parallel 20  -run=TestAccCUR_serial -timeout 360m
=== RUN   TestAccCUR_serial
=== PAUSE TestAccCUR_serial
=== CONT  TestAccCUR_serial
=== RUN   TestAccCUR_serial/ReportDefinition
=== RUN   TestAccCUR_serial/ReportDefinition/DataSource_basic
=== RUN   TestAccCUR_serial/ReportDefinition/DataSource_additional
=== RUN   TestAccCUR_serial/ReportDefinition/disappears
=== PAUSE TestAccCUR_serial/ReportDefinition/disappears
=== RUN   TestAccCUR_serial/ReportDefinition/parquet
=== PAUSE TestAccCUR_serial/ReportDefinition/parquet
=== RUN   TestAccCUR_serial/ReportDefinition/refresh
=== PAUSE TestAccCUR_serial/ReportDefinition/refresh
=== RUN   TestAccCUR_serial/ReportDefinition/overwrite
=== PAUSE TestAccCUR_serial/ReportDefinition/overwrite
=== RUN   TestAccCUR_serial/ReportDefinition/basic
=== PAUSE TestAccCUR_serial/ReportDefinition/basic
=== RUN   TestAccCUR_serial/ReportDefinition/textOrCsv
=== PAUSE TestAccCUR_serial/ReportDefinition/textOrCsv
=== RUN   TestAccCUR_serial/ReportDefinition/athena
=== PAUSE TestAccCUR_serial/ReportDefinition/athena
=== CONT  TestAccCUR_serial/ReportDefinition/disappears
=== CONT  TestAccCUR_serial/ReportDefinition/basic
=== CONT  TestAccCUR_serial/ReportDefinition/refresh
=== CONT  TestAccCUR_serial/ReportDefinition/overwrite
=== CONT  TestAccCUR_serial/ReportDefinition/parquet
=== CONT  TestAccCUR_serial/ReportDefinition/athena
=== CONT  TestAccCUR_serial/ReportDefinition/textOrCsv
=== NAME  TestAccCUR_serial/ReportDefinition/disappears
    report_definition_test.go:307: Error running post-test destroy, there may be dangling resources: exit status 1

        Error: deleting Cost And Usage Report Definition (tf_acc_test-4266098657865442595): ValidationException:

--- FAIL: TestAccCUR_serial (646.03s)
    --- FAIL: TestAccCUR_serial/ReportDefinition (286.58s)
        --- PASS: TestAccCUR_serial/ReportDefinition/DataSource_basic (141.80s)
        --- PASS: TestAccCUR_serial/ReportDefinition/DataSource_additional (144.78s)
        --- FAIL: TestAccCUR_serial/ReportDefinition/disappears (266.95s)
        --- PASS: TestAccCUR_serial/ReportDefinition/refresh (272.48s)
        --- PASS: TestAccCUR_serial/ReportDefinition/textOrCsv (273.39s)
        --- PASS: TestAccCUR_serial/ReportDefinition/overwrite (273.77s)
        --- PASS: TestAccCUR_serial/ReportDefinition/parquet (274.26s)
        --- PASS: TestAccCUR_serial/ReportDefinition/athena (274.66s)
        --- PASS: TestAccCUR_serial/ReportDefinition/basic (359.45s)
FAIL
FAIL    github.com/hashicorp/terraform-provider-aws/internal/service/cur        646.191s
FAIL
make: *** [GNUmakefile:403: testacc] Error 1

$

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 size/XS Managed by automation to categorize the size of a PR. service/cur Issues and PRs that pertain to the cur service. labels Mar 23, 2024
@terraform-aws-provider terraform-aws-provider bot added needs-triage Waiting for first response or review from a maintainer. external-maintainer Contribution from a trusted external contributor. labels Mar 23, 2024
@acwwat acwwat changed the title fix: Return error when aws_cur_report_definition is not associated with us-east-1 region [WIP] fix: Return error when aws_cur_report_definition is not associated with us-east-1 region Mar 23, 2024
@acwwat acwwat force-pushed the b-aws_cur_report_definition-add_region_check branch from b1b9e77 to 52bbcfc Compare March 23, 2024 05:30
@github-actions github-actions bot added size/S Managed by automation to categorize the size of a PR. and removed size/XS Managed by automation to categorize the size of a PR. labels Mar 23, 2024
@acwwat acwwat changed the title [WIP] fix: Return error when aws_cur_report_definition is not associated with us-east-1 region fix: Return error when aws_cur_report_definition is not associated with us-east-1 region Mar 23, 2024
@ewbankkit ewbankkit added bug Addresses a defect in current functionality. and removed needs-triage Waiting for first response or review from a maintainer. labels Mar 25, 2024
@ewbankkit ewbankkit self-assigned this Mar 25, 2024
@terraform-aws-provider terraform-aws-provider bot added the prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. label Mar 25, 2024
@ewbankkit ewbankkit added the aws-sdk-go-migration Issues that are related to the providers migration to AWS SDK for Go v2. label Mar 25, 2024
Copy link

Thank you for your contribution! 🚀

Please note that typically Go dependency changes are handled in this repository by dependabot or the maintainers. This is to prevent pull request merge conflicts and further delay reviews of contributions. Remove any changes to the go.mod or go.sum files and commit them into this pull request.

Additional details:

  • Check open pull requests with the dependencies label to view other dependency updates.
  • If this pull request includes an update the AWS Go SDK (or any other dependency) version, only updates submitted via dependabot will be merged. This pull request will need to remove these changes and will need to be rebased after the existing dependency update via dependabot has been merged for this pull request to be reviewed.
  • If this pull request is for supporting a new AWS service:
    • Ensure the new AWS service changes are following the Contributing Guide section on new services, in particular that the dependency addition and initial provider support are in a separate pull request from other changes (e.g. new resources). Contributions not following this item will not be reviewed until the changes are split.
    • If this pull request is already a separate pull request from the above item, you can ignore this message.

@github-actions github-actions bot added size/XL Managed by automation to categorize the size of a PR. tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure. and removed size/S Managed by automation to categorize the size of a PR. labels Mar 25, 2024
@github-actions github-actions bot added sweeper Pertains to changes to or issues with the sweeper. client-connections Pertains to the AWS Client and service connections. generators Relates to code generators. labels Mar 25, 2024
Copy link
Contributor

@ewbankkit ewbankkit left a comment

Choose a reason for hiding this comment

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

LGTM 🚀.

% make testacc TESTARGS='-run=TestAccCUR_serial' PKG=cur
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.21.8 test ./internal/service/cur/... -v -count 1 -parallel 20  -run=TestAccCUR_serial -timeout 360m
=== RUN   TestAccCUR_serial
=== PAUSE TestAccCUR_serial
=== CONT  TestAccCUR_serial
=== RUN   TestAccCUR_serial/ReportDefinition
=== RUN   TestAccCUR_serial/ReportDefinition/parquet
=== PAUSE TestAccCUR_serial/ReportDefinition/parquet
=== RUN   TestAccCUR_serial/ReportDefinition/athena
=== PAUSE TestAccCUR_serial/ReportDefinition/athena
=== RUN   TestAccCUR_serial/ReportDefinition/DataSource_basic
=== RUN   TestAccCUR_serial/ReportDefinition/basic
=== PAUSE TestAccCUR_serial/ReportDefinition/basic
=== RUN   TestAccCUR_serial/ReportDefinition/disappears
=== PAUSE TestAccCUR_serial/ReportDefinition/disappears
=== RUN   TestAccCUR_serial/ReportDefinition/textOrCsv
=== PAUSE TestAccCUR_serial/ReportDefinition/textOrCsv
=== RUN   TestAccCUR_serial/ReportDefinition/refresh
=== PAUSE TestAccCUR_serial/ReportDefinition/refresh
=== RUN   TestAccCUR_serial/ReportDefinition/overwrite
=== PAUSE TestAccCUR_serial/ReportDefinition/overwrite
=== RUN   TestAccCUR_serial/ReportDefinition/DataSource_additional
=== CONT  TestAccCUR_serial/ReportDefinition/parquet
=== CONT  TestAccCUR_serial/ReportDefinition/textOrCsv
=== CONT  TestAccCUR_serial/ReportDefinition/disappears
=== CONT  TestAccCUR_serial/ReportDefinition/basic
=== CONT  TestAccCUR_serial/ReportDefinition/overwrite
=== CONT  TestAccCUR_serial/ReportDefinition/refresh
=== CONT  TestAccCUR_serial/ReportDefinition/athena
--- PASS: TestAccCUR_serial (133.22s)
    --- PASS: TestAccCUR_serial/ReportDefinition (55.24s)
        --- PASS: TestAccCUR_serial/ReportDefinition/DataSource_basic (28.29s)
        --- PASS: TestAccCUR_serial/ReportDefinition/DataSource_additional (26.95s)
        --- PASS: TestAccCUR_serial/ReportDefinition/disappears (55.39s)
        --- PASS: TestAccCUR_serial/ReportDefinition/textOrCsv (60.66s)
        --- PASS: TestAccCUR_serial/ReportDefinition/overwrite (61.19s)
        --- PASS: TestAccCUR_serial/ReportDefinition/parquet (62.96s)
        --- PASS: TestAccCUR_serial/ReportDefinition/athena (63.34s)
        --- PASS: TestAccCUR_serial/ReportDefinition/refresh (63.46s)
        --- PASS: TestAccCUR_serial/ReportDefinition/basic (77.98s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/cur	144.256s

@ewbankkit
Copy link
Contributor

@acwwat Thanks for the contribution 🎉 👏.
The better thing here I think it to follow the example of route53domains (another service which only has an API endpoint in us-east-1) and always route all traffic to us-east-1.
I added the ValidationException check to resource Delete.

@ewbankkit ewbankkit merged commit f5a7d2c into hashicorp:main Mar 25, 2024
62 checks passed
@github-actions github-actions bot added this to the v5.43.0 milestone Mar 25, 2024
@github-actions github-actions bot removed the prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. label Mar 28, 2024
Copy link

This functionality has been released in v5.43.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!

@acwwat acwwat deleted the b-aws_cur_report_definition-add_region_check branch April 1, 2024 19:34
Copy link

github-actions bot commented May 2, 2024

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 May 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
aws-sdk-go-migration Issues that are related to the providers migration to AWS SDK for Go v2. bug Addresses a defect in current functionality. client-connections Pertains to the AWS Client and service connections. external-maintainer Contribution from a trusted external contributor. generators Relates to code generators. service/cur Issues and PRs that pertain to the cur service. size/XL Managed by automation to categorize the size of a PR. sweeper Pertains to changes to or issues with the sweeper. tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure.
Projects
None yet
2 participants