cli-plugins: do not change schema version

Per discussion on PR.

Author: milas

cli-plugins/manager/candidate_test.go

@@ -65,13 +65,10 @@ func TestValidateCandidate(t *testing.T) {
 		{name: "builtin alias", c: &fakeCandidate{path: builtinAlias}, invalid: `plugin "alias" duplicates an alias of builtin command "builtin"`},
 		{name: "fetch failure", c: &fakeCandidate{path: goodPluginPath, exec: false}, invalid: fmt.Sprintf("failed to fetch metadata: faked a failure to exec %q", goodPluginPath)},
 		{name: "metadata not json", c: &fakeCandidate{path: goodPluginPath, exec: true, meta: `xyzzy`}, invalid: "invalid character"},
-		{name: "empty schemaversion", c: &fakeCandidate{path: goodPluginPath, exec: true, meta: `{}`}, invalid: `plugin metadata failed validation: "SchemaVersion" field is required`},
-		{name: "invalid schemaversion", c: &fakeCandidate{path: goodPluginPath, exec: true, meta: `{"SchemaVersion": "xyzzy"}`}, invalid: `plugin metadata failed validation: unknown schema version: xyzzy`},
-		{name: "no vendor", c: &fakeCandidate{path: goodPluginPath, exec: true, meta: `{"SchemaVersion": "0.1.0"}`}, invalid: `plugin metadata failed validation: "Vendor" field is required`},
-		{
-			name: "empty vendor", c: &fakeCandidate{path: goodPluginPath, exec: true, meta: `{"SchemaVersion": "0.1.0", "Vendor": ""}`},
-			invalid: `plugin metadata failed validation: "Vendor" field is required`,
-		},
+		{name: "empty schemaversion", c: &fakeCandidate{path: goodPluginPath, exec: true, meta: `{}`}, invalid: `plugin SchemaVersion "" is not valid`},
+		{name: "invalid schemaversion", c: &fakeCandidate{path: goodPluginPath, exec: true, meta: `{"SchemaVersion": "xyzzy"}`}, invalid: `plugin SchemaVersion "xyzzy" is not valid`},
+		{name: "no vendor", c: &fakeCandidate{path: goodPluginPath, exec: true, meta: `{"SchemaVersion": "0.1.0"}`}, invalid: "plugin metadata does not define a vendor"},
+		{name: "empty vendor", c: &fakeCandidate{path: goodPluginPath, exec: true, meta: `{"SchemaVersion": "0.1.0", "Vendor": ""}`}, invalid: "plugin metadata does not define a vendor"},
 		// This one should work
 		{name: "valid", c: &fakeCandidate{path: goodPluginPath, exec: true, meta: `{"SchemaVersion": "0.1.0", "Vendor": "e2e-testing"}`}},
 		{name: "experimental + allowing experimental", c: &fakeCandidate{path: goodPluginPath, exec: true, meta: metaExperimental}},

cli-plugins/manager/metadata.go

@@ -1,7 +1,5 @@
 package manager
 
-import "fmt"
-
 const (
 	// NamePrefix is the prefix required on all plugin binary names
 	NamePrefix = "docker-"
@@ -14,44 +12,18 @@ const (
 
 // Metadata provided by the plugin.
 type Metadata struct {
-	// SchemaVersion describes the version of this struct. Mandatory.
+	// SchemaVersion describes the version of this struct. Mandatory, must be "0.1.0"
 	SchemaVersion string `json:",omitempty"`
-	// Name of the plugin.
+	// Vendor is the name of the plugin vendor. Mandatory
+	Vendor string `json:",omitempty"`
+	// Name is the name of the plugin.
 	//
-	// Mandatory if SchemaVersion >= 0.2.0.
+	// For compatibility reasons, this field is not mandatory.
 	Name string `json:",omitempty"`
-	// Vendor is the name of the plugin vendor. Mandatory.
-	Vendor string `json:",omitempty"`
 	// Version is the optional version of this plugin.
 	Version string `json:",omitempty"`
 	// ShortDescription should be suitable for a single line help message.
 	ShortDescription string `json:",omitempty"`
 	// URL is a pointer to the plugin's homepage.
 	URL string `json:",omitempty"`
 }
-
-// validateMetadata returns an error if any fields are missing or invalid for the
-// specified SchemaVersion.
-func validateMetadata(meta *Metadata) error {
-	if meta.SchemaVersion == "" {
-		return fmt.Errorf("%q field is required", "SchemaVersion")
-	}
-
-	switch meta.SchemaVersion {
-	case "0.1.0":
-		// clear fields not supported by version
-		meta.Name = ""
-	case "0.2.0":
-		if meta.Name == "" {
-			return fmt.Errorf("%q field is required", "Name")
-		}
-	default:
-		return NewPluginError("unknown schema version: %s", meta.SchemaVersion)
-	}
-
-	if meta.Vendor == "" {
-		return fmt.Errorf("%q field is required", "Vendor")
-	}
-
-	return nil
-}

cli-plugins/manager/metadata_test.go

@@ -90,11 +90,13 @@ func newPlugin(c Candidate, cmds []*cobra.Command) (Plugin, error) {
 		p.Err = wrapAsPluginError(err, "invalid metadata")
 		return p, nil
 	}
-
-	if err := validateMetadata(&p.Metadata); err != nil {
-		p.Err = wrapAsPluginError(err, "plugin metadata failed validation")
+	if p.Metadata.SchemaVersion != "0.1.0" {
+		p.Err = NewPluginError("plugin SchemaVersion %q is not valid, must be 0.1.0", p.Metadata.SchemaVersion)
+		return p, nil
+	}
+	if p.Metadata.Vendor == "" {
+		p.Err = NewPluginError("plugin metadata does not define a vendor")
 		return p, nil
 	}
-
 	return p, nil
 }