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.

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

Added fields to google_compute_security_policy to support Cloud Armor bot management #6857

Merged
merged 1 commit into from
Dec 1, 2022

Conversation

zli82016
Copy link
Member

@zli82016 zli82016 commented Nov 21, 2022

Fixed hashicorp/terraform-provider-google#10062

API: https://cloud.google.com/compute/docs/reference/rest/v1/securityPolicies

https://cloud.google.com/armor/docs/configure-security-policies#bot-management

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 fields to resource `google_compute_security_policy` to support Cloud Armor bot management

@modular-magician
Copy link
Collaborator

Oops! It looks like you're using an unknown release-note type in your changelog entries:

  • REPLACEME

Please only use the types listed in https://github.com/GoogleCloudPlatform/magic-modules/blob/master/.ci/RELEASE_NOTES_GUIDE.md.

@modular-magician
Copy link
Collaborator

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

I've detected that you're a community contributor. @roaks3, 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.


@zli82016 zli82016 changed the title Added fields to google_compute_security_policy to support Cloud Arm… Added fields to google_compute_security_policy to support Cloud Armor bot management Nov 22, 2022
@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 3 files changed, 503 insertions(+), 1 deletion(-))
Terraform Beta: Diff ( 3 files changed, 503 insertions(+), 1 deletion(-))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2280
Passed tests 2023
Skipped tests: 244
Failed tests: 13

Action taken

Triggering VCR tests in RECORDING mode for the tests that failed during VCR. Click here to see the failed tests
TestAccLoggingBucketConfigProject_cmekSettings|TestAccFirebaserulesRelease_BasicRelease|TestAccComputeSecurityPolicy_withRateLimitWithRedirectOptions|TestAccComputeSecurityPolicy_withRateLimitOptions|TestAccComputeSecurityPolicy_update|TestAccComputeSecurityPolicy_withPreconfiguredWafConfig|TestAccComputeSecurityPolicy_withRuleExpr|TestAccComputeSecurityPolicy_withRule|TestAccComputeSecurityPolicy_withRedirectOptionsExternal|TestAccComputeSecurityPolicy_withRedirectOptionsUpdate|TestAccComputeSecurityPolicy_withHeadAction|TestAccComputeSecurityPolicy_withRecaptchaOptionsConfig|TestAccComputeSecurityPolicy_withRedirectOptionsRecaptcha

@modular-magician
Copy link
Collaborator

Tests passed during RECORDING mode:
TestAccLoggingBucketConfigProject_cmekSettings[Debug log]
TestAccFirebaserulesRelease_BasicRelease[Debug log]
TestAccComputeSecurityPolicy_withRateLimitWithRedirectOptions[Debug log]
TestAccComputeSecurityPolicy_withRateLimitOptions[Debug log]
TestAccComputeSecurityPolicy_update[Debug log]
TestAccComputeSecurityPolicy_withPreconfiguredWafConfig[Debug log]
TestAccComputeSecurityPolicy_withRuleExpr[Debug log]
TestAccComputeSecurityPolicy_withRule[Debug log]
TestAccComputeSecurityPolicy_withRedirectOptionsExternal[Debug log]
TestAccComputeSecurityPolicy_withRedirectOptionsUpdate[Debug log]
TestAccComputeSecurityPolicy_withHeadAction[Debug log]
TestAccComputeSecurityPolicy_withRecaptchaOptionsConfig[Debug log]
TestAccComputeSecurityPolicy_withRedirectOptionsRecaptcha[Debug log]

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

@zli82016
Copy link
Member Author

/gcbrun

@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 3 files changed, 503 insertions(+), 1 deletion(-))
Terraform Beta: Diff ( 3 files changed, 503 insertions(+), 1 deletion(-))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2280
Passed tests 2035
Skipped tests: 244
Failed tests: 1

Action taken

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

@modular-magician
Copy link
Collaborator

Tests passed during RECORDING mode:
TestAccLoggingBucketConfigProject_cmekSettings[Debug log]

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

Copy link
Contributor

@roaks3 roaks3 left a comment

Choose a reason for hiding this comment

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

LGTM, I only had one clarifying question and some nits.

Adding Stephen for follow-up review

@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 3 files changed, 515 insertions(+), 1 deletion(-))
Terraform Beta: Diff ( 3 files changed, 515 insertions(+), 1 deletion(-))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2283
Passed tests 2038
Skipped tests: 244
Failed tests: 1

Action taken

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

@modular-magician
Copy link
Collaborator

Tests passed during RECORDING mode:
TestAccLoggingBucketConfigProject_cmekSettings[Debug log]

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

Copy link
Member

@melinath melinath left a comment

Choose a reason for hiding this comment

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

