Merge pull request #1324 from aFlyBird0/feat-config-dir

feat: support config dir

Author: daniel-hutao

cmd/devstream/apply.go

@@ -6,7 +6,6 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/devstream-io/devstream/internal/pkg/completion"
 	"github.com/devstream-io/devstream/internal/pkg/pluginengine"
 	"github.com/devstream-io/devstream/pkg/util/log"
 )
@@ -21,6 +20,7 @@ DevStream will generate and execute a new plan based on the config file and the
 }
 
 func applyCMDFunc(cmd *cobra.Command, args []string) {
+	checkConfigFile()
 	log.Info("Apply started.")
 	if err := pluginengine.Apply(configFilePath, continueDirectly); err != nil {
 		log.Errorf("Apply failed => %s.", err)
@@ -33,10 +33,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", defaultPluginDir, "plugins directory")
-	applyCMD.Flags().BoolVarP(&continueDirectly, "yes", "y", false, "apply directly without confirmation")
-
-	completion.FlagFilenameCompletion(applyCMD, configFlagName)
-	completion.FlagDirnameCompletion(applyCMD, pluginDirFlagName)
+	addFlagConfigFile(applyCMD)
+	addFlagPluginDir(applyCMD)
+	addFlagContinueDirectly(applyCMD)
 }

cmd/devstream/common.go

@@ -1,5 +1,15 @@
 package main
 
+import (
+	"os"
+	"strings"
+
+	"github.com/spf13/cobra"
+
+	"github.com/devstream-io/devstream/internal/pkg/completion"
+	"github.com/devstream-io/devstream/pkg/util/log"
+)
+
 var (
 	configFilePath   string
 	pluginDir        string
@@ -11,3 +21,24 @@ const (
 	pluginDirFlagName = "plugin-dir"
 	defaultPluginDir  = "~/.devstream/plugins"
 )
+
+func checkConfigFile() {
+	if strings.TrimSpace(configFilePath) == "" {
+		log.Errorf(`Config file is required. You could use "-f filename" or "-f directory" to specify it.`)
+		os.Exit(1)
+	}
+}
+
+func addFlagConfigFile(cmd *cobra.Command) {
+	cmd.Flags().StringVarP(&configFilePath, configFlagName, "f", "", "config file or directory")
+	completion.FlagFilenameCompletion(cmd, configFlagName)
+}
+
+func addFlagPluginDir(cmd *cobra.Command) {
+	cmd.Flags().StringVarP(&pluginDir, pluginDirFlagName, "d", defaultPluginDir, "plugins directory")
+	completion.FlagDirnameCompletion(cmd, pluginDirFlagName)
+}
+
+func addFlagContinueDirectly(cmd *cobra.Command) {
+	cmd.Flags().BoolVarP(&continueDirectly, "yes", "y", false, "continue directly without confirmation")
+}

cmd/devstream/delete.go

@@ -5,7 +5,6 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/devstream-io/devstream/internal/pkg/completion"
 	"github.com/devstream-io/devstream/internal/pkg/pluginengine"
 	"github.com/devstream-io/devstream/pkg/util/log"
 )
@@ -21,6 +20,7 @@ DevStream will delete everything defined in the config file, regardless of the s
 }
 
 func deleteCMDFunc(cmd *cobra.Command, args []string) {
+	checkConfigFile()
 	log.Info("Delete started.")
 	if err := pluginengine.Remove(configFilePath, continueDirectly, isForceDelete); err != nil {
 		log.Errorf("Delete error: %s.", err)
@@ -31,11 +31,9 @@ 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", defaultPluginDir, "plugins directory")
-	deleteCMD.Flags().BoolVarP(&continueDirectly, "yes", "y", false, "delete directly without confirmation")
+	addFlagConfigFile(deleteCMD)
+	addFlagPluginDir(deleteCMD)
+	addFlagContinueDirectly(deleteCMD)
 
-	completion.FlagFilenameCompletion(deleteCMD, configFlagName)
-	completion.FlagDirnameCompletion(deleteCMD, pluginDirFlagName)
+	deleteCMD.Flags().BoolVarP(&isForceDelete, "force", "", false, "force delete by config")
 }

cmd/devstream/destroy.go

@@ -5,7 +5,6 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/devstream-io/devstream/internal/pkg/completion"
 	"github.com/devstream-io/devstream/internal/pkg/pluginengine"
 	"github.com/devstream-io/devstream/pkg/util/log"
 )
