Fix missing default value in cloudfront_distribution's origin.origin_path

[kyontan]

The default value of origin_path parameter in origin block is blank string (""), not null.
It is known problem in #12065. The workaround is described in the issue.
Without this PR, modifing aws_cloudfront_distrtibution will crash and state get broken.

It is apparently a bug in the provider and it should be handled by provider.

I have confirmed CLI (aws cloudfront get-distribution) returns blank string ("") as default value if create resource without setting origin_path explicitly.

According to the document, the default value is not noted though.
https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_Origin.html

This problem is work-arounded jmgreg31/terraform-aws-cloudfront#38.

Relates: #12065

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

Output from acceptance testing:

$ make testacc TESTARGS='-run=TestAccAWSCloudFrontDistribution*'
==> Checking that code complies with gofmt requirements...

TF_ACC=1 go test ./aws -v -count 1 -parallel 20 -run=TestAccAWSCloudFrontDistribution* -timeout 180m
(RUN, PAUSE, and CONT are omitted)
--- PASS: TestAccAWSCloudFrontDistribution_Origin_EmptyOriginID (84.70s)
--- PASS: TestAccAWSCloudFrontDistribution_Origin_EmptyDomainName (88.44s)
--- PASS: TestAccAWSCloudFrontDistribution_disappears (378.55s)
--- PASS: TestAccAWSCloudFrontDistribution_DefaultCacheBehavior_TrustedSigners (381.56s)
--- PASS: TestAccAWSCloudFrontDistribution_DefaultCacheBehavior_TrustedKeyGroups (425.97s)
--- PASS: TestAccAWSCloudFrontDistribution_ViewerCertificate_AcmCertificateArn_ConflictsWithCloudFrontDefaultCertificate (430.12s)
--- PASS: TestAccAWSCloudFrontDistribution_DefaultCacheBehavior_RealtimeLogConfigArn (435.36s)
--- PASS: TestAccAWSCloudFrontDistribution_OrderedCacheBehavior_RealtimeLogConfigArn (442.50s)
--- PASS: TestAccAWSCloudFrontDistribution_DefaultCacheBehavior_ForwardedValues_Headers (455.09s)
--- PASS: TestAccAWSCloudFrontDistribution_DefaultCacheBehavior_ForwardedValues_Cookies_WhitelistedNames (483.63s)
--- PASS: TestAccAWSCloudFrontDistribution_noOptionalItemsConfig (504.55s)
--- PASS: TestAccAWSCloudFrontDistribution_RetainOnDelete (559.72s)
--- PASS: TestAccAWSCloudFrontDistribution_IsIPV6EnabledConfig (560.71s)
--- PASS: TestAccAWSCloudFrontDistribution_noCustomErrorResponseConfig (565.85s)
--- PASS: TestAccAWSCloudFrontDistribution_HTTP11Config (567.32s)
--- PASS: TestAccAWSCloudFrontDistribution_originPolicyOrdered (482.98s)
--- PASS: TestAccAWSCloudFrontDistribution_orderedCacheBehaviorCachePolicy (480.73s)
--- PASS: TestAccAWSCloudFrontDistribution_Origin_ConnectionTimeout (610.52s)
--- PASS: TestAccAWSCloudFrontDistribution_Origin_ConnectionAttempts (610.79s)
--- PASS: TestAccAWSCloudFrontDistribution_Origin_OriginShield (611.74s)
--- PASS: TestAccAWSCloudFrontDistribution_ViewerCertificate_AcmCertificateArn (236.41s)
--- PASS: TestAccAWSCloudFrontDistribution_OrderedCacheBehavior_ForwardedValues_Cookies_WhitelistedNames (265.15s)
--- PASS: TestAccAWSCloudFrontDistribution_OrderedCacheBehavior_ForwardedValues_Headers (306.66s)
--- PASS: TestAccAWSCloudFrontDistribution_forwardedValuesToCachePolicy (751.16s)
--- PASS: TestAccAWSCloudFrontDistribution_orderedCacheBehavior (392.02s)
--- PASS: TestAccAWSCloudFrontDistribution_customOrigin (473.06s)
--- PASS: TestAccAWSCloudFrontDistribution_originPolicyDefault (469.09s)
--- PASS: TestAccAWSCloudFrontDistribution_OriginGroups (479.67s)
--- PASS: TestAccAWSCloudFrontDistribution_Enabled (905.76s)
--- PASS: TestAccAWSCloudFrontDistribution_multiOrigin (531.50s)
--- PASS: TestAccAWSCloudFrontDistribution_S3Origin (374.37s)
--- PASS: TestAccAWSCloudFrontDistribution_WaitForDeployment (449.19s)
--- PASS: TestAccAWSCloudFrontDistribution_S3OriginWithTags (577.89s)
PASS
ok      github.com/terraform-providers/terraform-provider-aws/aws       1086.053s

[github-actions]

Welcome @kyontan 👋

It looks like this is your first Pull Request submission to the Terraform AWS Provider! If you haven’t already done so please make sure you have checked out our CONTRIBUTING guide and FAQ to make sure your contribution is adhering to best practice and has all the necessary elements in place for a successful approval.

Also take a look at our FAQ which details how we prioritize Pull Requests for inclusion.

Thanks again, and welcome to the community! 😃

[kyontan]

