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

fix enforce_on_key_configs #8165

Merged
merged 2 commits into from
Jul 21, 2023

Conversation

edwardmedia
Copy link
Contributor

@edwardmedia edwardmedia commented Jun 16, 2023

Fixes hashicorp/terraform-provider-google#14905

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).
  • 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).
  • Generated Terraform providers, and ran make test and make lint in the generated providers to ensure it passes unit and linter tests.
  • Ran relevant acceptance tests using my own Google Cloud project and credentials (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).
  • Read Write release notes before writing my release note below.

Release Note Template for Downstream PRs (will be copied)

compute: fixed wrongly trigger recreation on changes of `enforce_on_key_configs` on `google_compute_security_policy`

@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. @SarahFrench, 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
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 Beta: Diff ( 1 file changed, 1 deletion(-))

@SarahFrench
Copy link
Collaborator

Note for myself after the acceptance tests complete: rules in this policy resource are updated through add/delete actions because the resource is handwritten and uses a client library. The underlying API allows patches of the policy, patches of specific rules inside the policy, and imperative methods like addRule and removeRule.

Given this info, it definitely doesn't make sense for ForceNew to be there as individual rules can be deleted from the policy without issue and the API doesn't describe special behaviour for this field.

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2794
Passed tests 2490
Skipped tests: 301
Affected tests: 3

Action taken

Found 3 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
TestAccComputeSecurityPolicy_EnforceOnKeyUpdates|TestAccComputeNetworkEndpoints_networkEndpointsBasic|TestAccComputeFirewallPolicyRule_multipleRules

Get to know how VCR tests work

@modular-magician
Copy link
Collaborator

Tests passed during RECORDING mode:
TestAccComputeNetworkEndpoints_networkEndpointsBasic[Debug log]

Tests failed during RECORDING mode:
TestAccComputeSecurityPolicy_EnforceOnKeyUpdates[Error message] [Debug log]
TestAccComputeFirewallPolicyRule_multipleRules[Error message] [Debug log]

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

@SarahFrench
Copy link
Collaborator

SarahFrench commented Jun 16, 2023

Looks like the ForceNew for this field may have been masking an issue in an acceptance test?

The errors above say:

Error 400: Invalid value for field 'resource.rateLimitOptions.enforceOnKeyConfigs': ''. Only one of enforceOnKey and enforceOnKeyConfigs can be specified., invalid

Here's the relevant part of API docs that confirms this.

Maybe we should remove these lines from the acceptance tests:

Edit: and also make these fields mutually exclusive in the schema too?

@edwardmedia
Copy link
Contributor Author

edwardmedia commented Jun 25, 2023

This PR is put on hold as the api can't be reset between enforceOnKeyConfigs and enforceOnKey. Although only one of them is provided for the update, below error is still bing hit

Invalid value for field 'resource.rateLimitOptions.enforceOnKeyConfigs': ''. Only one of enforceOnKey and enforceOnKeyConfigs can be specified.

@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 ( 1 file changed, 1 deletion(-))
Terraform Beta: Diff ( 2 files changed, 75 insertions(+), 2 deletions(-))
TF Conversion: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2860
Passed tests 2554
Skipped tests: 299
Affected tests: 7

Action taken

Found 7 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
TestAccComputeSecurityPolicy_update|TestAccComputeSecurityPolicy_withPreconfiguredWafConfig|TestAccComputeSecurityPolicy_withRedirectOptionsUpdate|TestAccComputeSecurityPolicy_EnforceOnKeyUpdates|TestAccComputeSecurityPolicy_withHeadAction|TestAccContainerAwsNodePool_BetaBasicHandWritten|TestAccComputeFirewallPolicyRule_multipleRules

Get to know how VCR tests work

@modular-magician
Copy link
Collaborator

$\textcolor{green}{\textsf{Tests passed during RECORDING mode:}}$
TestAccComputeSecurityPolicy_update[Debug log]
TestAccComputeSecurityPolicy_withPreconfiguredWafConfig[Debug log]
TestAccComputeSecurityPolicy_withRedirectOptionsUpdate[Debug log]
TestAccComputeSecurityPolicy_EnforceOnKeyUpdates[Debug log]
TestAccComputeSecurityPolicy_withHeadAction[Debug log]

Rerun these tests in REPLAYING mode to catch issues

$\textcolor{green}{\textsf{No issues found for passed tests after REPLAYING rerun.}}$


$\textcolor{red}{\textsf{Tests failed during RECORDING mode:}}$
TestAccContainerAwsNodePool_BetaBasicHandWritten[Error message] [Debug log]
TestAccComputeFirewallPolicyRule_multipleRules[Error message] [Debug log]

$\textcolor{red}{\textsf{Please fix these to complete your PR.}}$
View the build log or the debug log for each test

Copy link
Collaborator

@SarahFrench SarahFrench left a comment

Choose a reason for hiding this comment

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

Sorry for the wait - looks good to me

@edwardmedia edwardmedia merged commit bea9ac7 into GoogleCloudPlatform:main Jul 21, 2023
8 checks passed
ericayyliu pushed a commit to ericayyliu/magic-modules that referenced this pull request Jul 26, 2023
* fix enforce_on_key_configs

* add updatemask

---------

Co-authored-by: Edward Sun <sunedward@google.com>
NickElliot pushed a commit to NickElliot/magic-modules that referenced this pull request Jul 31, 2023
* fix enforce_on_key_configs

* add updatemask

---------

Co-authored-by: Edward Sun <sunedward@google.com>
DanielRieske pushed a commit to bschaatsbergen/magic-modules that referenced this pull request Aug 2, 2023
* fix enforce_on_key_configs

* add updatemask

---------

Co-authored-by: Edward Sun <sunedward@google.com>
hao-nan-li pushed a commit to hao-nan-li/magic-modules that referenced this pull request Aug 9, 2023
* fix enforce_on_key_configs

* add updatemask

---------

Co-authored-by: Edward Sun <sunedward@google.com>
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.

enforce_on_key = "" # forces replacement
3 participants