Adds a registry mechanism for CLI commands.

7 years ago · 521e46ce91
parent 44d824a58f
commit 521e46ce91
4 changed files with 162 additions and 130 deletions
--- a/command/commands.go
+++ b/command/commands.go
@ -1,125 +0,0 @@
-package command
-
-import (
-	"os"
-	"os/signal"
-	"syscall"
-
-	"github.com/hashicorp/consul/command/agent"
-	"github.com/hashicorp/consul/command/catalog"
-	catlistdc "github.com/hashicorp/consul/command/catalog/list/dc"
-	catlistnodes "github.com/hashicorp/consul/command/catalog/list/nodes"
-	catlistsvc "github.com/hashicorp/consul/command/catalog/list/services"
-	"github.com/hashicorp/consul/command/event"
-	"github.com/hashicorp/consul/command/exec"
-	"github.com/hashicorp/consul/command/forceleave"
-	"github.com/hashicorp/consul/command/info"
-	"github.com/hashicorp/consul/command/join"
-	"github.com/hashicorp/consul/command/keygen"
-	"github.com/hashicorp/consul/command/keyring"
-	"github.com/hashicorp/consul/command/kv"
-	kvdel "github.com/hashicorp/consul/command/kv/del"
-	kvexp "github.com/hashicorp/consul/command/kv/exp"
-	kvget "github.com/hashicorp/consul/command/kv/get"
-	kvimp "github.com/hashicorp/consul/command/kv/imp"
-	kvput "github.com/hashicorp/consul/command/kv/put"
-	"github.com/hashicorp/consul/command/leave"
-	"github.com/hashicorp/consul/command/lock"
-	"github.com/hashicorp/consul/command/maint"
-	"github.com/hashicorp/consul/command/members"
-	"github.com/hashicorp/consul/command/monitor"
-	"github.com/hashicorp/consul/command/operator"
-	operauto "github.com/hashicorp/consul/command/operator/autopilot"
-	operautoget "github.com/hashicorp/consul/command/operator/autopilot/get"
-	operautoset "github.com/hashicorp/consul/command/operator/autopilot/set"
-	operraft "github.com/hashicorp/consul/command/operator/raft"
-	operraftlist "github.com/hashicorp/consul/command/operator/raft/listpeers"
-	operraftremove "github.com/hashicorp/consul/command/operator/raft/removepeer"
-	"github.com/hashicorp/consul/command/reload"
-	"github.com/hashicorp/consul/command/rtt"
-	"github.com/hashicorp/consul/command/snapshot"
-	snapinspect "github.com/hashicorp/consul/command/snapshot/inspect"
-	snaprestore "github.com/hashicorp/consul/command/snapshot/restore"
-	snapsave "github.com/hashicorp/consul/command/snapshot/save"
-	"github.com/hashicorp/consul/command/validate"
-	"github.com/hashicorp/consul/command/version"
-	"github.com/hashicorp/consul/command/watch"
-	consulversion "github.com/hashicorp/consul/version"
-
-	"github.com/mitchellh/cli"
-)
-
-// Commands is the mapping of all the available Consul commands.
-var Commands map[string]cli.CommandFactory
-
-func init() {
-	rev := consulversion.GitCommit
-	ver := consulversion.Version
-	verPre := consulversion.VersionPrerelease
-	verHuman := consulversion.GetHumanVersion()
-
-	ui := &cli.BasicUi{Writer: os.Stdout, ErrorWriter: os.Stderr}
-
-	Commands = map[string]cli.CommandFactory{
-		"agent": func() (cli.Command, error) {
-			return agent.New(ui, rev, ver, verPre, verHuman, make(chan struct{})), nil
-		},
-
-		"catalog":                       func() (cli.Command, error) { return catalog.New(), nil },
-		"catalog datacenters":           func() (cli.Command, error) { return catlistdc.New(ui), nil },
-		"catalog nodes":                 func() (cli.Command, error) { return catlistnodes.New(ui), nil },
-		"catalog services":              func() (cli.Command, error) { return catlistsvc.New(ui), nil },
-		"event":                         func() (cli.Command, error) { return event.New(ui), nil },
-		"exec":                          func() (cli.Command, error) { return exec.New(ui, makeShutdownCh()), nil },
-		"force-leave":                   func() (cli.Command, error) { return forceleave.New(ui), nil },
-		"info":                          func() (cli.Command, error) { return info.New(ui), nil },
-		"join":                          func() (cli.Command, error) { return join.New(ui), nil },
-		"keygen":                        func() (cli.Command, error) { return keygen.New(ui), nil },
-		"keyring":                       func() (cli.Command, error) { return keyring.New(ui), nil },
-		"kv":                            func() (cli.Command, error) { return kv.New(), nil },
-		"kv delete":                     func() (cli.Command, error) { return kvdel.New(ui), nil },
-		"kv export":                     func() (cli.Command, error) { return kvexp.New(ui), nil },
-		"kv get":                        func() (cli.Command, error) { return kvget.New(ui), nil },
-		"kv import":                     func() (cli.Command, error) { return kvimp.New(ui), nil },
-		"kv put":                        func() (cli.Command, error) { return kvput.New(ui), nil },
-		"leave":                         func() (cli.Command, error) { return leave.New(ui), nil },
-		"lock":                          func() (cli.Command, error) { return lock.New(ui), nil },
-		"maint":                         func() (cli.Command, error) { return maint.New(ui), nil },
-		"members":                       func() (cli.Command, error) { return members.New(ui), nil },
-		"monitor":                       func() (cli.Command, error) { return monitor.New(ui, makeShutdownCh()), nil },
-		"operator":                      func() (cli.Command, error) { return operator.New(), nil },
-		"operator autopilot":            func() (cli.Command, error) { return operauto.New(), nil },
-		"operator autopilot get-config": func() (cli.Command, error) { return operautoget.New(ui), nil },
-		"operator autopilot set-config": func() (cli.Command, error) { return operautoset.New(ui), nil },
-		"operator raft":                 func() (cli.Command, error) { return operraft.New(), nil },
-		"operator raft list-peers":      func() (cli.Command, error) { return operraftlist.New(ui), nil },
-		"operator raft remove-peer":     func() (cli.Command, error) { return operraftremove.New(ui), nil },
-		"reload":                        func() (cli.Command, error) { return reload.New(ui), nil },
-		"rtt":                           func() (cli.Command, error) { return rtt.New(ui), nil },
-		"snapshot":                      func() (cli.Command, error) { return snapshot.New(), nil },
-		"snapshot inspect":              func() (cli.Command, error) { return snapinspect.New(ui), nil },
-		"snapshot restore":              func() (cli.Command, error) { return snaprestore.New(ui), nil },
-		"snapshot save":                 func() (cli.Command, error) { return snapsave.New(ui), nil },
-		"validate":                      func() (cli.Command, error) { return validate.New(ui), nil },
-		"version":                       func() (cli.Command, error) { return version.New(ui, verHuman), nil },
-		"watch":                         func() (cli.Command, error) { return watch.New(ui, makeShutdownCh()), nil },
-	}
-}
-
-// makeShutdownCh returns a channel that can be used for shutdown
-// notifications for commands. This channel will send a message for every
-// interrupt or SIGTERM received.
-func makeShutdownCh() <-chan struct{} {
-	resultCh := make(chan struct{})
-
-	signalCh := make(chan os.Signal, 4)
-	signal.Notify(signalCh, os.Interrupt, syscall.SIGTERM)
-	go func() {
-		for {
-			<-signalCh
-			resultCh <- struct{}{}
-		}
-	}()
-
-	return resultCh
-}
--- a/command/commands_oss.go
+++ b/command/commands_oss.go
@ -0,0 +1,95 @@
+package command
+
+import (
+	"github.com/hashicorp/consul/command/agent"
+	"github.com/hashicorp/consul/command/catalog"
+	catlistdc "github.com/hashicorp/consul/command/catalog/list/dc"
+	catlistnodes "github.com/hashicorp/consul/command/catalog/list/nodes"
+	catlistsvc "github.com/hashicorp/consul/command/catalog/list/services"
+	"github.com/hashicorp/consul/command/event"
+	"github.com/hashicorp/consul/command/exec"
+	"github.com/hashicorp/consul/command/forceleave"
+	"github.com/hashicorp/consul/command/info"
+	"github.com/hashicorp/consul/command/join"
+	"github.com/hashicorp/consul/command/keygen"
+	"github.com/hashicorp/consul/command/keyring"
+	"github.com/hashicorp/consul/command/kv"
+	kvdel "github.com/hashicorp/consul/command/kv/del"
+	kvexp "github.com/hashicorp/consul/command/kv/exp"
+	kvget "github.com/hashicorp/consul/command/kv/get"
+	kvimp "github.com/hashicorp/consul/command/kv/imp"
+	kvput "github.com/hashicorp/consul/command/kv/put"
+	"github.com/hashicorp/consul/command/leave"
+	"github.com/hashicorp/consul/command/lock"
+	"github.com/hashicorp/consul/command/maint"
+	"github.com/hashicorp/consul/command/members"
+	"github.com/hashicorp/consul/command/monitor"
+	"github.com/hashicorp/consul/command/operator"
+	operauto "github.com/hashicorp/consul/command/operator/autopilot"
+	operautoget "github.com/hashicorp/consul/command/operator/autopilot/get"
+	operautoset "github.com/hashicorp/consul/command/operator/autopilot/set"
+	operraft "github.com/hashicorp/consul/command/operator/raft"
+	operraftlist "github.com/hashicorp/consul/command/operator/raft/listpeers"
+	operraftremove "github.com/hashicorp/consul/command/operator/raft/removepeer"
+	"github.com/hashicorp/consul/command/reload"
+	"github.com/hashicorp/consul/command/rtt"
+	"github.com/hashicorp/consul/command/snapshot"
+	snapinspect "github.com/hashicorp/consul/command/snapshot/inspect"
+	snaprestore "github.com/hashicorp/consul/command/snapshot/restore"
+	snapsave "github.com/hashicorp/consul/command/snapshot/save"
+	"github.com/hashicorp/consul/command/validate"
+	"github.com/hashicorp/consul/command/version"
+	"github.com/hashicorp/consul/command/watch"
+	consulversion "github.com/hashicorp/consul/version"
+
+	"github.com/mitchellh/cli"
+)
+
+func init() {
+	rev := consulversion.GitCommit
+	ver := consulversion.Version
+	verPre := consulversion.VersionPrerelease
+	verHuman := consulversion.GetHumanVersion()
+
+	Register("agent", func(ui cli.Ui) (cli.Command, error) {
+		return agent.New(ui, rev, ver, verPre, verHuman, make(chan struct{})), nil
+	})
+	Register("catalog", func(cli.Ui) (cli.Command, error) { return catalog.New(), nil })
+	Register("catalog datacenters", func(ui cli.Ui) (cli.Command, error) { return catlistdc.New(ui), nil })
+	Register("catalog nodes", func(ui cli.Ui) (cli.Command, error) { return catlistnodes.New(ui), nil })
+	Register("catalog services", func(ui cli.Ui) (cli.Command, error) { return catlistsvc.New(ui), nil })
+	Register("event", func(ui cli.Ui) (cli.Command, error) { return event.New(ui), nil })
+	Register("exec", func(ui cli.Ui) (cli.Command, error) { return exec.New(ui, MakeShutdownCh()), nil })
+	Register("force-leave", func(ui cli.Ui) (cli.Command, error) { return forceleave.New(ui), nil })
+	Register("info", func(ui cli.Ui) (cli.Command, error) { return info.New(ui), nil })
+	Register("join", func(ui cli.Ui) (cli.Command, error) { return join.New(ui), nil })
+	Register("keygen", func(ui cli.Ui) (cli.Command, error) { return keygen.New(ui), nil })
+	Register("keyring", func(ui cli.Ui) (cli.Command, error) { return keyring.New(ui), nil })
+	Register("kv", func(cli.Ui) (cli.Command, error) { return kv.New(), nil })
+	Register("kv delete", func(ui cli.Ui) (cli.Command, error) { return kvdel.New(ui), nil })
+	Register("kv export", func(ui cli.Ui) (cli.Command, error) { return kvexp.New(ui), nil })
+	Register("kv get", func(ui cli.Ui) (cli.Command, error) { return kvget.New(ui), nil })
+	Register("kv import", func(ui cli.Ui) (cli.Command, error) { return kvimp.New(ui), nil })
+	Register("kv put", func(ui cli.Ui) (cli.Command, error) { return kvput.New(ui), nil })
+	Register("leave", func(ui cli.Ui) (cli.Command, error) { return leave.New(ui), nil })
+	Register("lock", func(ui cli.Ui) (cli.Command, error) { return lock.New(ui), nil })
+	Register("maint", func(ui cli.Ui) (cli.Command, error) { return maint.New(ui), nil })
+	Register("members", func(ui cli.Ui) (cli.Command, error) { return members.New(ui), nil })
+	Register("monitor", func(ui cli.Ui) (cli.Command, error) { return monitor.New(ui, MakeShutdownCh()), nil })
+	Register("operator", func(cli.Ui) (cli.Command, error) { return operator.New(), nil })
+	Register("operator autopilot", func(cli.Ui) (cli.Command, error) { return operauto.New(), nil })
+	Register("operator autopilot get-config", func(ui cli.Ui) (cli.Command, error) { return operautoget.New(ui), nil })
+	Register("operator autopilot set-config", func(ui cli.Ui) (cli.Command, error) { return operautoset.New(ui), nil })
+	Register("operator raft", func(cli.Ui) (cli.Command, error) { return operraft.New(), nil })
+	Register("operator raft list-peers", func(ui cli.Ui) (cli.Command, error) { return operraftlist.New(ui), nil })
+	Register("operator raft remove-peer", func(ui cli.Ui) (cli.Command, error) { return operraftremove.New(ui), nil })
+	Register("reload", func(ui cli.Ui) (cli.Command, error) { return reload.New(ui), nil })
+	Register("rtt", func(ui cli.Ui) (cli.Command, error) { return rtt.New(ui), nil })
+	Register("snapshot", func(cli.Ui) (cli.Command, error) { return snapshot.New(), nil })
+	Register("snapshot inspect", func(ui cli.Ui) (cli.Command, error) { return snapinspect.New(ui), nil })
+	Register("snapshot restore", func(ui cli.Ui) (cli.Command, error) { return snaprestore.New(ui), nil })
+	Register("snapshot save", func(ui cli.Ui) (cli.Command, error) { return snapsave.New(ui), nil })
+	Register("validate", func(ui cli.Ui) (cli.Command, error) { return validate.New(ui), nil })
+	Register("version", func(ui cli.Ui) (cli.Command, error) { return version.New(ui, verHuman), nil })
+	Register("watch", func(ui cli.Ui) (cli.Command, error) { return watch.New(ui, MakeShutdownCh()), nil })
+}
--- a/command/registry.go
+++ b/command/registry.go
@ -0,0 +1,60 @@
+package command
+
+import (
+	"fmt"
+	"os"
+	"os/signal"
+	"syscall"
+
+	"github.com/mitchellh/cli"
+)
+
+// Factory is a function that returns a new instance of a CLI-sub command.
+type Factory func(cli.Ui) (cli.Command, error)
+
+// Register adds a new CLI sub-command to the registry.
+func Register(name string, fn Factory) {
+	if registry == nil {
+		registry = make(map[string]Factory)
+	}
+
+	if registry[name] != nil {
+		panic(fmt.Errorf("Command %q is already registered", name))
+	}
+	registry[name] = fn
+}
+
+// Map returns a realized mapping of available CLI commands in a format that
+// the CLI class can consume. This should be called after all registration is
+// complete.
+func Map(ui cli.Ui) map[string]cli.CommandFactory {
+	m := make(map[string]cli.CommandFactory)
+	for name, fn := range registry {
+		thisFn := fn
+		m[name] = func() (cli.Command, error) {
+			return thisFn(ui)
+		}
+	}
+	return m
+}
+
+// registry has an entry for each available CLI sub-command, indexed by sub
+// command name. This should be populated at package init() time via Register().
+var registry map[string]Factory
+
+// MakeShutdownCh returns a channel that can be used for shutdown notifications
+// for commands. This channel will send a message for every interrupt or SIGTERM
+// received.
+func MakeShutdownCh() <-chan struct{} {
+	resultCh := make(chan struct{})
+	signalCh := make(chan os.Signal, 4)
+	signal.Notify(signalCh, os.Interrupt, syscall.SIGTERM)
+	go func() {
+		for {
+			<-signalCh
+			resultCh <- struct{}{}
+		}
+	}()
+
+	return resultCh
+}
--- a/main.go
+++ b/main.go
@ -34,17 +34,19 @@ func realMain() int {
 		}
 	}

-	var cmds []string
-	for c := range command.Commands {
-		cmds = append(cmds, c)
+	ui := &cli.BasicUi{Writer: os.Stdout, ErrorWriter: os.Stderr}
+	cmds := command.Map(ui)
+	var names []string
+	for c := range cmds {
+		names = append(names, c)
 	}

 	cli := &cli.CLI{
 		Args:         args,
-		Commands:     command.Commands,
+		Commands:     cmds,
 		Autocomplete: true,
 		Name:         "consul",
-		HelpFunc:     cli.FilteredHelpFunc(cmds, cli.BasicHelpFunc("consul")),
+		HelpFunc:     cli.FilteredHelpFunc(names, cli.BasicHelpFunc("consul")),
 	}

 	exitCode, err := cli.Run()