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.

Sign up for GitHub

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

Jump to bottom

Fix writing of aws_security_group name_prefix to statefile. #14475

Merged
merged 1 commit into from Aug 5, 2020
Merged

Fix writing of aws_security_group name_prefix to statefile. #14475

merged 1 commit into from Aug 5, 2020

Conversation

alext
Copy link
Contributor

@alext alext commented Aug 5, 2020

Community Note

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

Closes #14474

Release note for CHANGELOG:

resource/aws_security_group: Properly store name_prefix in state file to prevent spurious re-creation.

Details

As reported in #14474, I've been seeing some of our security groups being recreated unnecessarily due to their name_prefix property not being written to the statefile.

resource.PrefixedUniqueId generates names with a suffix containing hex digits, whereas the naming package was assuming these were purely decimal. This meant that NamePrefixFromName was returning nil when the generated name included hex digits a-f, which in turn caused the name_prefix property not to be set in the statefile.

@alext
Fix naming.NamePrefixFromName with hex suffix.
82ff3c1 
github.com/hashicorp/terraform-plugin-sdk/helper/resource.PrefixedUniqueId
generates names with a suffix containing hex digits, whereas the naming
package was assuming these were purely decimal. This caused the
name_prefix property not to be set in the statefile for some resources
(eg aws_security_group) when the generated name included hex digits a-f.
@alext alext requested a review from a team August 5, 2020 11:12
@ghost ghost added size/S Managed by automation to categorize the size of a PR. needs-triage Waiting for first response or review from a maintainer. provider Pertains to the provider itself, rather than any interaction with AWS. tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure. labels Aug 5, 2020
@alext
Copy link
Contributor Author

alext commented Aug 5, 2020

I was trying to work out why this only started causing problems with the 3.0.0 release, when the code problem has been present for much longer than this. I think this was caused by the changes in #12616 which added setting of the name_prefix in the read operation, which would overwrite any existing value with nil when this bug was triggered...

@ewbankkit ewbankkit added bug Addresses a defect in current functionality. and removed needs-triage Waiting for first response or review from a maintainer. labels Aug 5, 2020
@bflad bflad self-assigned this Aug 5, 2020
@bflad bflad added this to the v3.1.0 milestone Aug 5, 2020
bflad
bflad approved these changes Aug 5, 2020
View reviewed changes
Copy link
Member

@bflad bflad left a comment

Choose a reason for hiding this comment

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

Thank you for fixing this, @alext 🚀

Output from acceptance testing:

--- PASS: TestAccAWSSecurityGroup_namePrefix (13.44s)

@bflad bflad merged commit 8bf9166 into hashicorp:master Aug 5, 2020
bflad added a commit that referenced this pull request Aug 5, 2020
@bflad
Update CHANGELOG for #14475
b64f0cb
@ewbankkit ewbankkit mentioned this pull request Aug 6, 2020
Closed
@ghost
Copy link

ghost commented Aug 7, 2020

This has been released in version 3.1.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 for triage. Thanks!

@ghost
Copy link

ghost commented Sep 5, 2020

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!

@hashicorp hashicorp locked and limited conversation to collaborators Sep 5, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@bflad bflad bflad approved these changes

Assignees

@bflad bflad

Labels
bug Addresses a defect in current functionality. provider Pertains to the provider itself, rather than any interaction with AWS. size/S Managed by automation to categorize the size of a PR. tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure.
Projects
None yet
Milestone
v3.1.0
Development

Successfully merging this pull request may close these issues.

aws_security_group name_prefix is sometimes not written to the statefile
3 participants
@alext @bflad @ewbankkit