resource/aws_ram_resource_share_accepter: Fix Read operation since invitations are purged after 7 days #11562

benoit74 · 2020-01-11T22:19:12Z

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 #10064
Closes #10186
Closes #11785

Release note for CHANGELOG:

resource/aws_ram_resource_share_accepter: Fix resource wanting to create again and import not working after invitation has been purged

Output from acceptance testing:

$ make testacc TEST='./aws' TESTARGS='-run=TestAccAwsRamResourceShareAccepter_basic'
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./aws -v -count 1 -parallel 20 -run=TestAccAwsRamResourceShareAccepter_basic -timeout 120m
=== RUN   TestAccAwsRamResourceShareAccepter_basic
=== PAUSE TestAccAwsRamResourceShareAccepter_basic
=== CONT  TestAccAwsRamResourceShareAccepter_basic
--- PASS: TestAccAwsRamResourceShareAccepter_basic (58.54s)
PASS
ok  	github.com/terraform-providers/terraform-provider-aws/aws	58.606s

benoit74 · 2020-01-11T22:27:10Z

Please advise.

I will keep it as a WIP until 7 days have passed, the invitations for my existing shares have being purged by AWS, so that I can confirm the code works as intended (so far I can only confirm that there is no regression with the existing acceptance test).

benoit74 · 2020-01-12T20:54:38Z

I did some local tests faking the fact that no invitation was still present. It showed me a significant remaining bug in the "import" behavior.

I made necessary changes and from my tests everything seems to be fine now.

benoit74 · 2020-01-12T21:04:55Z

website/docs/r/ram_resource_share_accepter.markdown

-* `status` - The status of the invitation (e.g., ACCEPTED, REJECTED).
+* `status` - The status of the resource share (ACTIVE, PENDING, FAILED, DELETING, DELETED).


Should we document such a breaking change somewhere else? I assume almost nobody uses this attribute for something else, but ...

I doubt anyone is really using it, but it wouldn't hurt to mention it in the changelog or somewhere. Not sure where breaking changes are normally logged for the providers.

Changes like these can be noted in the CHANGELOG.md file, which the maintainers will handle on merge. Always good to call this out in PRs though. 👍

benoit74 · 2020-01-12T21:07:38Z

aws/resource_aws_ram_resource_share_accepter.go

