Merge pull request #50 from hashicorp/f-info

Allocs/Evals in status/node-status output
This commit is contained in:
Ryan Uber 2015-09-15 16:51:54 -07:00
commit 15f59a0b43
10 changed files with 250 additions and 41 deletions

View file

@ -12,7 +12,7 @@ func TestAgentInfoCommand_Implements(t *testing.T) {
} }
func TestAgentInfoCommand_Run(t *testing.T) { func TestAgentInfoCommand_Run(t *testing.T) {
srv, _, url := testServer(t) srv, _, url := testServer(t, nil)
defer srv.Stop() defer srv.Stop()
ui := new(cli.MockUi) ui := new(cli.MockUi)

View file

@ -12,7 +12,7 @@ func TestAgentMembersCommand_Implements(t *testing.T) {
} }
func TestAgentMembersCommand_Run(t *testing.T) { func TestAgentMembersCommand_Run(t *testing.T) {
srv, client, url := testServer(t) srv, client, url := testServer(t, nil)
defer srv.Stop() defer srv.Stop()
ui := new(cli.MockUi) ui := new(cli.MockUi)

22
command/helpers.go Normal file
View file

@ -0,0 +1,22 @@
package command
import (
"github.com/ryanuber/columnize"
)
// formatKV takes a set of strings and formats them into properly
// aligned k = v pairs using the columnize library.
func formatKV(in []string) string {
columnConf := columnize.DefaultConfig()
columnConf.Glue = " = "
return columnize.Format(in, columnConf)
}
// formatList takes a set of strings and formats them into properly
// aligned output, replacing any blank fields with a placeholder
// for awk-ability.
func formatList(in []string) string {
columnConf := columnize.DefaultConfig()
columnConf.Empty = "<none>"
return columnize.Format(in, columnConf)
}

28
command/helpers_test.go Normal file
View file

@ -0,0 +1,28 @@
package command
import (
"testing"
)
func TestHelpers_FormatKV(t *testing.T) {
in := []string{"alpha|beta", "charlie|delta"}
out := formatKV(in)
expect := "alpha = beta\n"
expect += "charlie = delta"
if out != expect {
t.Fatalf("expect: %s, got: %s", expect, out)
}
}
func TestHelpers_FormatList(t *testing.T) {
in := []string{"alpha|beta||delta"}
out := formatList(in)
expect := "alpha beta <none> delta"
if out != expect {
t.Fatalf("expect: %s, got: %s", expect, out)
}
}

View file

@ -12,7 +12,7 @@ func TestNodeDrainCommand_Implements(t *testing.T) {
} }
func TestNodeDrainCommand_Fails(t *testing.T) { func TestNodeDrainCommand_Fails(t *testing.T) {
srv, _, url := testServer(t) srv, _, url := testServer(t, nil)
defer srv.Stop() defer srv.Stop()
ui := new(cli.MockUi) ui := new(cli.MockUi)

View file

@ -3,8 +3,6 @@ package command
import ( import (
"fmt" "fmt"
"strings" "strings"
"github.com/ryanuber/columnize"
) )
type NodeStatusCommand struct { type NodeStatusCommand struct {
@ -25,7 +23,14 @@ Usage: nomad node-status [options] [node]
General Options: General Options:
` + generalOptionsUsage() ` + generalOptionsUsage() + `
Node Status Options:
-short
Display short output. Used only when a single node is being
queried, and drops verbose output about node allocations.
`
return strings.TrimSpace(helpText) return strings.TrimSpace(helpText)
} }
@ -34,8 +39,12 @@ func (c *NodeStatusCommand) Synopsis() string {
} }
func (c *NodeStatusCommand) Run(args []string) int { func (c *NodeStatusCommand) Run(args []string) int {
var short bool
flags := c.Meta.FlagSet("node-status", FlagSetClient) flags := c.Meta.FlagSet("node-status", FlagSetClient)
flags.Usage = func() { c.Ui.Output(c.Help()) } flags.Usage = func() { c.Ui.Output(c.Help()) }
flags.BoolVar(&short, "short", false, "")
if err := flags.Parse(args); err != nil { if err := flags.Parse(args); err != nil {
return 1 return 1
} }
@ -82,7 +91,7 @@ func (c *NodeStatusCommand) Run(args []string) int {
} }
// Dump the output // Dump the output
c.Ui.Output(columnize.SimpleFormat(out)) c.Ui.Output(formatList(out))
return 0 return 0
} }
@ -95,20 +104,44 @@ func (c *NodeStatusCommand) Run(args []string) int {
} }
// Format the output // Format the output
out := []string{ basic := []string{
fmt.Sprintf("ID | %s", node.ID), fmt.Sprintf("ID|%s", node.ID),
fmt.Sprintf("Name | %s", node.Name), fmt.Sprintf("Name|%s", node.Name),
fmt.Sprintf("Class | %s", node.NodeClass), fmt.Sprintf("Class|%s", node.NodeClass),
fmt.Sprintf("Datacenter | %s", node.Datacenter), fmt.Sprintf("Datacenter|%s", node.Datacenter),
fmt.Sprintf("Drain | %v", node.Drain), fmt.Sprintf("Drain|%v", node.Drain),
fmt.Sprintf("Status | %s", node.Status), fmt.Sprintf("Status|%s", node.Status),
} }
// Make the column config so we can dump k = v pairs var allocs []string
columnConf := columnize.DefaultConfig() if !short {
columnConf.Glue = " = " // Query the node allocations
nodeAllocs, _, err := client.Nodes().Allocations(nodeID, nil)
if err != nil {
c.Ui.Error(fmt.Sprintf("Error querying node allocations: %s", err))
return 1
}
// Format the allocations
allocs = make([]string, len(nodeAllocs)+1)
allocs[0] = "ID|EvalID|JobID|TaskGroup|DesiredStatus|ClientStatus"
for i, alloc := range nodeAllocs {
allocs[i+1] = fmt.Sprintf("%s|%s|%s|%s|%s|%s",
alloc.ID,
alloc.EvalID,
alloc.JobID,
alloc.NodeID,
alloc.TaskGroup,
alloc.DesiredStatus,
alloc.ClientStatus)
}
}
// Dump the output // Dump the output
c.Ui.Output(columnize.Format(out, columnConf)) c.Ui.Output(formatKV(basic))
if !short {
c.Ui.Output("\n### Allocations")
c.Ui.Output(formatList(allocs))
}
return 0 return 0
} }

View file

@ -1,9 +1,11 @@
package command package command
import ( import (
"fmt"
"strings" "strings"
"testing" "testing"
"github.com/hashicorp/nomad/testutil"
"github.com/mitchellh/cli" "github.com/mitchellh/cli"
) )
@ -12,25 +14,70 @@ func TestNodeStatusCommand_Implements(t *testing.T) {
} }
func TestNodeStatusCommand_Run(t *testing.T) { func TestNodeStatusCommand_Run(t *testing.T) {
srv, _, url := testServer(t) // Start in dev mode so we get a node registration
srv, client, url := testServer(t, func(c *testutil.TestServerConfig) {
c.DevMode = true
c.NodeName = "mynode"
})
defer srv.Stop() defer srv.Stop()
ui := new(cli.MockUi) ui := new(cli.MockUi)
cmd := &NodeStatusCommand{Meta: Meta{Ui: ui}} cmd := &NodeStatusCommand{Meta: Meta{Ui: ui}}
// Wait for a node to appear
var nodeID string
testutil.WaitForResult(func() (bool, error) {
nodes, _, err := client.Nodes().List(nil)
if err != nil {
return false, err
}
if len(nodes) == 0 {
return false, fmt.Errorf("missing node")
}
nodeID = nodes[0].ID
return true, nil
}, func(err error) {
t.Fatalf("err: %s", err)
})
// Query all node statuses // Query all node statuses
if code := cmd.Run([]string{"-address=" + url}); code != 0 { if code := cmd.Run([]string{"-address=" + url}); code != 0 {
t.Fatalf("expected exit 0, got: %d", code) t.Fatalf("expected exit 0, got: %d", code)
} }
out := ui.OutputWriter.String()
if !strings.Contains(out, "mynode") {
t.Fatalf("expect to find mynode, got: %s", out)
}
ui.OutputWriter.Reset()
// Expect empty output since we have no nodes // Query a single node
if out := ui.OutputWriter.String(); out != "<nil>" { if code := cmd.Run([]string{"-address=" + url, nodeID}); code != 0 {
t.Fatalf("expected empty output, got: %s", out) t.Fatalf("expected exit 0, got: %d", code)
}
out = ui.OutputWriter.String()
if !strings.Contains(out, "mynode") {
t.Fatalf("expect to find mynode, got: %s", out)
}
if !strings.Contains(out, "Allocations") {
t.Fatalf("expected allocations, got: %s", out)
}
ui.OutputWriter.Reset()
// Query single node in short view
if code := cmd.Run([]string{"-address=" + url, "-short", nodeID}); code != 0 {
t.Fatalf("expected exit 0, got: %d", code)
}
out = ui.OutputWriter.String()
if !strings.Contains(out, "mynode") {
t.Fatalf("expect to find mynode, got: %s", out)
}
if strings.Contains(out, "Allocations") {
t.Fatalf("should not dump allocations")
} }
} }
func TestNodeStatusCommand_Fails(t *testing.T) { func TestNodeStatusCommand_Fails(t *testing.T) {
srv, _, url := testServer(t) srv, _, url := testServer(t, nil)
defer srv.Stop() defer srv.Stop()
ui := new(cli.MockUi) ui := new(cli.MockUi)

View file

@ -3,8 +3,6 @@ package command
import ( import (
"fmt" "fmt"
"strings" "strings"
"github.com/ryanuber/columnize"
) )
type StatusCommand struct { type StatusCommand struct {
@ -20,7 +18,15 @@ Usage: nomad status [options] [job]
General Options: General Options:
` + generalOptionsUsage() ` + generalOptionsUsage() + `
Status Options:
-short
Display short output. Used only when a single job is being
queried, and drops verbose information about allocations
and evaluations.
`
return strings.TrimSpace(helpText) return strings.TrimSpace(helpText)
} }
@ -29,8 +35,12 @@ func (c *StatusCommand) Synopsis() string {
} }
func (c *StatusCommand) Run(args []string) int { func (c *StatusCommand) Run(args []string) int {
var short bool
flags := c.Meta.FlagSet("status", FlagSetClient) flags := c.Meta.FlagSet("status", FlagSetClient)
flags.Usage = func() { c.Ui.Output(c.Help()) } flags.Usage = func() { c.Ui.Output(c.Help()) }
flags.BoolVar(&short, "short", false, "")
if err := flags.Parse(args); err != nil { if err := flags.Parse(args); err != nil {
return 1 return 1
} }
@ -71,7 +81,7 @@ func (c *StatusCommand) Run(args []string) int {
job.Priority, job.Priority,
job.Status) job.Status)
} }
c.Ui.Output(columnize.SimpleFormat(out)) c.Ui.Output(formatList(out))
return 0 return 0
} }
@ -85,20 +95,64 @@ func (c *StatusCommand) Run(args []string) int {
// Format the job info // Format the job info
basic := []string{ basic := []string{
fmt.Sprintf("ID | %s", job.ID), fmt.Sprintf("ID|%s", job.ID),
fmt.Sprintf("Name | %s", job.Name), fmt.Sprintf("Name|%s", job.Name),
fmt.Sprintf("Type | %s", job.Type), fmt.Sprintf("Type|%s", job.Type),
fmt.Sprintf("Priority | %d", job.Priority), fmt.Sprintf("Priority|%d", job.Priority),
fmt.Sprintf("Datacenters | %s", strings.Join(job.Datacenters, ",")), fmt.Sprintf("Datacenters|%s", strings.Join(job.Datacenters, ",")),
fmt.Sprintf("Status | %s", job.Status), fmt.Sprintf("Status|%s", job.Status),
fmt.Sprintf("StatusDescription | %s", job.StatusDescription),
} }
// Make the column config so we can dump k = v pairs var evals, allocs []string
columnConf := columnize.DefaultConfig() if !short {
columnConf.Glue = " = " // Query the evaluations
jobEvals, _, err := client.Jobs().Evaluations(jobID, nil)
if err != nil {
c.Ui.Error(fmt.Sprintf("Error querying job evaluations: %s", err))
return 1
}
// Query the allocations
jobAllocs, _, err := client.Jobs().Allocations(jobID, nil)
if err != nil {
c.Ui.Error(fmt.Sprintf("Error querying job allocations: %s", err))
return 1
}
// Format the evals
evals = make([]string, len(jobEvals)+1)
evals[0] = "ID|Priority|Type|TriggeredBy|NodeID|Status"
for i, eval := range jobEvals {
evals[i+1] = fmt.Sprintf("%s|%d|%s|%s|%s|%s",
eval.ID,
eval.Priority,
eval.Type,
eval.TriggeredBy,
eval.NodeID,
eval.Status)
}
// Format the allocs
allocs = make([]string, len(jobAllocs)+1)
allocs[0] = "ID|EvalID|NodeID|TaskGroup|DesiredStatus|ClientStatus"
for i, alloc := range jobAllocs {
allocs[i+1] = fmt.Sprintf("%s|%s|%s|%s|%s|%s",
alloc.ID,
alloc.EvalID,
alloc.NodeID,
alloc.TaskGroup,
alloc.DesiredStatus,
alloc.ClientStatus)
}
}
// Dump the output // Dump the output
c.Ui.Output(columnize.Format(basic, columnConf)) c.Ui.Output(formatKV(basic))
if !short {
c.Ui.Output("\n### Evaluations")
c.Ui.Output(formatList(evals))
c.Ui.Output("\n### Allocations")
c.Ui.Output(formatList(allocs))
}
return 0 return 0
} }