We have ran the acceptance tests and confirmed no regression found.

[kyontan]

@breathingdust Could you see this pr? Thanks.

[kyontan]

@ewbankkit @DrFaust92 Could you take a look for this pr?
Our environment's tfstate got broken by this bug, so I think it should have higher priority.

[zhelding]

Pull request #21306 has significantly refactored the AWS Provider codebase. As a result, most PRs opened prior to the refactor now have merge conflicts that must be resolved before proceeding.

Specifically, PR #21306 relocated the code for all AWS resources and data sources from a single aws directory to a large number of separate directories in internal/service, each corresponding to a particular AWS service. This separation of code has also allowed for us to simplify the names of underlying functions -- while still avoiding namespace collisions.

We recognize that many pull requests have been open for some time without yet being addressed by our maintainers. Therefore, we want to make it clear that resolving these conflicts in no way affects the prioritization of a particular pull request. Once a pull request has been prioritized for review, the necessary changes will be made by a maintainer -- either directly or in collaboration with the pull request author.

For a more complete description of this refactor, including examples of how old filepaths and function names correspond to their new counterparts: please refer to issue #20000.

For a quick guide on how to amend your pull request to resolve the merge conflicts resulting from this refactor and bring it in line with our new code patterns: please refer to our Service Package Refactor Pull Request Guide.

[kyontan]

I have followed the refactoring, and waiting for maintainer review.

[YakDriver]

Thank you 🎉

% make testacc TESTS=TestAccCloudFrontDistribution PKG=cloudfront
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/cloudfront/... -v -count 1 -parallel 20 -run='TestAccCloudFrontDistribution'  -timeout 180m
--- PASS: TestAccCloudFrontDistribution_OrderedCacheBehaviorForwardedValues_headers (202.36s)
--- PASS: TestAccCloudFrontDistribution_DefaultCacheBehaviorForwardedValuesCookies_whitelistedNames (204.63s)
--- PASS: TestAccCloudFrontDistribution_DefaultCacheBehavior_trustedSigners (204.70s)
--- PASS: TestAccCloudFrontDistribution_OrderedCacheBehaviorForwardedValuesCookies_whitelistedNames (204.97s)
--- PASS: TestAccCloudFrontDistribution_ViewerCertificate_acmCertificateARN (224.22s)
--- PASS: TestAccCloudFrontDistribution_DefaultCacheBehavior_trustedKeyGroups (232.73s)
--- PASS: TestAccCloudFrontDistribution_DefaultCacheBehavior_realtimeLogARN (239.07s)
--- PASS: TestAccCloudFrontDistribution_OrderedCacheBehavior_realtimeLogARN (248.34s)
--- PASS: TestAccCloudFrontDistribution_DefaultCacheBehaviorForwardedValues_headers (256.20s)
--- PASS: TestAccCloudFrontDistribution_ViewerCertificateACMCertificateARN_conflictsWithCloudFrontDefaultCertificate (268.27s)
--- PASS: TestAccCloudFrontDistribution_http11 (370.16s)
--- PASS: TestAccCloudFrontDistribution_isIPV6Enabled (371.68s)
--- PASS: TestAccCloudFrontDistribution_Origin_emptyDomainName (0.80s)
--- PASS: TestAccCloudFrontDistribution_Origin_emptyOriginID (0.78s)
--- PASS: TestAccCloudFrontDistribution_noCustomErrorResponse (384.29s)
--- PASS: TestAccCloudFrontDistribution_Origin_connectionAttempts (386.37s)
--- PASS: TestAccCloudFrontDistributionDataSource_basic (387.11s)
--- PASS: TestAccCloudFrontDistribution_retainOnDelete (389.10s)
--- PASS: TestAccCloudFrontDistribution_waitForDeployment (396.73s)
--- PASS: TestAccCloudFrontDistribution_orderedCacheBehaviorCachePolicy (487.60s)
--- PASS: TestAccCloudFrontDistribution_originGroups (497.02s)
--- PASS: TestAccCloudFrontDistribution_disappears (189.06s)
--- PASS: TestAccCloudFrontDistribution_enabled (560.13s)
--- PASS: TestAccCloudFrontDistribution_orderedCacheBehavior (355.57s)
--- PASS: TestAccCloudFrontDistribution_originPolicyOrdered (359.08s)
--- PASS: TestAccCloudFrontDistribution_noOptionalItems (337.64s)
--- PASS: TestAccCloudFrontDistribution_multiOrigin (366.12s)
--- PASS: TestAccCloudFrontDistribution_originPolicyDefault (372.31s)
--- PASS: TestAccCloudFrontDistribution_customOrigin (332.03s)
--- PASS: TestAccCloudFrontDistribution_Origin_originShield (450.51s)
--- PASS: TestAccCloudFrontDistribution_s3Origin (421.80s)
--- PASS: TestAccCloudFrontDistribution_Origin_connectionTimeout (414.74s)
--- PASS: TestAccCloudFrontDistribution_orderedCacheBehaviorResponseHeadersPolicy (358.96s)
--- PASS: TestAccCloudFrontDistribution_s3OriginWithTags (514.25s)
--- PASS: TestAccCloudFrontDistribution_forwardedValuesToCachePolicy (511.07s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/cloudfront	886.647s

[github-actions]

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

[github-actions]

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.