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

r/aws_dynamodb: wait for tag propagation #39326

Merged
merged 1 commit into from
Sep 13, 2024
Merged

r/aws_dynamodb: wait for tag propagation #39326

merged 1 commit into from
Sep 13, 2024

Conversation

jar-b
Copy link
Member

@jar-b jar-b commented Sep 13, 2024

Description

Previously the TagResource and UntagResource API's in the DynamoDB service were strongly consistent. An AWS change in August 2024 made these API's eventually consistent, resulting in failures when the aws_dynamodb_tag resource (or other resources which support the tags argument) attempted to read back tags at the end of a create or update operation. This change adds waiting logic into the generated UpdateTags function, ensuring the tags exist before proceeding with any subsequent read operations.

Relations

Closes #39275

Output from Acceptance Testing

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

--- PASS: TestAccDynamoDBTag_basic (43.96s)
--- PASS: TestAccDynamoDBTag_disappears (51.42s)
--- PASS: TestAccDynamoDBTag_value (70.05s)
--- PASS: TestAccDynamoDBTag_ResourceARN_tableReplica (214.62s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/dynamodb   220.704s

Additional tests with observed tagging failures prior to this change:

% make testacc PKG=dynamodb TESTS="TestAccDynamoDBTable_Replica_tagsUpdate|TestAccDynamoDBTableReplica_basic|TestAccDynamoDBTableReplica_tableClass|TestAccDynamoDBTableReplica_tags"
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.6 test ./internal/service/dynamodb/... -v -count 1 -parallel 20 -run='TestAccDynamoDBTable_Replica_tagsUpdate|TestAccDynamoDBTableReplica_basic|TestAccDynamoDBTableRepl
ica_tableClass|TestAccDynamoDBTableReplica_tags'  -timeout 360m

--- PASS: TestAccDynamoDBTableReplica_tags (215.54s)
--- PASS: TestAccDynamoDBTableReplica_basic (253.02s)
--- PASS: TestAccDynamoDBTableReplica_tableClass (377.68s)
--- PASS: TestAccDynamoDBTable_Replica_tagsUpdate (451.54s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/dynamodb   457.615s

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 service/dynamodb Issues and PRs that pertain to the dynamodb service. tags Pertains to resource tagging. generators Relates to code generators. prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. labels Sep 13, 2024
Previously the `TagResource` and `UntagResource` API's in the DynamoDB service were strongly consistent. An AWS change in August 2024 made these API's eventually consistent, resulting in failures when the `aws_dynamodb_tag` resource (or other resources which support the `tags` argument) attempted to read back tags at the end of a create or update operation. This change adds waiting logic into the generated `UpdateTags` function, ensuring the tags exist before proceeding with any subsequent read operations.

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

--- PASS: TestAccDynamoDBTag_basic (43.96s)
--- PASS: TestAccDynamoDBTag_disappears (51.42s)
--- PASS: TestAccDynamoDBTag_value (70.05s)
--- PASS: TestAccDynamoDBTag_ResourceARN_tableReplica (214.62s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/dynamodb   220.704s
```

Additional tests with observed tagging failures prior to this change:

```console
% make testacc PKG=dynamodb TESTS="TestAccDynamoDBTable_Replica_tagsUpdate|TestAccDynamoDBTableReplica_basic|TestAccDynamoDBTableReplica_tableClass|TestAccDynamoDBTableReplica_tags"
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.6 test ./internal/service/dynamodb/... -v -count 1 -parallel 20 -run='TestAccDynamoDBTable_Replica_tagsUpdate|TestAccDynamoDBTableReplica_basic|TestAccDynamoDBTableRepl
ica_tableClass|TestAccDynamoDBTableReplica_tags'  -timeout 360m

--- PASS: TestAccDynamoDBTableReplica_tags (215.54s)
--- PASS: TestAccDynamoDBTableReplica_basic (253.02s)
--- PASS: TestAccDynamoDBTableReplica_tableClass (377.68s)
--- PASS: TestAccDynamoDBTable_Replica_tagsUpdate (451.54s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/dynamodb   457.615s
```
@jar-b jar-b marked this pull request as ready for review September 13, 2024 18:59
@jar-b jar-b requested a review from a team as a code owner September 13, 2024 18:59
Copy link
Contributor

@nam054 nam054 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 PKG=dynamodb TESTS=TestAccDynamoDBTag_
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.6 test ./internal/service/dynamodb/... -v -count 1 -parallel 20 -run='TestAccDynamoDBTag_'  -timeout 360m
=== RUN   TestAccDynamoDBTag_basic
=== PAUSE TestAccDynamoDBTag_basic
=== RUN   TestAccDynamoDBTag_disappears
=== PAUSE TestAccDynamoDBTag_disappears
=== RUN   TestAccDynamoDBTag_ResourceARN_tableReplica
=== PAUSE TestAccDynamoDBTag_ResourceARN_tableReplica
=== RUN   TestAccDynamoDBTag_value
=== PAUSE TestAccDynamoDBTag_value
=== CONT  TestAccDynamoDBTag_basic
=== CONT  TestAccDynamoDBTag_ResourceARN_tableReplica
=== CONT  TestAccDynamoDBTag_disappears
=== CONT  TestAccDynamoDBTag_value
--- PASS: TestAccDynamoDBTag_disappears (51.77s)
--- PASS: TestAccDynamoDBTag_basic (53.66s)
--- PASS: TestAccDynamoDBTag_value (75.72s)
--- PASS: TestAccDynamoDBTag_ResourceARN_tableReplica (166.70s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/dynamodb   171.559s

> make testacc PKG=dynamodb TESTS="TestAccDynamoDBTable_Replica_tagsUpdate|TestAccDynamoDBTableReplica_basic|TestAccDynamoDBTableReplica_tableClass|TestAccDynamoDBTableReplica_tags"
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.6 test ./internal/service/dynamodb/... -v -count 1 -parallel 20 -run='TestAccDynamoDBTable_Replica_tagsUpdate|TestAccDynamoDBTableReplica_basic|TestAccDynamoDBTableReplica_tableClass|TestAccDynamoDBTableReplica_tags'  -timeout 360m
=== RUN   TestAccDynamoDBTableReplica_basic
=== PAUSE TestAccDynamoDBTableReplica_basic
=== RUN   TestAccDynamoDBTableReplica_tags
=== PAUSE TestAccDynamoDBTableReplica_tags
=== RUN   TestAccDynamoDBTableReplica_tableClass
=== PAUSE TestAccDynamoDBTableReplica_tableClass
=== RUN   TestAccDynamoDBTable_Replica_tagsUpdate
=== PAUSE TestAccDynamoDBTable_Replica_tagsUpdate
=== CONT  TestAccDynamoDBTableReplica_basic
=== CONT  TestAccDynamoDBTableReplica_tableClass
=== CONT  TestAccDynamoDBTable_Replica_tagsUpdate
=== CONT  TestAccDynamoDBTableReplica_tags
--- PASS: TestAccDynamoDBTableReplica_basic (278.40s)
--- PASS: TestAccDynamoDBTableReplica_tags (314.84s)
--- PASS: TestAccDynamoDBTableReplica_tableClass (384.68s)
--- PASS: TestAccDynamoDBTable_Replica_tagsUpdate (500.79s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/dynamodb   505.628s

@jar-b jar-b merged commit a612c7d into main Sep 13, 2024
37 checks passed
@jar-b jar-b deleted the b-dynamodb-tags branch September 13, 2024 21:00
@github-actions github-actions bot added this to the v5.68.0 milestone Sep 13, 2024
terraform-aws-provider bot pushed a commit that referenced this pull request Sep 13, 2024
@github-actions github-actions bot removed the prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. label Sep 20, 2024
Copy link

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

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 Oct 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
generators Relates to code generators. service/dynamodb Issues and PRs that pertain to the dynamodb service. tags Pertains to resource tagging.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: DynamoDB table tagging failures due to API changes
2 participants