luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

commands: get HTTP API flags for usage automatically

This commit is contained in:
Frank Schroeder 2017-10-18 00:00:01 +02:00 committed by Frank Schröder
parent cb8faa3559
commit 8f58a603ea
40 changed files with 79 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
command/agent/agent.go
View File

@ -70,7 +70,7 @@ type cmd struct {
func (c *cmd) init() {
c.flags = flag.NewFlagSet("", flag.ContinueOnError)
config.AddFlags(c.flags, &c.flagArgs)
c.help = flags.Usage(help, c.flags, nil, nil)
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/catalog/catalog.go
View File

@ -20,7 +20,7 @@ func (c *cmd) Synopsis() string {
}
func (c *cmd) Help() string {
return flags.Usage(help, nil, nil, nil)
return flags.Usage(help, nil)
}
const synopsis = "Interact with the catalog"

2
command/catalog/list/dc/catalog_list_datacenters.go
View File

@ -26,7 +26,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
flags.Merge(c.flags, c.http.ServerFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), c.http.ServerFlags())
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/catalog/list/nodes/catalog_list_nodes.go
View File

@ -48,7 +48,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
flags.Merge(c.flags, c.http.ServerFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), c.http.ServerFlags())
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/catalog/list/services/catalog_list_services.go
View File

@ -46,7 +46,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
flags.Merge(c.flags, c.http.ServerFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), c.http.ServerFlags())
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/event/event.go
View File

@ -40,7 +40,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), nil)
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/exec/exec.go
View File

@ -60,7 +60,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
flags.Merge(c.flags, c.http.ServerFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), c.http.ServerFlags())
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/flags/merge.go
View File

@ -10,6 +10,6 @@ func Merge(dst, src *flag.FlagSet) {
return
}
src.VisitAll(func(f *flag.Flag) {
dst.Var(f.Value, f.Name, f.DefValue)
dst.Var(f.Value, f.Name, f.Usage)
})
}

57
command/flags/usage.go
View File

