check for plugins file schema version and type

docs/content/reference/file-formats.md

@@ -162,21 +162,22 @@ You can use this [json schema][plugins-schema] to validate a plugins config file
 ```yaml
 schemaType: Plugins
 schemaVersion: 1.0.0
-azure:
-  version: v1.0.0
-  feedURL: https://cdn.porter.sh/plugins/atom.xml
-  url: https://example.com
-  mirror: https://example.com
+plugins:
+  azure:
+    version: v1.0.0
+    feedURL: https://cdn.porter.sh/plugins/atom.xml
+    url: https://example.com
+    mirror: https://example.com
 ```
 
 | Field                | Required | Description                                                                                                                                    |
 |----------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------|
 | schemaType           | false    | The type of document. This isn't used by Porter but is included when Porter outputs the file, so that editors can determine the resource type. |
 | schemaVersion        | true     | The version of the Plugins schema used in this file.                                                                                     |
-| <pluginName>.version | false    | The version of the plugin.                                                                                                                 |
-| <pluginName>.feedURL | false    | The url of an atom feed where the plugin can be downloaded.
-| <pluginName>.url     | false    | The url from where the plugin can be downloaded.                                                                                                                 |
-| <pluginName>.mirror  | false    | The mirror of official Porter assets.                                                                                                                 |
+| plugins.<pluginName>.version | false    | The version of the plugin.                                                                                                                 |
+| plugins.<pluginName>.feedURL | false    | The url of an atom feed where the plugin can be downloaded.
+| plugins.<pluginName>.url     | false    | The url from where the plugin can be downloaded.                                                                                                                 |
+| plugins.<pluginName>.mirror  | false    | The mirror of official Porter assets.                                                                                                                 |
 
 [cs-schema]: /schema/v1/credential-set.schema.json
 [ps-schema]: /schema/v1/parameter-set.schema.json

pkg/plugins/install.go

@@ -6,8 +6,13 @@ import (
 
 	"get.porter.sh/porter/pkg/pkgmgmt"
 	"get.porter.sh/porter/pkg/portercontext"
+	"github.com/cnabio/cnab-go/schema"
 )
 
+// InstallPluginsSchemaVersion represents the version associated with the schema
+// plugins configuration documents.
+var InstallPluginsSchemaVersion = schema.Version("1.0.0")
+
 type InstallOptions struct {
 	pkgmgmt.InstallOptions
 
@@ -25,8 +30,9 @@ func (o *InstallOptions) Validate(args []string, cxt *portercontext.Context) err
 			return fmt.Errorf("plugin URL should not be specified when --file is provided")
 		}
 
