This repository has been archived by the owner on Aug 29, 2023. It is now read-only.
[WIP] Display information about the cluster or all running footloose containers #103
+385
−2
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,21 @@ | ||
| module github.com/weaveworks/footloose | ||
|
|
||
| require ( | ||
| github.com/apcera/termtables v0.0.0-20170405184538-bcbc5dc54055 | ||
| github.com/docker/distribution v2.7.1+incompatible // indirect | ||
| github.com/docker/docker v1.13.1 | ||
| github.com/docker/go-connections v0.4.0 // indirect | ||
| github.com/docker/go-units v0.3.3 // indirect | ||
| github.com/ghodss/yaml v1.0.0 | ||
| github.com/inconshreveable/mousetrap v1.0.0 // indirect | ||
| github.com/mattn/go-runewidth v0.0.4 // indirect | ||
| github.com/opencontainers/go-digest v1.0.0-rc1 // indirect | ||
| github.com/pkg/errors v0.8.1 | ||
| github.com/sirupsen/logrus v1.3.0 | ||
| github.com/spf13/cobra v0.0.3 | ||
| github.com/spf13/pflag v1.0.3 // indirect | ||
| github.com/stretchr/testify v1.2.2 | ||
| golang.org/x/net v0.0.0-20190322120337-addf6b3196f6 // indirect | ||
| gopkg.in/yaml.v2 v2.2.2 // indirect | ||
| sigs.k8s.io/kind v0.0.0-20190204012257-d1773a79317d | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "github.com/spf13/cobra" | ||
| "github.com/weaveworks/footloose/pkg/cluster" | ||
| ) | ||
|
|
||
| var listCmd = &cobra.Command{ | ||
| Use: "list", | ||
| Short: "List all running machines", | ||
| RunE: list, | ||
| } | ||
|
|
||
| var listOptions struct { | ||
| format string | ||
| config string | ||
| all bool | ||
| } | ||
|
|
||
| func init() { | ||
| listCmd.Flags().StringVarP(&listOptions.config, "config", "c", Footloose, "Cluster configuration file") | ||
| listCmd.Flags().StringVarP(&listOptions.format, "format", "f", "default", "Formatting options") | ||
| listCmd.Flags().BoolVar(&listOptions.all, "all", false, "List all footloose created machines in every cluster.") | ||
| footloose.AddCommand(listCmd) | ||
| } | ||
|
|
||
| // list will list all machines in a given cluster. | ||
| // if --all option is provided it will list every machine created by | ||
| // footloose no matter what cluster they are in. | ||
| func list(cmd *cobra.Command, args []string) error { | ||
| cluster, err := cluster.NewFromFile(listOptions.config) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| return cluster.List(listOptions.all, listOptions.format) | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| package cluster | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/apcera/termtables" | ||
| "github.com/weaveworks/footloose/pkg/config" | ||
| ) | ||
|
|
||
| // Formatter formats a slice of machines and outputs the result | ||
| // in a given format. | ||
| type Formatter interface { | ||
| Format([]*Machine) error | ||
| } | ||
|
|
||
| // JSONFormatter formats a slice of machines into a JSON and | ||
| // outputs it to stdout. | ||
| type JSONFormatter struct{} | ||
|
|
||
| // NormalFormatter formats a slice of machines into a colored | ||
| // table like output and prints that to stdout. | ||
| type NormalFormatter struct{} | ||
|
|
||
| type port struct { | ||
| Guest int `json:"guest"` | ||
| Host int `json:"host"` | ||
| } | ||
|
|
||
| type status struct { | ||
| Name string `json:"name"` | ||
| Spec config.Machine `json:"spec"` | ||
| Status string `json:"status"` | ||
| Ports []port `json:"ports"` | ||
| Hostname string `json:"hostname"` | ||
| } | ||
|
|
||
| // Format will output to stdout in JSON format. | ||
| func (JSONFormatter) Format(machines []*Machine) error { | ||
| statuses := make([]status, 0) | ||
| for _, m := range machines { | ||
| s := status{} | ||
| s.Hostname = m.Hostname() | ||
| s.Name = m.ContainerName() | ||
| s.Spec = *m.spec | ||
| state := "Stopped" | ||
| if m.IsRunning() { | ||
| state = "Running" | ||
| } | ||
| s.Status = state | ||
| var ports []port | ||
| for k, v := range m.ports { | ||
| p := port{ | ||
| Host: v, | ||
| Guest: k, | ||
| } | ||
| ports = append(ports, p) | ||
| } | ||
| s.Ports = ports | ||
| statuses = append(statuses, s) | ||
| } | ||
| m := struct { | ||
| Machines []status `json:"machines"` | ||
| }{ | ||
| Machines: statuses, | ||
| } | ||
| ms, err := json.Marshal(m) | ||
|
There was a problem hiding this comment. It'll be nice to directly provide an indented output I think (MashalIndent) There was a problem hiding this comment. Sure. I just thought that usually when you want JSON you want it because you would like to parse it. In which case indentation might cause a problem in certain cases. There was a problem hiding this comment. json parsers should really be able to handle the whitespace introduced by the indentation :) |
||
| if err != nil { | ||
| return err | ||
| } | ||
| fmt.Printf("%s", ms) | ||
| return nil | ||
| } | ||
|
|
||
| // Format will output to stdout in table format. | ||
| func (NormalFormatter) Format(machines []*Machine) error { | ||
| table := termtables.CreateTable() | ||
| table.AddHeaders("Name", "Hostname", "Ports", "Image", "Cmd", "Volumes", "State") | ||
| for _, m := range machines { | ||
| state := "Stopped" | ||
| if m.IsRunning() { | ||
| state = "Running" | ||
| } | ||
| var ports []string | ||
| for k, v := range m.ports { | ||
| p := fmt.Sprintf("%d->%d", k, v) | ||
| ports = append(ports, p) | ||
| } | ||
| if len(ports) < 1 { | ||
| for _, p := range m.spec.PortMappings { | ||
| port := fmt.Sprintf("%d->%d", p.ContainerPort, 0) | ||
| ports = append(ports, port) | ||
| } | ||
| } | ||
| ps := strings.Join(ports, ",") | ||
| var volumes []string | ||
| for _, v := range m.spec.Volumes { | ||
| vf := fmt.Sprintf("%s->%s", v.Source, v.Destination) | ||
| volumes = append(volumes, vf) | ||
| } | ||
| vs := strings.Join(volumes, ",") | ||
| table.AddRow(m.ContainerName(), m.hostname, ps, m.spec.Image, m.spec.Cmd, vs, state) | ||
| } | ||
| fmt.Println(table.Render()) | ||
| return nil | ||
| } | ||
|
|
||
| func getFormatter(format string) (Formatter, error) { | ||
| var formatter Formatter | ||
| switch format { | ||
| case "json": | ||
| formatter = new(JSONFormatter) | ||
| case "default": | ||
|
There was a problem hiding this comment. Could use a better name, like |
||
| formatter = new(NormalFormatter) | ||
| default: | ||
| return nil, errors.New("unrecognised formatting method") | ||
|
There was a problem hiding this comment. It's nice to add information about what is wrong, say: so the user knows at a glance which part of the command line is wrong. |
||
| } | ||
| return formatter, nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| footloose config create --config %testName.footloose --name %testName --key %testName-key --image quay.io/footloose/ubuntu18.04 | ||
| footloose create --config %testName.footloose | ||
| footloose delete --config %testName.footloose | ||
| %out footloose list --config %testName.footloose | ||
| %out footloose list -f json --config %testName.footloose |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| +-----------------------------+----------+-------+-------------------------------+-----+---------+---------+ | ||
|
There was a problem hiding this comment. Right now, considering how the golden output works, I can only test for non running containers, since the running ones have dynamic data. Like the host port number which would be different on each test run. This is good enough for now... There was a problem hiding this comment. I'm envisioning being able to query parts of the json like we could use to test |
||
| | Name | Hostname | Ports | Image | Cmd | Volumes | State | | ||
| +-----------------------------+----------+-------+-------------------------------+-----+---------+---------+ | ||
| | test-list-ubuntu18.04-node0 | node0 | 22->0 | quay.io/footloose/ubuntu18.04 | | | Stopped | | ||
| +-----------------------------+----------+-------+-------------------------------+-----+---------+---------+ | ||
|
|
||
| {"machines":[{"name":"test-list-ubuntu18.04-node0","spec":{"name":"node%d","image":"quay.io/footloose/ubuntu18.04","portMappings":[{"containerPort":22}]},"status":"Stopped","ports":null,"hostname":"node0"}]} | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please use
--output, -ohere so we can reserve--formatfor go templates.