LGTM, one question

ImportStateVerify: true,
},
{
Config: testAccComputeSecurityPolicy_withRecaptchaOptionsConfig(project, spName, keyDisplayNameUpdate),
Copy link
Member

Choose a reason for hiding this comment

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

it looks like keyDisplayName is only used in google_recaptcha_enterprise_key, which isn't the resource under test - why do we need this configuration change?

@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 3 files changed, 515 insertions(+), 1 deletion(-))
Terraform Beta: Diff ( 3 files changed, 515 insertions(+), 1 deletion(-))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@zli82016
Copy link
Member Author

/gcbrun

@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 3 files changed, 515 insertions(+), 1 deletion(-))
Terraform Beta: Diff ( 3 files changed, 515 insertions(+), 1 deletion(-))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2304
Passed tests 2052
Skipped tests: 244
Failed tests: 8

Action taken

Triggering VCR tests in RECORDING mode for the tests that failed during VCR. Click here to see the failed tests
TestAccDataFusionInstance_dataFusionInstanceFullExample|TestAccDataFusionInstance_dataFusionInstanceZoneExample|TestAccDataFusionInstance_dataFusionInstanceEventExample|TestAccComputeSecurityPolicy_withRecaptchaOptionsConfig|TestAccDataFusionInstanceIamBindingGenerated|TestAccDataFusionInstanceIamPolicyGenerated|TestAccDataFusionInstanceIamMemberGenerated|TestAccLoggingBucketConfigProject_cmekSettings

@zli82016 zli82016 force-pushed the armor-bot branch 2 times, most recently from 64c312d to 0ee62a4 Compare November 29, 2022 19:18
@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 3 files changed, 515 insertions(+), 1 deletion(-))
Terraform Beta: Diff ( 3 files changed, 515 insertions(+), 1 deletion(-))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@melinath
Copy link
Member

melinath commented Nov 29, 2022

It looks like the TFV failures are because the order of the rules flipped - which makes sense since it's a Set, so the ordering shouldn't be deterministic. But if the new ordering is consistent, it would probably be easiest to make the expected test output match the current output: https://github.com/GoogleCloudPlatform/magic-modules/blob/main/mmv1/third_party/validator/tests/data/example_compute_security_policy.json

(And open an issue to track fixing the tests to handle set fields better)

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2304
Passed tests 2054
Skipped tests: 244
Failed tests: 6

Action taken

Triggering VCR tests in RECORDING mode for the tests that failed during VCR. Click here to see the failed tests
TestAccFirebaserulesRelease_BasicRelease|TestAccComputeSecurityPolicy_withRecaptchaOptionsConfig|TestAccCloudfunctions2function_cloudfunctions2BasicAuditlogsExample|TestAccCloudfunctions2function_cloudfunctions2BasicGcsExample|TestAccCloudFunctions2Function_fullUpdate|TestAccLoggingBucketConfigProject_cmekSettings

@modular-magician
Copy link
Collaborator

Tests passed during RECORDING mode:
TestAccFirebaserulesRelease_BasicRelease[Debug log]
TestAccComputeSecurityPolicy_withRecaptchaOptionsConfig[Debug log]
TestAccCloudfunctions2function_cloudfunctions2BasicAuditlogsExample[Debug log]
TestAccCloudfunctions2function_cloudfunctions2BasicGcsExample[Debug log]
TestAccCloudFunctions2Function_fullUpdate[Debug log]
TestAccLoggingBucketConfigProject_cmekSettings[Debug log]

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

@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 3 files changed, 543 insertions(+), 1 deletion(-))
Terraform Beta: Diff ( 3 files changed, 543 insertions(+), 1 deletion(-))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2304
Passed tests 2058
Skipped tests: 244
Failed tests: 2

Action taken

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

@modular-magician
Copy link
Collaborator

Tests passed during RECORDING mode:
TestAccLoggingBucketConfigProject_cmekSettings[Debug log]
TestAccFirebaserulesRelease_BasicRelease[Debug log]

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

@zli82016
Copy link
Member Author

It looks like the TFV failures are because the order of the rules flipped - which makes sense since it's a Set, so the ordering shouldn't be deterministic. But if the new ordering is consistent, it would probably be easiest to make the expected test output match the current output: https://github.com/GoogleCloudPlatform/magic-modules/blob/main/mmv1/third_party/validator/tests/data/example_compute_security_policy.json

(And open an issue to track fixing the tests to handle set fields better)

Thanks. I modified the test cases and no validation errors this time.

Copy link
Member

@melinath melinath left a comment

Choose a reason for hiding this comment

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

LGTM - feel free to merge whenever you're ready.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Terraform support for Cloud Armor bot management
4 participants