-		if o.Version != "" {
-			return fmt.Errorf("plugin version should not be specified when --file is provided")
+		// version should not be set to anything other than the default value
+		if o.Version != "" && o.Version != "latest" {
+			return fmt.Errorf("plugin version %s should not be specified when --file is provided", o.Version)
 		}
 
 		if _, err := cxt.FileSystem.Stat(o.File); err != nil {
@@ -39,20 +45,37 @@ func (o *InstallOptions) Validate(args []string, cxt *portercontext.Context) err
 	return o.InstallOptions.Validate(args)
 }
 
-// InstallFileOption is the go representation of plugin installation file format.
-type InstallFileOption map[string]pkgmgmt.InstallOptions
+// InstallPluginsSpec represents the user-defined configuration for plugins installation.
+type InstallPluginsSpec struct {
+	SchemaType    string               `yaml:"schemaType"`
+	SchemaVersion string               `yaml:"schemaVersion"`
+	Plugins       InstallPluginsConfig `yaml:"plugins"`
+}
+
+func (spec InstallPluginsSpec) Validate() error {
+	if InstallPluginsSchemaVersion != schema.Version(spec.SchemaVersion) {
+		if spec.SchemaVersion == "" {
+			spec.SchemaVersion = "(none)"
+		}
+		return fmt.Errorf("invalid schemaVersion provided: %s. This version of Porter is compatible with %s.", spec.SchemaVersion, InstallPluginsSchemaVersion)
+	}
+	return nil
+}
+
+// InstallPluginsConfig is the go representation of plugin installation file format.
+type InstallPluginsConfig map[string]pkgmgmt.InstallOptions
 
-// InstallPluginsConfig is a sorted list of InstallationFileOption in alphabetical order.
-type InstallPluginsConfig struct {
-	data InstallFileOption
+// InstallPluginsConfigList is a sorted list of InstallationFileOption in alphabetical order.
+type InstallPluginsConfigList struct {
+	data InstallPluginsConfig
 	keys []string
 }
 
 // NewInstallPluginConfigs returns a new instance of InstallPluginConfigs with plugins sorted in alphabetical order
 // using their names.
-func NewInstallPluginConfigs(opt InstallFileOption) InstallPluginsConfig {
+func NewInstallPluginConfigs(opt InstallPluginsConfig) InstallPluginsConfigList {
 	keys := make([]string, 0, len(opt))
-	data := make(InstallFileOption, len(opt))
+	data := make(InstallPluginsConfig, len(opt))
 	for k, v := range opt {
 		keys = append(keys, k)
 
@@ -65,14 +88,14 @@ func NewInstallPluginConfigs(opt InstallFileOption) InstallPluginsConfig {
 		return keys[i] < keys[j]
 	})
 
-	return InstallPluginsConfig{
+	return InstallPluginsConfigList{
 		data: data,
 		keys: keys,
 	}
 }
 
-// Configs returns InstallOptions list in alphabetical order.
-func (pc InstallPluginsConfig) Configs() []pkgmgmt.InstallOptions {
+// Values returns InstallOptions list in alphabetical order.
+func (pc InstallPluginsConfigList) Values() []pkgmgmt.InstallOptions {
 	value := make([]pkgmgmt.InstallOptions, 0, len(pc.keys))
 	for _, k := range pc.keys {
 		value = append(value, pc.data[k])

pkg/plugins/install_test.go

@@ -19,9 +19,9 @@ func TestInstallOptions_Validate(t *testing.T) {
 }
 
 func TestInstallPluginsConfig(t *testing.T) {
-	input := InstallFileOption{"kubernetes": pkgmgmt.InstallOptions{URL: "test-kubernetes.com"}, "azure": pkgmgmt.InstallOptions{URL: "test-azure.com"}}
+	input := InstallPluginsConfig{"kubernetes": pkgmgmt.InstallOptions{URL: "test-kubernetes.com"}, "azure": pkgmgmt.InstallOptions{URL: "test-azure.com"}}
 	expected := []pkgmgmt.InstallOptions{{Name: "azure", PackageType: "plugin", URL: "test-azure.com"}, {Name: "kubernetes", PackageType: "plugin", URL: "test-kubernetes.com"}}
 
 	cfg := NewInstallPluginConfigs(input)
-	require.Equal(t, expected, cfg.Configs())
+	require.Equal(t, expected, cfg.Values())
 }

pkg/porter/plugins.go

@@ -158,23 +158,23 @@ func (p *Porter) InstallPlugin(ctx context.Context, opts plugins.InstallOptions)
 	ctx, log := tracing.StartSpan(ctx)
 	defer log.EndSpan()
 
-	installConfigs, err := p.getPluginInstallConfigs(ctx, opts)
+	installOpts, err := p.getPluginInstallOptions(ctx, opts)
 	if err != nil {
 		return err
 	}
-	for _, cfg := range installConfigs {
-		err := p.Plugins.Install(ctx, cfg)
+	for _, opt := range installOpts {
+		err := p.Plugins.Install(ctx, opt)
 		if err != nil {
 			return err
 		}
 
-		plugin, err := p.Plugins.GetMetadata(ctx, cfg.Name)
+		plugin, err := p.Plugins.GetMetadata(ctx, opt.Name)
 		if err != nil {
 			return fmt.Errorf("failed to get plugin metadata: %w", err)
 		}
 
 		v := plugin.GetVersionInfo()
-		fmt.Fprintf(p.Out, "installed %s plugin %s (%s)\n", cfg.Name, v.Version, v.Commit)
+		fmt.Fprintf(p.Out, "installed %s plugin %s (%s)\n", opt.Name, v.Version, v.Commit)
 	}
 
 	return nil
@@ -191,13 +191,13 @@ func (p *Porter) UninstallPlugin(ctx context.Context, opts pkgmgmt.UninstallOpti
 	return nil
 }
 
-func (p *Porter) getPluginInstallConfigs(ctx context.Context, opts plugins.InstallOptions) ([]pkgmgmt.InstallOptions, error) {
+func (p *Porter) getPluginInstallOptions(ctx context.Context, opts plugins.InstallOptions) ([]pkgmgmt.InstallOptions, error) {
 	_, log := tracing.StartSpan(ctx)
 	defer log.EndSpan()
 
 	var installConfigs []pkgmgmt.InstallOptions
 	if opts.File != "" {
-		var data plugins.InstallFileOption
+		var data plugins.InstallPluginsSpec
 		if log.ShouldLog(zapcore.DebugLevel) {
 			// ignoring any error here, printing debug info isn't critical
 			contents, _ := p.FileSystem.ReadFile(opts.File)
@@ -207,9 +207,14 @@ func (p *Porter) getPluginInstallConfigs(ctx context.Context, opts plugins.Insta
 		if err := encoding.UnmarshalFile(p.FileSystem, opts.File, &data); err != nil {
 			return nil, fmt.Errorf("unable to parse %s as an installation document: %w", opts.File, err)
 		}
-		sortedCfgs := plugins.NewInstallPluginConfigs(data)
 
-		for _, config := range sortedCfgs.Configs() {
+		if err := data.Validate(); err != nil {
+			return nil, err
+		}
+
+		sortedCfgs := plugins.NewInstallPluginConfigs(data.Plugins)
+
+		for _, config := range sortedCfgs.Values() {
 			// if user specified a feed url or mirror using the flags, it will become
 			// the default value and apply to empty values parsed from the provided file
 			if config.FeedURL == "" {

pkg/porter/testdata/plugins.json

@@ -1,8 +1,12 @@
 {
-  "plugin1": {
-    "version": "v1.0"
-  },
-  "plugin2": {
-    "version": "v1.0"
+  "schemaType": "Plugins",
+  "schemaVersion": "1.0.0",
+  "plugins": {
+    "plugin1": {
+      "version": "v1.0"
+    },
+    "plugin2": {
+      "version": "v1.0"
+    }
   }
 }

pkg/porter/testdata/plugins.yaml

@@ -1,4 +1,7 @@
-plugin1:
-  version: v1.0
-plugin2:
-  version: v1.0
+schemaType: Plugins
+schemaVersion: 1.0.0
+plugins:
+  plugin1:
+    version: v1.0
+  plugin2:
+    version: v1.0

pkg/schema/plugins.schema.json

@@ -11,41 +11,46 @@
       "description": "Version of the plugins schema to which this document adheres",
       "type": "string",
       "default": "1.0.0"
-    }
-  },
-  "required": [
-    "schemaVersion"
-  ],
-  "title": "Plugins json schema",
-  "type": "object",
-  "additionalProperties": {
-    "type": "object",
-    "properties": {
-      "key": {
-        "type": "string"
-      },
-      "value": {
+    },
+    "plugins": {
+      "description": "The definition of plugins to install",
+      "type": "object",
+      "default": "1.0.0",
+      "additionalProperties": {
         "type": "object",
         "properties": {
-          "version": {
-            "description": "The version for the plugins.",
-            "type": "string"
-          },
-          "feedURL": {
-            "description": "The URL of an atom feed where the plugin can be downloaded.",
+          "key": {
             "type": "string"
           },
-          "url": {
-            "description": "The URL from where the plugin can be downloaded",
-            "type": "string"
-          },
-          "mirror": {
-            "description": "Mirror of official Porter assets.",
-            "type": "string"
-          },
-          "additionalProperties": false
+          "value": {
+            "type": "object",
+            "properties": {
+              "version": {
+                "description": "The version for the plugin.",
+                "type": "string"
+              },
+              "feedURL": {
+                "description": "The URL of an atom feed where the plugin can be downloaded.",
+                "type": "string"
+              },
+              "url": {
+                "description": "The URL from where the plugin can be downloaded",
+                "type": "string"
+              },
+              "mirror": {
+                "description": "Mirror of official Porter assets.",
+                "type": "string"
+              },
+              "additionalProperties": false
+            }
+          }
         }
       }
     }
-  }
+  },
+  "required": [
+    "schemaVersion"
+  ],
+  "title": "Plugins json schema",
+  "type": "object"
 }

tests/smoke/hello_test.go

@@ -22,10 +22,15 @@ func TestHelloBundle(t *testing.T) {
 
 	test.PrepareTestBundle()
 	require.NoError(t, shx.Copy("testdata/buncfg.json", test.TestDir))
+	require.NoError(t, shx.Copy("testdata/plugins.yaml", test.TestDir))
 	test.Chdir(test.TestDir)
 
+	// Verify plugins installation
+	_, output := test.RequirePorter("plugins", "install", "-f", "plugins.yaml")
+	require.Contains(t, output, "installed azure plugin", "expected to see plugin successfully installed")
+
 	// Run a stateless action before we install and make sure nothing is persisted
-	_, output := test.RequirePorter("invoke", testdata.MyBuns, "--action=dry-run", "--reference", testdata.MyBunsRef, "-c=mybuns")
+	_, output = test.RequirePorter("invoke", testdata.MyBuns, "--action=dry-run", "--reference", testdata.MyBunsRef, "-c=mybuns")
 	t.Log(output)
 	test.RequireInstallationNotFound(test.CurrentNamespace(), testdata.MyBuns)
 

tests/smoke/testdata/plugins.yaml

@@ -0,0 +1,4 @@
+schemaType: Plugins
+schemaVersion: 1.0.0
+plugins:
+  azure: {}