Add support for cacheKeyPolicy in BackendBuckets #6043

genkami · 2022-05-18T08:14:05Z

This PR adds support for cacheKeyPolicy in google_compute_backend_bucket.

Resolves hashicorp/terraform-provider-google#11114.

This is my first PR to this repo so feel free to correct me if there is anything wrong.

If this PR is for Terraform, I acknowledge that I have:

Searched through the issue tracker for an open issue that this either resolves or contributes to, commented on it to claim it, and written "fixes {url}" or "part of {url}" in this PR description. If there were no relevant open issues, I opened one and commented that I would like to work on it (not necessary for very small changes).
Generated Terraform, and ran make test and make lint to ensure it passes unit and linter tests.
Ensured that all new fields I added that can be set by a user appear in at least one example (for generated resources) or third_party test (for handwritten resources or update tests).
Ran relevant acceptance tests (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).
Read the Release Notes Guide before writing my release note below.

Release Note Template for Downstream PRs (will be copied)

compute: added `cache_key_policy` field to `google_compute_backend_bucket` resource

Question:
After I ran make terraform, make lint fails because of the files that seem to be irrelevant to my changes. Is this an expected behavior?

output of `make lint` (hashicorp-provider-google)

$ cd /path/to/hashicorp/terraform-provider-google
$ git log -n 1 | head -n 1
commit 05616d2ee0e1e676ff042fc96187d20dcb51d9ab
$ golangci-lint --version
golangci-lint has version 1.46.2 built from a333689 on 2022-05-17T06:05:08Z
$ make lint
==> Checking source code against linters...
google/config_test.go:67:3: S1038: should use t.Skipf(...) instead of t.Skip(fmt.Sprintf(...)) (gosimple)
		t.Skip(fmt.Sprintf("Network access not allowed; use %s=1 to enable", TestEnvVar))
		^
google/config_test.go:95:3: S1038: should use t.Skipf(...) instead of t.Skip(fmt.Sprintf(...)) (gosimple)
		t.Skip(fmt.Sprintf("Network access not allowed; use %s=1 to enable", TestEnvVar))
		^
google/config_test.go:125:3: S1038: should use t.Skipf(...) instead of t.Skip(fmt.Sprintf(...)) (gosimple)
		t.Skip(fmt.Sprintf("Network access not allowed; use %s=1 to enable", TestEnvVar))
		^
google/config_test.go:165:3: S1038: should use t.Skipf(...) instead of t.Skip(fmt.Sprintf(...)) (gosimple)
		t.Skip(fmt.Sprintf("Network access not allowed; use %s=1 to enable", TestEnvVar))
		^
google/resource_compute_disk_test.go:188:3: S1038: should use t.Skipf(...) instead of t.Skip(fmt.Sprintf(...)) (gosimple)
		t.Skip(fmt.Sprintf("Network access not allowed; use %s=1 to enable", TestEnvVar))
		^
google/resource_compute_instance_migrate_test.go:21:3: S1038: should use t.Skipf(...) instead of t.Skip(fmt.Sprintf(...)) (gosimple)
		t.Skip(fmt.Sprintf("Network access not allowed; use %s=1 to enable", TestEnvVar))
		^
google/resource_compute_instance_migrate_test.go:125:3: S1038: should use t.Skipf(...) instead of t.Skip(fmt.Sprintf(...)) (gosimple)
		t.Skip(fmt.Sprintf("Network access not allowed; use %s=1 to enable", TestEnvVar))
		^
google/resource_compute_instance_migrate_test.go:153:3: S1038: should use t.Skipf(...) instead of t.Skip(fmt.Sprintf(...)) (gosimple)
		t.Skip(fmt.Sprintf("Network access not allowed; use %s=1 to enable", TestEnvVar))
		^
google/resource_compute_instance_migrate_test.go:221:3: S1038: should use t.Skipf(...) instead of t.Skip(fmt.Sprintf(...)) (gosimple)
		t.Skip(fmt.Sprintf("Network access not allowed; use %s=1 to enable", TestEnvVar))
		^
google/resource_compute_instance_migrate_test.go:288:3: S1038: should use t.Skipf(...) instead of t.Skip(fmt.Sprintf(...)) (gosimple)
		t.Skip(fmt.Sprintf("Network access not allowed; use %s=1 to enable", TestEnvVar))
		^
