Skip to content

Commit

Permalink
Merge pull request #30187 from thaJeztah/show-error-on-unsupported-flags
Browse files Browse the repository at this point in the history
print error if unsupported flags are used
  • Loading branch information
vdemeester authored Feb 4, 2017
2 parents eb6b972 + 3414897 commit f538c4b
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 4 deletions.
2 changes: 1 addition & 1 deletion client/errors.go
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ func IsErrPluginPermissionDenied(err error) bool {
// if less than the current supported version
func (cli *Client) NewVersionError(APIrequired, feature string) error {
if versions.LessThan(cli.version, APIrequired) {
return fmt.Errorf("%q requires API version %s, but the Docker server is version %s", feature, APIrequired, cli.version)
return fmt.Errorf("%q requires API version %s, but the Docker daemon API version is %s", feature, APIrequired, cli.version)
}
return nil
}
Expand Down
38 changes: 35 additions & 3 deletions cmd/docker/docker.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import (
"github.com/docker/docker/pkg/term"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
"strings"
)

func newDockerCommand(dockerCli *command.DockerCli) *cobra.Command {
Expand Down Expand Up @@ -144,7 +145,7 @@ func hideUnsupportedFeatures(cmd *cobra.Command, clientVersion string, hasExperi
}

// hide flags not supported by the server
if flagVersion, ok := f.Annotations["version"]; ok && len(flagVersion) == 1 && versions.LessThan(clientVersion, flagVersion[0]) {
if !isFlagSupported(f, clientVersion) {
f.Hidden = true
}

Expand All @@ -168,13 +169,44 @@ func hideUnsupportedFeatures(cmd *cobra.Command, clientVersion string, hasExperi
func isSupported(cmd *cobra.Command, clientVersion string, hasExperimental bool) error {
if !hasExperimental {
if _, ok := cmd.Tags["experimental"]; ok {
return errors.New("only supported with experimental daemon")
return errors.New("only supported on a Docker daemon with experimental features enabled")
}
}

if cmdVersion, ok := cmd.Tags["version"]; ok && versions.LessThan(clientVersion, cmdVersion) {
return fmt.Errorf("only supported with daemon version >= %s", cmdVersion)
return fmt.Errorf("requires API version %s, but the Docker daemon API version is %s", cmdVersion, clientVersion)
}

errs := []string{}

cmd.Flags().VisitAll(func(f *pflag.Flag) {
if f.Changed {
if !isFlagSupported(f, clientVersion) {
errs = append(errs, fmt.Sprintf("\"--%s\" requires API version %s, but the Docker daemon API version is %s", f.Name, getFlagVersion(f), clientVersion))
return
}
if _, ok := f.Annotations["experimental"]; ok && !hasExperimental {
errs = append(errs, fmt.Sprintf("\"--%s\" is only supported on a Docker daemon with experimental features enabled", f.Name))
}
}
})
if len(errs) > 0 {
return errors.New(strings.Join(errs, "\n"))
}

return nil
}

func getFlagVersion(f *pflag.Flag) string {
if flagVersion, ok := f.Annotations["version"]; ok && len(flagVersion) == 1 {
return flagVersion[0]
}
return ""
}

func isFlagSupported(f *pflag.Flag, clientVersion string) bool {
if v := getFlagVersion(f); v != "" {
return versions.GreaterThanOrEqualTo(clientVersion, v)
}
return true
}

0 comments on commit f538c4b

Please sign in to comment.