-
Notifications
You must be signed in to change notification settings - Fork 4.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
cli: Add JSON and Pretty Print formatting for `consul snapshot inspec…
…t` (#9006)
- Loading branch information
s-christoff
authored
Oct 29, 2020
1 parent
a670f7a
commit 79ce24e
Showing
9 changed files
with
353 additions
and
123 deletions.
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 |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| ```release-note:feature | ||
| cli: snapshot inspect command supports JSON output | ||
| ``` |
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,114 @@ | ||
| package inspect | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "encoding/json" | ||
| "fmt" | ||
| "strconv" | ||
| "strings" | ||
| "text/tabwriter" | ||
| ) | ||
|
|
||
| const ( | ||
| PrettyFormat string = "pretty" | ||
| JSONFormat string = "json" | ||
| ) | ||
|
|
||
| type Formatter interface { | ||
| Format(*OutputFormat) (string, error) | ||
| } | ||
|
|
||
| func GetSupportedFormats() []string { | ||
| return []string{PrettyFormat, JSONFormat} | ||
| } | ||
|
|
||
| type prettyFormatter struct{} | ||
|
|
||
| func newPrettyFormatter() Formatter { | ||
| return &prettyFormatter{} | ||
| } | ||
| func NewFormatter(format string) (Formatter, error) { | ||
| switch format { | ||
| case PrettyFormat: | ||
| return newPrettyFormatter(), nil | ||
| case JSONFormat: | ||
| return newJSONFormatter(), nil | ||
| default: | ||
| return nil, fmt.Errorf("Unknown format: %s", format) | ||
| } | ||
| } | ||
|
|
||
| func (_ *prettyFormatter) Format(info *OutputFormat) (string, error) { | ||
| var b bytes.Buffer | ||
| tw := tabwriter.NewWriter(&b, 8, 8, 6, ' ', 0) | ||
|
|
||
| fmt.Fprintf(tw, " ID\t%s", info.Meta.ID) | ||
| fmt.Fprintf(tw, "\n Size\t%d", info.Meta.Size) | ||
| fmt.Fprintf(tw, "\n Index\t%d", info.Meta.Index) | ||
| fmt.Fprintf(tw, "\n Term\t%d", info.Meta.Term) | ||
| fmt.Fprintf(tw, "\n Version\t%d", info.Meta.Version) | ||
| fmt.Fprintf(tw, "\n") | ||
| fmt.Fprintln(tw, "\n Type\tCount\tSize\t") | ||
| fmt.Fprintf(tw, " %s\t%s\t%s\t", "----", "----", "----") | ||
| // For each different type generate new output | ||
| for _, s := range info.Stats { | ||
| fmt.Fprintf(tw, "\n %s\t%d\t%s\t", s.Name, s.Count, ByteSize(uint64(s.Sum))) | ||
| } | ||
| fmt.Fprintf(tw, "\n %s\t%s\t%s\t", "----", "----", "----") | ||
| fmt.Fprintf(tw, "\n Total\t\t%s\t", ByteSize(uint64(info.TotalSize))) | ||
|
|
||
| if err := tw.Flush(); err != nil { | ||
| return b.String(), err | ||
| } | ||
| return b.String(), nil | ||
| } | ||
|
|
||
| type jsonFormatter struct{} | ||
|
|
||
| func newJSONFormatter() Formatter { | ||
| return &jsonFormatter{} | ||
| } | ||
|
|
||
| func (_ *jsonFormatter) Format(info *OutputFormat) (string, error) { | ||
| b, err := json.MarshalIndent(info, "", " ") | ||
| if err != nil { | ||
| return "", fmt.Errorf("Failed to marshal original snapshot stats: %v", err) | ||
| } | ||
| return string(b), nil | ||
| } | ||
|
|
||
| const ( | ||
| BYTE = 1 << (10 * iota) | ||
| KILOBYTE | ||
| MEGABYTE | ||
| GIGABYTE | ||
| TERABYTE | ||
| ) | ||
|
|
||
| func ByteSize(bytes uint64) string { | ||
| unit := "" | ||
| value := float64(bytes) | ||
|
|
||
| switch { | ||
| case bytes >= TERABYTE: | ||
| unit = "TB" | ||
| value = value / TERABYTE | ||
| case bytes >= GIGABYTE: | ||
| unit = "GB" | ||
| value = value / GIGABYTE | ||
| case bytes >= MEGABYTE: | ||
| unit = "MB" | ||
| value = value / MEGABYTE | ||
| case bytes >= KILOBYTE: | ||
| unit = "KB" | ||
| value = value / KILOBYTE | ||
| case bytes >= BYTE: | ||
| unit = "B" | ||
| case bytes == 0: | ||
| return "0" | ||
| } | ||
|
|
||
| result := strconv.FormatFloat(value, 'f', 1, 64) | ||
| result = strings.TrimSuffix(result, ".0") | ||
| return result + unit | ||
| } |
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,45 @@ | ||
| package inspect | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestFormat(t *testing.T) { | ||
| m := []typeStats{{ | ||
| Name: "msg", | ||
| Sum: 1, | ||
| Count: 2, | ||
| }} | ||
| info := OutputFormat{ | ||
| Meta: &MetadataInfo{ | ||
| ID: "one", | ||
| Size: 2, | ||
| Index: 3, | ||
| Term: 4, | ||
| Version: 1, | ||
| }, | ||
| Stats: m, | ||
| TotalSize: 1, | ||
| } | ||
|
|
||
| formatters := map[string]Formatter{ | ||
| "pretty": newPrettyFormatter(), | ||
| // the JSON formatter ignores the showMeta | ||
| "json": newJSONFormatter(), | ||
| } | ||
|
|
||
| for fmtName, formatter := range formatters { | ||
| t.Run(fmtName, func(t *testing.T) { | ||
| actual, err := formatter.Format(&info) | ||
| require.NoError(t, err) | ||
|
|
||
| gName := fmt.Sprintf("%s", fmtName) | ||
|
|
||
| expected := golden(t, gName, actual) | ||
| require.Equal(t, expected, actual) | ||
| }) | ||
| } | ||
| } |
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
Oops, something went wrong.