Merge pull request #4577 from michelleN/deisctl-list-nodes

deisctl list-machines

Author: Matthew Fisher

deisctl/backend/backend.go

@@ -16,6 +16,7 @@ type Backend interface {
 	SSH(string) error
 	SSHExec(string, string) error
 	Dock(string, []string) error
+	ListMachines() error
 	ListUnits() error
 	ListUnitFiles() error
 	Status(string) error

deisctl/backend/fleet/list_machines.go

@@ -0,0 +1,76 @@
+package fleet
+
+import (
+	"fmt"
+	"sort"
+	"strings"
+
+	"github.com/coreos/fleet/machine"
+)
+
+const (
+	defaultListMachinesFields = "machine,ip,metadata"
+)
+
+var (
+	listMachinesFields = map[string]machineToField{
+		"machine": func(ms *machine.MachineState, full bool) string {
+			return machineIDLegend(*ms, full)
+		},
+		"ip": func(ms *machine.MachineState, full bool) string {
+			if len(ms.PublicIP) == 0 {
+				return "-"
+			}
+			return ms.PublicIP
+		},
+		"metadata": func(ms *machine.MachineState, full bool) string {
+			if len(ms.Metadata) == 0 {
+				return "-"
+			}
+			return formatMetadata(ms.Metadata)
+		},
+	}
+)
+
+type machineToField func(ms *machine.MachineState, full bool) string
+
+// ListMachines prints all nodes to Stdout
+func (c *FleetClient) ListMachines() (err error) {
+	machines, err := c.Fleet.Machines()
+	if err != nil {
+		return err
+	}
+
+	c.printMachines(machines)
+	return
+}
+
+// printUnits writes units to stdout using a tabwriter
+func (c *FleetClient) printMachines(states []machine.MachineState) {
+	cols := strings.Split(defaultListMachinesFields, ",")
+	fmt.Fprintln(c.out, strings.ToUpper(strings.Join(cols, "\t")))
+	for _, ms := range states {
+		var f []string
+		for _, c := range cols {
+			f = append(f, listMachinesFields[c](&ms, false))
+		}
+		fmt.Fprintln(c.out, strings.Join(f, "\t"))
+	}
+	c.out.Flush()
+}
+
+func formatMetadata(metadata map[string]string) string {
+	pairs := make([]string, len(metadata))
+	idx := 0
+	var sorted sort.StringSlice
+	for k := range metadata {
+		sorted = append(sorted, k)
+	}
+	sorted.Sort()
+	for _, key := range sorted {
+		value := metadata[key]
+		pairs[idx] = fmt.Sprintf("%s=%s", key, value)
+		idx++
+	}
+	return strings.Join(pairs, ",")
+}

deisctl/backend/fleet/list_machines_test.go

@@ -0,0 +1,57 @@
+package fleet
+
+import (
+	"bytes"
+	"testing"
+	"text/tabwriter"
+
+	"github.com/coreos/fleet/machine"
+)
+
+func TestListMachines(t *testing.T) {
+	testMachines := []machine.MachineState{
+		machine.MachineState{
+			ID:       "123456",
+			PublicIP: "1.1.1.1",
+			Metadata: map[string]string{
+				"foo":  "bar",
+				"ping": "pong",
+			},
+			Version: "",
+		},
+		machine.MachineState{
+			ID:       "654321",
+			PublicIP: "2.2.2.2",
+			Metadata: nil,
+			Version:  "",
+		},
+	}
+
+	testWriter := bytes.Buffer{}
+	testTabWriter := new(tabwriter.Writer)
+	testTabWriter.Init(&testWriter, 0, 8, 1, '\t', 0)
+
+	c := &FleetClient{
+		Fleet: &stubFleetClient{
+			testMachineStates: testMachines,
+		},
+		out: testTabWriter,
+	}
+
+	err := c.ListMachines()
+
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	expected := `MACHINE		IP	METADATA
+123456...	1.1.1.1	foo=bar,ping=pong
+654321...	2.2.2.2	-
+`
+
+	actual := testWriter.String()
+
+	if expected != actual {
+		t.Errorf("Expected '%s', Got '%s'", expected, actual)
+	}
+}

deisctl/client/client.go

@@ -22,6 +22,7 @@ type DeisCtlClient interface {
 	Install(argv []string) error
 	Journal(argv []string) error
 	List(argv []string) error
+	Machines(argv []string) error
 	RefreshUnits(argv []string) error
 	Restart(argv []string) error
 	Scale(argv []string) error
@@ -240,6 +241,20 @@ Usage:
 	return cmd.ListUnits(c.Backend)
 }
 
+func (c *Client) Machines(argv []string) error {
+	usage := `List the current hosts in the cluster
+
+
+Usage:
+  deisctl machines
+`
+	// parse command-line arguments
+	if _, err := docopt.Parse(usage, argv, true, "", false); err != nil {
+		return err
+	}
+	return cmd.ListMachines(c.Backend)
+}
+
 // RefreshUnits overwrites local unit files with those requested.
 func (c *Client) RefreshUnits(argv []string) error {
 	usage := `Overwrites local unit files with those requested.

deisctl/cmd/cmd.go

@@ -35,6 +35,11 @@ func ListUnits(b backend.Backend) error {
 	return b.ListUnits()
 }
 
+// ListMachines prints a list of current hosts.
+func ListMachines(b backend.Backend) error {
+	return b.ListMachines()
+}
+
 // ListUnitFiles prints the contents of all defined unit files.
 func ListUnitFiles(b backend.Backend) error {
 	return b.ListUnitFiles()

deisctl/cmd/cmd_test.go

@@ -54,6 +54,10 @@ func (backend *backendStub) RollingRestart(target string, wg *sync.WaitGroup, ou
 	backend.restartedUnits = append(backend.restartedUnits, target)
 }
 
+func (backend *backendStub) ListMachines() error {
+	return nil
+}
+
 func (backend *backendStub) ListUnits() error {
 	return nil
 }

deisctl/deisctl.go

@@ -32,6 +32,7 @@ Commands, use "deisctl help <command>" to learn more:
   install           install components, or the entire platform
   uninstall         uninstall components
   list              list installed components
+  machines          list the current hosts in the cluster
   start             start components
   stop              stop components
   restart           stop, then start components
@@ -75,7 +76,7 @@ Options:
 		return 0
 	}
 
-	command := args["<command>"]
+	command := args["<command>"].(string)
 	setTunnel := true
 	// "--help" and "refresh-units" doesn't need SSH tunneling
 	if helpFlag || command == "refresh-units" {
@@ -95,6 +96,8 @@ Options:
 	switch command {
 	case "list":
 		err = c.List(argv)
+	case "machines":
+		err = c.Machines(argv)
 	case "scale":
 		err = c.Scale(argv)
 	case "start":

deisctl/test/mock/config.go

@@ -83,5 +83,3 @@ func (cb ConfigBackend) SetWithTTL(key string, value string, ttl uint64) (string
 	}
 	return "", fmt.Errorf("%s does not exist", cb.Expected)
 }
-
-