VM: Move check for container-specific prefixed keys applied to VMs up #14680
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
… to VMs up This fixes the following regression: https://github.com/canonical/lxd-ci/actions/runs/12367790805/job/34516721509#step:11:93 Signed-off-by: Kadin Sayani <[email protected]>
kadinsayani
changed the title
simondeziel
reviewed
Dec 17, 2024
| if instanceType == instancetype.VM && shared.StringHasPrefix(key, instancetype.ConfigKeyPrefixesContainer...) { | ||
| return fmt.Errorf("%q isn't supported for %q", key, instanceType) | ||
| } | ||
|
|
||
| // Check if the key is a valid prefix and whether or not it requires a subkey. | ||
| knownPrefixes := append(instancetype.ConfigKeyPrefixesAny, instancetype.ConfigKeyPrefixesContainer...) | ||
| if strings.HasSuffix(key, ".") { |
There was a problem hiding this comment.
Shouldn't we simply reject anything that ends with a trailing . as that's never going to be a valid config key anyway so why bother doing more checks?
There was a problem hiding this comment.
We can do that, however, the additional check allows us to return more specific error messages:
"Unknown configuration key: %q" if the key is not known and "%q requires a subkey" if the key is known but missing a subkey. Also, the check is pretty inexpensive computationally since the knownPrefixes slice is only 5 elements.
simondeziel
approved these changes
Dec 17, 2024
tomponline
approved these changes
Dec 17, 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.
This PR fixes the following regression:
https://github.com/canonical/lxd-ci/actions/runs/12367790805/job/34516721509#step:11:93.
We always need to check config keys applied to VM's to ensure container-specific prefixed keys are disallowed.