+	if invitation != nil {
+		d.Set("invitation_arn", invitation.ResourceShareInvitationArn)
+		d.Set("receiver_account_id", invitation.ReceiverAccountId)
+	} else {
+		d.Set("receiver_account_id", meta.(*AWSClient).accountid)


If invitation is still present, we source both attributes from the invitation.
If the invitation is not present anymore, we source only the receiver_account_id from the current client accountid.

benoit74 · 2020-01-12T21:09:02Z

aws/resource_aws_ram_resource_share_accepter.go

+	if *invitation.ReceiverAccountId != client.accountid {
+		// Report an error, this won't work on the long term since once the invitation has disappeared
+		// the receiver_account_id is populated with the account_id (and same during import)
+		return nil, fmt.Errorf("Unexpected behavior while reading RAM resource share invitation %s: receiver_account_id is %s while current account_id is %s", resourceShareARN, *invitation.ReceiverAccountId, client.accountid)
+	}
+


I see no reason why this could happen, but I prefer to have the check in place to be notified if this happens under a corner-case condition, since this would cause the bugs fixed by this change to reappear under this corner-case condition.

We may also want to remove this since its not guaranteed client.accountid is populated in the case it cannot be detected automatically via other means and the provider skip_requesting_account_id argument is set.

benoit74 · 2020-01-24T17:37:40Z

Testing is now complete and sucessful (I do not have any more invitations is my calls to AWS but terraform does not tries anymore to re-accept invitations that have already been processed)

@bflad : could you please have a look at this PR now that testing is complete? Looking at the associated issue, it seems that I'm not the only one waiting for this to be merged ;)

Thanks in advance !

bflad

Hi @benoit74 👋 Thank you so much for this fix and for this note:

Testing is now complete and sucessful (I do not have any more invitations is my calls to AWS but terraform does not tries anymore to re-accept invitations that have already been processed)

Overall this looks like a preferred solution for this situation. Pulling this in with very minor changes (for reasons mentioned below). 🚀

Output from acceptance testing (while the invitation is still active of course 😅):

--- PASS: TestAccAwsRamResourceShareAccepter_basic (39.67s)

bflad · 2020-02-18T14:33:00Z

aws/resource_aws_ram_resource_share_accepter.go

@@ -217,13 +237,13 @@ func resourceAwsRamResourceShareAccepterDelete(d *schema.ResourceData, meta inte
 	return nil
 }

-func resourceAwsRamResourceShareGetInvitation(conn *ram.RAM, resourceShareARN, status string) (*ram.ResourceShareInvitation, error) {


Nit: For consistency across the provider codebase, we prefer these functions to take the service-specific clients.

bflad · 2020-02-18T14:35:40Z

aws/resource_aws_ram_resource_share_accepter.go

+	if *invitation.ReceiverAccountId != client.accountid {
+		// Report an error, this won't work on the long term since once the invitation has disappeared
+		// the receiver_account_id is populated with the account_id (and same during import)
+		return nil, fmt.Errorf("Unexpected behavior while reading RAM resource share invitation %s: receiver_account_id is %s while current account_id is %s", resourceShareARN, *invitation.ReceiverAccountId, client.accountid)
+	}
+


We may also want to remove this since its not guaranteed client.accountid is populated in the case it cannot be detected automatically via other means and the provider skip_requesting_account_id argument is set.

bflad · 2020-02-18T14:36:43Z

website/docs/r/ram_resource_share_accepter.markdown

-* `status` - The status of the invitation (e.g., ACCEPTED, REJECTED).
+* `status` - The status of the resource share (ACTIVE, PENDING, FAILED, DELETING, DELETED).


Changes like these can be noted in the CHANGELOG.md file, which the maintainers will handle on merge. Always good to call this out in PRs though. 👍

…anges Reference: #11562 (review) Output from acceptance testing: ``` --- PASS: TestAccAwsRamResourceShareAccepter_basic (39.67s) ```

ghost · 2020-02-21T00:23:48Z

This has been released in version 2.50.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 · 2020-03-20T14:50:52Z

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!

benoit74 requested a review from a team January 11, 2020 22:19

Fix Read operation since invitations are purged after 7 days

2d02527

ghost added size/M Managed by automation to categorize the size of a PR. and removed size/S Managed by automation to categorize the size of a PR. labels Jan 12, 2020

benoit74 commented Jan 12, 2020

View reviewed changes

Remove unneeded argument + fix import still not working

f35906e

benoit74 changed the title ~~[WIP] Fix Read operation since invitations are purged after 7 days~~ Fix Read operation since invitations are purged after 7 days Jan 24, 2020

benoit74 changed the title ~~Fix Read operation since invitations are purged after 7 days~~ resource/aws_ram_resource_share_accepter: Fix Read operation since invitations are purged after 7 days Jan 24, 2020

joerg mentioned this pull request Jan 31, 2020

No RAM Resource Share (arn:aws:ram:eu-west-2:XXXXXXX:resource-share/XXXXXXXXXXXXX) invitation found #11785

Closed

bflad added bug Addresses a defect in current functionality. and removed needs-triage Waiting for first response or review from a maintainer. labels Feb 18, 2020

bflad approved these changes Feb 18, 2020

View reviewed changes

bflad added this to the v2.50.0 milestone Feb 18, 2020

bflad added a commit that referenced this pull request Feb 18, 2020

resource/aws_ram_resource_share_accepter: Minor PR review feedback ch…

85962e2

…anges Reference: #11562 (review) Output from acceptance testing: ``` --- PASS: TestAccAwsRamResourceShareAccepter_basic (39.67s) ```

bflad merged commit f35906e into hashicorp:master Feb 18, 2020

bflad added a commit that referenced this pull request Feb 18, 2020

Update CHANGELOG for #11562

7804e33

ghost locked and limited conversation to collaborators Mar 20, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

resource/aws_ram_resource_share_accepter: Fix Read operation since invitations are purged after 7 days #11562

resource/aws_ram_resource_share_accepter: Fix Read operation since invitations are purged after 7 days #11562

benoit74 commented Jan 11, 2020 •

edited by bflad

Loading

benoit74 commented Jan 11, 2020

benoit74 commented Jan 12, 2020

benoit74 Jan 12, 2020

dthvt Jan 13, 2020

bflad Feb 18, 2020

benoit74 Jan 12, 2020

benoit74 Jan 12, 2020

bflad Feb 18, 2020

benoit74 commented Jan 24, 2020 •

edited

Loading

bflad left a comment

bflad Feb 18, 2020

bflad Feb 18, 2020

bflad Feb 18, 2020

ghost commented Feb 21, 2020

ghost commented Mar 20, 2020

		* `status` - The status of the invitation (e.g., ACCEPTED, REJECTED).
		* `status` - The status of the resource share (ACTIVE, PENDING, FAILED, DELETING, DELETED).

resource/aws_ram_resource_share_accepter: Fix Read operation since invitations are purged after 7 days #11562

resource/aws_ram_resource_share_accepter: Fix Read operation since invitations are purged after 7 days #11562

Conversation

benoit74 commented Jan 11, 2020 • edited by bflad Loading

Community Note

benoit74 commented Jan 11, 2020

benoit74 commented Jan 12, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

benoit74 commented Jan 24, 2020 • edited Loading

bflad left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented Feb 21, 2020

ghost commented Mar 20, 2020

benoit74 commented Jan 11, 2020 •

edited by bflad

Loading

benoit74 commented Jan 24, 2020 •

edited

Loading