snap/naming: move various name validation helpers to separate package #6016
Conversation
Introuduce a new package that pulls out the validation of various names around snaps. Name validation covers: snaps, instances, apps, aliases, hooks, slots/plugs/interfaces, sockets. The package has no extra dependencies. Signed-off-by: Maciej Borzecki <maciej.zenon.borzecki@canonical.com>
Signed-off-by: Maciej Borzecki <maciej.zenon.borzecki@canonical.com>
Signed-off-by: Maciej Borzecki <maciej.zenon.borzecki@canonical.com>
|
wouldn't (super big +1 to the change beyond this) |
|
@chipaca that's something I thought of in the beginning. The downside is, you'd still need to have access to |
Signed-off-by: Maciej Borzecki <maciej.zenon.borzecki@canonical.com>
Signed-off-by: Maciej Borzecki <maciej.zenon.borzecki@canonical.com>
|
I think this is nice - I am not sure if I understand @chipaca correct but I also prefer |
|
Please deconflict @bboozzoo |
…ame-separate-package
…ame-separate-package
Rename the package Signed-off-by: Maciej Borzecki <maciej.zenon.borzecki@canonical.com>
Signed-off-by: Maciej Borzecki <maciej.zenon.borzecki@canonical.com>
Signed-off-by: Maciej Borzecki <maciej.zenon.borzecki@canonical.com>
|
As discussed, I've renamed the package to |
bboozzoo
changed the title
Signed-off-by: Maciej Borzecki <maciej.zenon.borzecki@canonical.com>
| return fmt.Errorf("invalid instance key: %q", instanceKey) | ||
| } | ||
| return nil | ||
| return naming.ValidateInstance(instanceName) |
There was a problem hiding this comment.
what are your thoughts? is that a intermediate step for churn? I would suppose in the end we don't want this indirection functions
There was a problem hiding this comment.
Yes, I didn't want the diff to be overly large. The cleanup can be introduced once this PR lands.
snap/naming/validate.go
Outdated
| } | ||
| if !validInstanceKey.MatchString(instanceKey) { | ||
| // TODO parallel-install: extend the error message once snap | ||
| // install help has been updated |
There was a problem hiding this comment.
is this TODO still relevant? something we can do now?
snap/naming/validate.go
Outdated
| // validators. | ||
| var almostValidName = regexp.MustCompile("^[a-z0-9-]*[a-z][a-z0-9-]*$") | ||
|
|
||
| // validInstanceKey is a regular expression describing valid snap instance key |
| * | ||
| */ | ||
|
|
||
| package naming |
There was a problem hiding this comment.
// Package naming implements naming constraints for snaps and their elements.
snap/naming/validate.go
Outdated
| // validInstanceKey is a regular expression describing valid snap instance key | ||
| var validInstanceKey = regexp.MustCompile("^[a-z0-9]{1,10}$") | ||
|
|
||
| // isValidName checks snap and socket socket identifiers. |
There was a problem hiding this comment.
s/socket socket/socket/ ?
Signed-off-by: Maciej Borzecki <maciej.zenon.borzecki@canonical.com>
…ame-separate-package
Follow-up on the package separation idea discussed in #5948. The PR moves various snap related name validation helpers into a separate package that can be easily imported without pulling in the whole of
githut.com/snapcore/snapd/snapbaggage.As part of the PR, the package is used by model assertion validation code, where the
snappackage could not have been previously used.