@ -10,21 +10,17 @@ import (
text "github.com/tonnerre/golang-text"
)
func Usage(txt string, cmdFlags, clientFlags, serverFlags *flag.FlagSet) string {
func Usage(txt string, flags *flag.FlagSet) string {
u := &Usager{
Usage: txt,
CmdFlags: cmdFlags,
HTTPClientFlags: clientFlags,
HTTPServerFlags: serverFlags,
Flags: flags,
}
return u.String()
}
type Usager struct {
Usage string
CmdFlags *flag.FlagSet
HTTPClientFlags *flag.FlagSet
HTTPServerFlags *flag.FlagSet
Flags *flag.FlagSet
}
func (u *Usager) String() string {
@ -33,12 +29,25 @@ func (u *Usager) String() string {
out.WriteString("\n")
out.WriteString("\n")
httpFlags := u.HTTPClientFlags
if u.Flags != nil {
f := &HTTPFlags{}
clientFlags := f.ClientFlags()
serverFlags := f.ServerFlags()
var httpFlags, cmdFlags *flag.FlagSet
u.Flags.VisitAll(func(f *flag.Flag) {
if contains(clientFlags, f) || contains(serverFlags, f) {
if httpFlags == nil {
httpFlags = u.HTTPServerFlags
} else {
Merge(httpFlags, u.HTTPServerFlags)
httpFlags = flag.NewFlagSet("", flag.ContinueOnError)
}
httpFlags.Var(f.Value, f.Name, f.Usage)
} else {
if cmdFlags == nil {
cmdFlags = flag.NewFlagSet("", flag.ContinueOnError)
}
cmdFlags.Var(f.Value, f.Name, f.Usage)
}
})
if httpFlags != nil {
printTitle(out, "HTTP API Options")
@ -47,15 +56,13 @@ func (u *Usager) String() string {
})
}
if u.CmdFlags != nil {
if cmdFlags != nil {
printTitle(out, "Command Options")
u.CmdFlags.VisitAll(func(f *flag.Flag) {
if flagContains(httpFlags, f) {
return
}
cmdFlags.VisitAll(func(f *flag.Flag) {
printFlag(out, f)
})
}
}
return strings.TrimRight(out.String(), "\n")
}
@ -78,26 +85,18 @@ func printFlag(w io.Writer, f *flag.Flag) {
fmt.Fprintf(w, "%s\n\n", indented)
}
// flagContains returns true if the given flag is contained in the given flag
// contains returns true if the given flag is contained in the given flag
// set or false otherwise.
func flagContains(fs *flag.FlagSet, f *flag.Flag) bool {
func contains(fs *flag.FlagSet, f *flag.Flag) bool {
if fs == nil {
return false
}
var skip bool
var in bool
fs.VisitAll(func(hf *flag.Flag) {
if skip {
return
}
if f.Name == hf.Name {
skip = true
return
}
in = in || f.Name == hf.Name
})
return skip
return in
}
// maxLineLength is the maximum width of any line.

2
command/forceleave/forceleave.go
View File

@ -25,7 +25,7 @@ func (c *cmd) init() {
c.flags = flag.NewFlagSet("", flag.ContinueOnError)
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), nil)
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/info/info.go
View File

@ -26,7 +26,7 @@ func (c *cmd) init() {
c.flags = flag.NewFlagSet("", flag.ContinueOnError)
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), nil)
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/join/join.go
View File

@ -29,7 +29,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), nil)
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/keygen/keygen.go
View File

@ -24,7 +24,7 @@ type cmd struct {
func (c *cmd) init() {
c.flags = flag.NewFlagSet("", flag.ContinueOnError)
c.help = flags.Usage(help, c.flags, nil, nil)
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/keyring/keyring.go
View File

@ -51,7 +51,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), nil)
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/kv/del/kv_delete.go
View File

@ -39,7 +39,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
flags.Merge(c.flags, c.http.ServerFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), c.http.ServerFlags())
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/kv/exp/kv_export.go
View File

@ -29,7 +29,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
flags.Merge(c.flags, c.http.ServerFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), c.http.ServerFlags())
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/kv/get/kv_get.go
View File

@ -54,7 +54,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
flags.Merge(c.flags, c.http.ServerFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), c.http.ServerFlags())
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/kv/imp/kv_import.go
View File

@ -38,7 +38,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
flags.Merge(c.flags, c.http.ServerFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), c.http.ServerFlags())
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/kv/kv.go
View File

@ -20,7 +20,7 @@ func (c *cmd) Synopsis() string {
}
func (c *cmd) Help() string {
return flags.Usage(help, nil, nil, nil)
return flags.Usage(help, nil)
}
const synopsis = "Interact with the key-value store"

2
command/kv/put/kv_put.go
View File

@ -70,7 +70,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
flags.Merge(c.flags, c.http.ServerFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), c.http.ServerFlags())
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/leave/leave.go
View File

@ -25,7 +25,7 @@ func (c *cmd) init() {
c.flags = flag.NewFlagSet("", flag.ContinueOnError)
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), nil)
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/lock/lock.go
View File

@ -103,7 +103,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
flags.Merge(c.flags, c.http.ServerFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), c.http.ServerFlags())
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/maint/maint.go
View File

@ -44,7 +44,7 @@ func (c *cmd) init() {
c.flags.StringVar(&c.serviceID, "service", "",
"Control maintenance mode for a specific service ID.")
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), nil)
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/members/members.go
View File

@ -51,7 +51,7 @@ func (c *cmd) init() {
c.flags.StringVar(&c.segment, "segment", consulapi.AllSegments,
"(Enterprise-only) If provided, output is filtered to only nodes in"+
"the given segment.")
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), nil)
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/monitor/monitor.go
View File