@@ -20,6 +19,7 @@ var destroyCMD = &cobra.Command{
 }
 
 func destroyCMDFunc(cmd *cobra.Command, args []string) {
+	checkConfigFile()
 	log.Info("Destroy started.")
 	if err := pluginengine.Destroy(configFilePath, continueDirectly, isForceDestroy); err != nil {
 		log.Errorf("Destroy failed => %s.", err)
@@ -29,10 +29,9 @@ 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", defaultPluginDir, "plugins directory")
-	destroyCMD.Flags().BoolVarP(&continueDirectly, "yes", "y", false, "destroy directly without confirmation")
+	addFlagConfigFile(destroyCMD)
+	addFlagPluginDir(destroyCMD)
+	addFlagContinueDirectly(destroyCMD)
 
-	completion.FlagFilenameCompletion(destroyCMD, configFlagName)
+	destroyCMD.Flags().BoolVarP(&isForceDestroy, "force", "", false, "force destroy by config")
 }

cmd/devstream/init.go

@@ -9,7 +9,6 @@ import (
 	"github.com/spf13/cobra"
 
 	"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/pluginmanager"
 	"github.com/devstream-io/devstream/internal/pkg/version"
@@ -117,17 +116,13 @@ func GetPluginsFromFlags() (tools configmanager.Tools, err error) {
 }
 
 func init() {
-	// flags for init from config file
-	initCMD.Flags().StringVarP(&configFilePath, configFlagName, "f", "config.yaml", "config file")
-	initCMD.Flags().StringVarP(&pluginDir, pluginDirFlagName, "d", defaultPluginDir, "plugins directory")
+	addFlagConfigFile(initCMD)
+	addFlagPluginDir(initCMD)
 
 	// downloading specific plugins from flags
 	initCMD.Flags().BoolVar(&downloadOnly, "download-only", false, "download plugins only")
 	initCMD.Flags().StringSliceVarP(&pluginsToDownload, "plugins", "p", []string{}, "the plugins to be downloaded")
 	initCMD.Flags().BoolVarP(&downloadAll, "all", "a", false, "download all plugins")
 	initCMD.Flags().StringVar(&initOS, "os", runtime.GOOS, "download plugins for specific os")
 	initCMD.Flags().StringVar(&initArch, "arch", runtime.GOARCH, "download plugins for specific arch")
-
-	completion.FlagFilenameCompletion(initCMD, configFlagName)
-	completion.FlagDirnameCompletion(initCMD, pluginDirFlagName)
 }

cmd/devstream/show.go

@@ -60,14 +60,14 @@ func init() {
 	showCMD.AddCommand(showConfigCMD)
 	showCMD.AddCommand(showStatusCMD)
 
+	addFlagConfigFile(showConfigCMD)
+	addFlagPluginDir(showConfigCMD)
+
 	showConfigCMD.Flags().StringVarP(&plugin, "plugin", "p", "", "specify name with the plugin")
 	showConfigCMD.Flags().StringVarP(&template, "template", "t", "", "print a template config, e.g. quickstart/gitops/...")
 	completion.FlagPluginsCompletion(showConfigCMD, "plugin")
 
 	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, pluginDirFlagName, "d", defaultPluginDir, "plugins directory")
-	showStatusCMD.Flags().StringVarP(&configFilePath, "config-file", "f", "config.yaml", "config file")
-	completion.FlagPluginsCompletion(showStatusCMD, "plugin")
 }

cmd/devstream/upgrade.go

@@ -21,5 +21,5 @@ func upgradeCMDFunc(cmd *cobra.Command, args []string) {
 }
 
 func init() {
-	upgradeCMD.Flags().BoolVarP(&continueDirectly, "yes", "y", false, "upgrade directly without confirmation")
+	addFlagContinueDirectly(upgradeCMD)
 }

cmd/devstream/verify.go

@@ -3,7 +3,6 @@ package main
 import (
 	"github.com/spf13/cobra"
 
-	"github.com/devstream-io/devstream/internal/pkg/completion"
 	"github.com/devstream-io/devstream/internal/pkg/pluginengine"
 	"github.com/devstream-io/devstream/pkg/util/log"
 )
@@ -25,9 +24,6 @@ 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", defaultPluginDir, "plugins directory")
-
-	completion.FlagFilenameCompletion(verifyCMD, configFlagName)
-	completion.FlagDirnameCompletion(verifyCMD, pluginDirFlagName)
+	addFlagConfigFile(verifyCMD)
+	addFlagPluginDir(verifyCMD)
 }

docs/best-practices/gitops.md

@@ -211,7 +211,7 @@ export DOCKERHUB_TOKEN="YOUR_DOCKERHUB_TOKEN_HERE"
 Run:
 
 ```bash
-./dtm init
+./dtm init -f config.yaml
 ```
 
 This downloads the required plugins, according to the config file, automatically.
@@ -233,7 +233,7 @@ You'll get some outputs similar to the following:
 Run:
 
 ```bash
-./dtm apply -y
+./dtm apply -f config.yaml -y
 ```
 
 You will see similar outputs as the following:
@@ -332,7 +332,7 @@ And accesses `localhost:8080` in your browser, you can see the deployed app retu
 Run:
 
 ```bash
-./dtm delete -y
+./dtm delete -f config.yaml -y
 ```
 
 And you will get similar outputs to the following:

docs/best-practices/gitops.zh.md

@@ -210,7 +210,7 @@ export DOCKERHUB_TOKEN="YOUR_DOCKERHUB_TOKEN_HERE"
 运行以下命令，以根据配置文件自动下载所需插件：
 
 ```bash
-./dtm init
+./dtm init -f config.yaml
 ```
 
 你会看到类似下面的输出：
@@ -230,7 +230,7 @@ export DOCKERHUB_TOKEN="YOUR_DOCKERHUB_TOKEN_HERE"
 运行：
 
 ```bash
-./dtm apply -y
+./dtm apply -f config.yaml -y
 ```
 
 你会看到类似下面的输出：
@@ -329,7 +329,7 @@ kubectl port-forward -n default svc/helloworld 8080:80
 运行：
 
 ```bash
-./dtm delete -y
+./dtm delete -f config.yaml -y
 ```
 
 你会看到如下的输出：