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

Made bigquery table schema diffsuppress func handle nested lists gracefully #9302

Conversation

modular-magician
Copy link
Collaborator

Resolved #9230. The comparison function was assuming that if the current object was a list, it was the top-level schema list and could be sorted by field name. However, this logic ended up also getting applied to nested lists, which don't have a field name to sort by (thus causing a panic.)

Specifically, bigquery table schema can specify policyTags per-column.

I believe the purpose of sorting by field name is to prevent diffs if fields in the schema are reordered. We can preserve this logic by pre-sorting the schema by field name prior to passing it to the comparison function. (Note: due to nested fields, ended up going with a different strategy.)

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)

bigquery: Fixed `google_bigquery_table.schema` handling of policyTags

Derived from GoogleCloudPlatform/magic-modules#4832

…efully (hashicorp#4832)

* Added basic tests for biquery table schema diff suppress

* Only sort the top level of a bigquery schema when checking diff suppression

* Keep suppressing diff for subfield reordering

* Merged BigQueryDataTableJSONEquivalencyTestCases into diff suppress test cases

* Formatting cleanup

* Added a test with multiple levels of reordering and also policyTags at multiple levels

Signed-off-by: Modular Magician <[email protected]>
@modular-magician modular-magician merged commit 8a8f27e into hashicorp:master Jun 4, 2021
@github-actions
Copy link

github-actions bot commented Jul 5, 2021

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 5, 2021
@modular-magician modular-magician deleted the downstream-pr-c57c10bd793c5582cdf68aadef549dad8948d62e branch November 17, 2024 01:45
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Terraform plan crashes: interface conversion: interface {} is string, not map[string]interface {}
1 participant