many: make snap pack --check-skeleton error logs consistent #14547
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -318,7 +318,7 @@ func validateContainer(c Container, needsrx, needsx, needsr, needsf, noskipd map | |
|
|
||
| // bad modes are logged instead of being returned because the end user | ||
| // can do nothing with the info (and the developer can read the logs) | ||
| var firstBadModeErr error | ||
| err := c.Walk(".", func(path string, info os.FileInfo, err error) error { | ||
| if err != nil { | ||
| return err | ||
|
|
@@ -342,7 +342,9 @@ func validateContainer(c Container, needsrx, needsx, needsr, needsf, noskipd map | |
| symlinkInfo, err := evalAndValidateSymlink(c, path) | ||
| if err != nil { | ||
| logf("%s", err) | ||
| if firstBadModeErr == nil { | ||
| firstBadModeErr = err | ||
| } | ||
| } else { | ||
| // use target mode for checks below | ||
| mode = symlinkInfo.targetMode | ||
|
|
@@ -351,33 +353,48 @@ func validateContainer(c Container, needsrx, needsx, needsr, needsf, noskipd map | |
|
|
||
| if mode.IsDir() { | ||
| if mode.Perm()&0555 != 0555 { | ||
| err := fmt.Errorf("%q should be world-readable and executable, and isn't: %s", path, mode) | ||
| logf("in %s %q: %v", contType, name, err) | ||
| if firstBadModeErr == nil { | ||
| firstBadModeErr = err | ||
| } | ||
| } | ||
| } else { | ||
| if needsrx[path] { | ||
| if mode.Perm()&0555 != 0555 { | ||
| err := fmt.Errorf("%q should be world-readable and executable, and isn't: %s", path, mode) | ||
| logf("in snap %q: %v", name, err) | ||
| if firstBadModeErr == nil { | ||
| firstBadModeErr = err | ||
| } | ||
| } | ||
| } | ||
| // XXX: do we need to match other directories? | ||
| if needsf[path] || strings.HasPrefix(path, "meta/") { | ||
| if mode&(os.ModeNamedPipe|os.ModeSocket|os.ModeDevice) != 0 { | ||
| err := fmt.Errorf("%q should be a regular file (or a symlink) and isn't", path) | ||
| logf("in %s %q: ", contType, name, err) | ||
| if firstBadModeErr == nil { | ||
| firstBadModeErr = err | ||
| } | ||
| } | ||
| } | ||
| if needsx[path] || strings.HasPrefix(path, "meta/hooks/") { | ||
| if mode.Perm()&0111 == 0 { | ||
| err := fmt.Errorf("%q should be executable, and isn't: %s", path, mode) | ||
| logf("in %s %q: %v", contType, name, err) | ||
| if firstBadModeErr == nil { | ||
| firstBadModeErr = err | ||
| } | ||
| } | ||
| } else { | ||
| // in needsr, or under meta but not a hook | ||
| if mode.Perm()&0444 != 0444 { | ||
| err := fmt.Errorf("%q should be world-readable, and isn't: %s", path, mode) | ||
| logf("in %s %q: %v", contType, name, err) | ||
| if firstBadModeErr == nil { | ||
| firstBadModeErr = err | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -387,18 +404,25 @@ func validateContainer(c Container, needsrx, needsx, needsr, needsf, noskipd map | |
| return err | ||
| } | ||
| if len(seen) != len(needsx)+len(needsrx)+len(needsr) { | ||
| var firstPath string | ||
| for _, needs := range []map[string]bool{needsx, needsrx, needsr} { | ||
| for path := range needs { | ||
| if !seen[path] { | ||
| logf("in %s %q: path %q does not exist", contType, name, path) | ||
| if firstPath == "" { | ||
| firstPath = path | ||
| } | ||
| } | ||
| } | ||
| } | ||
| // TODO: aggregate path errors not just the first one | ||
| return fmt.Errorf("%w: path %q does not exist", ErrMissingPaths, firstPath) | ||
| } | ||
|
|
||
| if firstBadModeErr != nil { | ||
| // TODO: fmt.Errorf("%w: %w", ErrBadModes, firstBadModeErr) when using go 1.20+ | ||
| // TODO: aggregate bad mode errors not just the first one | ||
| return fmt.Errorf("%w: %v", ErrBadModes, firstBadModeErr) | ||
|
There was a problem hiding this comment. Can we use %w twice? I think we can but I'm not sure if this goes all the way back to go 1.18. There was a problem hiding this comment. Unfortunately we can't, I believe we need go 1.20 for that https://tip.golang.org/doc/go1.20#errors |
||
| } | ||
| return nil | ||
| } | ||
|
|
||
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This works.
It made me think about error aggregation and identification of first instance as a generally useful concept.
Could create error type for aggregation, containing list of
Errors []errorthat defaults to error[0] for message, but can be iterated to concert errors to e.g. json output or detail log entry etc as required.This could the become e.g. accErrorBadModes.add(...)
Anyways, more applicable to longer term solution...