r/user_pool_domain - remove from state when deleted + move waiters to their own package

[DrFaust92]

improve check for disappears + test

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 #5313

Release note for CHANGELOG:

resource_aws_user_pool_domain - remove from state when deleted

Output from acceptance testing:

$ make testacc TESTARGS='-run=TestAccAWSCognitoUserPoolDomain_'
--- PASS: TestAccAWSCognitoUserPoolDomain_basic (54.56s)
--- SKIP: TestAccAWSCognitoUserPoolDomain_custom (0.00s)
--- PASS: TestAccAWSCognitoUserPoolDomain_disappears (46.92s)

[ewbankkit]

I suggest a pattern of

const (
	userPoolDomainStatusNotFound = "NotFound"
	userPoolDomainStatusUnknown  = "Unknown"
)

...

		if err != nil {
			return nil, userPoolDomainStatusUnknown, err
		}

		if output == nil {
			return nil, userPoolDomainStatusNotFound, nil
		}

Although these statuses are never explicitly tested, I think having a value other than "" helps with logging etc.
Having the constant names lowercase ensures they're not used outside this package.

[ewbankkit]

I think the "correct" way to do this is Target: []string{},:

https://github.com/terraform-providers/terraform-provider-aws/blob/691d0645ceed9453a8fc77a88e7fb0fce29b1ad3/vendor/github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource/state.go#L122-L131

This code runs when the StateRefreshFunc returns nil, "anything", nil

[DrFaust92]

this failed for me

        Error: error waiting for User Pool Domain (tf-acc-test-domain-3112558782247577448) deletion: unexpected state '', wanted target ''. last error: %!s(<nil>)

[ewbankkit]

Hmm, I guess the AWS API may be returning a non-null response but the status is "".
Target: []string{""}, must be required.

[ewbankkit]

Yes, that's what's happening here:

2020/08/19 10:14:59 [DEBUG] [aws-sdk-go] DEBUG: Response cognito-idp/DescribeUserPoolDomain Details:
---[ RESPONSE ]--------------------------------------
HTTP/1.1 200 OK
Connection: close
Content-Length: 24
Content-Type: application/x-amz-json-1.1
Date: Wed, 19 Aug 2020 14:14:59 GMT
X-Amzn-Requestid: abe5941d-5d1e-4153-a926-84cfbfce7f91


-----------------------------------------------------
2020/08/19 10:14:59 [DEBUG] [aws-sdk-go] {"DomainDescription":{}}

[ewbankkit]

LGTM.

Verified acceptance tests:

$ make testacc TEST=./aws/ TESTARGS=-run='TestAccAWSCognitoUserPoolDomain_basic'
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./aws -v -count 1 -parallel 20 -run=TestAccAWSCognitoUserPoolDomain_basic -timeout 120m
=== RUN   TestAccAWSCognitoUserPoolDomain_basic
=== PAUSE TestAccAWSCognitoUserPoolDomain_basic
=== CONT  TestAccAWSCognitoUserPoolDomain_basic
--- PASS: TestAccAWSCognitoUserPoolDomain_basic (23.01s)
PASS
ok  	github.com/terraform-providers/terraform-provider-aws/aws	23.056s
$ make testacc TEST=./aws/ TESTARGS=-run='TestAccAWSCognitoUserPoolDomain_disappears'
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./aws -v -count 1 -parallel 20 -run=TestAccAWSCognitoUserPoolDomain_disappears -timeout 120m
=== RUN   TestAccAWSCognitoUserPoolDomain_disappears
=== PAUSE TestAccAWSCognitoUserPoolDomain_disappears
=== CONT  TestAccAWSCognitoUserPoolDomain_disappears
    resource_aws_cognito_user_pool_domain_test.go:159: [INFO] Got non-empty plan, as expected
--- PASS: TestAccAWSCognitoUserPoolDomain_disappears (19.69s)
PASS
ok  	github.com/terraform-providers/terraform-provider-aws/aws	19.728s

[bflad]

One little thing, otherwise looks good to me. 🚀

Output from acceptance testing:

--- PASS: TestAccAWSCognitoUserPoolDomain_disappears (15.35s)
--- PASS: TestAccAWSCognitoUserPoolDomain_basic (17.98s)

[bflad]

In StateChangeConf the MinTimeout field represents the minimum amount of time between refreshes, which the constant naming doesn't follow. I would suggest renaming the constant and providing a comment or removing this field and seeing if the resource still works as expected.

[DrFaust92]

removed! tests are passing

[ghost]

This has been released in version 3.3.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]

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!