[RFC] otk: error when a otk.include inside a dict override the dict
#176
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
We allow the following:
```yaml
otk.target.osbuild:
sub:
c: d
otk.include: "foo.yaml"
```
The current semantic is that if the resolved value of `foo.yaml` is in
itself a dict the two are merged and if it's a non-dict value
the `sub` tree is replaced with the scalar value from `foo.yaml`.
However in the above example this can lead to unexpected results,
i.e. depending on how `foo.yaml` resolves `c: d` is removed or
kept.
This commit make it an error if an `otk.include` inside a non
empty dict returns a scalar. We *could* consider also making it
a warning but I fail to see a use-case right now (that is not
contrived) where this would not be unexpected/unwanted behavior.
supakeen
approved these changes
Jul 10, 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.
We allow the following:
The current semantic is that if the resolved value of
foo.yamlis in itself a dict the two are merged and if it's a non-dict value thesubtree is replaced with the scalar value fromfoo.yaml.However in the above example this can lead to unexpected results, i.e. depending on how
foo.yamlresolvesc: dis removed or kept.This commit make it an error if an
otk.includeinside a non empty dict returns a scalar. We could consider also making it a warning but I fail to see a use-case right now (that is not contrived) where this would not be unexpected/unwanted behavior.