1berry/docker-cli
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

cli-plugins: Fix searching inaccessible directories

Browse Source 
Fix a case where one inaccessible plugin search path stops the whole
search and prevents latter paths from being scanned.

Remove a preliminary `Stat` call that verifies whether path is an actual
directory and is accessible.
It's unneeded and doesn't actually check whether the directory can be
listed or not.
`os.ReadDir` will fail in such case anyway, so just attempt to do that
and ignore any encountered error, instead of erroring out the whole
plugin candidate listing.

Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
This commit is contained in:
Paweł Gronowski 2024-11-28 12:45:19 +01:00
parent 682cf57d73
commit 6de3d71ab6
No known key found for this signature in database
GPG Key ID: B85EFCFE26DEF92A
2 changed files with 27 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
cli-plugins/manager/manager.go
View File

@ -77,8 +77,10 @@ func getPluginDirs(cfg *configfile.ConfigFile) ([]string, error) {
func addPluginCandidatesFromDir(res map[string][]string, d string) error { func addPluginCandidatesFromDir(res map[string][]string, d string) error {
dentries, err := os.ReadDir(d) dentries, err := os.ReadDir(d)
// Silently ignore any directories which we cannot list (e.g. due to
// permissions or anything else) or which is not a directory
if err != nil { if err != nil {
return err return nil
} }
for _, dentry := range dentries { for _, dentry := range dentries {
switch dentry.Type() & os.ModeType { switch dentry.Type() & os.ModeType {
@ -106,12 +108,6 @@ func addPluginCandidatesFromDir(res map[string][]string, d string) error {
func listPluginCandidates(dirs []string) (map[string][]string, error) { func listPluginCandidates(dirs []string) (map[string][]string, error) {
result := make(map[string][]string) result := make(map[string][]string)
for _, d := range dirs { for _, d := range dirs {
// Silently ignore any directories which we cannot
// Stat (e.g. due to permissions or anything else) or
// which is not a directory.
if fi, err := os.Stat(d); err != nil || !fi.IsDir() {
continue
}
if err := addPluginCandidatesFromDir(result, d); err != nil { if err := addPluginCandidatesFromDir(result, d); err != nil {
// Silently ignore paths which don't exist. // Silently ignore paths which don't exist.
if os.IsNotExist(err) { if os.IsNotExist(err) {

24
cli-plugins/manager/manager_test.go
View File

@ -82,6 +82,30 @@ func TestListPluginCandidates(t *testing.T) {
assert.DeepEqual(t, candidates, exp) assert.DeepEqual(t, candidates, exp)
} }
// Regression test for https://github.com/docker/cli/issues/5643.
// Check that inaccessible directories that come before accessible ones are ignored
// and do not prevent the latter from being processed.
func TestListPluginCandidatesInaccesibleDir(t *testing.T) {
dir := fs.NewDir(t, t.Name(),
fs.WithDir("no-perm", fs.WithMode(0)),
fs.WithDir("plugins",
fs.WithFile("docker-buildx", ""),
),
)
defer dir.Remove()
candidates, err := listPluginCandidates([]string{
dir.Join("no-perm"),
dir.Join("plugins"),
})
assert.NilError(t, err)
assert.DeepEqual(t, candidates, map[string][]string{
"buildx": {
dir.Join("plugins", "docker-buildx"),
},
})
}
func TestGetPlugin(t *testing.T) { func TestGetPlugin(t *testing.T) {
dir := fs.NewDir(t, t.Name(), dir := fs.NewDir(t, t.Name(),
fs.WithFile("docker-bbb", ` fs.WithFile("docker-bbb", `