Merge pull request #41 from unistack-org/options

allow to pass additional options

flag.go

@@ -5,6 +5,7 @@ import (
 	"errors"
 	"flag"
 	"fmt"
+	"os"
 	"reflect"
 	"time"
 
@@ -27,6 +28,7 @@ var (
 */
 
 type flagConfig struct {
+	fset *flag.FlagSet
 	opts config.Options
 }
 
@@ -44,6 +46,7 @@ func (c *flagConfig) Init(opts ...config.Option) error {
 		return err
 	}
 
+	// flag.CommandLine.Init(os.Args[0], flag.ContinueOnError)
 	for _, sf := range fields {
 		tf, ok := sf.Field.Tag.Lookup(c.opts.StructTag)
 		if !ok {
@@ -53,7 +56,19 @@ func (c *flagConfig) Init(opts ...config.Option) error {
 
 		rcheck := true
 
-		switch sf.Value.Interface().(type) {
+		if !sf.Value.IsValid() {
+			continue
+		}
+		vi := sf.Value.Interface()
+		if vi == nil {
+			continue
+		}
+		if f := flag.Lookup(fn); f != nil {
+			return nil
+		}
+
+		fmt.Printf("register %s flag\n", fn)
+		switch vi.(type) {
 		case time.Duration:
 			err = c.flagDuration(sf.Value, fn, fv, fd)
 			rcheck = false
@@ -139,5 +154,37 @@ func NewConfig(opts ...config.Option) config.Config {
 	if len(options.StructTag) == 0 {
 		options.StructTag = DefaultStructTag
 	}
-	return &flagConfig{opts: options}
+	flagSet := flag.CommandLine
+	flagSetName := os.Args[0]
+	flagSetErrorHandling := flag.ExitOnError
+	var flagUsage func()
+	var isSet bool
+
+	if options.Context != nil {
+		if v, ok := options.Context.Value(flagSetNameKey{}).(string); ok {
+			isSet = true
+			flagSetName = v
+		}
+		if v, ok := options.Context.Value(flagSetErrorHandlingKey{}).(flag.ErrorHandling); ok {
+			isSet = true
+			flagSetErrorHandling = v
+		}
+		if v, ok := options.Context.Value(flagSetKey{}).(*flag.FlagSet); ok {
+			flagSet = v
+		}
+		if v, ok := options.Context.Value(flagSetUsageKey{}).(func()); ok {
+			flagUsage = v
+		}
+	}
+
+	if isSet {
+		flagSet.Init(flagSetName, flagSetErrorHandling)
+	}
+	if flagUsage != nil {
+		flagSet.Usage = flagUsage
+	}
+
+	c := &flagConfig{opts: options, fset: flagSet}
+
+	return c
 }

flag_test.go

@@ -2,6 +2,7 @@ package flag
 
 import (
 	"context"
+	"flag"
 	"os"
 	"testing"
 	"time"
@@ -17,22 +18,35 @@ func TestLoad(t *testing.T) {
 	os.Args = append(os.Args, "-addr", "33,44")
 	os.Args = append(os.Args, "-time", time.RFC822)
 	os.Args = append(os.Args, "-metadata", "key=20")
+	os.Args = append(os.Args, "-components", "all=info,api=debug")
+	os.Args = append(os.Args, "-addr", "33,44")
+	os.Args = append(os.Args, "-badflag", "test")
+	type NestedConfig struct {
+		Value string `flag:"name=nested_value"`
+	}
 	type Config struct {
-		Broker         string         `flag:"name=broker,desc='description with, comma',default='127.0.0.1:9092'"`
-		Verbose        bool           `flag:"name=verbose,desc='verbose output',default='false'"`
-		Addr           []string       `flag:"name=addr,desc='addrs',default='127.0.0.1:9092'"`
-		Wait           time.Duration  `flag:"name=wait,desc='wait time',default='2s'"`
-		Time           time.Time      `flag:"name=time,desc='some time',default='02 Jan 06 15:04 MST'"`
-		Metadata       map[string]int `flag:"name=metadata,desc='some meta',default=''"`
-		WithoutDefault string         `flag:"name=without_default,desc='with'"`
-		WithoutDesc    string         `flag:"name=without_desc,default='without_default'"`
-		WithoutAll     string         `flag:"name=without_all"`
+		Time           time.Time         `flag:"name=time,desc='some time',default='02 Jan 06 15:04 MST'"`
+		Components     map[string]string `flag:"name=components,desc='components logging'"`
+		Metadata       map[string]int    `flag:"name=metadata,desc='some meta',default=''"`
+		Nested         *NestedConfig
+		Broker         string        `flag:"name=broker,desc='description with, comma',default='127.0.0.1:9092'"`
+		WithoutDesc    string        `flag:"name=without_desc,default='without_default'"`
+		WithoutAll     string        `flag:"name=without_all"`
+		WithoutDefault string        `flag:"name=without_default,desc='with'"`
+		Addr           []string      `flag:"name=addr,desc='addrs',default='127.0.0.1:9092'"`
+		Wait           time.Duration `flag:"name=wait,desc='wait time',default='2s'"`
+		Verbose        bool          `flag:"name=verbose,desc='verbose output',default='false'"`
 	}
 
 	ctx := context.Background()
-	cfg := &Config{}
+	cfg := &Config{Nested: &NestedConfig{}}
 
-	c := NewConfig(config.Struct(cfg), TimeFormat(time.RFC822))
+	c := NewConfig(config.Struct(cfg), TimeFormat(time.RFC822), FlagErrorHandling(flag.ContinueOnError))
+	if err := c.Init(); err != nil {
+		t.Fatalf("init failed: %v", err)
+	}
+
+	// double init test
 	if err := c.Init(); err != nil {
 		t.Fatalf("init failed: %v", err)
 	}
@@ -47,4 +61,8 @@ func TestLoad(t *testing.T) {
 	if tf := cfg.Time.Format(time.RFC822); tf != "02 Jan 06 15:04 MST" {
 		t.Fatalf("parse time error: %s != %s", tf, "02 Jan 06 15:04 MST")
 	}
+
+	if len(cfg.Components) != 2 {
+		t.Fatalf("cant parse map components %#+v", cfg)
+	}
 }

go.mod

@@ -2,4 +2,4 @@ module go.unistack.org/micro-config-flag/v3
 
 go 1.16
 
-require go.unistack.org/micro/v3 v3.9.0
+require go.unistack.org/micro/v3 v3.9.7

go.sum

@@ -22,7 +22,7 @@ github.com/envoyproxy/go-control-plane v0.9.9-0.20210512163311-63b5d3c536b0/go.m
 github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c=
 github.com/flowstack/go-jsonschema v0.1.1/go.mod h1:yL7fNggx1o8rm9RlgXv7hTBWxdBM0rVwpMwimd3F3N0=
 github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04=
-github.com/golang-jwt/jwt/v4 v4.4.0/go.mod h1:/xlHOz8bRuivTWchD4jCa+NbatV+wEUSzwAxVc6locg=
+github.com/golang-jwt/jwt/v4 v4.4.1/go.mod h1:m21LjoU+eqJr34lmDMbreY2eSTRJ1cv77w39/MY0Ch0=
 github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q=
 github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A=
 github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
@@ -73,8 +73,8 @@ github.com/xeipuuv/gojsonschema v1.2.0/go.mod h1:anYRn/JVcOK2ZgGU+IjEV4nwlhoK5sQ
 go.opentelemetry.io/proto/otlp v0.7.0/go.mod h1:PqfVotwruBrMGOCsRd/89rSnXhoiJIqeYNgFYFoEGnI=
 go.unistack.org/micro-proto/v3 v3.2.7 h1:zG6d69kHc+oij2lwQ3AfrCgdjiEVRG2A7TlsxjusWs4=
 go.unistack.org/micro-proto/v3 v3.2.7/go.mod h1:ZltVWNECD5yK+40+OCONzGw4OtmSdTpVi8/KFgo9dqM=
-go.unistack.org/micro/v3 v3.9.0 h1:n5w7Y0QlFA0Rhh5XON1f1MfdmY+4BMQopYmX6Uy7tdU=
-go.unistack.org/micro/v3 v3.9.0/go.mod h1:7ssIWk+PJXvb2nSl8NUnQRs32JJEId2IDi9PobrQlKo=
+go.unistack.org/micro/v3 v3.9.7 h1:ROx4X6nP9rE72lKgawyys/8VdNXqU65fb3he7d00iZk=
+go.unistack.org/micro/v3 v3.9.7/go.mod h1:E1pmj0cNC7P+QVX1sElRBMiNaQVTjDoEtYlbqZY84c4=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=

options.go

@@ -1,6 +1,8 @@
 package flag
 
 import (
+	"flag"
+
 	"go.unistack.org/micro/v3/config"
 )
 
@@ -24,3 +26,31 @@ type timeFormatKey struct{}
 func TimeFormat(s string) config.Option {
 	return config.SetOption(timeFormatKey{}, s)
 }
+
+type flagSetKey struct{}
+
+// FlagSet set flag set name
+func FlagSet(f *flag.FlagSet) config.Option {
+	return config.SetOption(flagSetKey{}, f)
+}
+
+type flagSetNameKey struct{}
+
+// FlagSetName set flag set name
+func FlagSetName(n string) config.Option {
+	return config.SetOption(flagSetNameKey{}, n)
+}
+
+type flagSetErrorHandlingKey struct{}
+
+// FlagErrorHandling set flag set error handling
+func FlagErrorHandling(eh flag.ErrorHandling) config.Option {
+	return config.SetOption(flagSetErrorHandlingKey{}, eh)
+}
+
+type flagSetUsageKey struct{}
+
+// FlagUsage set flag set usage func
+func FlagUsage(fn func()) config.Option {
+	return config.SetOption(flagSetUsageKey{}, fn)
+}

util.go

@@ -2,12 +2,131 @@ package flag
 
 import (
 	"flag"
+	"fmt"
 	"reflect"
 	"strconv"
 	"strings"
 	"time"
 )
 
+type mapValue struct {
+	delim string
+	def   string
+	v     reflect.Value
+}
+
+func (v mapValue) String() string {
+	if v.v.Kind() != reflect.Invalid {
+		var kv []string
+		it := v.v.MapRange()
+		for it.Next() {
+			k := it.Key().Interface()
+			v := it.Value().Interface()
+			kv = append(kv, fmt.Sprintf("%v=%v", k, v))
+		}
+		return strings.Join(kv, ",")
+	}
+	return v.def
+}
+
+func (v mapValue) Set(s string) error {
+	ps := strings.Split(s, v.delim)
+	if len(ps) == 0 {
+		return nil
+	}
+	v.v.Set(reflect.MakeMapWithSize(v.v.Type(), len(ps)))
+	kt := v.v.Type().Key().Kind()
+	vt := v.v.Type().Elem().Kind()
+
+	for i := 0; i < len(ps); i++ {
+		fs := strings.Split(ps[i], "=")
+		switch len(fs) {
+		case 0:
+			return nil
+		case 1:
+			if len(fs[0]) == 0 {
+				return nil
+			}
+			return ErrInvalidValue
+		case 2:
+			break
+		default:
+			return ErrInvalidValue
+		}
+		key, err := convertType(reflect.ValueOf(fs[0]), kt)
+		if err != nil {
+			return err
+		}
+		val, err := convertType(reflect.ValueOf(fs[1]), vt)
+		if err != nil {
+			return err
+		}
+		v.v.SetMapIndex(key.Convert(v.v.Type().Key()), val.Convert(v.v.Type().Elem()))
+	}
+	return nil
+}
+
+type sliceValue struct {
+	delim string
+	def   string
+	v     reflect.Value
+}
+
+func (v sliceValue) String() string {
+	if v.v.Kind() != reflect.Invalid {
+		var kv []string
+		for idx := 0; idx < v.v.Len(); idx++ {
+			kv = append(kv, fmt.Sprintf("%v", v.v.Index(idx).Interface()))
+		}
+		return strings.Join(kv, ",")
+	}
+	return v.def
+}
+
+func (v sliceValue) Set(s string) error {
+	p := strings.Split(s, v.delim)
+	v.v.Set(reflect.MakeSlice(v.v.Type(), len(p), len(p)))
+	switch v.v.Type().Elem().Kind() {
+	case reflect.Int, reflect.Int64:
+		for idx := range p {
+			i, err := strconv.ParseInt(p[idx], 10, 64)
+			if err != nil {
+				return err
+			}
+			v.v.Index(idx).SetInt(i)
+		}
+	case reflect.Uint, reflect.Uint64:
+		for idx := range p {
+			i, err := strconv.ParseUint(p[idx], 10, 64)
+			if err != nil {
+				return err
+			}
+			v.v.Index(idx).SetUint(i)
+		}
+	case reflect.Float64:
+		for idx := range p {
+			i, err := strconv.ParseFloat(p[idx], 64)
+			if err != nil {
+				return err
+			}
+			v.v.Index(idx).SetFloat(i)
+		}
+	case reflect.Bool:
+		for idx := range p {
+			i, err := strconv.ParseBool(p[idx])
+			if err != nil {
+				return err
+			}
+			v.v.Index(idx).SetBool(i)
+		}
+	case reflect.String:
+		for idx := range p {
+			v.v.Index(idx).SetString(p[idx])
+		}
+	}
+	return nil
+}
+
 func convertType(v reflect.Value, t reflect.Kind) (reflect.Value, error) {
 	switch v.Kind() {
 	case reflect.String:
@@ -51,50 +170,12 @@ func (c *flagConfig) flagSlice(v reflect.Value, fn, fv, fd string) error {
 		}
 	}
 
-	flag.Func(fn, fd, func(s string) error {
-		p := strings.Split(s, delim)
-		v.Set(reflect.MakeSlice(v.Type(), len(p), len(p)))
-		switch v.Type().Elem().Kind() {
-		case reflect.Int, reflect.Int64:
-			for idx := range p {
-				i, err := strconv.ParseInt(p[idx], 10, 64)
-				if err != nil {
-					return err
-				}
-				v.Index(idx).SetInt(i)
-			}
-		case reflect.Uint, reflect.Uint64:
-			for idx := range p {
-				i, err := strconv.ParseUint(p[idx], 10, 64)
-				if err != nil {
-					return err
-				}
-				v.Index(idx).SetUint(i)
-			}
-		case reflect.Float64:
-			for idx := range p {
-				i, err := strconv.ParseFloat(p[idx], 64)
-				if err != nil {
-					return err
-				}
-				v.Index(idx).SetFloat(i)
-			}
-		case reflect.Bool:
-			for idx := range p {
-				i, err := strconv.ParseBool(p[idx])
-				if err != nil {
-					return err
-				}
-				v.Index(idx).SetBool(i)
-			}
-		case reflect.String:
-			for idx := range p {
-				v.Index(idx).SetString(p[idx])
-			}
-		}
-		return nil
-	})
-
+	v.Set(reflect.MakeSlice(v.Type(), 0, 0))
+	mp := &sliceValue{v: v, def: fv, delim: delim}
+	if err := mp.Set(fv); err != nil {
+		return err
+	}
+	flag.Var(mp, fn, fd)
 	return nil
 }
 
@@ -105,43 +186,12 @@ func (c *flagConfig) flagMap(v reflect.Value, fn, fv, fd string) error {
 			delim = d
 		}
 	}
-	flag.Func(fn, fv, func(s string) error {
-		ps := strings.Split(s, delim)
-		if len(ps) == 0 {
-			return nil
-		}
-		v.Set(reflect.MakeMapWithSize(v.Type(), len(ps)))
-		kt := v.Type().Key().Kind()
-		vt := v.Type().Elem().Kind()
-
-		for i := 0; i < len(ps); i++ {
-			fs := strings.Split(ps[i], "=")
-			switch len(fs) {
-			case 0:
-				return nil
-			case 1:
-				if len(fs[0]) == 0 {
-					return nil
-				}
-				return ErrInvalidValue
-			case 2:
-				break
-			default:
-				return ErrInvalidValue
-			}
-			key, err := convertType(reflect.ValueOf(fs[0]), kt)
-			if err != nil {
-				return err
-			}
-			val, err := convertType(reflect.ValueOf(fs[1]), vt)
-			if err != nil {
-				return err
-			}
-			v.SetMapIndex(key.Convert(v.Type().Key()), val.Convert(v.Type().Elem()))
-		}
-		return nil
-	})
-
+	v.Set(reflect.MakeMapWithSize(v.Type(), 0))
+	mp := &mapValue{v: v, def: fv, delim: delim}
+	if err := mp.Set(fv); err != nil {
+		return err
+	}
+	flag.Var(mp, fn, fd)
 	return nil
 }
 
@@ -277,35 +327,74 @@ func (c *flagConfig) flagStringSlice(v reflect.Value, fn, fv, fd string) error {
 }
 
 func getFlagOpts(tf string) (string, string, string) {
-	ret := make([]string, 3)
-	vals := strings.Split(tf, ",")
-	f := 0
-	for _, val := range vals {
-		p := strings.Split(val, "=")
-		switch p[0] {
-		case "name":
-			f = 0
-		case "desc":
-			f = 1
-		case "default":
-			f = 2
-		default:
-			ret[f] += "," + val
-			continue
-		}
-		ret[f] = p[1]
-	}
+	var name, desc, def string
+	delim := ","
 
-	for idx := range ret {
-		if len(ret[idx]) == 0 {
-			continue
-		}
-		if ret[idx][0] == '\'' {
-			ret[idx] = ret[idx][1:]
-		}
-		if ret[idx][len(ret[idx])-1] == '\'' {
-			ret[idx] = ret[idx][:len(ret[idx])-1]
+	var buf string
+	for idx := 0; idx < len(tf); idx++ {
+		buf += string(tf[idx])
+		switch buf {
+		case "name":
+			ndx := idx + 2
+			stop := ","
+			var quote bool
+			for ; ndx < len(tf); ndx++ {
+				if string(tf[ndx]) == stop {
+					if quote {
+						ndx++
+					}
+					break
+				}
+				if string(tf[ndx]) == "'" {
+					stop = "'"
+					quote = true
+					continue
+				}
+				name += string(tf[ndx])
+			}
+			idx = ndx
+			buf = ""
+		case "desc":
+			ndx := idx + 2
+			stop := ","
+			var quote bool
+			for ; ndx < len(tf); ndx++ {
+				if string(tf[ndx]) == stop {
+					if quote {
+						ndx++
+					}
+					break
+				}
+				if string(tf[ndx]) == "'" {
+					stop = "'"
+					quote = true
+					continue
+				}
+				desc += string(tf[ndx])
+			}
+			idx = ndx
+			buf = ""
+		case "default":
+			ndx := idx + 2
+			stop := ","
+			var quote bool
+			for ; ndx < len(tf); ndx++ {
+				if string(tf[ndx]) == stop && (stop != delim) {
+					if quote {
+						ndx++
+					}
+					break
+				}
+				if string(tf[ndx]) == "'" {
+					stop = "'"
+					quote = true
+					continue
+				}
+				def += string(tf[ndx])
+			}
+			idx = ndx
+			buf = ""
 		}
 	}
-	return ret[0], ret[1], ret[2]
+	return name, desc, def
 }