Browse Source

commands: move watch command to separate pkg

pull/3584/head
Frank Schroeder 7 years ago committed by Frank Schröder
parent
commit
10e0be65a9
  1. 9
      command/commands.go
  2. 111
      command/watch/watch.go
  3. 14
      command/watch/watch_test.go

9
command/commands.go

@ -42,6 +42,7 @@ import (
"github.com/hashicorp/consul/command/snapshotsave" "github.com/hashicorp/consul/command/snapshotsave"
"github.com/hashicorp/consul/command/validate" "github.com/hashicorp/consul/command/validate"
versioncmd "github.com/hashicorp/consul/command/version" versioncmd "github.com/hashicorp/consul/command/version"
watchcmd "github.com/hashicorp/consul/command/watch"
"github.com/hashicorp/consul/version" "github.com/hashicorp/consul/version"
"github.com/mitchellh/cli" "github.com/mitchellh/cli"
) )
@ -216,13 +217,7 @@ func init() {
}, },
"watch": func() (cli.Command, error) { "watch": func() (cli.Command, error) {
return &WatchCommand{ return watchcmd.New(ui, makeShutdownCh()), nil
ShutdownCh: makeShutdownCh(),
BaseCommand: BaseCommand{
Flags: FlagSetHTTP,
UI: ui,
},
}, nil
}, },
} }
} }

111
command/watch.go → command/watch/watch.go

