Merge pull request #1252 from merico-dev/config-ht

Feat: Remove pluginDir Item in Config File

Author: daniel-hutao

cmd/devstream/apply.go

@@ -30,7 +30,7 @@ func applyCMDFunc(cmd *cobra.Command, args []string) {
 
 func init() {
 	applyCMD.Flags().StringVarP(&configFilePath, configFlagName, "f", "config.yaml", "config file")
-	applyCMD.Flags().StringVarP(&pluginDir, pluginDirFlagName, "d", "", "plugins directory")
+	applyCMD.Flags().StringVarP(&pluginDir, pluginDirFlagName, "d", defaultPluginDir, "plugins directory")
 	applyCMD.Flags().BoolVarP(&continueDirectly, "yes", "y", false, "apply directly without confirmation")
 
 	completion.FlagFilenameCompletion(applyCMD, configFlagName)

cmd/devstream/common.go

@@ -9,4 +9,5 @@ var (
 const (
 	configFlagName    = "config-file"
 	pluginDirFlagName = "plugin-dir"
+	defaultPluginDir  = "~/.devstream/plugins"
 )

cmd/devstream/delete.go

@@ -33,7 +33,7 @@ func deleteCMDFunc(cmd *cobra.Command, args []string) {
 func init() {
 	deleteCMD.Flags().BoolVarP(&isForceDelete, "force", "", false, "force delete by config")
 	deleteCMD.Flags().StringVarP(&configFilePath, configFlagName, "f", "config.yaml", "config file")
-	deleteCMD.Flags().StringVarP(&pluginDir, pluginDirFlagName, "d", "", "plugins directory")
+	deleteCMD.Flags().StringVarP(&pluginDir, pluginDirFlagName, "d", defaultPluginDir, "plugins directory")
 	deleteCMD.Flags().BoolVarP(&continueDirectly, "yes", "y", false, "delete directly without confirmation")
 
 	completion.FlagFilenameCompletion(deleteCMD, configFlagName)

cmd/devstream/destroy.go

@@ -31,7 +31,7 @@ func destroyCMDFunc(cmd *cobra.Command, args []string) {
 func init() {
 	destroyCMD.Flags().BoolVarP(&isForceDestroy, "force", "", false, "force destroy by config")
 	destroyCMD.Flags().StringVarP(&configFilePath, configFlagName, "f", "config.yaml", "config file")
-	destroyCMD.Flags().StringVarP(&pluginDir, pluginDirFlagName, "d", "", "plugins directory")
+	destroyCMD.Flags().StringVarP(&pluginDir, pluginDirFlagName, "d", defaultPluginDir, "plugins directory")
 	destroyCMD.Flags().BoolVarP(&continueDirectly, "yes", "y", false, "destroy directly without confirmation")
 
 	completion.FlagFilenameCompletion(destroyCMD, configFlagName)

cmd/devstream/init.go

@@ -7,12 +7,10 @@ import (
 	"strings"
 
 	"github.com/spf13/cobra"
-	"github.com/spf13/viper"
 
 	"github.com/devstream-io/devstream/cmd/devstream/list"
 	"github.com/devstream-io/devstream/internal/pkg/completion"
 	"github.com/devstream-io/devstream/internal/pkg/configmanager"
-	"github.com/devstream-io/devstream/internal/pkg/pluginengine"
 	"github.com/devstream-io/devstream/internal/pkg/pluginmanager"
 	"github.com/devstream-io/devstream/internal/pkg/version"
 	"github.com/devstream-io/devstream/pkg/util/log"
@@ -39,46 +37,46 @@ func initCMDFunc(_ *cobra.Command, _ []string) {
 	}
 
 	var (
-		realPluginDir string
-		tools         []configmanager.Tool
-		err           error
+		tools []configmanager.Tool
+		err   error
 	)
 
 	if downloadOnly {
 		// download plugins from flags
-		tools, realPluginDir, err = GetPluginsAndPluginDirFromFlags()
+		tools, err = GetPluginsFromFlags()
 	} else {
 		// download plugins according to the config file
-		tools, realPluginDir, err = GetPluginsAndPluginDirFromConfig()
+		tools, err = GetPluginsFromConfig()
 	}
 
 	if err != nil {
 		log.Fatal(err)
 	}
 
-	if err := pluginmanager.DownloadPlugins(tools, realPluginDir, initOS, initArch); err != nil {
+	pluginDir, err = pluginmanager.GetPluginDir()
+	if err != nil {
+		log.Fatal(err)
+	}
+	log.Debugf("Plugin directory: %s.", pluginDir)
+
+	if err = pluginmanager.DownloadPlugins(tools, pluginDir, initOS, initArch); err != nil {
 		log.Fatal(err)
 	}
 
 	fmt.Println()
 	log.Success("Initialize finished.")
 }
 
-func GetPluginsAndPluginDirFromConfig() (tools []configmanager.Tool, pluginDir string, err error) {
+func GetPluginsFromConfig() (tools []configmanager.Tool, err error) {
 	cfg, err := configmanager.NewManager(configFilePath).LoadConfig()
 	if err != nil {
-		return nil, "", err
+		return nil, err
 	}
 
-	// combine plugin dir from config file and flag
-	if err = pluginengine.SetPluginDir(cfg.PluginDir); err != nil {
-		return nil, "", err
-	}
-
-	return cfg.Tools, viper.GetString(pluginDirFlagName), nil
+	return cfg.Tools, nil
 }
 
-func GetPluginsAndPluginDirFromFlags() (tools []configmanager.Tool, pluginDir string, err error) {
+func GetPluginsFromFlags() (tools []configmanager.Tool, err error) {
 	// 1. get plugins from flags
 	var pluginsName []string
 	if downloadAll {
@@ -94,18 +92,18 @@ func GetPluginsAndPluginDirFromFlags() (tools []configmanager.Tool, pluginDir st
 		// check if plugins to download are supported by dtm
 		for _, plugin := range pluginsName {
 			if _, ok := list.PluginNamesMap()[plugin]; !ok {
-				return nil, "", fmt.Errorf("Plugin %s is not supported by dtm", plugin)
+				return nil, fmt.Errorf("Plugin %s is not supported by dtm", plugin)
 			}
 		}
 	}
 
 	if len(pluginsName) == 0 {
-		return nil, "", errors.New("Please use --plugins to specify plugins to download or use --all to download all plugins.")
+		return nil, errors.New("Please use --plugins to specify plugins to download or use --all to download all plugins.")
 	}
 	log.Debugf("plugins to download: %v", pluginsName)
 
 	if initOS == "" || initArch == "" {
-		return nil, "", fmt.Errorf("Once you use the --all flag, you must specify the --os and --arch flags")
+		return nil, fmt.Errorf("Once you use the --all flag, you must specify the --os and --arch flags")
 	}
 
 	log.Infof("Plugins to download: %v", pluginsName)
@@ -115,18 +113,13 @@ func GetPluginsAndPluginDirFromFlags() (tools []configmanager.Tool, pluginDir st
 		tools = append(tools, configmanager.Tool{Name: pluginName})
 	}
 
-	// 2. handle plugin dir
-	if err = pluginengine.SetPluginDir(""); err != nil {
-		return nil, "", err
-	}
-
-	return tools, viper.GetString(pluginDirFlagName), nil
+	return tools, nil
 }
 
 func init() {
 	// flags for init from config file
 	initCMD.Flags().StringVarP(&configFilePath, configFlagName, "f", "config.yaml", "config file")
-	initCMD.Flags().StringVarP(&pluginDir, pluginDirFlagName, "d", "", "plugins directory")
+	initCMD.Flags().StringVarP(&pluginDir, pluginDirFlagName, "d", defaultPluginDir, "plugins directory")
 
 	// downloading specific plugins from flags
 	initCMD.Flags().BoolVar(&downloadOnly, "download-only", false, "download plugins only")

cmd/devstream/show.go

@@ -67,7 +67,7 @@ func init() {
 	showStatusCMD.Flags().StringVarP(&plugin, "plugin", "p", "", "specify name with the plugin")
 	showStatusCMD.Flags().StringVarP(&instanceID, "id", "i", "", "specify id with the plugin instance")
 	showStatusCMD.Flags().BoolVarP(&statusAllFlag, "all", "a", false, "show all instances of all plugins status")
-	showStatusCMD.Flags().StringVarP(&pluginDir, "plugin-dir", "d", "", "plugins directory")
+	showStatusCMD.Flags().StringVarP(&pluginDir, pluginDirFlagName, "d", defaultPluginDir, "plugins directory")
 	showStatusCMD.Flags().StringVarP(&configFilePath, "config-file", "f", "config.yaml", "config file")
 	completion.FlagPluginsCompletion(showStatusCMD, "plugin")
 }

cmd/devstream/verify.go

@@ -26,7 +26,7 @@ func verifyCMDFunc(cmd *cobra.Command, args []string) {
 
 func init() {
 	verifyCMD.Flags().StringVarP(&configFilePath, configFlagName, "f", "config.yaml", "config file")
-	verifyCMD.Flags().StringVarP(&pluginDir, pluginDirFlagName, "d", "", "plugins directory")
+	verifyCMD.Flags().StringVarP(&pluginDir, pluginDirFlagName, "d", defaultPluginDir, "plugins directory")
 
 	completion.FlagFilenameCompletion(verifyCMD, configFlagName)
 	completion.FlagDirnameCompletion(verifyCMD, pluginDirFlagName)

docs/best-practices/air-gapped-deployment.zh.md

@@ -290,7 +290,6 @@ harbor-1.10.0.tgz jenkins-4.2.5.tgz
     ```yaml title="local Backend"
     varFile: "" # If not empty, use the specified external variables config file
     toolFile: "" # If not empty, use the specified external tools config file
-    pluginDir: "./plugins" # If empty, use the default value: ~/.devstream/plugins, or use -d flag to specify a directory
     state: # state config, backend can be local, s3 or k8s
       backend: local
       options:
@@ -302,7 +301,6 @@ harbor-1.10.0.tgz jenkins-4.2.5.tgz
     ```yaml title="k8s Backend"
     varFile: "" # If not empty, use the specified external variables config file
     toolFile: "" # If not empty, use the specified external tools config file
-    pluginDir: "./plugins" # If empty, use the default value: ~/.devstream/plugins, or use -d flag to specify a directory
     state: # state config, backend can be local, s3 or k8s
       backend: k8s
       options:
@@ -330,7 +328,6 @@ harborURL: harbor.example.com
 # core config
 varFile: "" # If not empty, use the specified external variables config file
 toolFile: "" # If not empty, use the specified external tools config file
-pluginDir: "./plugins" # If empty, use the default value: ~/.devstream/plugins, or use -d flag to specify a directory
 state: # state config, backend can be local, s3 or k8s
   backend: k8s
   options: