Trim quotes from TLS flags.

dnephin · dnephin · commit abe32de6b468 · 2017-01-03T15:58:41.000-05:00
Signed-off-by: Daniel Nephin &lt;dnephin@docker.com&gt;
diff --git a/cli/flags/common.go b/cli/flags/common.go
@@ -59,11 +59,15 @@ func (commonOpts *CommonOptions) InstallFlags(flags *pflag.FlagSet) {
 
 	// TODO use flag flags.String("identity"}, "i", "", "Path to libtrust key file")
 
-	commonOpts.TLSOptions = &tlsconfig.Options{}
+	commonOpts.TLSOptions = &tlsconfig.Options{
+		CAFile:   filepath.Join(dockerCertPath, DefaultCaFile),
+		CertFile: filepath.Join(dockerCertPath, DefaultCertFile),
+		KeyFile:  filepath.Join(dockerCertPath, DefaultKeyFile),
+	}
 	tlsOptions := commonOpts.TLSOptions
-	flags.StringVar(&tlsOptions.CAFile, "tlscacert", filepath.Join(dockerCertPath, DefaultCaFile), "Trust certs signed only by this CA")
-	flags.StringVar(&tlsOptions.CertFile, "tlscert", filepath.Join(dockerCertPath, DefaultCertFile), "Path to TLS certificate file")
-	flags.StringVar(&tlsOptions.KeyFile, "tlskey", filepath.Join(dockerCertPath, DefaultKeyFile), "Path to TLS key file")
+	flags.Var(opts.NewQuotedString(&tlsOptions.CAFile), "tlscacert", "Trust certs signed only by this CA")
+	flags.Var(opts.NewQuotedString(&tlsOptions.CertFile), "tlscert", "Path to TLS certificate file")
+	flags.Var(opts.NewQuotedString(&tlsOptions.KeyFile), "tlskey", "Path to TLS key file")
 
 	hostOpt := opts.NewNamedListOptsRef("hosts", &commonOpts.Hosts, opts.ValidateHost)
 	flags.VarP(hostOpt, "host", "H", "Daemon socket(s) to connect to")
diff --git a/cli/flags/common_test.go b/cli/flags/common_test.go
@@ -0,0 +1,42 @@
+package flags
+
+import (
+	"path/filepath"
+	"testing"
+
+	cliconfig "github.com/docker/docker/cli/config"
+	"github.com/docker/docker/pkg/testutil/assert"
+	"github.com/spf13/pflag"
+)
+
+func TestCommonOptionsInstallFlags(t *testing.T) {
+	flags := pflag.NewFlagSet("testing", pflag.ContinueOnError)
+	opts := NewCommonOptions()
+	opts.InstallFlags(flags)
+
+	err := flags.Parse([]string{
+		"--tlscacert=\"/foo/cafile\"",
+		"--tlscert=\"/foo/cert\"",
+		"--tlskey=\"/foo/key\"",
+	})
+	assert.NilError(t, err)
+	assert.Equal(t, opts.TLSOptions.CAFile, "/foo/cafile")
+	assert.Equal(t, opts.TLSOptions.CertFile, "/foo/cert")
+	assert.Equal(t, opts.TLSOptions.KeyFile, "/foo/key")
+}
+
+func defaultPath(filename string) string {
+	return filepath.Join(cliconfig.Dir(), filename)
+}
+
+func TestCommonOptionsInstallFlagsWithDefaults(t *testing.T) {
+	flags := pflag.NewFlagSet("testing", pflag.ContinueOnError)
+	opts := NewCommonOptions()
+	opts.InstallFlags(flags)
+
+	err := flags.Parse([]string{})
+	assert.NilError(t, err)
+	assert.Equal(t, opts.TLSOptions.CAFile, defaultPath("ca.pem"))
+	assert.Equal(t, opts.TLSOptions.CertFile, defaultPath("cert.pem"))
+	assert.Equal(t, opts.TLSOptions.KeyFile, defaultPath("key.pem"))
+}
diff --git a/opts/quotedstring.go b/opts/quotedstring.go
@@ -2,11 +2,13 @@ package opts
 
 // QuotedString is a string that may have extra quotes around the value. The
 // quotes are stripped from the value.
-type QuotedString string
+type QuotedString struct {
+	value *string
+}
 
 // Set sets a new value
 func (s *QuotedString) Set(val string) error {
-	*s = QuotedString(trimQuotes(val))
+	*s.value = trimQuotes(val)
 	return nil
 }
 
@@ -16,7 +18,7 @@ func (s *QuotedString) Type() string {
 }
 
 func (s *QuotedString) String() string {
-	return string(*s)
+	return string(*s.value)
 }
 
 func trimQuotes(value string) string {
@@ -28,3 +30,8 @@ func trimQuotes(value string) string {
 	}
 	return value
 }
+
+// NewQuotedString returns a new quoted string option
+func NewQuotedString(value *string) *QuotedString {
+	return &QuotedString{value: value}
+}
diff --git a/opts/quotedstring_test.go b/opts/quotedstring_test.go
@@ -6,19 +6,23 @@ import (
 )
 
 func TestQuotedStringSetWithQuotes(t *testing.T) {
-	qs := QuotedString("")
+	value := ""
+	qs := NewQuotedString(&value)
 	assert.NilError(t, qs.Set("\"something\""))
 	assert.Equal(t, qs.String(), "something")
+	assert.Equal(t, value, "something")
 }
 
 func TestQuotedStringSetWithMismatchedQuotes(t *testing.T) {
-	qs := QuotedString("")
+	value := ""
+	qs := NewQuotedString(&value)
 	assert.NilError(t, qs.Set("\"something'"))
 	assert.Equal(t, qs.String(), "\"something'")
 }
 
 func TestQuotedStringSetWithNoQuotes(t *testing.T) {
-	qs := QuotedString("")
+	value := ""
+	qs := NewQuotedString(&value)
 	assert.NilError(t, qs.Set("something"))
 	assert.Equal(t, qs.String(), "something")
 }

Original file line number	Diff line number	Diff line change
`@@ -2,11 +2,13 @@ package opts`
`2`	`2`
`3`	`3`	`// QuotedString is a string that may have extra quotes around the value. The`
`4`	`4`	`// quotes are stripped from the value.`
`5`		`-type QuotedString string`
	`5`	`+type QuotedString struct {`
	`6`	`+ value *string`
	`7`	`+}`
`6`	`8`
`7`	`9`	`// Set sets a new value`
`8`	`10`	`func (s *QuotedString) Set(val string) error {`
`9`		`- *s = QuotedString(trimQuotes(val))`
	`11`	`+ *s.value = trimQuotes(val)`
`10`	`12`	`return nil`
`11`	`13`	`}`
`12`	`14`
`@@ -16,7 +18,7 @@ func (s *QuotedString) Type() string {`
`16`	`18`	`}`
`17`	`19`
`18`	`20`	`func (s *QuotedString) String() string {`
`19`		`- return string(*s)`
	`21`	`+ return string(*s.value)`
`20`	`22`	`}`
`21`	`23`
`22`	`24`	`func trimQuotes(value string) string {`
`@@ -28,3 +30,8 @@ func trimQuotes(value string) string {`
`28`	`30`	`}`
`29`	`31`	`return value`
`30`	`32`	`}`
	`33`	`+`
	`34`	`+// NewQuotedString returns a new quoted string option`
	`35`	`+func NewQuotedString(value string) QuotedString {`
	`36`	`+ return &QuotedString{value: value}`
	`37`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -6,19 +6,23 @@ import (`
`6`	`6`	`)`
`7`	`7`
`8`	`8`	`func TestQuotedStringSetWithQuotes(t *testing.T) {`
`9`		`- qs := QuotedString("")`
	`9`	`+ value := ""`
	`10`	`+ qs := NewQuotedString(&value)`
`10`	`11`	`assert.NilError(t, qs.Set("\"something\""))`
`11`	`12`	`assert.Equal(t, qs.String(), "something")`
	`13`	`+ assert.Equal(t, value, "something")`
`12`	`14`	`}`
`13`	`15`
`14`	`16`	`func TestQuotedStringSetWithMismatchedQuotes(t *testing.T) {`
`15`		`- qs := QuotedString("")`
	`17`	`+ value := ""`
	`18`	`+ qs := NewQuotedString(&value)`
`16`	`19`	`assert.NilError(t, qs.Set("\"something'"))`
`17`	`20`	`assert.Equal(t, qs.String(), "\"something'")`
`18`	`21`	`}`
`19`	`22`
`20`	`23`	`func TestQuotedStringSetWithNoQuotes(t *testing.T) {`
`21`		`- qs := QuotedString("")`
	`24`	`+ value := ""`
	`25`	`+ qs := NewQuotedString(&value)`
`22`	`26`	`assert.NilError(t, qs.Set("something"))`
`23`	`27`	`assert.Equal(t, qs.String(), "something")`
`24`	`28`	`}`