internal/schemavalidator: Fix bug where unknown values were returning error diagnostics too early #252
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
… error diagnostics too early
austinvalle
changed the title
SBGoods
approved these changes
Dec 12, 2024
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.
Closes #251
This PR introduces a small fix to the
internal/schemavalidatorpackage (used by all of the type specific equivalents), where unknown values were being treated as if they were known "not null" values, thus raising early diagnostics where they may not be valid (see linked issue).This fix was made to
ConflictsWithandAlsoRequires, but I also added tests to the other already working schema validators. Eventually when #250 lands, we can update these validators to check for the "not null refinement", to reintroduce earlier diagnostics accurately for unknown values.Test errors prior to fix:
--- FAIL: TestConflictsWithValidatorValidate (0.00s) --- FAIL: TestConflictsWithValidatorValidate/self-is-unknown (0.00s) /Users/austin.valle/code/terraform-plugin-framework-validators/internal/schemavalidator/conflicts_with_test.go:287: expected no error(s), got 1: [{{Attribute "foo" cannot be specified when "bar" is specified Invalid Attribute Combination} {[bar]}}]--- FAIL: TestAlsoRequiresValidatorValidate (0.00s) --- FAIL: TestAlsoRequiresValidatorValidate/self-is-unknown (0.00s) /Users/austin.valle/code/terraform-plugin-framework-validators/internal/schemavalidator/also_requires_test.go:286: expected no error(s), got 1: [{{Attribute "foo" must be specified when "bar" is specified Invalid Attribute Combination} {[bar]}}]