New Checks: XS003: Check Schema for potential panic/diff #236
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
… not string literal (as comment said)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The XS003 analyzer reports cases of schemas where a non-computed nested block property of
TypeListcontains optional-only and non-default child properties, which has noAtLeastOneOf/ExactlyOneOfconstraint.This kind of schema causes panic like in hashicorp/terraform-provider-azurerm#11426 (and more). Also, if we work this kind of issue around during expanding, an empty block will still cause noising plan diff. A good solution is to add the constraint in schema.
This check has help AzureRM provider codebase to detect ~100 schemas that have panic risk (hashicorp/terraform-provider-azurerm#11452).