@ -40,7 +40,7 @@ func (c *cmd) init() {
c.flags.StringVar(&c.logLevel, "log-level", "INFO",
"Log level of the agent.")
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), nil)
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/operator/autopilot/get/operator_autopilot_get.go
View File

@ -27,7 +27,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
flags.Merge(c.flags, c.http.ServerFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), c.http.ServerFlags())
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/operator/autopilot/operator_autopilot.go
View File

@ -20,7 +20,7 @@ func (c *cmd) Synopsis() string {
}
func (c *cmd) Help() string {
return flags.Usage(help, nil, nil, nil)
return flags.Usage(help, nil)
}
const synopsis = "Provides tools for modifying Autopilot configuration"

2
command/operator/autopilot/set/operator_autopilot_set.go
View File

@ -62,7 +62,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
flags.Merge(c.flags, c.http.ServerFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), c.http.ServerFlags())
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/operator/operator.go
View File

@ -20,7 +20,7 @@ func (c *cmd) Synopsis() string {
}
func (c *cmd) Help() string {
return flags.Usage(help, nil, nil, nil)
return flags.Usage(help, nil)
}
const synopsis = "Provides cluster-level tools for Consul operators"

2
command/operator/raft/listpeers/operator_raft_list.go
View File

@ -28,7 +28,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
flags.Merge(c.flags, c.http.ServerFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), c.http.ServerFlags())
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/operator/raft/operator_raft.go
View File

@ -20,7 +20,7 @@ func (c *cmd) Synopsis() string {
}
func (c *cmd) Help() string {
return flags.Usage(help, nil, nil, nil)
return flags.Usage(help, nil)
}
const synopsis = "Provides cluster-level tools for Consul operators"

2
command/operator/raft/removepeer/operator_raft_remove.go
View File

@ -36,7 +36,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
flags.Merge(c.flags, c.http.ServerFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), c.http.ServerFlags())
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/reload/reload.go
View File

@ -25,7 +25,7 @@ func (c *cmd) init() {
c.flags = flag.NewFlagSet("", flag.ContinueOnError)
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), nil)
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/rtt/rtt.go
View File

@ -34,7 +34,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), nil)
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/snapshot/inspect/snapshot_inspect.go
View File

@ -26,7 +26,7 @@ type cmd struct {
func (c *cmd) init() {
c.flags = flag.NewFlagSet("", flag.ContinueOnError)
c.help = flags.Usage(help, c.flags, nil, nil)
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/snapshot/restore/snapshot_restore.go
View File

@ -27,7 +27,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
flags.Merge(c.flags, c.http.ServerFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), c.http.ServerFlags())
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/snapshot/save/snapshot_save.go
View File

@ -30,7 +30,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
flags.Merge(c.flags, c.http.ServerFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), c.http.ServerFlags())
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/snapshot/snapshot_command.go
View File

@ -20,7 +20,7 @@ func (c *cmd) Synopsis() string {
}
func (c *cmd) Help() string {
return flags.Usage(help, nil, nil, nil)
return flags.Usage(help, nil)
}
const synopsis = "Saves, restores and inspects snapshots of Consul server state"

2
command/validate/validate.go
View File

@ -26,7 +26,7 @@ func (c *cmd) init() {
c.flags = flag.NewFlagSet("", flag.ContinueOnError)
c.flags.BoolVar(&c.quiet, "quiet", false,
"When given, a successful run will produce no output.")
c.help = flags.Usage(help, c.flags, nil, nil)
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {

2
command/watch/watch.go
View File

@ -70,7 +70,7 @@ func (c *cmd) init() {
c.http = &flags.HTTPFlags{}
flags.Merge(c.flags, c.http.ClientFlags())
flags.Merge(c.flags, c.http.ServerFlags())
c.help = flags.Usage(help, c.flags, c.http.ClientFlags(), c.http.ServerFlags())
c.help = flags.Usage(help, c.flags)
}
func (c *cmd) Run(args []string) int {