mirror of https://github.com/docker/cli.git
Additional experimental features in non-experimental mode error handling
This fix is the follow up of the last commit. In this fix: 1. If any of the parents of a command has tags, then this command's `Args` (Args validation func) will be wrapped up. The warpped up func will check to see if the feature is supported or not. If it is not supported, then a not supported message is generated instead. This fix is related to 28626. Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
This commit is contained in:
parent
8e688f17a3
commit
d5010088e3
99
docker.go
99
docker.go
|
@ -53,32 +53,43 @@ func newDockerCommand(dockerCli *command.DockerCli) *cobra.Command {
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
cli.SetupRootCommand(cmd)
|
cli.SetupRootCommand(cmd)
|
||||||
|
|
||||||
|
flags = cmd.Flags()
|
||||||
|
flags.BoolVarP(&opts.Version, "version", "v", false, "Print version information and quit")
|
||||||
|
flags.StringVar(&opts.ConfigDir, "config", cliconfig.Dir(), "Location of client config files")
|
||||||
|
opts.Common.InstallFlags(flags)
|
||||||
|
|
||||||
|
setFlagErrorFunc(dockerCli, cmd, flags, opts)
|
||||||
|
|
||||||
|
setHelpFunc(dockerCli, cmd, flags, opts)
|
||||||
|
|
||||||
|
cmd.SetOutput(dockerCli.Out())
|
||||||
|
cmd.AddCommand(newDaemonCommand())
|
||||||
|
commands.AddCommands(cmd, dockerCli)
|
||||||
|
|
||||||
|
setValidateArgs(dockerCli, cmd, flags, opts)
|
||||||
|
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
func setFlagErrorFunc(dockerCli *command.DockerCli, cmd *cobra.Command, flags *pflag.FlagSet, opts *cliflags.ClientOptions) {
|
||||||
// When invoking `docker stack --nonsense`, we need to make sure FlagErrorFunc return appropriate
|
// When invoking `docker stack --nonsense`, we need to make sure FlagErrorFunc return appropriate
|
||||||
// output if the feature is not supported.
|
// output if the feature is not supported.
|
||||||
// As above cli.SetupRootCommand(cmd) have already setup the FlagErrorFunc, we will add a pre-check before the FlagErrorFunc
|
// As above cli.SetupRootCommand(cmd) have already setup the FlagErrorFunc, we will add a pre-check before the FlagErrorFunc
|
||||||
// is called.
|
// is called.
|
||||||
flagErrorFunc := cmd.FlagErrorFunc()
|
flagErrorFunc := cmd.FlagErrorFunc()
|
||||||
cmd.SetFlagErrorFunc(func(cmd *cobra.Command, err error) error {
|
cmd.SetFlagErrorFunc(func(cmd *cobra.Command, err error) error {
|
||||||
if dockerCli.Client() == nil { // when using --help, PersistenPreRun is not called, so initialization is needed.
|
initializeDockerCli(dockerCli, flags, opts)
|
||||||
// flags must be the top-level command flags, not cmd.Flags()
|
|
||||||
opts.Common.SetDefaultOptions(flags)
|
|
||||||
dockerPreRun(opts)
|
|
||||||
dockerCli.Initialize(opts)
|
|
||||||
}
|
|
||||||
if err := isSupported(cmd, dockerCli.Client().ClientVersion(), dockerCli.HasExperimental()); err != nil {
|
if err := isSupported(cmd, dockerCli.Client().ClientVersion(), dockerCli.HasExperimental()); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return flagErrorFunc(cmd, err)
|
return flagErrorFunc(cmd, err)
|
||||||
})
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func setHelpFunc(dockerCli *command.DockerCli, cmd *cobra.Command, flags *pflag.FlagSet, opts *cliflags.ClientOptions) {
|
||||||
cmd.SetHelpFunc(func(ccmd *cobra.Command, args []string) {
|
cmd.SetHelpFunc(func(ccmd *cobra.Command, args []string) {
|
||||||
if dockerCli.Client() == nil { // when using --help, PersistentPreRun is not called, so initialization is needed.
|
initializeDockerCli(dockerCli, flags, opts)
|
||||||
// flags must be the top-level command flags, not cmd.Flags()
|
|
||||||
opts.Common.SetDefaultOptions(flags)
|
|
||||||
dockerPreRun(opts)
|
|
||||||
dockerCli.Initialize(opts)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := isSupported(ccmd, dockerCli.Client().ClientVersion(), dockerCli.HasExperimental()); err != nil {
|
if err := isSupported(ccmd, dockerCli.Client().ClientVersion(), dockerCli.HasExperimental()); err != nil {
|
||||||
ccmd.Println(err)
|
ccmd.Println(err)
|
||||||
return
|
return
|
||||||
|
@ -90,17 +101,52 @@ func newDockerCommand(dockerCli *command.DockerCli) *cobra.Command {
|
||||||
ccmd.Println(err)
|
ccmd.Println(err)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
}
|
||||||
|
|
||||||
flags = cmd.Flags()
|
func setValidateArgs(dockerCli *command.DockerCli, cmd *cobra.Command, flags *pflag.FlagSet, opts *cliflags.ClientOptions) {
|
||||||
flags.BoolVarP(&opts.Version, "version", "v", false, "Print version information and quit")
|
// The Args is handled by ValidateArgs in cobra, which does not allows a pre-hook.
|
||||||
flags.StringVar(&opts.ConfigDir, "config", cliconfig.Dir(), "Location of client config files")
|
// As a result, here we replace the existing Args validation func to a wrapper,
|
||||||
opts.Common.InstallFlags(flags)
|
// where the wrapper will check to see if the feature is supported or not.
|
||||||
|
// The Args validation error will only be returned if the feature is supported.
|
||||||
|
visitAll(cmd, func(ccmd *cobra.Command) {
|
||||||
|
// if there is no tags for a command or any of its parent,
|
||||||
|
// there is no need to wrap the Args validation.
|
||||||
|
if !hasTags(ccmd) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
cmd.SetOutput(dockerCli.Out())
|
if ccmd.Args == nil {
|
||||||
cmd.AddCommand(newDaemonCommand())
|
return
|
||||||
commands.AddCommands(cmd, dockerCli)
|
}
|
||||||
|
|
||||||
return cmd
|
cmdArgs := ccmd.Args
|
||||||
|
ccmd.Args = func(cmd *cobra.Command, args []string) error {
|
||||||
|
initializeDockerCli(dockerCli, flags, opts)
|
||||||
|
if err := isSupported(cmd, dockerCli.Client().ClientVersion(), dockerCli.HasExperimental()); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return cmdArgs(cmd, args)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func initializeDockerCli(dockerCli *command.DockerCli, flags *pflag.FlagSet, opts *cliflags.ClientOptions) {
|
||||||
|
if dockerCli.Client() == nil { // when using --help, PersistentPreRun is not called, so initialization is needed.
|
||||||
|
// flags must be the top-level command flags, not cmd.Flags()
|
||||||
|
opts.Common.SetDefaultOptions(flags)
|
||||||
|
dockerPreRun(opts)
|
||||||
|
dockerCli.Initialize(opts)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// visitAll will traverse all commands from the root.
|
||||||
|
// This is different from the VisitAll of cobra.Command where only parents
|
||||||
|
// are checked.
|
||||||
|
func visitAll(root *cobra.Command, fn func(*cobra.Command)) {
|
||||||
|
for _, cmd := range root.Commands() {
|
||||||
|
visitAll(cmd, fn)
|
||||||
|
}
|
||||||
|
fn(root)
|
||||||
}
|
}
|
||||||
|
|
||||||
func noArgs(cmd *cobra.Command, args []string) error {
|
func noArgs(cmd *cobra.Command, args []string) error {
|
||||||
|
@ -230,3 +276,14 @@ func isFlagSupported(f *pflag.Flag, clientVersion string) bool {
|
||||||
}
|
}
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// hasTags return true if any of the command's parents has tags
|
||||||
|
func hasTags(cmd *cobra.Command) bool {
|
||||||
|
for curr := cmd; curr != nil; curr = curr.Parent() {
|
||||||
|
if len(curr.Tags) > 0 {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
Loading…
Reference in New Issue