Create a dedicated schema Validation method #22484
Closed
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
jbardin
force-pushed
the
jbardin/configschema-validate
branch
from
f14c1e3
to
8247472
Compare
jbardin
changed the title
jbardin
force-pushed
the
jbardin/configschema-validate
branch
from
51d757f
to
8fca378
Compare
jbardin
changed the title
jbardin
force-pushed
the
jbardin/configschema-validate
branch
from
8fca378
to
de524fb
Compare
jbardin
changed the title
Due to both the nature of dynamic blocks, and the need for resources to sometimes communicate incomplete values, we cannot validate MinItems and MaxItems during decoding or CoerceValue. Since we're reducing the early automatic validation, add a Block.Validate method to precisely validate values, once they are fully known.
If a NestingGroup block has any RequiredAttributes, automatically instantiating that would create a block missing those required attributes. This means that the block itself is essentially required, which we can enforce early in InternalValidate.
Calling this during EvalDiff allows us to validate the final configuration, immediately after all values have been evaluated. This allows us to ensure that values passed to providers always conform to the provider's schema.
This wasn't used until now but we should enforce the schema consistency, especially when providers start generating their own rather than having it done by helper/schema. These will be presented as a warning initially to prevent any unexpected breakage.
jbardin
force-pushed
the
jbardin/configschema-validate
branch
from
5b56d40
to
23a36cf
Compare
|
Rebased to squash a couple commits, hopefully the last cleanup for this PR |
|
I'm still not completely happy with the validation concessions we need here. |
|
I'm going to lock this issue 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 similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
ghost
locked and limited conversation to collaborators
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.
Due to both the nature of dynamic blocks, and the need for resources to
sometimes communicate incomplete values, we cannot validate
MinItemsandMaxItemsduring decoding or inCoerceValue.Since we're reducing the early automatic validation, add a
Block.Validatemethod to precisely validate values. The number of items in theblock will be validated once the values is wholly known.
If a
NestingGroupblock has anyRequiredAttributes, automaticallyinstantiating that would create a block missing those required
attributes, which will fail with the new validation. This means that the
block itself is essentially required, which we can enforce early in
InternalValidate.Since nothing currently makes use of
NestingGroup, we can change thesemantics slightly to better align with the validation rules already present.
This also turns on
InternalValidatefor the schema. While the generated configschemafor existing providers should follow the expectations of
InternalValidate, this willonly return warnings for the time being to avoid breaking any existing providers.
Fixes #22414