google/resource_compute_instance_migrate_test.go:369:3: S1038: should use t.Skipf(...) instead of t.Skip(fmt.Sprintf(...)) (gosimple)
		t.Skip(fmt.Sprintf("Network access not allowed; use %s=1 to enable", TestEnvVar))
		^
google/resource_compute_instance_migrate_test.go:449:3: S1038: should use t.Skipf(...) instead of t.Skip(fmt.Sprintf(...)) (gosimple)
		t.Skip(fmt.Sprintf("Network access not allowed; use %s=1 to enable", TestEnvVar))
		^
google/resource_compute_instance_migrate_test.go:518:3: S1038: should use t.Skipf(...) instead of t.Skip(fmt.Sprintf(...)) (gosimple)
		t.Skip(fmt.Sprintf("Network access not allowed; use %s=1 to enable", TestEnvVar))
		^
google/resource_compute_instance_migrate_test.go:586:3: S1038: should use t.Skipf(...) instead of t.Skip(fmt.Sprintf(...)) (gosimple)
		t.Skip(fmt.Sprintf("Network access not allowed; use %s=1 to enable", TestEnvVar))
		^
google/resource_compute_instance_migrate_test.go:659:3: S1038: should use t.Skipf(...) instead of t.Skip(fmt.Sprintf(...)) (gosimple)
		t.Skip(fmt.Sprintf("Network access not allowed; use %s=1 to enable", TestEnvVar))
		^
google/resource_compute_instance_migrate_test.go:731:3: S1038: should use t.Skipf(...) instead of t.Skip(fmt.Sprintf(...)) (gosimple)
		t.Skip(fmt.Sprintf("Network access not allowed; use %s=1 to enable", TestEnvVar))
		^
google/resource_compute_instance_migrate_test.go:797:3: S1038: should use t.Skipf(...) instead of t.Skip(fmt.Sprintf(...)) (gosimple)
		t.Skip(fmt.Sprintf("Network access not allowed; use %s=1 to enable", TestEnvVar))
		^
make: *** [lint] Error 1

google-cla · 2022-05-18T08:14:09Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

For more information, open the CLA check for this pull request.

modular-magician · 2022-05-18T08:15:09Z

Hello! I am a robot who works on Magic Modules PRs.

I've detected that you're a community contributor. @melinath, a repository maintainer, has been assigned to assist you and help review your changes.

❓ First time contributing? Click here for more details

Your assigned reviewer will help review your code by:

Ensuring it's backwards compatible, covers common error cases, etc.
Summarizing the change into a user-facing changelog note.
Passes tests, either our "VCR" suite, a set of presubmit tests, or with manual test runs.

You can help make sure that review is quick by running local tests and ensuring they're passing in between each push you make to your PR's branch. Also, try to leave a comment with each push you make, as pushes generally don't generate emails.

If your reviewer doesn't get back to you within a week after your most recent change, please feel free to leave a comment on the issue asking them to take a look! In the absence of a dedicated review dashboard most maintainers manage their pending reviews through email, and those will sometimes get lost in their inbox.

modular-magician · 2022-05-18T08:29:34Z

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 6 files changed, 202 insertions(+), 16 deletions(-))
Terraform Beta: Diff ( 3 files changed, 186 insertions(+))
TF Validator: Diff ( 3 files changed, 44 insertions(+), 3 deletions(-))
TF OiCS: Diff ( 4 files changed, 117 insertions(+))

modular-magician · 2022-05-18T09:12:27Z

Tests analytics

Total tests: 2020
Passed tests 1792
Skipped tests: 226
Failed tests: 2

Action taken

Triggering VCR tests in RECORDING mode for the following tests that failed during VCR: TestAccComputeBackendBucket_backendBucketCacheKeyPolicyExample|TestAccCloudAssetFolderFeed_cloudAssetFolderFeedExample

modular-magician · 2022-05-18T09:13:23Z

Tests passed during RECORDING mode:
TestAccComputeBackendBucket_backendBucketCacheKeyPolicyExample[view]

Tests failed during RECORDING mode:
TestAccCloudAssetFolderFeed_cloudAssetFolderFeedExample[view]

Please fix these to complete your PR
View the build log or the debug log for each test

melinath

This looks good overall - the failure of TestAccCloudAssetFolderFeed_cloudAssetFolderFeedExample seems to be unrelated. Regarding the lint issues - it could be due to a different golang or golangci-lint version than what is used in CI/CD.

CI/CD versions are:

