feat: separate plugins.yml file

changelog.md

@@ -2,6 +2,7 @@
 
 ### Features
 
+- [#3184](https://github.com/ignite/cli/pull/3184) Separate `plugins.yml` config file.
 - [#3038](https://github.com/ignite/cli/pull/3038) Addition of Plugin Hooks in Plugin System
 - [#3056](https://github.com/ignite/cli/pull/3056) Add `--genesis-config` flag option to `ignite network chain publish`
 - [#2892](https://github.com/ignite/cli/pull/2982/) Add `ignite scaffold react` command.

ignite/cmd/cmd.go

@@ -33,6 +33,7 @@ const (
 	flagYes        = "yes"
 	flagClearCache = "clear-cache"
 	flagSkipProto  = "skip-proto"
+	flagPlugins    = "plugins"
 
 	checkVersionTimeout = time.Millisecond * 600
 	cacheFileName       = "ignite_cache.db"
@@ -81,6 +82,7 @@ To get started, create a blockchain:
 	c.AddCommand(NewVersion())
 	c.AddCommand(NewPlugin())
 	c.AddCommand(deprecated()...)
+	c.PersistentFlags().AddFlagSet(flagSetPlugins())
 
 	return c
 }
@@ -130,6 +132,17 @@ func getConfig(cmd *cobra.Command) (config string) {
 	return
 }
 
+func flagSetPlugins() *flag.FlagSet {
+	fs := flag.NewFlagSet("", flag.ContinueOnError)
+	fs.StringP(flagPlugins, "x", "", "Ignite plugins file (default: ./plugins.yml)")
+	return fs
+}
+
+func getPlugins(cmd *cobra.Command) (config string) {
+	config, _ = cmd.Flags().GetString(flagPlugins)
+	return
+}
+
 func flagSetYes() *flag.FlagSet {
 	fs := flag.NewFlagSet("", flag.ContinueOnError)
 	fs.BoolP(flagYes, "y", false, "answers interactive yes/no questions with yes")

ignite/cmd/plugin.go

@@ -7,9 +7,12 @@ import (
 	"strings"
 	"time"
 
+	"github.com/ignite/cli/ignite/config"
+
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 
+	pluginsconfig "github.com/ignite/cli/ignite/config/plugins"
 	"github.com/ignite/cli/ignite/pkg/cliui"
 	"github.com/ignite/cli/ignite/pkg/xgit"
 	"github.com/ignite/cli/ignite/services/plugin"
@@ -27,18 +30,27 @@ const (
 // If no configuration found, it returns w/o error.
 func LoadPlugins(ctx context.Context, rootCmd *cobra.Command) error {
 	// NOTE(tb) Not sure if it's the right place to load this.
-	chain, err := newChainWithHomeFlags(rootCmd)
+	cfg, err := parseLocalPlugins(rootCmd)
 	if err != nil {
-		// Binary is run outside of an chain app, plugins can't be loaded
+		// if binary is run where there is no plugin.yml, don't load
 		return nil
 	}
-	plugins, err = plugin.Load(ctx, chain)
+
+	// TODO: parse global config
+
+	plugins, err = plugin.Load(ctx, cfg)
 	if err != nil {
 		return err
 	}
 	return loadPlugins(rootCmd, plugins)
 }
 
+func parseLocalPlugins(rootCmd *cobra.Command) (*pluginsconfig.Config, error) {
+	pluginsPath := getPlugins(rootCmd)
+
+	return config.ParsePluginsFile(pluginsPath)
+}
+
 func loadPlugins(rootCmd *cobra.Command, plugins []*plugin.Plugin) error {
 	// Link plugins to related commands
 	var loadErrors []string

ignite/cmd/plugin_test.go

@@ -13,7 +13,7 @@ import (
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/require"
 
-	"github.com/ignite/cli/ignite/config"
+	config "github.com/ignite/cli/ignite/config/plugins"
 	"github.com/ignite/cli/ignite/services/plugin"
 	"github.com/ignite/cli/ignite/services/plugin/mocks"
 )

ignite/config/chain/v1/config.go

@@ -23,30 +23,6 @@ type Config struct {
 	base.Config `yaml:",inline"`
 
 	Validators []Validator `yaml:"validators"`
-	Plugins    []Plugin    `yaml:"plugins,omitempty"`
-}
-
-// Plugin keeps plugin name and location.
-type Plugin struct {
-	// Path holds the location of the plugin.
-	// A path can be local, in that case it must start with a `/`.
-	// A remote path on the other hand, is an URL to a public remote git
-	// repository. For example:
-	//
-	// path: github.com/foo/bar
-	//
-	// It can contain a path inside that repository, if for instance the repo
-	// contains multiple plugins, For example:
-	//
-	// path: github.com/foo/bar/plugin1
-	//
-	// It can also specify a tag or a branch, by adding a `@` and the branch/tag
-	// name at the end of the path. For example:
-	//
-	// path: github.com/foo/bar/plugin1@v42
-	Path string `yaml:"path"`
-	// With holds arguments passed to the plugin interface
-	With map[string]string `yaml:"with"`
 }
 
 func (c *Config) SetDefaults() error {

ignite/config/chain/v1/config_test.go

@@ -73,15 +73,6 @@ func TestConfigDecode(t *testing.T) {
 				},
 			},
 		}},
-		Plugins: []v1.Plugin{
-			{
-				Path: "/path/to/plugin1",
-			},
-			{
-				Path: "/path/to/plugin2",
-				With: map[string]string{"foo": "bar", "bar": "baz"},
-			},
-		},
 	}
 	assert.Equal(expected, cfg)
 }

ignite/config/parse.go

@@ -10,13 +10,14 @@ import (
 	"gopkg.in/yaml.v2"
 
 	chainconfig "github.com/ignite/cli/ignite/config/chain"
+	"github.com/ignite/cli/ignite/config/plugins"
 )
 
 // Parse reads a config file.
 // When the version of the file being read is not the latest
 // it is automatically migrated to the latest version.
 func Parse(configFile io.Reader) (*ChainConfig, error) {
-	cfg, err := parse(configFile)
+	cfg, err := parseChainConfig(configFile)
 	if err != nil {
 		return cfg, fmt.Errorf("error parsing config file: %w", err)
 	}
@@ -28,15 +29,20 @@ func Parse(configFile io.Reader) (*ChainConfig, error) {
 // When the version of the file being read is not the latest
 // it is automatically migrated to the latest version.
 func ParseNetwork(configFile io.Reader) (*ChainConfig, error) {
-	cfg, err := parse(configFile)
+	cfg, err := parseChainConfig(configFile)
 	if err != nil {
 		return cfg, err
 	}
 
 	return cfg, validateNetworkConfig(cfg)
 }
 
-func parse(configFile io.Reader) (*ChainConfig, error) {
+// ParsePlugins reads a config file for ignite binary plugins
+func ParsePlugins(configFile io.Reader) (*plugins.Config, error) {
+	return parsePluginsConfig(configFile)
+}
+
+func parseChainConfig(configFile io.Reader) (*ChainConfig, error) {
 	var buf bytes.Buffer
 
 	// Read the config file version first to know how to decode it
@@ -47,7 +53,7 @@ func parse(configFile io.Reader) (*ChainConfig, error) {
 
 	// Decode the current config file version and assign default
 	// values for the fields that are empty
-	c, err := decodeConfig(&buf, version)
+	c, err := decodeChainConfig(&buf, version)
 	if err != nil {
 		return DefaultChainConfig(), err
 	}
@@ -67,6 +73,14 @@ func parse(configFile io.Reader) (*ChainConfig, error) {
 	return cfg, nil
 }
 
+func parsePluginsConfig(configFile io.Reader) (*plugins.Config, error) {
+	var c plugins.Config
+
+	err := yaml.NewDecoder(configFile).Decode(&c)
+
+	return &c, err
+}
+
 // ParseFile parses a config from a file path.
 func ParseFile(path string) (*ChainConfig, error) {
 	file, err := os.Open(path)
@@ -91,6 +105,18 @@ func ParseNetworkFile(path string) (*ChainConfig, error) {
 	return ParseNetwork(file)
 }
 
+// ParsePluginsFile parses a plugins config.
+func ParsePluginsFile(path string) (*plugins.Config, error) {
+	file, err := os.Open(path)
+	if err != nil {
+		return plugins.DefaultConfig(), err
+	}
+
+	defer file.Close()
+
+	return ParsePlugins(file)
+}
+
 // ReadConfigVersion reads the config version.
 func ReadConfigVersion(configFile io.Reader) (chainconfig.Version, error) {
 	c := struct {
@@ -102,7 +128,7 @@ func ReadConfigVersion(configFile io.Reader) (chainconfig.Version, error) {
 	return c.Version, err
 }
 
-func decodeConfig(r io.Reader, version chainconfig.Version) (chainconfig.Converter, error) {
+func decodeChainConfig(r io.Reader, version chainconfig.Version) (chainconfig.Converter, error) {
 	c, ok := Versions[version]
 	if !ok {
 		return nil, &UnsupportedVersionError{version}

ignite/config/plugins/config.go

@@ -0,0 +1,56 @@
+package plugins
+
+import (
+	"io"
+
+	"github.com/imdario/mergo"
+	"gopkg.in/yaml.v2"
+)
+
+// DefaultConfig returns a config with default values.
+func DefaultConfig() *Config {
+	c := Config{}
+	return &c
+}
+
+type Config struct {
+	Plugins []Plugin `yaml:"plugins,omitempty"`
+}
+
+// Plugin keeps plugin name and location.
+type Plugin struct {
+	// Path holds the location of the plugin.
+	// A path can be local, in that case it must start with a `/`.
+	// A remote path on the other hand, is an URL to a public remote git
+	// repository. For example:
+	//
+	// path: github.com/foo/bar
+	//
+	// It can contain a path inside that repository, if for instance the repo
+	// contains multiple plugins, For example:
+	//
+	// path: github.com/foo/bar/plugin1
+	//
+	// It can also specify a tag or a branch, by adding a `@` and the branch/tag
+	// name at the end of the path. For example:
+	//
+	// path: github.com/foo/bar/plugin1@v42
+	Path string `yaml:"path"`
+	// With holds arguments passed to the plugin interface
+	With map[string]string `yaml:"with"`
+}
+
+// Clone returns an identical copy of the instance
+func (c *Config) Clone() (*Config, error) {
+	copy := Config{}
+	if err := mergo.Merge(&copy, c, mergo.WithAppendSlice); err != nil {
+		return nil, err
+	}
+
+	return &copy, nil
+}
+
+// Decode decodes the config file values from YAML.
+func (c *Config) Decode(r io.Reader) error {
+	return yaml.NewDecoder(r).Decode(c)
+}

ignite/config/plugins/config_test.go

@@ -0,0 +1,36 @@
+package plugins_test
+
+import (
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"github.com/ignite/cli/ignite/config/plugins"
+)
+
+func TestConfigDecode(t *testing.T) {
+	assert := assert.New(t)
+	require := require.New(t)
+	f, err := os.Open("testdata/plugins.yml")
+	require.NoError(err)
+	defer f.Close()
+	var cfg plugins.Config
+
+	err = cfg.Decode(f)
+
+	require.NoError(err)
+	expected := plugins.Config{
+		Plugins: []plugins.Plugin{
+			{
+				Path: "/path/to/plugin1",
+			},
+			{
+				Path: "/path/to/plugin2",
+				With: map[string]string{"foo": "bar", "bar": "baz"},
+			},
+		},
+	}
+	assert.Equal(expected, cfg)
+}

ignite/config/plugins/testdata/plugins.yml

@@ -0,0 +1,8 @@
+plugins:
+  - name: plugin1
+    path: /path/to/plugin1
+  - name: plugin2
+    path: /path/to/plugin2
+    with:
+      foo: bar
+      bar: baz