Skip to content

Commit

Permalink
Simplify cli plugin config file entry
Browse files Browse the repository at this point in the history 
Make it a simple `map[string]string` for now.

Signed-off-by: Ian Campbell <ijc@docker.com>
  • Loading branch information
Ian Campbell committed Feb 18, 2019
1 parent 3a27e2b commit db0bd19
Show file tree
Hide file tree
Showing 4 changed files with 111 additions and 62 deletions.
84 changes: 57 additions & 27 deletions cli/config/configfile/file.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,32 +24,32 @@ const (

// ConfigFile ~/.docker/config.json file info
type ConfigFile struct {
AuthConfigs map[string]types.AuthConfig `json:"auths"`
HTTPHeaders map[string]string `json:"HttpHeaders,omitempty"`
PsFormat string `json:"psFormat,omitempty"`
ImagesFormat string `json:"imagesFormat,omitempty"`
NetworksFormat string `json:"networksFormat,omitempty"`
PluginsFormat string `json:"pluginsFormat,omitempty"`
VolumesFormat string `json:"volumesFormat,omitempty"`
StatsFormat string `json:"statsFormat,omitempty"`
DetachKeys string `json:"detachKeys,omitempty"`
CredentialsStore string `json:"credsStore,omitempty"`
CredentialHelpers map[string]string `json:"credHelpers,omitempty"`
Filename string `json:"-"` // Note: for internal use only
ServiceInspectFormat string `json:"serviceInspectFormat,omitempty"`
ServicesFormat string `json:"servicesFormat,omitempty"`
TasksFormat string `json:"tasksFormat,omitempty"`
SecretFormat string `json:"secretFormat,omitempty"`
ConfigFormat string `json:"configFormat,omitempty"`
NodesFormat string `json:"nodesFormat,omitempty"`
PruneFilters []string `json:"pruneFilters,omitempty"`
Proxies map[string]ProxyConfig `json:"proxies,omitempty"`
Experimental string `json:"experimental,omitempty"`
StackOrchestrator string `json:"stackOrchestrator,omitempty"`
Kubernetes *KubernetesConfig `json:"kubernetes,omitempty"`
CurrentContext string `json:"currentContext,omitempty"`
CLIPluginsExtraDirs []string `json:"cliPluginsExtraDirs,omitempty"`
Plugins map[string]json.RawMessage `json:"plugins,omitempty"`
AuthConfigs map[string]types.AuthConfig `json:"auths"`
HTTPHeaders map[string]string `json:"HttpHeaders,omitempty"`
PsFormat string `json:"psFormat,omitempty"`
ImagesFormat string `json:"imagesFormat,omitempty"`
NetworksFormat string `json:"networksFormat,omitempty"`
PluginsFormat string `json:"pluginsFormat,omitempty"`
VolumesFormat string `json:"volumesFormat,omitempty"`
StatsFormat string `json:"statsFormat,omitempty"`
DetachKeys string `json:"detachKeys,omitempty"`
CredentialsStore string `json:"credsStore,omitempty"`
CredentialHelpers map[string]string `json:"credHelpers,omitempty"`
Filename string `json:"-"` // Note: for internal use only
ServiceInspectFormat string `json:"serviceInspectFormat,omitempty"`
ServicesFormat string `json:"servicesFormat,omitempty"`
TasksFormat string `json:"tasksFormat,omitempty"`
SecretFormat string `json:"secretFormat,omitempty"`
ConfigFormat string `json:"configFormat,omitempty"`
NodesFormat string `json:"nodesFormat,omitempty"`
PruneFilters []string `json:"pruneFilters,omitempty"`
Proxies map[string]ProxyConfig `json:"proxies,omitempty"`
Experimental string `json:"experimental,omitempty"`
StackOrchestrator string `json:"stackOrchestrator,omitempty"`
Kubernetes *KubernetesConfig `json:"kubernetes,omitempty"`
CurrentContext string `json:"currentContext,omitempty"`
CLIPluginsExtraDirs []string `json:"cliPluginsExtraDirs,omitempty"`
Plugins map[string]map[string]string `json:"plugins,omitempty"`
}

// ProxyConfig contains proxy configuration settings
Expand All @@ -71,7 +71,7 @@ func New(fn string) *ConfigFile {
AuthConfigs: make(map[string]types.AuthConfig),
HTTPHeaders: make(map[string]string),
Filename: fn,
Plugins: make(map[string]json.RawMessage),
Plugins: make(map[string]map[string]string),
}
}

Expand Down Expand Up @@ -332,6 +332,36 @@ func (configFile *ConfigFile) GetFilename() string {
return configFile.Filename
}

// PluginConfig retrieves the requested option for the given plugin.
func (configFile *ConfigFile) PluginConfig(pluginname, option string) (string, bool) {
pluginConfig, ok := configFile.Plugins[pluginname]
if !ok {
return "", false
}
value, ok := pluginConfig[option]
return value, ok
}

// SetPluginConfig sets the option to the given value for the given
// plugin. Passing a value of "" will remove the option. If removing
// the final config item for a given plugin then also cleans up the
// overall plugin entry.
func (configFile *ConfigFile) SetPluginConfig(pluginname, option, value string) {
pluginConfig, ok := configFile.Plugins[pluginname]
if !ok {
pluginConfig = make(map[string]string)
configFile.Plugins[pluginname] = pluginConfig
}
if value != "" {
pluginConfig[option] = value
} else {
delete(pluginConfig, option)
}
if len(pluginConfig) == 0 {
delete(configFile.Plugins, pluginname)
}
}

func checkKubernetesConfiguration(kubeConfig *KubernetesConfig) error {
if kubeConfig == nil {
return nil
Expand Down
75 changes: 41 additions & 34 deletions cli/config/configfile/file_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package configfile

import (
"bytes"
"encoding/json"
"io/ioutil"
"os"
"testing"
Expand Down Expand Up @@ -437,31 +436,17 @@ func TestPluginConfig(t *testing.T) {
configFile := New("test-plugin")
defer os.Remove("test-plugin")

type PluginConfig1 struct {
Data1 string `json:"data1"`
Data2 int `json:"data2"`
// Populate some initial values
configFile.Plugins["plugin1"] = map[string]string{
"data1": "some string",
"data2": "42",
}
type PluginConfig2 struct {
Data3 string `json:"data3"`
configFile.Plugins["plugin2"] = map[string]string{
"data3": "some other string",
}
p1 := PluginConfig1{
Data1: "some string",
Data2: 42,
}
p2 := PluginConfig2{
Data3: "some other string",
}

plugin1, err := json.MarshalIndent(p1, "", "\t")
assert.NilError(t, err)
configFile.Plugins["plugin1"] = plugin1

plugin2, err := json.MarshalIndent(p2, "", "\t")
assert.NilError(t, err)
configFile.Plugins["plugin2"] = plugin2

// Save a config file with some plugin config
err = configFile.Save()
err := configFile.Save()
assert.NilError(t, err)

// Read it back and check it has the expected content
Expand All @@ -471,25 +456,47 @@ func TestPluginConfig(t *testing.T) {

// Load it, resave and check again that the content is
// preserved through a load/save cycle.
configFile2 := New("test-plugin2")
configFile = New("test-plugin2")
defer os.Remove("test-plugin2")
assert.NilError(t, configFile2.LoadFromReader(bytes.NewReader(cfg)))
err = configFile2.Save()
assert.NilError(t, configFile.LoadFromReader(bytes.NewReader(cfg)))
err = configFile.Save()
assert.NilError(t, err)
cfg, err = ioutil.ReadFile("test-plugin2")
assert.NilError(t, err)
golden.Assert(t, string(cfg), "plugin-config.golden")

// Check that the contents was retained properly
var p1bis PluginConfig1
assert.Assert(t, is.Contains(configFile2.Plugins, "plugin1"))
err = json.Unmarshal(configFile2.Plugins["plugin1"], &p1bis)
// Check that the contents was reloaded properly
v, ok := configFile.PluginConfig("plugin1", "data1")
assert.Assert(t, ok)
assert.Equal(t, v, "some string")
v, ok = configFile.PluginConfig("plugin1", "data2")
assert.Assert(t, ok)
assert.Equal(t, v, "42")
v, ok = configFile.PluginConfig("plugin1", "data3")
assert.Assert(t, !ok)
assert.Equal(t, v, "")
v, ok = configFile.PluginConfig("plugin2", "data3")
assert.Assert(t, ok)
assert.Equal(t, v, "some other string")
v, ok = configFile.PluginConfig("plugin2", "data4")
assert.Assert(t, !ok)
assert.Equal(t, v, "")
v, ok = configFile.PluginConfig("plugin3", "data5")
assert.Assert(t, !ok)
assert.Equal(t, v, "")

// Add, remove and modify
configFile.SetPluginConfig("plugin1", "data1", "some replacement string") // replacing a key
configFile.SetPluginConfig("plugin1", "data2", "") // deleting a key
configFile.SetPluginConfig("plugin1", "data3", "some additional string") // new key
configFile.SetPluginConfig("plugin2", "data3", "") // delete the whole plugin, since this was the only data
configFile.SetPluginConfig("plugin3", "data5", "a new plugin") // add a new plugin

err = configFile.Save()
assert.NilError(t, err)
assert.DeepEqual(t, p1, p1bis)

var p2bis PluginConfig2
assert.Assert(t, is.Contains(configFile2.Plugins, "plugin2"))
err = json.Unmarshal(configFile2.Plugins["plugin2"], &p2bis)
// Read it back and check it has the expected content again
cfg, err = ioutil.ReadFile("test-plugin2")
assert.NilError(t, err)
assert.DeepEqual(t, p2, p2bis)
golden.Assert(t, string(cfg), "plugin-config-2.golden")
}
12 changes: 12 additions & 0 deletions cli/config/configfile/testdata/plugin-config-2.golden
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"auths": {},
"plugins": {
"plugin1": {
"data1": "some replacement string",
"data3": "some additional string"
},
"plugin3": {
"data5": "a new plugin"
}
}
}
2 changes: 1 addition & 1 deletion cli/config/configfile/testdata/plugin-config.golden
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"plugins": {
"plugin1": {
"data1": "some string",
"data2": 42
"data2": "42"
},
"plugin2": {
"data3": "some other string"
Expand Down

0 comments on commit db0bd19

Please sign in to comment.