Merge pull request #9441 from gyuho/strings

*: replace "--host-whitelist" with "flags.StringSlice"

etcdmain/config.go

@@ -85,11 +85,10 @@ type config struct {
 
 // configFlags has the set of flags used for command line parsing a Config
 type configFlags struct {
-	flagSet       *flag.FlagSet
-	hostWhitelist string
-	clusterState  *flags.StringsFlag
-	fallback      *flags.StringsFlag
-	proxy         *flags.StringsFlag
+	flagSet      *flag.FlagSet
+	clusterState *flags.StringsFlag
+	fallback     *flags.StringsFlag
+	proxy        *flags.StringsFlag
 }
 
 func newConfig() *config {
@@ -190,7 +189,7 @@ func newConfig() *config {
 	fs.BoolVar(&cfg.ec.PeerAutoTLS, "peer-auto-tls", false, "Peer TLS using generated certificates")
 	fs.StringVar(&cfg.ec.PeerTLSInfo.CRLFile, "peer-crl-file", "", "Path to the peer certificate revocation list file.")
 	fs.StringVar(&cfg.ec.PeerTLSInfo.AllowedCN, "peer-cert-allowed-cn", "", "Allowed CN for inter peer authentication.")
-	fs.StringVar(&cfg.cf.hostWhitelist, "host-whitelist", "", "Comma-separated acceptable hostnames from HTTP client requests, if server is not secure (empty means allow all).")
+	fs.Var(flags.NewStringSlice(""), "host-whitelist", "Comma-separated acceptable hostnames from HTTP client requests, if server is not secure (empty means allow all).")
 
 	// logging
 	fs.BoolVar(&cfg.ec.Debug, "debug", false, "Enable debug-level logging for etcd.")
@@ -269,6 +268,7 @@ func (cfg *config) configFromCmdLine() error {
 	cfg.ec.APUrls = flags.URLsFromFlag(cfg.cf.flagSet, "initial-advertise-peer-urls")
 	cfg.ec.LCUrls = flags.URLsFromFlag(cfg.cf.flagSet, "listen-client-urls")
 	cfg.ec.ACUrls = flags.URLsFromFlag(cfg.cf.flagSet, "advertise-client-urls")
+	cfg.ec.HostWhitelist = flags.StringSliceFromFlag(cfg.cf.flagSet, "host-whitelist")
 
 	if len(cfg.ec.ListenMetricsUrlsJSON) > 0 {
 		u, err := types.NewURLs(strings.Split(cfg.ec.ListenMetricsUrlsJSON, ","))
@@ -278,15 +278,6 @@ func (cfg *config) configFromCmdLine() error {
 		cfg.ec.ListenMetricsUrls = []url.URL(u)
 	}
 
-	hosts := []string{}
-	for _, h := range strings.Split(cfg.cf.hostWhitelist, ",") {
-		h = strings.TrimSpace(h)
-		if h != "" {
-			hosts = append(hosts, h)
-		}
-	}
-	cfg.ec.HostWhitelist = hosts
-
 	cfg.ec.ClusterState = cfg.cf.clusterState.String()
 	cfg.cp.Fallback = cfg.cf.fallback.String()
 	cfg.cp.Proxy = cfg.cf.proxy.String()

pkg/flags/flag.go

@@ -153,6 +153,11 @@ func URLsFromFlag(fs *flag.FlagSet, urlsFlagName string) []url.URL {
 	return []url.URL(*fs.Lookup(urlsFlagName).Value.(*URLsValue))
 }
 
+// StringSliceFromFlag returns a string slice from the flag.
+func StringSliceFromFlag(fs *flag.FlagSet, flagName string) []string {
+	return []string(*fs.Lookup(flagName).Value.(*StringSlice))
+}
+
 func IsSet(fs *flag.FlagSet, name string) bool {
 	set := false
 	fs.Visit(func(f *flag.Flag) {

pkg/flags/string_slice.go

@@ -0,0 +1,44 @@
+// Copyright 2018 The etcd Authors
+//
+// 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 (
+	"sort"
+	"strings"
+)
+
+// StringSlice wraps "sort.StringSlice".
+type StringSlice sort.StringSlice
+
+// Set parses a command line set of strings, separated by comma.
+func (ss *StringSlice) Set(s string) error {
+	*ss = strings.Split(s, ",")
+	return nil
+}
+
+func (ss *StringSlice) String() string { return strings.Join(*ss, ",") }
+
+// NewStringSlice implements string slice as flag.Value interface.
+// Given value is to be separated by comma.
+func NewStringSlice(s string) (ss *StringSlice) {
+	if s == "" {
+		return &StringSlice{}
+	}
+	ss = new(StringSlice)
+	if err := ss.Set(s); err != nil {
+		plog.Panicf("new StringSlice should never fail: %v", err)
+	}
+	return ss
+}

pkg/flags/string_slice_test.go

@@ -0,0 +1,37 @@
+// Copyright 2018 The etcd Authors
+//
+// 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 (
+	"reflect"
+	"testing"
+)
+
+func TestStringSlice(t *testing.T) {
+	tests := []struct {
+		s   string
+		exp []string
+	}{
+		{s: "a,b,c", exp: []string{"a", "b", "c"}},
+		{s: "a, b,c", exp: []string{"a", " b", "c"}},
+		{s: "", exp: []string{}},
+	}
+	for i := range tests {
+		ss := []string(*NewStringSlice(tests[i].s))
+		if !reflect.DeepEqual(tests[i].exp, ss) {
+			t.Fatalf("#%d: expected %q, got %q", i, tests[i].exp, ss)
+		}
+	}
+}