@ -1,8 +1,9 @@
package command package watch
import ( import (
"bytes" "bytes"
"encoding/json" "encoding/json"
"flag"
"fmt" "fmt"
"os" "os"
"os/exec" "os/exec"
@ -10,14 +11,24 @@ import (
"strings" "strings"
"github.com/hashicorp/consul/agent" "github.com/hashicorp/consul/agent"
"github.com/hashicorp/consul/watch" "github.com/hashicorp/consul/command/flags"
consulwatch "github.com/hashicorp/consul/watch"
"github.com/mitchellh/cli"
) )
// WatchCommand is a Command implementation that is used to setup func New(ui cli.Ui, shutdownCh <-chan struct{}) *cmd {
// a "watch" which uses a sub-process c := &cmd{UI: ui, shutdownCh: shutdownCh}
type WatchCommand struct { c.init()
BaseCommand return c
ShutdownCh <-chan struct{} }
type cmd struct {
UI cli.Ui
flags *flag.FlagSet
http *flags.HTTPFlags
usage string
shutdownCh <-chan struct{}
// flags // flags
watchType string watchType string
@ -31,50 +42,47 @@ type WatchCommand struct {
shell bool shell bool
} }
func (c *WatchCommand) initFlags() { func (c *cmd) init() {
c.InitFlagSet() c.flags = flag.NewFlagSet("", flag.ContinueOnError)
c.FlagSet.StringVar(&c.watchType, "type", "", c.flags.StringVar(&c.watchType, "type", "",
"Specifies the watch type. One of key, keyprefix, services, nodes, "+ "Specifies the watch type. One of key, keyprefix, services, nodes, "+
"service, checks, or event.") "service, checks, or event.")
c.FlagSet.StringVar(&c.key, "key", "", c.flags.StringVar(&c.key, "key", "",
"Specifies the key to watch. Only for 'key' type.") "Specifies the key to watch. Only for 'key' type.")
c.FlagSet.StringVar(&c.prefix, "prefix", "", c.flags.StringVar(&c.prefix, "prefix", "",
"Specifies the key prefix to watch. Only for 'keyprefix' type.") "Specifies the key prefix to watch. Only for 'keyprefix' type.")
c.FlagSet.StringVar(&c.service, "service", "", c.flags.StringVar(&c.service, "service", "",
"Specifies the service to watch. Required for 'service' type, "+ "Specifies the service to watch. Required for 'service' type, "+
"optional for 'checks' type.") "optional for 'checks' type.")
c.FlagSet.StringVar(&c.tag, "tag", "", c.flags.StringVar(&c.tag, "tag", "",
"Specifies the service tag to filter on. Optional for 'service' type.") "Specifies the service tag to filter on. Optional for 'service' type.")
c.FlagSet.StringVar(&c.passingOnly, "passingonly", "", c.flags.StringVar(&c.passingOnly, "passingonly", "",
"Specifies if only hosts passing all checks are displayed. "+ "Specifies if only hosts passing all checks are displayed. "+
"Optional for 'service' type, must be one of `[true|false]`. Defaults false.") "Optional for 'service' type, must be one of `[true|false]`. Defaults false.")
c.FlagSet.BoolVar(&c.shell, "shell", true, c.flags.BoolVar(&c.shell, "shell", true,
"Use a shell to run the command (can set a custom shell via the SHELL "+ "Use a shell to run the command (can set a custom shell via the SHELL "+
"environment variable).") "environment variable).")
c.FlagSet.StringVar(&c.state, "state", "", c.flags.StringVar(&c.state, "state", "",
"Specifies the states to watch. Optional for 'checks' type.") "Specifies the states to watch. Optional for 'checks' type.")
c.FlagSet.StringVar(&c.name, "name", "", c.flags.StringVar(&c.name, "name", "",
"Specifies an event name to watch. Only for 'event' type.") "Specifies an event name to watch. Only for 'event' type.")
}
func (c *WatchCommand) Help() string {
c.initFlags()
return c.HelpCommand(`
Usage: consul watch [options] [child...]
Watches for changes in a given data view from Consul. If a child process c.http = &flags.HTTPFlags{}
is specified, it will be invoked with the latest results on changes. Otherwise, flags.Merge(c.flags, c.http.ClientFlags())
the latest values are dumped to stdout and the watch terminates. flags.Merge(c.flags, c.http.ServerFlags())
c.usage = flags.Usage(usage, c.flags, c.http.ClientFlags(), c.http.ServerFlags())
}
Providing the watch type is required, and other parameters may be required func (c *cmd) Synopsis() string {
or supported depending on the watch type. return "Watch for changes in Consul"
}
`) func (c *cmd) Help() string {
return c.usage
} }
func (c *WatchCommand) Run(args []string) int { func (c *cmd) Run(args []string) int {
c.initFlags() if err := c.flags.Parse(args); err != nil {
if err := c.FlagSet.Parse(args); err != nil {
return 1 return 1
} }
@ -91,11 +99,11 @@ func (c *WatchCommand) Run(args []string) int {
if c.watchType != "" { if c.watchType != "" {
params["type"] = c.watchType params["type"] = c.watchType
} }
if c.HTTPDatacenter() != "" { if c.http.Datacenter() != "" {
params["datacenter"] = c.HTTPDatacenter() params["datacenter"] = c.http.Datacenter()
} }
if c.HTTPToken() != "" { if c.http.Token() != "" {
params["token"] = c.HTTPToken() params["token"] = c.http.Token()
} }
if c.key != "" { if c.key != "" {
params["key"] = c.key params["key"] = c.key
@ -109,8 +117,8 @@ func (c *WatchCommand) Run(args []string) int {
if c.tag != "" { if c.tag != "" {
params["tag"] = c.tag params["tag"] = c.tag
} }
if c.HTTPStale() { if c.http.Stale() {
params["stale"] = c.HTTPStale() params["stale"] = c.http.Stale()
} }
if c.state != "" { if c.state != "" {
params["state"] = c.state params["state"] = c.state
@ -128,14 +136,14 @@ func (c *WatchCommand) Run(args []string) int {
} }
// Create the watch // Create the watch
wp, err := watch.Parse(params) wp, err := consulwatch.Parse(params)
if err != nil { if err != nil {
c.UI.Error(fmt.Sprintf("%s", err)) c.UI.Error(fmt.Sprintf("%s", err))
return 1 return 1
} }
// Create and test the HTTP client // Create and test the HTTP client
client, err := c.HTTPClient() client, err := c.http.APIClient()
if err != nil { if err != nil {
c.UI.Error(fmt.Sprintf("Error connecting to Consul agent: %s", err)) c.UI.Error(fmt.Sprintf("Error connecting to Consul agent: %s", err))
return 1 return 1
@ -152,7 +160,7 @@ func (c *WatchCommand) Run(args []string) int {
// 0: false // 0: false
// 1: true // 1: true
errExit := 0 errExit := 0
if len(c.FlagSet.Args()) == 0 { if len(c.flags.Args()) == 0 {
wp.Handler = func(idx uint64, data interface{}) { wp.Handler = func(idx uint64, data interface{}) {
defer wp.Stop() defer wp.Stop()
buf, err := json.MarshalIndent(data, "", " ") buf, err := json.MarshalIndent(data, "", " ")
@ -175,9 +183,9 @@ func (c *WatchCommand) Run(args []string) int {
var err error var err error
var cmd *exec.Cmd var cmd *exec.Cmd
if !c.shell { if !c.shell {
cmd, err = agent.ExecSubprocess(c.FlagSet.Args()) cmd, err = agent.ExecSubprocess(c.flags.Args())
} else { } else {
cmd, err = agent.ExecScript(strings.Join(c.FlagSet.Args(), " ")) cmd, err = agent.ExecScript(strings.Join(c.flags.Args(), " "))
} }
if err != nil { if err != nil {
c.UI.Error(fmt.Sprintf("Error executing handler: %s", err)) c.UI.Error(fmt.Sprintf("Error executing handler: %s", err))
@ -219,13 +227,13 @@ func (c *WatchCommand) Run(args []string) int {
// Watch for a shutdown // Watch for a shutdown
go func() { go func() {
<-c.ShutdownCh <-c.shutdownCh
wp.Stop() wp.Stop()
os.Exit(0) os.Exit(0)
}() }()
// Run the watch // Run the watch
if err := wp.Run(c.HTTPAddr()); err != nil { if err := wp.Run(c.http.Addr()); err != nil {
c.UI.Error(fmt.Sprintf("Error querying Consul agent: %s", err)) c.UI.Error(fmt.Sprintf("Error querying Consul agent: %s", err))
return 1 return 1
} }
@ -233,6 +241,11 @@ func (c *WatchCommand) Run(args []string) int {
return errExit return errExit
} }
func (c *WatchCommand) Synopsis() string { const usage = `Usage: consul watch [options] [child...]
return "Watch for changes in Consul"
} Watches for changes in a given data view from Consul. If a child process
is specified, it will be invoked with the latest results on changes. Otherwise,
the latest values are dumped to stdout and the watch terminates.
Providing the watch type is required, and other parameters may be required
or supported depending on the watch type.`

14
command/watch_test.go → command/watch/watch_test.go

@ -1,4 +1,4 @@
package command package watch
import ( import (
"strings" "strings"
@ -8,23 +8,13 @@ import (
"github.com/mitchellh/cli" "github.com/mitchellh/cli"
) )
func TestWatchCommand_implements(t *testing.T) {
t.Parallel()
var _ cli.Command = &WatchCommand{}
}
func TestWatchCommandRun(t *testing.T) { func TestWatchCommandRun(t *testing.T) {
t.Parallel() t.Parallel()
a := agent.NewTestAgent(t.Name(), ``) a := agent.NewTestAgent(t.Name(), ``)
defer a.Shutdown() defer a.Shutdown()
ui := cli.NewMockUi() ui := cli.NewMockUi()
c := &WatchCommand{ c := New(ui, nil)
BaseCommand: BaseCommand{
UI: ui,
Flags: FlagSetHTTP,
},
}
args := []string{"-http-addr=" + a.HTTPAddr(), "-type=nodes"} args := []string{"-http-addr=" + a.HTTPAddr(), "-type=nodes"}
code := c.Run(args) code := c.Run(args)
Loading…
Cancel
Save