Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions cli-plugins/manager/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,24 @@ func (e errPluginNotFound) Error() string {
// [ConfigFile.CLIPluginsExtraDirs]: https://pkg.go.dev/github.com/docker/[email protected]+incompatible/cli/config/configfile#ConfigFile.CLIPluginsExtraDirs
func getPluginDirs(cfg *configfile.ConfigFile) []string {
var pluginDirs []string

if cfg != nil {
pluginDirs = append(pluginDirs, cfg.CLIPluginsExtraDirs...)
pluginDirs = append(pluginDirs, expandEnvVars(cfg.CLIPluginsExtraDirs)...)
}
pluginDir := filepath.Join(config.Dir(), "cli-plugins")
pluginDirs = append(pluginDirs, pluginDir)
pluginDirs = append(pluginDirs, defaultSystemPluginDirs...)
return pluginDirs
}

// Resolve statements like $HOME in plugin directory paths
func expandEnvVars(pluginDirs []string) []string {
var replacedPluginDirs []string
for _, dir := range pluginDirs {
replacedPluginDirs = append(replacedPluginDirs, os.ExpandEnv(dir))
}
return replacedPluginDirs
}

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
Expand Down
24 changes: 24 additions & 0 deletions cli-plugins/manager/manager_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,30 @@ func TestListPluginCandidatesEmpty(t *testing.T) {
assert.Assert(t, len(candidates) == 0)
}

func TestPluginDirEnvironmentVariableExpansion(t *testing.T) {
pluginDir := "plugins1"
t.Setenv("MY_PLUGIN_DIR", pluginDir)
dir := fs.NewDir(t, t.Name(),
fs.WithDir("${MY_PLUGIN_DIR}",
fs.WithFile("docker-plugin1", ""),
),
)
defer dir.Remove()

t.Setenv("DOCKER_CLI_E2E_PLUGINS_EXTRA_DIRS", dir.Join(pluginDir))

cli := test.NewFakeCli(nil)
cli.SetConfigFile(&configfile.ConfigFile{CLIPluginsExtraDirs: []string{"$DOCKER_CLI_E2E_PLUGINS_EXTRA_DIRS"}})

pluginDirs := getPluginDirs(cli.ConfigFile())
expected := []string{
dir.Join(pluginDir),
filepath.Join(config.Dir(), "cli-plugins"),
}
expected = append(expected, defaultSystemPluginDirs...)
assert.DeepEqual(t, expected, pluginDirs)
}

// 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.
Expand Down