many: fix snap set and unset panics on empty strings #14958
Merged
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #14958 +/- ##
=========================================
Coverage ? 78.26%
=========================================
Files ? 1160
Lines ? 153488
Branches ? 0
=========================================
Hits ? 120133
Misses ? 25950
Partials ? 7405
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
olivercalder
approved these changes
Jan 21, 2025
|
@olivercalder done, thanks! |
|
Fri Jan 24 17:00:57 UTC 2025 Failures:Preparing:
Restoring:
|
bboozzoo
reviewed
Jan 22, 2025
client/clientutil/config.go
Outdated
| @@ -52,6 +53,10 @@ func ParseConfigValues(confValues []string, opts *ParseConfigOptions) (map[strin | |||
| parts := strings.SplitN(patchValue, "=", 2) | |||
| if len(parts) == 1 && strings.HasSuffix(patchValue, "!") { | |||
| key := strings.TrimSuffix(patchValue, "!") | |||
| if key == "" { | |||
| return nil, nil, errors.New(i18n.G("configuration keys cannot be empty")) | |||
There was a problem hiding this comment.
maybe we could use a more specific error for ! input:
Suggested change
| return nil, nil, errors.New(i18n.G("configuration keys cannot be empty")) | |
| return nil, nil, errors.New(i18n.G("configuration keys cannot be empty (want key! to unset a key)")) |
andrewphelpsj
force-pushed
the
fix-snap-unset-panic
branch
from
0b0767e to
e9e0278
Compare
valentindavid
approved these changes
Jan 24, 2025
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.
These cases were triggering panics:
These all end up in
config.Transaction.Set, which callsconfig.PatchConfig. That function assumes that the parameters that are passed in are valid. In these given cases, the key we're either trying to set or unset is an empty string.I added a check in
config.Transaction.Setto hopefully prevent this kind of thing in the future, and I added explicit checks on the CLI side to prevent a trip to the daemon in the case that we have invalid parameters.This was reported here: https://forum.snapcraft.io/t/bug-calling-unset-with-empty-string-explodes-snapd/44741