Implement "stripe plugin config" command

Author: vcheung-stripe

pkg/cmd/plugin.go

@@ -25,6 +25,7 @@ func newPluginCmd() *pluginCmd {
 	pc.cmd.AddCommand(plugin.NewInstallCmd(&Config).Cmd)
 	pc.cmd.AddCommand(plugin.NewUpgradeCmd(&Config).Cmd)
 	pc.cmd.AddCommand(plugin.NewUninstallCmd(&Config).Cmd)
+	pc.cmd.AddCommand(plugin.NewConfigCmd(&Config).Cmd)
 
 	return pc
 }

pkg/cmd/plugin/config.go

@@ -0,0 +1,84 @@
+package plugin
+
+import (
+	"fmt"
+	"slices"
+
+	"github.com/spf13/cobra"
+
+	"github.com/stripe/stripe-cli/pkg/config"
+)
+
+// ConfigCmd handles `stripe plugin config` for reading and writing plugin settings.
+type ConfigCmd struct {
+	cfg *config.Config
+	Cmd *cobra.Command
+
+	set   bool
+	unset string
+}
+
+// NewConfigCmd creates the `stripe plugin config` command.
+func NewConfigCmd(cfg *config.Config) *ConfigCmd {
+	cc := &ConfigCmd{cfg: cfg}
+
+	cc.Cmd = &cobra.Command{
+		Hidden: true,
+		Use:    "config [plugin]",
+		Short:  "Read and write plugin configuration",
+		Long: `Read and write configuration for plugins. Omit the plugin name to apply the setting globally.
+
+Available fields:
+  updates   Controls automatic background updates for a plugin. When set to "off",
+            the CLI will not check for or download newer versions automatically.
+            Accepted values: on, off (default: off)`,
+		Example: `stripe plugin config --set updates on
+  stripe plugin config --unset updates
+  stripe plugin config apps --set updates off
+  stripe plugin config apps --unset updates`,
+		RunE: cc.run,
+	}
+
+	cc.Cmd.Flags().BoolVar(&cc.set, "set", false, "Set a config field to some value")
+	cc.Cmd.Flags().StringVar(&cc.unset, "unset", "", "Unset a specific config field")
+
+	return cc
+}
+
+func (cc *ConfigCmd) run(cmd *cobra.Command, args []string) error {
+	switch {
+	case cc.set && len(args) == 2:
+		// stripe plugin config --set updates <value>  (global)
+		return cc.setUpdates("__global", args[0], args[1])
+	case cc.set && len(args) == 3:
+		// stripe plugin config <plugin> --set updates <value>
+		return cc.setUpdates(args[0], args[1], args[2])
+	case cc.unset != "" && len(args) == 0:
+		// stripe plugin config --unset updates  (global)
+		return cc.cfg.DeleteConfigField(fmt.Sprintf("plugin_configs.__global.%s", cc.unset))
+	case cc.unset != "" && len(args) == 1:
+		// stripe plugin config <plugin> --unset updates
+		pluginName := args[0]
+		if !slices.Contains(cc.cfg.GetInstalledPlugins(), pluginName) {
+			return fmt.Errorf("plugin %q is not installed", pluginName)
+		}
+		return cc.cfg.DeleteConfigField(fmt.Sprintf("plugin_configs.%s.%s", pluginName, cc.unset))
+	default:
+		return cmd.Help()
+	}
+}
+
+func (cc *ConfigCmd) setUpdates(scope, field, value string) error {
+	if field != "updates" {
+		return fmt.Errorf("unknown config field %q", field)
+	}
+	if value != "on" && value != "off" {
+		return fmt.Errorf("invalid value %q for updates — must be \"on\" or \"off\"", value)
+	}
+	if scope != "__global" {
+		if !slices.Contains(cc.cfg.GetInstalledPlugins(), scope) {
+			return fmt.Errorf("plugin %q is not installed", scope)
+		}
+	}
+	return cc.cfg.WriteConfigField(fmt.Sprintf("plugin_configs.%s.%s", scope, field), value)
+}

pkg/cmd/plugin/config_test.go

