// Package cmd is an interface for parsing the command line package cmd import ( "fmt" "math/rand" "strings" "time" "github.com/micro/go-micro/v2/auth" "github.com/micro/go-micro/v2/auth/provider" "github.com/micro/go-micro/v2/broker" "github.com/micro/go-micro/v2/client" "github.com/micro/go-micro/v2/client/selector" "github.com/micro/go-micro/v2/config" configSrv "github.com/micro/go-micro/v2/config/source/service" "github.com/micro/go-micro/v2/debug/profile" "github.com/micro/go-micro/v2/debug/profile/http" "github.com/micro/go-micro/v2/debug/profile/pprof" "github.com/micro/go-micro/v2/debug/trace" "github.com/micro/go-micro/v2/logger" "github.com/micro/go-micro/v2/registry" "github.com/micro/go-micro/v2/runtime" "github.com/micro/go-micro/v2/server" "github.com/micro/go-micro/v2/store" "github.com/micro/go-micro/v2/transport" // clients cgrpc "github.com/micro/go-micro/v2/client/grpc" cmucp "github.com/micro/go-micro/v2/client/mucp" // servers "github.com/micro/cli/v2" sgrpc "github.com/micro/go-micro/v2/server/grpc" smucp "github.com/micro/go-micro/v2/server/mucp" // brokers "github.com/micro/go-micro/v2/broker/memory" "github.com/micro/go-micro/v2/broker/nats" brokerSrv "github.com/micro/go-micro/v2/broker/service" // registries "github.com/micro/go-micro/v2/registry/etcd" kreg "github.com/micro/go-micro/v2/registry/kubernetes" "github.com/micro/go-micro/v2/registry/mdns" rmem "github.com/micro/go-micro/v2/registry/memory" regSrv "github.com/micro/go-micro/v2/registry/service" // runtimes kRuntime "github.com/micro/go-micro/v2/runtime/kubernetes" lRuntime "github.com/micro/go-micro/v2/runtime/local" srvRuntime "github.com/micro/go-micro/v2/runtime/service" // selectors "github.com/micro/go-micro/v2/client/selector/dns" "github.com/micro/go-micro/v2/client/selector/router" "github.com/micro/go-micro/v2/client/selector/static" // transports thttp "github.com/micro/go-micro/v2/transport/http" tmem "github.com/micro/go-micro/v2/transport/memory" // stores memStore "github.com/micro/go-micro/v2/store/memory" svcStore "github.com/micro/go-micro/v2/store/service" // tracers // jTracer "github.com/micro/go-micro/v2/debug/trace/jaeger" memTracer "github.com/micro/go-micro/v2/debug/trace/memory" // auth svcAuth "github.com/micro/go-micro/v2/auth/service" // auth providers "github.com/micro/go-micro/v2/auth/provider/basic" "github.com/micro/go-micro/v2/auth/provider/oauth" ) type Cmd interface { // The cli app within this cmd App() *cli.App // Adds options, parses flags and initialise // exits on error Init(opts ...Option) error // Options set within this command Options() Options } type cmd struct { opts Options app *cli.App } type Option func(o *Options) var ( DefaultCmd = newCmd() DefaultFlags = []cli.Flag{ &cli.StringFlag{ Name: "client", EnvVars: []string{"MICRO_CLIENT"}, Usage: "Client for go-micro; rpc", }, &cli.StringFlag{ Name: "client_request_timeout", EnvVars: []string{"MICRO_CLIENT_REQUEST_TIMEOUT"}, Usage: "Sets the client request timeout. e.g 500ms, 5s, 1m. Default: 5s", }, &cli.IntFlag{ Name: "client_retries", EnvVars: []string{"MICRO_CLIENT_RETRIES"}, Value: client.DefaultRetries, Usage: "Sets the client retries. Default: 1", }, &cli.IntFlag{ Name: "client_pool_size", EnvVars: []string{"MICRO_CLIENT_POOL_SIZE"}, Usage: "Sets the client connection pool size. Default: 1", }, &cli.StringFlag{ Name: "client_pool_ttl", EnvVars: []string{"MICRO_CLIENT_POOL_TTL"}, Usage: "Sets the client connection pool ttl. e.g 500ms, 5s, 1m. Default: 1m", }, &cli.IntFlag{ Name: "register_ttl", EnvVars: []string{"MICRO_REGISTER_TTL"}, Value: 60, Usage: "Register TTL in seconds", }, &cli.IntFlag{ Name: "register_interval", EnvVars: []string{"MICRO_REGISTER_INTERVAL"}, Value: 30, Usage: "Register interval in seconds", }, &cli.StringFlag{ Name: "server", EnvVars: []string{"MICRO_SERVER"}, Usage: "Server for go-micro; rpc", }, &cli.StringFlag{ Name: "server_name", EnvVars: []string{"MICRO_SERVER_NAME"}, Usage: "Name of the server. go.micro.srv.example", }, &cli.StringFlag{ Name: "server_version", EnvVars: []string{"MICRO_SERVER_VERSION"}, Usage: "Version of the server. 1.1.0", }, &cli.StringFlag{ Name: "server_id", EnvVars: []string{"MICRO_SERVER_ID"}, Usage: "Id of the server. Auto-generated if not specified", }, &cli.StringFlag{ Name: "server_address", EnvVars: []string{"MICRO_SERVER_ADDRESS"}, Usage: "Bind address for the server. 127.0.0.1:8080", }, &cli.StringFlag{ Name: "server_advertise", EnvVars: []string{"MICRO_SERVER_ADVERTISE"}, Usage: "Used instead of the server_address when registering with discovery. 127.0.0.1:8080", }, &cli.StringSliceFlag{ Name: "server_metadata", EnvVars: []string{"MICRO_SERVER_METADATA"}, Value: &cli.StringSlice{}, Usage: "A list of key-value pairs defining metadata. version=1.0.0", }, &cli.StringFlag{ Name: "broker", EnvVars: []string{"MICRO_BROKER"}, Usage: "Broker for pub/sub. http, nats, rabbitmq", }, &cli.StringFlag{ Name: "broker_address", EnvVars: []string{"MICRO_BROKER_ADDRESS"}, Usage: "Comma-separated list of broker addresses", }, &cli.StringFlag{ Name: "profile", Usage: "Debug profiler for cpu and memory stats", EnvVars: []string{"MICRO_DEBUG_PROFILE"}, }, &cli.StringFlag{ Name: "registry", EnvVars: []string{"MICRO_REGISTRY"}, Usage: "Registry for discovery. etcd, mdns", }, &cli.StringFlag{ Name: "registry_address", EnvVars: []string{"MICRO_REGISTRY_ADDRESS"}, Usage: "Comma-separated list of registry addresses", }, &cli.StringFlag{ Name: "runtime", Usage: "Runtime for building and running services e.g local, kubernetes", EnvVars: []string{"MICRO_RUNTIME"}, Value: "local", }, &cli.StringFlag{ Name: "runtime_source", Usage: "Runtime source for building and running services e.g github.com/micro/service", EnvVars: []string{"MICRO_RUNTIME_SOURCE"}, Value: "github.com/micro/services", }, &cli.StringFlag{ Name: "selector", EnvVars: []string{"MICRO_SELECTOR"}, Usage: "Selector used to pick nodes for querying", }, &cli.StringFlag{ Name: "store", EnvVars: []string{"MICRO_STORE"}, Usage: "Store used for key-value storage", }, &cli.StringFlag{ Name: "store_address", EnvVars: []string{"MICRO_STORE_ADDRESS"}, Usage: "Comma-separated list of store addresses", }, &cli.StringFlag{ Name: "store_namespace", EnvVars: []string{"MICRO_STORE_NAMESPACE"}, Usage: "Namespace for store data", }, &cli.StringFlag{ Name: "transport", EnvVars: []string{"MICRO_TRANSPORT"}, Usage: "Transport mechanism used; http", }, &cli.StringFlag{ Name: "transport_address", EnvVars: []string{"MICRO_TRANSPORT_ADDRESS"}, Usage: "Comma-separated list of transport addresses", }, &cli.StringFlag{ Name: "tracer", EnvVars: []string{"MICRO_TRACER"}, Usage: "Tracer for distributed tracing, e.g. memory, jaeger", }, &cli.StringFlag{ Name: "tracer_address", EnvVars: []string{"MICRO_TRACER_ADDRESS"}, Usage: "Comma-separated list of tracer addresses", }, &cli.StringFlag{ Name: "auth", EnvVars: []string{"MICRO_AUTH"}, Usage: "Auth for role based access control, e.g. service", }, &cli.StringFlag{ Name: "auth_token", EnvVars: []string{"MICRO_AUTH_TOKEN"}, Usage: "Auth token used for client authentication", }, &cli.StringFlag{ Name: "auth_public_key", EnvVars: []string{"MICRO_AUTH_PUBLIC_KEY"}, Usage: "Public key for JWT auth (base64 encoded PEM)", }, &cli.StringFlag{ Name: "auth_private_key", EnvVars: []string{"MICRO_AUTH_PRIVATE_KEY"}, Usage: "Private key for JWT auth (base64 encoded PEM)", }, &cli.StringFlag{ Name: "auth_provider", EnvVars: []string{"MICRO_AUTH_PROVIDER"}, Usage: "Auth provider used to login user", }, &cli.StringFlag{ Name: "auth_provider_client_id", EnvVars: []string{"MICRO_AUTH_PROVIDER_CLIENT_ID"}, Usage: "The client id to be used for oauth", }, &cli.StringFlag{ Name: "auth_provider_client_secret", EnvVars: []string{"MICRO_AUTH_PROVIDER_CLIENT_SECRET"}, Usage: "The client secret to be used for oauth", }, &cli.StringFlag{ Name: "auth_provider_endpoint", EnvVars: []string{"MICRO_AUTH_PROVIDER_ENDPOINT"}, Usage: "The enpoint to be used for oauth", }, &cli.StringFlag{ Name: "auth_provider_redirect", EnvVars: []string{"MICRO_AUTH_PROVIDER_REDIRECT"}, Usage: "The redirect to be used for oauth", }, &cli.StringFlag{ Name: "auth_provider_scope", EnvVars: []string{"MICRO_AUTH_PROVIDER_SCOPE"}, Usage: "The scope to be used for oauth", }, &cli.StringFlag{ Name: "config", EnvVars: []string{"MICRO_CONFIG"}, Usage: "The source of the config to be used to get configuration", }, } DefaultBrokers = map[string]func(...broker.Option) broker.Broker{ "service": brokerSrv.NewBroker, "memory": memory.NewBroker, "nats": nats.NewBroker, } DefaultClients = map[string]func(...client.Option) client.Client{ "mucp": cmucp.NewClient, "grpc": cgrpc.NewClient, } DefaultRegistries = map[string]func(...registry.Option) registry.Registry{ "service": regSrv.NewRegistry, "etcd": etcd.NewRegistry, "mdns": mdns.NewRegistry, "memory": rmem.NewRegistry, "kubernetes": kreg.NewRegistry, } DefaultSelectors = map[string]func(...selector.Option) selector.Selector{ "dns": dns.NewSelector, "router": router.NewSelector, "static": static.NewSelector, } DefaultServers = map[string]func(...server.Option) server.Server{ "mucp": smucp.NewServer, "grpc": sgrpc.NewServer, } DefaultTransports = map[string]func(...transport.Option) transport.Transport{ "memory": tmem.NewTransport, "http": thttp.NewTransport, } DefaultRuntimes = map[string]func(...runtime.Option) runtime.Runtime{ "local": lRuntime.NewRuntime, "service": srvRuntime.NewRuntime, "kubernetes": kRuntime.NewRuntime, } DefaultStores = map[string]func(...store.Option) store.Store{ "memory": memStore.NewStore, "service": svcStore.NewStore, } DefaultTracers = map[string]func(...trace.Option) trace.Tracer{ "memory": memTracer.NewTracer, // "jaeger": jTracer.NewTracer, } DefaultAuths = map[string]func(...auth.Option) auth.Auth{ "service": svcAuth.NewAuth, } DefaultAuthProviders = map[string]func(...provider.Option) provider.Provider{ "oauth": oauth.NewProvider, "basic": basic.NewProvider, } DefaultProfiles = map[string]func(...profile.Option) profile.Profile{ "http": http.NewProfile, "pprof": pprof.NewProfile, } DefaultConfigs = map[string]func(...config.Option) (config.Config, error){ "service": config.NewConfig, } ) func init() { rand.Seed(time.Now().Unix()) } func newCmd(opts ...Option) Cmd { options := Options{ Auth: &auth.DefaultAuth, Broker: &broker.DefaultBroker, Client: &client.DefaultClient, Registry: ®istry.DefaultRegistry, Server: &server.DefaultServer, Selector: &selector.DefaultSelector, Transport: &transport.DefaultTransport, Runtime: &runtime.DefaultRuntime, Store: &store.DefaultStore, Tracer: &trace.DefaultTracer, Profile: &profile.DefaultProfile, Config: &config.DefaultConfig, Brokers: DefaultBrokers, Clients: DefaultClients, Registries: DefaultRegistries, Selectors: DefaultSelectors, Servers: DefaultServers, Transports: DefaultTransports, Runtimes: DefaultRuntimes, Stores: DefaultStores, Tracers: DefaultTracers, Auths: DefaultAuths, Profiles: DefaultProfiles, Configs: DefaultConfigs, } for _, o := range opts { o(&options) } if len(options.Description) == 0 { options.Description = "a go-micro service" } cmd := new(cmd) cmd.opts = options cmd.app = cli.NewApp() cmd.app.Name = cmd.opts.Name cmd.app.Version = cmd.opts.Version cmd.app.Usage = cmd.opts.Description cmd.app.Before = cmd.Before cmd.app.Flags = DefaultFlags cmd.app.Action = func(c *cli.Context) error { return nil } if len(options.Version) == 0 { cmd.app.HideVersion = true } return cmd } func (c *cmd) App() *cli.App { return c.app } func (c *cmd) Options() Options { return c.opts } func (c *cmd) Before(ctx *cli.Context) error { // If flags are set then use them otherwise do nothing var authOpts []auth.Option var serverOpts []server.Option var clientOpts []client.Option // Set the store if name := ctx.String("store"); len(name) > 0 { s, ok := c.opts.Stores[name] if !ok { return fmt.Errorf("Unsupported store: %s", name) } *c.opts.Store = s() } // Set the runtime if name := ctx.String("runtime"); len(name) > 0 { r, ok := c.opts.Runtimes[name] if !ok { return fmt.Errorf("Unsupported runtime: %s", name) } *c.opts.Runtime = r() } // Set the tracer if name := ctx.String("tracer"); len(name) > 0 { r, ok := c.opts.Tracers[name] if !ok { return fmt.Errorf("Unsupported tracer: %s", name) } *c.opts.Tracer = r() } // Set the auth if name := ctx.String("auth"); len(name) > 0 { a, ok := c.opts.Auths[name] if !ok { return fmt.Errorf("Unsupported auth: %s", name) } *c.opts.Auth = a() } // Set the profile if name := ctx.String("profile"); len(name) > 0 { p, ok := c.opts.Profiles[name] if !ok { return fmt.Errorf("Unsupported profile: %s", name) } *c.opts.Profile = p() } // Set the client if name := ctx.String("client"); len(name) > 0 { // only change if we have the client and type differs if cl, ok := c.opts.Clients[name]; ok && (*c.opts.Client).String() != name { *c.opts.Client = cl() } } // Set the server if name := ctx.String("server"); len(name) > 0 { // only change if we have the server and type differs if s, ok := c.opts.Servers[name]; ok && (*c.opts.Server).String() != name { *c.opts.Server = s() } } // Set the broker if name := ctx.String("broker"); len(name) > 0 && (*c.opts.Broker).String() != name { b, ok := c.opts.Brokers[name] if !ok { return fmt.Errorf("Broker %s not found", name) } *c.opts.Broker = b() serverOpts = append(serverOpts, server.Broker(*c.opts.Broker)) clientOpts = append(clientOpts, client.Broker(*c.opts.Broker)) } // Set the registry if name := ctx.String("registry"); len(name) > 0 && (*c.opts.Registry).String() != name { r, ok := c.opts.Registries[name] if !ok { return fmt.Errorf("Registry %s not found", name) } *c.opts.Registry = r() serverOpts = append(serverOpts, server.Registry(*c.opts.Registry)) clientOpts = append(clientOpts, client.Registry(*c.opts.Registry)) if err := (*c.opts.Selector).Init(selector.Registry(*c.opts.Registry)); err != nil { logger.Fatalf("Error configuring registry: %v", err) } clientOpts = append(clientOpts, client.Selector(*c.opts.Selector)) if err := (*c.opts.Broker).Init(broker.Registry(*c.opts.Registry)); err != nil { logger.Fatalf("Error configuring broker: %v", err) } } // Set the selector if name := ctx.String("selector"); len(name) > 0 && (*c.opts.Selector).String() != name { s, ok := c.opts.Selectors[name] if !ok { return fmt.Errorf("Selector %s not found", name) } *c.opts.Selector = s(selector.Registry(*c.opts.Registry)) // No server option here. Should there be? clientOpts = append(clientOpts, client.Selector(*c.opts.Selector)) } // Set the transport if name := ctx.String("transport"); len(name) > 0 && (*c.opts.Transport).String() != name { t, ok := c.opts.Transports[name] if !ok { return fmt.Errorf("Transport %s not found", name) } *c.opts.Transport = t() serverOpts = append(serverOpts, server.Transport(*c.opts.Transport)) clientOpts = append(clientOpts, client.Transport(*c.opts.Transport)) } // Parse the server options metadata := make(map[string]string) for _, d := range ctx.StringSlice("server_metadata") { var key, val string parts := strings.Split(d, "=") key = parts[0] if len(parts) > 1 { val = strings.Join(parts[1:], "=") } metadata[key] = val } if len(metadata) > 0 { serverOpts = append(serverOpts, server.Metadata(metadata)) } if len(ctx.String("broker_address")) > 0 { if err := (*c.opts.Broker).Init(broker.Addrs(strings.Split(ctx.String("broker_address"), ",")...)); err != nil { logger.Fatalf("Error configuring broker: %v", err) } } if len(ctx.String("registry_address")) > 0 { if err := (*c.opts.Registry).Init(registry.Addrs(strings.Split(ctx.String("registry_address"), ",")...)); err != nil { logger.Fatalf("Error configuring registry: %v", err) } } if len(ctx.String("transport_address")) > 0 { if err := (*c.opts.Transport).Init(transport.Addrs(strings.Split(ctx.String("transport_address"), ",")...)); err != nil { logger.Fatalf("Error configuring transport: %v", err) } } if len(ctx.String("store_address")) > 0 { if err := (*c.opts.Store).Init(store.Nodes(strings.Split(ctx.String("store_address"), ",")...)); err != nil { logger.Fatalf("Error configuring store: %v", err) } } if len(ctx.String("store_namespace")) > 0 { if err := (*c.opts.Store).Init(store.Namespace(ctx.String("store_address"))); err != nil { logger.Fatalf("Error configuring store: %v", err) } } if len(ctx.String("server_name")) > 0 { serverOpts = append(serverOpts, server.Name(ctx.String("server_name"))) } if len(ctx.String("server_version")) > 0 { serverOpts = append(serverOpts, server.Version(ctx.String("server_version"))) } if len(ctx.String("server_id")) > 0 { serverOpts = append(serverOpts, server.Id(ctx.String("server_id"))) } if len(ctx.String("server_address")) > 0 { serverOpts = append(serverOpts, server.Address(ctx.String("server_address"))) } if len(ctx.String("server_advertise")) > 0 { serverOpts = append(serverOpts, server.Advertise(ctx.String("server_advertise"))) } if ttl := time.Duration(ctx.Int("register_ttl")); ttl >= 0 { serverOpts = append(serverOpts, server.RegisterTTL(ttl*time.Second)) } if val := time.Duration(ctx.Int("register_interval")); val >= 0 { serverOpts = append(serverOpts, server.RegisterInterval(val*time.Second)) } if len(ctx.String("runtime_source")) > 0 { if err := (*c.opts.Runtime).Init(runtime.WithSource(ctx.String("runtime_source"))); err != nil { logger.Fatalf("Error configuring runtime: %v", err) } } if len(ctx.String("auth_token")) > 0 { authOpts = append(authOpts, auth.ServiceToken(ctx.String("auth_token"))) } if len(ctx.String("auth_public_key")) > 0 { authOpts = append(authOpts, auth.PublicKey(ctx.String("auth_public_key"))) } if len(ctx.String("auth_private_key")) > 0 { authOpts = append(authOpts, auth.PrivateKey(ctx.String("auth_private_key"))) } if name := ctx.String("auth_provider"); len(name) > 0 { p, ok := DefaultAuthProviders[name] if !ok { return fmt.Errorf("AuthProvider %s not found", name) } var provOpts []provider.Option clientID := ctx.String("auth_provider_client_id") clientSecret := ctx.String("auth_provider_client_secret") if len(clientID) > 0 || len(clientSecret) > 0 { provOpts = append(provOpts, provider.Credentials(clientID, clientSecret)) } if e := ctx.String("auth_provider_endpoint"); len(e) > 0 { provOpts = append(provOpts, provider.Endpoint(e)) } if r := ctx.String("auth_provider_redirect"); len(r) > 0 { provOpts = append(provOpts, provider.Redirect(r)) } if s := ctx.String("auth_provider_scope"); len(s) > 0 { provOpts = append(provOpts, provider.Scope(s)) } authOpts = append(authOpts, auth.Provider(p(provOpts...))) } if len(authOpts) > 0 { (*c.opts.Auth).Init(authOpts...) } if ctx.String("config") == "service" { opt := config.WithSource(configSrv.NewSource()) if err := (*c.opts.Config).Init(opt); err != nil { logger.Fatalf("Error configuring config: %v", err) } } // client opts if r := ctx.Int("client_retries"); r >= 0 { clientOpts = append(clientOpts, client.Retries(r)) } if t := ctx.String("client_request_timeout"); len(t) > 0 { d, err := time.ParseDuration(t) if err != nil { return fmt.Errorf("failed to parse client_request_timeout: %v", t) } clientOpts = append(clientOpts, client.RequestTimeout(d)) } if r := ctx.Int("client_pool_size"); r > 0 { clientOpts = append(clientOpts, client.PoolSize(r)) } if t := ctx.String("client_pool_ttl"); len(t) > 0 { d, err := time.ParseDuration(t) if err != nil { return fmt.Errorf("failed to parse client_pool_ttl: %v", t) } clientOpts = append(clientOpts, client.PoolTTL(d)) } // We have some command line opts for the server. // Lets set it up if len(serverOpts) > 0 { if err := (*c.opts.Server).Init(serverOpts...); err != nil { logger.Fatalf("Error configuring server: %v", err) } } // Use an init option? if len(clientOpts) > 0 { if err := (*c.opts.Client).Init(clientOpts...); err != nil { logger.Fatalf("Error configuring client: %v", err) } } return nil } func (c *cmd) Init(opts ...Option) error { for _, o := range opts { o(&c.opts) } if len(c.opts.Name) > 0 { c.app.Name = c.opts.Name } if len(c.opts.Version) > 0 { c.app.Version = c.opts.Version } c.app.HideVersion = len(c.opts.Version) == 0 c.app.Usage = c.opts.Description c.app.RunAndExitOnError() return nil } func DefaultOptions() Options { return DefaultCmd.Options() } func App() *cli.App { return DefaultCmd.App() } func Init(opts ...Option) error { return DefaultCmd.Init(opts...) } func NewCmd(opts ...Option) Cmd { return newCmd(opts...) }