Skip to content

inspect: list allowed object types in --type help #7315

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.

Sign up for GitHub

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

Open
TastyHeadphones wants to merge 1 commit into
base: master
Choose a base branch
from
+11 −1
Open

inspect: list allowed object types in --type help #7315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cli/command/system/inspect.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ func newInspectCommand(dockerCLI command.Cli) *cobra.Command {

flags := cmd.Flags()
flags.StringVarP(&opts.format, "format", "f", "", flagsHelper.InspectFormatHelp)
flags.StringVar(&opts.objectType, "type", "", "Only inspect objects of the given type")
flags.StringVar(&opts.objectType, "type", "", `Only inspect objects of the given type ("`+strings.Join(allTypes, `", "`)+`")`)
flags.BoolVarP(&opts.size, "size", "s", false, "Display total file sizes if the type is container")

_ = cmd.RegisterFlagCompletionFunc("type", completion.FromList(allTypes...))
Expand Down
10 changes: 10 additions & 0 deletions cli/command/system/inspect_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,13 @@ func TestInspectValidateFlagsAndArgs(t *testing.T) {
})
}
}

func TestInspectTypeFlagHelpListsObjectTypes(t *testing.T) {
cmd := newInspectCommand(test.NewFakeCli(&fakeClient{}))
typeFlag := cmd.Flags().Lookup("type")
assert.Assert(t, typeFlag != nil)
usage := typeFlag.Usage
for _, objectType := range allTypes {
assert.Check(t, is.Contains(usage, objectType), "help should mention %q", objectType)
}
}