@@ -0,0 +1,173 @@
+package plugin
+
+import (
+	"path/filepath"
+	"testing"
+
+	"github.com/99designs/keyring"
+	"github.com/spf13/viper"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"github.com/stripe/stripe-cli/pkg/config"
+)
+
+func setupPluginConfigTest(t *testing.T) (*config.Config, func()) {
+	t.Helper()
+
+	profilesFile := filepath.Join(t.TempDir(), "config.toml")
+	cfg := &config.Config{
+		Color:        "auto",
+		LogLevel:     "info",
+		ProfilesFile: profilesFile,
+		Profile:      config.Profile{ProfileName: "default"},
+	}
+	cfg.InitConfig()
+	config.KeyRing = keyring.NewArrayKeyring(nil)
+
+	return cfg, func() {
+		viper.Reset()
+	}
+}
+
+func newTestConfigCmd(cfg *config.Config) *ConfigCmd {
+	cc := NewConfigCmd(cfg)
+	return cc
+}
+
+// -- global --set -----------------------------------------------------------
+
+func TestGlobalSet_UpdatesOn(t *testing.T) {
+	cfg, cleanup := setupPluginConfigTest(t)
+	defer cleanup()
+
+	cc := newTestConfigCmd(cfg)
+	cc.set = true
+
+	err := cc.run(cc.Cmd, []string{"updates", "on"})
+	require.NoError(t, err)
+	assert.Equal(t, "on", viper.GetString("plugin_configs.__global.updates"))
+}
+
+func TestGlobalSet_UpdatesOff(t *testing.T) {
+	cfg, cleanup := setupPluginConfigTest(t)
+	defer cleanup()
+
+	cc := newTestConfigCmd(cfg)
+	cc.set = true
+
+	err := cc.run(cc.Cmd, []string{"updates", "off"})
+	require.NoError(t, err)
+	assert.Equal(t, "off", viper.GetString("plugin_configs.__global.updates"))
+}
+
+func TestGlobalSet_InvalidValue(t *testing.T) {
+	cfg, cleanup := setupPluginConfigTest(t)
+	defer cleanup()
+
+	cc := newTestConfigCmd(cfg)
+	cc.set = true
+
+	err := cc.run(cc.Cmd, []string{"updates", "maybe"})
+	require.Error(t, err)
+	assert.Contains(t, err.Error(), "invalid value")
+}
+
+func TestGlobalSet_UnknownField(t *testing.T) {
+	cfg, cleanup := setupPluginConfigTest(t)
+	defer cleanup()
+
+	cc := newTestConfigCmd(cfg)
+	cc.set = true
+
+	err := cc.run(cc.Cmd, []string{"unknown_field", "on"})
+	require.Error(t, err)
+	assert.Contains(t, err.Error(), "unknown config field")
+}
+
+// -- global --unset ---------------------------------------------------------
+
+func TestGlobalUnset_Updates(t *testing.T) {
+	cfg, cleanup := setupPluginConfigTest(t)
+	defer cleanup()
+
+	require.NoError(t, cfg.WriteConfigField("plugin_configs.__global.updates", "off"))
+
+	cc := newTestConfigCmd(cfg)
+	cc.unset = "updates"
+
+	err := cc.run(cc.Cmd, []string{})
+	require.NoError(t, err)
+	assert.False(t, viper.IsSet("plugin_configs.__global.updates"))
+}
+
+// -- per-plugin --set -------------------------------------------------------
+
+func TestPluginSet_UpdatesOff(t *testing.T) {
+	cfg, cleanup := setupPluginConfigTest(t)
+	defer cleanup()
+
+	require.NoError(t, cfg.WriteConfigField("installed_plugins", []string{"apps"}))
+
+	cc := newTestConfigCmd(cfg)
+	cc.set = true
+
+	err := cc.run(cc.Cmd, []string{"apps", "updates", "off"})
+	require.NoError(t, err)
+	assert.Equal(t, "off", viper.GetString("plugin_configs.apps.updates"))
+}
+
+func TestPluginSet_NotInstalled(t *testing.T) {
+	cfg, cleanup := setupPluginConfigTest(t)
+	defer cleanup()
+
+	cc := newTestConfigCmd(cfg)
+	cc.set = true
+
+	err := cc.run(cc.Cmd, []string{"apps", "updates", "off"})
+	require.Error(t, err)
+	assert.Contains(t, err.Error(), "not installed")
+}
+
+func TestPluginSet_InvalidValue(t *testing.T) {
+	cfg, cleanup := setupPluginConfigTest(t)
+	defer cleanup()
+
+	require.NoError(t, cfg.WriteConfigField("installed_plugins", []string{"apps"}))
+
+	cc := newTestConfigCmd(cfg)
+	cc.set = true
+
+	err := cc.run(cc.Cmd, []string{"apps", "updates", "maybe"})
+	require.Error(t, err)
+	assert.Contains(t, err.Error(), "invalid value")
+}
+
+// -- per-plugin --unset -----------------------------------------------------
+
+func TestPluginUnset_Updates(t *testing.T) {
+	cfg, cleanup := setupPluginConfigTest(t)
+	defer cleanup()
+
+	require.NoError(t, cfg.WriteConfigField("installed_plugins", []string{"apps"}))
+	require.NoError(t, cfg.WriteConfigField("plugin_configs.apps.updates", "off"))
+
+	cc := newTestConfigCmd(cfg)
+	cc.unset = "updates"
+
+	err := cc.run(cc.Cmd, []string{"apps"})
+	require.NoError(t, err)
+	assert.False(t, viper.IsSet("plugin_configs.apps.updates"))
+}
+
+func TestPluginUnset_NotInstalled(t *testing.T) {
+	cfg, cleanup := setupPluginConfigTest(t)
+	defer cleanup()
+
+	cc := newTestConfigCmd(cfg)
+	cc.unset = "updates"
+
+	err := cc.run(cc.Cmd, []string{"apps"})
+	require.Error(t, err)
+	assert.Contains(t, err.Error(), "not installed")
+}

