New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add the format option to the docker stack ls command #31557
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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,67 @@ | ||
package formatter | ||
|
||
import ( | ||
"strconv" | ||
) | ||
|
||
const ( | ||
defaultStackTableFormat = "table {{.Name}}\t{{.Services}}" | ||
|
||
stackServicesHeader = "SERVICES" | ||
) | ||
|
||
// Stack contains deployed stack information. | ||
type Stack struct { | ||
// Name is the name of the stack | ||
Name string | ||
// Services is the number of the services | ||
Services int | ||
} | ||
|
||
// NewStackFormat returns a format for use with a stack Context | ||
func NewStackFormat(source string) Format { | ||
switch source { | ||
case TableFormatKey: | ||
return defaultStackTableFormat | ||
} | ||
return Format(source) | ||
} | ||
|
||
// StackWrite writes formatted stacks using the Context | ||
func StackWrite(ctx Context, stacks []*Stack) error { | ||
render := func(format func(subContext subContext) error) error { | ||
for _, stack := range stacks { | ||
if err := format(&stackContext{s: stack}); err != nil { | ||
return err | ||
} | ||
} | ||
return nil | ||
} | ||
return ctx.Write(newStackContext(), render) | ||
} | ||
|
||
type stackContext struct { | ||
HeaderContext | ||
s *Stack | ||
} | ||
|
||
func newStackContext() *stackContext { | ||
stackCtx := stackContext{} | ||
stackCtx.header = map[string]string{ | ||
"Name": nameHeader, | ||
"Services": stackServicesHeader, | ||
} | ||
return &stackCtx | ||
} | ||
|
||
func (s *stackContext) MarshalJSON() ([]byte, error) { | ||
return marshalJSON(s) | ||
} | ||
|
||
func (s *stackContext) Name() string { | ||
return s.s.Name | ||
} | ||
|
||
func (s *stackContext) Services() string { | ||
return strconv.Itoa(s.s.Services) | ||
} |
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,64 @@ | ||
package formatter | ||
|
||
import ( | ||
"bytes" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/assert" | ||
) | ||
|
||
func TestStackContextWrite(t *testing.T) { | ||
cases := []struct { | ||
context Context | ||
expected string | ||
}{ | ||
// Errors | ||
{ | ||
Context{Format: "{{InvalidFunction}}"}, | ||
`Template parsing error: template: :1: function "InvalidFunction" not defined | ||
`, | ||
}, | ||
{ | ||
Context{Format: "{{nil}}"}, | ||
`Template parsing error: template: :1:2: executing "" at <nil>: nil is not a command | ||
`, | ||
}, | ||
// Table format | ||
{ | ||
Context{Format: NewStackFormat("table")}, | ||
`NAME SERVICES | ||
baz 2 | ||
bar 1 | ||
`, | ||
}, | ||
{ | ||
Context{Format: NewStackFormat("table {{.Name}}")}, | ||
`NAME | ||
baz | ||
bar | ||
`, | ||
}, | ||
// Custom Format | ||
{ | ||
Context{Format: NewStackFormat("{{.Name}}")}, | ||
`baz | ||
bar | ||
`, | ||
}, | ||
} | ||
|
||
stacks := []*Stack{ | ||
{Name: "baz", Services: 2}, | ||
{Name: "bar", Services: 1}, | ||
} | ||
for _, testcase := range cases { | ||
out := bytes.NewBufferString("") | ||
testcase.context.Output = out | ||
err := StackWrite(testcase.context, stacks) | ||
if err != nil { | ||
assert.Error(t, err, testcase.expected) | ||
} else { | ||
assert.Equal(t, out.String(), testcase.expected) | ||
} | ||
} | ||
} |
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
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
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.
MarshalJSON is needed
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.
👍