mirror of
https://github.com/docker/cli.git
synced 2026-01-26 15:41:42 +03:00
baabf6e8ad
They were listed twice in `docker --help` (but not `docker help`), since the stubs were added in both `tryRunPluginHelp` and the `setHelpFunc` closure. Calling `AddPluginStubCommands` earlier in `setHelpFunc` before the call to `tryRunPluginHelp` is sufficient. Also it is no longer necessary to add just valid plugins (`tryRunPluginHelp` handles invalid plugins correctly) so remove that logic (which was in any case broken for e.g. `docker --help`). Update the e2e test to check for duplicate entries and also to test `docker --help` which was previously missed. Signed-off-by: Ian Campbell <ijc@docker.com>
55 lines
1.6 KiB
Go
55 lines
1.6 KiB
Go
package manager
|
|
|
|
import (
|
|
"github.com/docker/cli/cli/command"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
const (
|
|
// CommandAnnotationPlugin is added to every stub command added by
|
|
// AddPluginCommandStubs with the value "true" and so can be
|
|
// used to distinguish plugin stubs from regular commands.
|
|
CommandAnnotationPlugin = "com.docker.cli.plugin"
|
|
|
|
// CommandAnnotationPluginVendor is added to every stub command
|
|
// added by AddPluginCommandStubs and contains the vendor of
|
|
// that plugin.
|
|
CommandAnnotationPluginVendor = "com.docker.cli.plugin.vendor"
|
|
|
|
// CommandAnnotationPluginInvalid is added to any stub command
|
|
// added by AddPluginCommandStubs for an invalid command (that
|
|
// is, one which failed it's candidate test) and contains the
|
|
// reason for the failure.
|
|
CommandAnnotationPluginInvalid = "com.docker.cli.plugin-invalid"
|
|
)
|
|
|
|
// AddPluginCommandStubs adds a stub cobra.Commands for each valid and invalid
|
|
// plugin. The command stubs will have several annotations added, see
|
|
// `CommandAnnotationPlugin*`.
|
|
func AddPluginCommandStubs(dockerCli command.Cli, cmd *cobra.Command) error {
|
|
plugins, err := ListPlugins(dockerCli, cmd)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
for _, p := range plugins {
|
|
vendor := p.Vendor
|
|
if vendor == "" {
|
|
vendor = "unknown"
|
|
}
|
|
annotations := map[string]string{
|
|
CommandAnnotationPlugin: "true",
|
|
CommandAnnotationPluginVendor: vendor,
|
|
}
|
|
if p.Err != nil {
|
|
annotations[CommandAnnotationPluginInvalid] = p.Err.Error()
|
|
}
|
|
cmd.AddCommand(&cobra.Command{
|
|
Use: p.Name,
|
|
Short: p.ShortDescription,
|
|
Run: func(_ *cobra.Command, _ []string) {},
|
|
Annotations: annotations,
|
|
})
|
|
}
|
|
return nil
|
|
}
|