Skip to content

Commit

Permalink
cli-plugins: Simplify addPluginCandidatesFromDir
Browse files Browse the repository at this point in the history
The returned error is always nil now, so just remove it.

Signed-off-by: Paweł Gronowski <[email protected]>
(cherry picked from commit fcd94fe)
Signed-off-by: Paweł Gronowski <[email protected]>
  • Loading branch information
vvoland committed Nov 28, 2024
1 parent 5476e9e commit 790d09e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 25 deletions.
28 changes: 7 additions & 21 deletions cli-plugins/manager/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,12 @@ func getPluginDirs(cfg *configfile.ConfigFile) ([]string, error) {
return pluginDirs, nil
}

func addPluginCandidatesFromDir(res map[string][]string, d string) error {
func addPluginCandidatesFromDir(res map[string][]string, d string) {
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 {
return nil
return
}
for _, dentry := range dentries {
switch dentry.Type() & os.ModeType {
Expand All @@ -101,22 +101,15 @@ func addPluginCandidatesFromDir(res map[string][]string, d string) error {
}
res[name] = append(res[name], filepath.Join(d, dentry.Name()))
}
return nil
}

// listPluginCandidates returns a map from plugin name to the list of (unvalidated) Candidates. The list is in descending order of priority.
func listPluginCandidates(dirs []string) (map[string][]string, error) {
func listPluginCandidates(dirs []string) map[string][]string {
result := make(map[string][]string)
for _, d := range dirs {
if err := addPluginCandidatesFromDir(result, d); err != nil {
// Silently ignore paths which don't exist.
if os.IsNotExist(err) {
continue
}
return nil, err // Or return partial result?
}
addPluginCandidatesFromDir(result, d)
}
return result, nil
return result
}

// GetPlugin returns a plugin on the system by its name
Expand All @@ -126,11 +119,7 @@ func GetPlugin(name string, dockerCli command.Cli, rootcmd *cobra.Command) (*Plu
return nil, err
}

candidates, err := listPluginCandidates(pluginDirs)
if err != nil {
return nil, err
}

candidates := listPluginCandidates(pluginDirs)
if paths, ok := candidates[name]; ok {
if len(paths) == 0 {
return nil, errPluginNotFound(name)
Expand All @@ -156,10 +145,7 @@ func ListPlugins(dockerCli command.Cli, rootcmd *cobra.Command) ([]Plugin, error
return nil, err
}

candidates, err := listPluginCandidates(pluginDirs)
if err != nil {
return nil, err
}
candidates := listPluginCandidates(pluginDirs)

var plugins []Plugin
var mu sync.Mutex
Expand Down
6 changes: 2 additions & 4 deletions cli-plugins/manager/manager_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,7 @@ func TestListPluginCandidates(t *testing.T) {
dirs = append(dirs, dir.Join(d))
}

candidates, err := listPluginCandidates(dirs)
assert.NilError(t, err)
candidates := listPluginCandidates(dirs)
exp := map[string][]string{
"plugin1": {
dir.Join("plugins1", "docker-plugin1"),
Expand Down Expand Up @@ -94,11 +93,10 @@ func TestListPluginCandidatesInaccesibleDir(t *testing.T) {
)
defer dir.Remove()

candidates, err := listPluginCandidates([]string{
candidates := 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"),
Expand Down

0 comments on commit 790d09e

Please sign in to comment.