Stop provider sending empty description fields in IAM conditions, to avoid permadiffs in plans #12653
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…avoid permadiffs in plans (hashicorp#6473) * Stop provider sending empty description field, to avoid permadiffs in plans * Add test asserting that `description` fields are omitted from `policy_data` if it's not set in the config * Update existing IAM tests to include conditions with empty descriptions * Fix "Too many condition blocks" error in `google_project_iam_binding` test * Make titles unique between multiple `google_project_iam_binding` resources * Update new test to assert both policy_data match after resource creation finishes Previously this wasn't the case; the resource was Read from the API after create and saved to state, resulting in changes in the policy from the API being saved to state and causing diffs * Change tests to hardcode the title of the second condition This makes this branchs changes consistent and minimises the change on function signatures. Also, the new bindings are not imported so the data is not needed in the body of the test. * Allow IAM condition test generation in GA provider * Allow IAM condition docs generation in GA provider * Update context for IAM condition acctests to include descriptions and fields for bindings without descriptions * Update import step of acctests to navigate possible SDK bug * Fix variable name and expected policy order in admin IAM condition tests * Add missing member type to IAM condition test, update code comments * Change test back to using ImportStateVerify instead of ImportStateCheck for IAM condition acctests * Add checks to test steps, remove changes to handwritten tests & new test * Update comment about bindings with no descriptions * Add more explicit check that empty descriptions aren't stored in google_iam_policy data sources * Fix comment syntax * Add resources and import steps for `*_member` and `*_binding` IAM conditions without descriptions Signed-off-by: Modular Magician <magic-modules@google.com>
|
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. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Partially fixes #8701
This PR changes the
expandIamConditionfunction, which is used in all IAM_bindingand_memberresources to read parts of the resources state and convert it into acloudresourcemanager.Exprvariable.By removing
"Description"from theForceSendFieldsit stops those variables containing empty Description fields. In the case of thegoogle_iam_policydata source, this means that all the zero valueddescriptionfields are ignored when thepolicy_dataJSON is generated from the config input.This prevents the
policy_dataJSON containing empty description fields:If the JSON contains empty description fields there is a perma-diff that is only present in plans after a user makes a legitimate change to the config. Then, the plan contains lots of additional meaningless diffs to add empty descriptions:
If this PR is for Terraform, I acknowledge that I have:
make testandmake lintto 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).N/ARelease Note Template for Downstream PRs (will be copied)
Derived from GoogleCloudPlatform/magic-modules#6473