Merge pull request #1608 from jonboulle/flags

pkg: move to more generic StringsFlag

etcdmain/etcd.go

@@ -40,6 +40,13 @@ import (
 const (
 	// the owner can make/remove files inside the directory
 	privateDirMode = 0700
+
+	proxyFlagOff      = "off"
+	proxyFlagReadonly = "readonly"
+	proxyFlagOn       = "on"
+
+	fallbackFlagExit  = "exit"
+	fallbackFlagProxy = "proxy"
 )
 
 var (
@@ -47,7 +54,6 @@ var (
 	name         = fs.String("name", "default", "Unique human-readable name for this node")
 	dir          = fs.String("data-dir", "", "Path to the data directory")
 	durl         = fs.String("discovery", "", "Discovery service used to bootstrap the cluster")
-	dfallback    = new(flags.Fallback)
 	snapCount    = fs.Uint64("snapshot-count", etcdserver.DefaultSnapCount, "Number of committed transactions to trigger a snapshot")
 	printVersion = fs.Bool("version", false, "Print the version and exit")
 
@@ -56,7 +62,15 @@ var (
 	clusterState        = new(etcdserver.ClusterState)
 
 	corsInfo  = &cors.CORSInfo{}
-	proxyFlag = new(flags.Proxy)
+	proxyFlag = flags.NewStringsFlag(
+		proxyFlagOff,
+		proxyFlagReadonly,
+		proxyFlagOn,
+	)
+	fallbackFlag = flags.NewStringsFlag(
+		fallbackFlagExit,
+		fallbackFlagProxy,
+	)
 
 	clientTLSInfo = transport.TLSInfo{}
 	peerTLSInfo   = transport.TLSInfo{}
@@ -92,13 +106,13 @@ func init() {
 
 	fs.Var(corsInfo, "cors", "Comma-separated white list of origins for CORS (cross-origin resource sharing).")
 
-	fs.Var(proxyFlag, "proxy", fmt.Sprintf("Valid values include %s", strings.Join(flags.ProxyValues, ", ")))
+	fs.Var(proxyFlag, "proxy", fmt.Sprintf("Valid values include %s", strings.Join(proxyFlag.Values, ", ")))
-	if err := proxyFlag.Set(flags.ProxyValueOff); err != nil {
+	if err := proxyFlag.Set(proxyFlagOff); err != nil {
 		// Should never happen.
 		log.Panicf("unexpected error setting up proxyFlag: %v", err)
 	}
-	fs.Var(dfallback, "discovery-fallback", fmt.Sprintf("Valid values include %s", strings.Join(flags.FallbackValues, ", ")))
+	fs.Var(fallbackFlag, "discovery-fallback", fmt.Sprintf("Valid values include %s", strings.Join(fallbackFlag.Values, ", ")))
-	if err := dfallback.Set(flags.FallbackProxy); err != nil {
+	if err := fallbackFlag.Set(fallbackFlagProxy); err != nil {
 		// Should never happen.
 		log.Panicf("unexpected error setting up discovery-fallback flag: %v", err)
 	}
@@ -143,13 +157,13 @@ func Main() {
 
 	flags.SetFlagsFromEnv(fs)
 
-	if string(*proxyFlag) == flags.ProxyValueOff {
+	if proxyFlag.String() == proxyFlagOff {
 		if err := startEtcd(); err == nil {
 			// Block indefinitely
 			<-make(chan struct{})
 		} else {
-			if err == discovery.ErrFullCluster && *dfallback == flags.FallbackProxy {
+			if err == discovery.ErrFullCluster && fallbackFlag.String() == fallbackFlagProxy {
-				fmt.Printf("etcd: dicovery cluster full, falling back to %s", flags.FallbackProxy)
+				fmt.Printf("etcd: discovery cluster full, falling back to %s", fallbackFlagProxy)
 			} else {
 				log.Fatalf("etcd: %v", err)
 			}
@@ -318,7 +332,7 @@ func startProxy() error {
 		Info:    corsInfo,
 	}
 
-	if string(*proxyFlag) == flags.ProxyValueReadonly {
+	if proxyFlag.String() == proxyFlagReadonly {
 		ph = proxy.NewReadonlyHandler(ph)
 	}
 	lcurls, err := flags.URLsFromFlags(fs, "listen-client-urls", "bind-addr", clientTLSInfo)

pkg/flags/proxy.go

@@ -1,55 +0,0 @@
-/*
-   Copyright 2014 CoreOS, Inc.
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-*/
-
-package flags
-
-import (
-	"errors"
-)
-
-const (
-	ProxyValueOff      = "off"
-	ProxyValueReadonly = "readonly"
-	ProxyValueOn       = "on"
-)
-
-var (
-	ProxyValues = []string{
-		ProxyValueOff,
-		ProxyValueReadonly,
-		ProxyValueOn,
-	}
-)
-
-// ProxyFlag implements the flag.Value interface.
-type Proxy string
-
-// Set verifies the argument to be a valid member of proxyFlagValues
-// before setting the underlying flag value.
-func (pf *Proxy) Set(s string) error {
-	for _, v := range ProxyValues {
-		if s == v {
-			*pf = Proxy(s)
-			return nil
-		}
-	}
-
-	return errors.New("invalid value")
-}
-
-func (pf *Proxy) String() string {
-	return string(*pf)
-}

pkg/flags/strings.go

@@ -16,38 +16,33 @@
 
 package flags
 
-import (
+import "errors"
-	"errors"
-)
 
-const (
+// NewStringsFlag creates a new string flag for which any one of the given
-	FallbackExit  = "exit"
+// strings is a valid value, and any other value is an error.
-	FallbackProxy = "proxy"
+func NewStringsFlag(valids ...string) *StringsFlag {
-)
+	return &StringsFlag{Values: valids}
-
-var (
-	FallbackValues = []string{
-		FallbackExit,
-		FallbackProxy,
 }
-)
 
-// FallbackFlag implements the flag.Value interface.
+// StringsFlag implements the flag.Value interface.
-type Fallback string
+type StringsFlag struct {
+	Values []string
+	val    string
+}
 
-// Set verifies the argument to be a valid member of FallbackFlagValues
+// Set verifies the argument to be a valid member of the allowed values
 // before setting the underlying flag value.
-func (fb *Fallback) Set(s string) error {
+func (ss *StringsFlag) Set(s string) error {
-	for _, v := range FallbackValues {
+	for _, v := range ss.Values {
 		if s == v {
-			*fb = Fallback(s)
+			ss.val = s
 			return nil
 		}
 	}
-
 	return errors.New("invalid value")
 }
 
-func (fb *Fallback) String() string {
+// String returns the set value (if any) of the StringsFlag
-	return string(*fb)
+func (ss *StringsFlag) String() string {
+	return ss.val
 }

pkg/flags/strings_test.go

@@ -20,23 +20,26 @@ import (
 	"testing"
 )
 
-func TestProxySet(t *testing.T) {
+func TestStringsSet(t *testing.T) {
 	tests := []struct {
+		vals []string
+
 		val  string
 		pass bool
 	}{
 		// known values
-		{"on", true},
+		{[]string{"abc", "def"}, "abc", true},
-		{"off", true},
+		{[]string{"on", "off", "false"}, "on", true},
 
 		// unrecognized values
-		{"foo", false},
+		{[]string{"abc", "def"}, "ghi", false},
-		{"", false},
+		{[]string{"on", "off"}, "", false},
+		{[]string{}, "asdf", false},
 	}
 
 	for i, tt := range tests {
-		pf := new(Proxy)
+		sf := NewStringsFlag(tt.vals...)
-		err := pf.Set(tt.val)
+		err := sf.Set(tt.val)
 		if tt.pass != (err == nil) {
 			t.Errorf("#%d: want pass=%t, but got err=%v", i, tt.pass, err)
 		}