pkg/config/config.go

@@ -44,7 +44,7 @@ type IConfig interface {
 	SwitchProfile(targetProfileName string) error
 	RemoveProfile(profileName string) error
 	RemoveAllProfiles() error
-	WriteConfigField(field string, value interface{}) error
+	WriteConfigField(field string, value any) error
 	GetInstalledPlugins() []string
 }
 
@@ -227,7 +227,7 @@ func (c *Config) CopyProfile(source string, target string) error {
 
 	// Clone the profile map and update profile_name
 	safeTarget := strings.ReplaceAll(target, ".", " ")
-	existingMap := existing.(map[string]interface{})
+	existingMap := existing.(map[string]any)
 	newProfile := maps.Clone(existingMap)
 	newProfile["profile_name"] = safeTarget
 
@@ -242,7 +242,7 @@ func (c *Config) ListProfiles() error {
 
 	for _, value := range runtimeViper.AllSettings() {
 		// TODO: there's probably a better way to e.g. hydrate a Profile and read from there?
-		profile, isProfile := value.(map[string]interface{})
+		profile, isProfile := value.(map[string]any)
 		if isProfile {
 			displayName, _ := profile["display_name"].(string)
 			if !slices.Contains(profiles, displayName) {
@@ -341,7 +341,7 @@ func (c *Config) RemoveProfile(profileName string) error {
 		if isProfile(value) {
 			var profileNameAttr string
 			switch v := value.(type) {
-			case map[string]interface{}:
+			case map[string]any:
 				if pn, ok := v["profile_name"].(string); ok {
 					profileNameAttr = pn
 				}
@@ -397,9 +397,9 @@ func deleteLivemodeKey(key string, profile string) error {
 }
 
 // isProfile identifies whether a value in the config pertains to a profile.
-func isProfile(value interface{}) bool {
+func isProfile(value any) bool {
 	// TODO: ianjabour - ideally find a better way to identify projects in config
-	_, ok := value.(map[string]interface{})
+	_, ok := value.(map[string]any)
 	if !ok {
 		_, ok = value.(map[string]string)
 	}
@@ -409,13 +409,24 @@ func isProfile(value interface{}) bool {
 
 // WriteConfigField updates a configuration field and writes the updated
 // configuration to disk.
-func (c *Config) WriteConfigField(field string, value interface{}) error {
+func (c *Config) WriteConfigField(field string, value any) error {
 	runtimeViper := viper.GetViper()
 	runtimeViper.Set(field, value)
 
 	return runtimeViper.WriteConfig()
 }
 
+// DeleteConfigField removes a top-level (non-profile-scoped) configuration
+// field and writes the updated configuration to disk.
+func (c *Config) DeleteConfigField(field string) error {
+	v, err := removeKey(viper.GetViper(), field)
+	if err != nil {
+		return err
+	}
+
+	return writeConfig(v)
+}
+
 // writeConfig writes a viper instance to the config file and syncs the global viper.
 func writeConfig(runtimeViper *viper.Viper) error {
 	profilesFile := viper.ConfigFileUsed()
@@ -479,24 +490,24 @@ func makePath(path string) error {
 
 // taken from https://github.com/spf13/viper/blob/master/util.go#L199,
 // we need this to delete configs, remove when viper supprts unset natively
-func deepSearch(m map[string]interface{}, path []string) map[string]interface{} {
+func deepSearch(m map[string]any, path []string) map[string]any {
 	for _, k := range path {
 		m2, ok := m[k]
 		if !ok {
 			// intermediate key does not exist
 			// => create it and continue from there
-			m3 := make(map[string]interface{})
+			m3 := make(map[string]any)
 			m[k] = m3
 			m = m3
 
 			continue
 		}
 
-		m3, ok := m2.(map[string]interface{})
+		m3, ok := m2.(map[string]any)
 		if !ok {
 			// intermediate key is a value
 			// => replace with a new map
-			m3 = make(map[string]interface{})
+			m3 = make(map[string]any)
 			m[k] = m3
 		}