go 1.16
golangci-lint v1.40.1 (looks like you're using 1.46.2)

melinath · 2022-05-24T20:58:00Z

mmv1/products/compute/api.yaml

+          description: 'The CacheKeyPolicy for this CdnPolicy.'
+          properties:
+          - !ruby/object:Api::Type::Array
+            send_empty_value: true


Why is send_empty_value set here & below?

I think that not setting send_empty_value causes a problem that is similar to hashicorp/terraform-provider-google#5273, but I'm not 100% sure about it because I am not quite familiar with Terraform.

melinath · 2022-05-24T20:58:50Z

mmv1/products/compute/terraform.yaml

@@ -166,6 +166,11 @@ overrides: !ruby/object:Overrides::ResourceOverrides
        vars:
          backend_bucket_name: "image-backend-bucket"
          bucket_name: "image-store-bucket"
+      - !ruby/object:Provider::Terraform::Examples
+        name: "backend_bucket_cache_key_policy"


Could you add another example that uses include_http_headers?

OK. I added it!

modular-magician · 2022-05-26T08:05:18Z

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 3 files changed, 257 insertions(+))
Terraform Beta: Diff ( 3 files changed, 257 insertions(+))
TF Validator: Diff ( 3 files changed, 44 insertions(+), 3 deletions(-))
TF OiCS: Diff ( 8 files changed, 234 insertions(+))

modular-magician · 2022-05-26T08:52:42Z

Tests analytics

Total tests: 2030
Passed tests 1801
Skipped tests: 226
Failed tests: 3

Action taken

Triggering VCR tests in RECORDING mode for the tests that failed during VCR. Click here to see the failed tests

TestAccFirebaserulesRelease_BasicRelease|TestAccComputeBackendBucket_backendBucketIncludeHttpHeadersExample|TestAccComputeBackendBucket_backendBucketQueryStringWhitelistExample

modular-magician · 2022-05-26T08:54:05Z

Tests passed during RECORDING mode:
TestAccComputeBackendBucket_backendBucketQueryStringWhitelistExample[view]
TestAccFirebaserulesRelease_BasicRelease[view]
TestAccComputeBackendBucket_backendBucketIncludeHttpHeadersExample[view]

All tests passed
View the build log or the debug log for each test

melinath

lgtm

Add support for cacheKeyPolicy in BackendBuckets

c38a90a

modular-magician requested a review from melinath May 18, 2022 08:15

melinath requested changes May 24, 2022

View reviewed changes

Add an example of include_http_headers

01023aa

melinath self-requested a review May 26, 2022 15:24

melinath approved these changes May 31, 2022

View reviewed changes

melinath merged commit 46d49d3 into GoogleCloudPlatform:main May 31, 2022

genkami deleted the support-backend-bucket-cache-key-policy branch June 1, 2022 05:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for cacheKeyPolicy in BackendBuckets #6043

Add support for cacheKeyPolicy in BackendBuckets #6043

genkami commented May 18, 2022

google-cla bot commented May 18, 2022

modular-magician commented May 18, 2022

modular-magician commented May 18, 2022

modular-magician commented May 18, 2022

modular-magician commented May 18, 2022

melinath left a comment •

edited

Loading

melinath May 24, 2022

genkami May 26, 2022

melinath May 24, 2022

genkami May 26, 2022

modular-magician commented May 26, 2022

modular-magician commented May 26, 2022

modular-magician commented May 26, 2022

melinath left a comment

Add support for cacheKeyPolicy in BackendBuckets #6043

Add support for cacheKeyPolicy in BackendBuckets #6043

Conversation

genkami commented May 18, 2022

google-cla bot commented May 18, 2022

modular-magician commented May 18, 2022

modular-magician commented May 18, 2022

Diff report:

modular-magician commented May 18, 2022

Tests analytics

Action taken

modular-magician commented May 18, 2022

melinath left a comment • edited Loading

Choose a reason for hiding this comment

melinath May 24, 2022

Choose a reason for hiding this comment

genkami May 26, 2022

Choose a reason for hiding this comment

melinath May 24, 2022

Choose a reason for hiding this comment

genkami May 26, 2022

Choose a reason for hiding this comment

modular-magician commented May 26, 2022

Diff report:

modular-magician commented May 26, 2022

Tests analytics

Action taken

modular-magician commented May 26, 2022

melinath left a comment

Choose a reason for hiding this comment

melinath left a comment •

edited

Loading