View file

@ -13,7 +13,7 @@ func TestStatusCommand_Implements(t *testing.T) {
} }
func TestStatusCommand_Run(t *testing.T) { func TestStatusCommand_Run(t *testing.T) {
srv, client, url := testServer(t) srv, client, url := testServer(t, nil)
defer srv.Stop() defer srv.Stop()
ui := new(cli.MockUi) ui := new(cli.MockUi)
@ -59,6 +59,28 @@ func TestStatusCommand_Run(t *testing.T) {
if strings.Contains(out, "job1") || !strings.Contains(out, "job2") { if strings.Contains(out, "job1") || !strings.Contains(out, "job2") {
t.Fatalf("expected only job2, got: %s", out) t.Fatalf("expected only job2, got: %s", out)
} }
if !strings.Contains(out, "Evaluations") {
t.Fatalf("should dump evaluations")
}
if !strings.Contains(out, "Allocations") {
t.Fatalf("should dump allocations")
}
ui.OutputWriter.Reset()
// Query in short view mode
if code := cmd.Run([]string{"-address=" + url, "-short", "job2"}); code != 0 {
t.Fatalf("expected exit 0, got: %d", code)
}
out = ui.OutputWriter.String()
if !strings.Contains(out, "job2") {
t.Fatalf("expected job2, got: %s", out)
}
if strings.Contains(out, "Evaluations") {
t.Fatalf("should not dump evaluations")
}
if strings.Contains(out, "Allocations") {
t.Fatalf("should not dump allocations")
}
} }
func TestStatusCommand_Fails(t *testing.T) { func TestStatusCommand_Fails(t *testing.T) {

View file

@ -15,7 +15,10 @@ func init() {
seen = make(map[*testing.T]struct{}) seen = make(map[*testing.T]struct{})
} }
func testServer(t *testing.T) (*testutil.TestServer, *api.Client, string) { func testServer(
t *testing.T,
cb testutil.ServerConfigCallback) (*testutil.TestServer, *api.Client, string) {
// Always run these tests in parallel. // Always run these tests in parallel.
if _, ok := seen[t]; !ok { if _, ok := seen[t]; !ok {
seen[t] = struct{}{} seen[t] = struct{}{}
@ -23,7 +26,7 @@ func testServer(t *testing.T) (*testutil.TestServer, *api.Client, string) {
} }
// Make a new test server // Make a new test server
srv := testutil.NewTestServer(t, nil) srv := testutil.NewTestServer(t, cb)
// Make a client // Make a client
clientConf := api.DefaultConfig() clientConf := api.DefaultConfig()