Merge pull request #3 from yoanbernabeu/use-config-file

📦 NEW: Configure with file

Author: yoanbernabeu

.gitignore

@@ -1 +1,2 @@
 *.json
+.env

README.md

@@ -48,44 +48,53 @@ go build -o GoJelastic
 * URL: Your Jelastic API URL
 * NODEID: The unique ID of the node/container
 
+### Configure Environment into a file
+
+If you want to use the CLI without passing the token and the URL each time, you can configure it into a file (stored in your home directory in a file named `gojelastic.env`)
+
+
+```bash
+GoJelastic configure --token <TOKEN> --url <URL>
+```
+
 ### Get Environment Info
 
 Get informations about one environment
 
 ```bash
-./GoJelastic getEnv --appid <APPID> --token <TOKEN> --url <URL>
+GoJelastic getEnv --appid <APPID>
 ```
 
 ### Get Environments Info
 
 Get informations about all environments
 
 ```bash
-./GoJelastic getEnvs --token <TOKEN> --url <URL>
+GoJelastic getEnvs
 ```
 
 ### Start Environment
 
 Start an environment
 
 ```bash
-./GoJelastic startEnv --appid <APPID> --token <TOKEN> --url <URL>
+GoJelastic startEnv --appid <APPID>
 ```
 
 ### Stop Environment
 
 Stop an environment
 
 ```bash
-./GoJelastic stopEnv --appid <APPID> --token <TOKEN> --url <URL>
+GoJelastic stopEnv --appid <APPID>
 ```
 
 ### Redeploy Container by ID
 
 Redeploy a container by ID and target tag
 
 ```bash
-./GoJelastic redeployEnv --nodeid <NODEID> --tag <TAG> --appid <APPID> --token <TOKEN> --url <URL>
+GoJelastic redeployEnv --nodeid <NODEID> --tag <TAG> --appid <APPID>
 ```
 
 ## License

cmd/configure.go

@@ -0,0 +1,22 @@
+package cmd
+
+import (
+	"github.com/spf13/cobra"
+)
+
+func init() {
+	rootCmd.AddCommand(configure)
+	configure.Flags().String("token", "", "Your Jelastic token")
+	configure.Flags().String("url", "", "Your Jelastic url")
+	configure.MarkFlagRequired("token")
+	configure.MarkFlagRequired("url")
+}
+
+var configure = &cobra.Command{
+	Use:   "configure",
+	Short: "Configure your Jelastic account",
+	Long:  "Configure your Jelastic account",
+	Run: func(cmd *cobra.Command, args []string) {
+		writeConfig(cmd.Flags().Lookup("url").Value.String(), cmd.Flags().Lookup("token").Value.String())
+	},
+}

cmd/jelastic.go

@@ -10,45 +10,25 @@ import (
 
 func init() {
 	rootCmd.AddCommand(getEnvsCmd)
-	getEnvsCmd.Flags().String("token", "", "A token is required")
-	getEnvsCmd.Flags().String("url", "", "A url is required")
-	getEnvsCmd.MarkFlagRequired("token")
-	getEnvsCmd.MarkFlagRequired("url")
 
 	rootCmd.AddCommand(getEnvCmd)
-	getEnvCmd.Flags().String("token", "", "A token is required")
-	getEnvCmd.Flags().String("url", "", "A url is required")
 	getEnvCmd.Flags().String("appid", "", "An appid is required")
 	getEnvCmd.MarkFlagRequired("appid")
-	getEnvCmd.MarkFlagRequired("token")
-	getEnvCmd.MarkFlagRequired("url")
 
 	rootCmd.AddCommand(startEnvCmd)
-	startEnvCmd.Flags().String("token", "", "A token is required")
-	startEnvCmd.Flags().String("url", "", "A url is required")
 	startEnvCmd.Flags().String("appid", "", "An appid is required")
 	startEnvCmd.MarkFlagRequired("appid")
-	startEnvCmd.MarkFlagRequired("token")
-	startEnvCmd.MarkFlagRequired("url")
 
 	rootCmd.AddCommand(stopEnvCmd)
-	stopEnvCmd.Flags().String("token", "", "A token is required")
-	stopEnvCmd.Flags().String("url", "", "A url is required")
 	stopEnvCmd.Flags().String("appid", "", "An appid is required")
 	stopEnvCmd.MarkFlagRequired("appid")
-	stopEnvCmd.MarkFlagRequired("token")
-	stopEnvCmd.MarkFlagRequired("url")
 
 	rootCmd.AddCommand(redeployContainerByIdCmd)
-	redeployContainerByIdCmd.Flags().String("token", "", "A token is required")
-	redeployContainerByIdCmd.Flags().String("url", "", "A url is required")
 	redeployContainerByIdCmd.Flags().String("nodeid", "", "An nodeid is required")
 	redeployContainerByIdCmd.Flags().String("tag", "", "An tag is required")
 	redeployContainerByIdCmd.Flags().String("appid", "", "An appid is required")
 	redeployContainerByIdCmd.MarkFlagRequired("nodeid")
 	redeployContainerByIdCmd.MarkFlagRequired("tag")
-	redeployContainerByIdCmd.MarkFlagRequired("token")
-	redeployContainerByIdCmd.MarkFlagRequired("url")
 	redeployContainerByIdCmd.MarkFlagRequired("appid")
 }
 

cmd/root.go

@@ -1,13 +1,15 @@
 /*
-Copyright © 2022 NAME HERE <EMAIL ADDRESS>
+Copyright © 2022 Yoan BERNABEU <yoan.bernabeu@gmail.com>
 
 */
 package cmd
 
 import (
+	"fmt"
 	"os"
 
 	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
 )
 
 // rootCmd represents the base command when called without any subcommands
@@ -30,13 +32,54 @@ func Execute() {
 }
 
 func init() {
-	// Here you will define your flags and configuration settings.
-	// Cobra supports persistent flags, which, if defined here,
-	// will be global for your application.
+	config := initConfig()
 
-	// rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.GoCronify.yaml)")
+	if config["token"] != nil {
+		rootCmd.PersistentFlags().String("token", config["token"].(string), "A token is required")
+	} else {
+		rootCmd.PersistentFlags().String("token", "", "A token is required")
+		rootCmd.MarkPersistentFlagRequired("token")
+	}
+
+	if config["url"] != nil {
+		rootCmd.PersistentFlags().String("url", config["url"].(string), "A url is required")
+	} else {
+		rootCmd.PersistentFlags().String("url", "", "A url is required")
+		rootCmd.MarkPersistentFlagRequired("url")
+	}
 
-	// Cobra also supports local flags, which will only run
-	// when this action is called directly.
 	rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
 }
+
+// initConfig reads in config file and ENV variables if set.
+func initConfig() map[string]interface{} {
+	// Don't forget to read config either from cfgFile or from home directory!
+	viper.SetConfigType("env")
+	viper.SetConfigName("gojelastic.env") // name of config file (without extension)
+	viper.AddConfigPath("$HOME")          // adding home directory as first search path
+	viper.AutomaticEnv()                  // read in environment variables that match
+
+	// If a config file is found, read it in.
+	if err := viper.ReadInConfig(); err == nil {
+		fmt.Println("Using config file:", viper.ConfigFileUsed())
+	} else {
+		fmt.Println("No config file found")
+	}
+
+	return viper.AllSettings()
+}
+
+//writeConfig writes config file and ENV variables if set.
+func writeConfig(url string, token string) {
+	viper.SetConfigType("env")
+	viper.SetConfigName("gojelastic") // name of config file (without extension)
+	viper.AddConfigPath("$HOME")      // adding home directory as first search path
+	viper.AutomaticEnv()              // read in environment variables that match
+
+	viper.Set("url", url)
+	viper.Set("token", token)
+
+	viper.WriteConfig()
+
+	fmt.Println("Config file written or updated")
+}

go.mod

@@ -5,6 +5,22 @@ go 1.18
 require github.com/spf13/cobra v1.6.1
 
 require (
+	github.com/fsnotify/fsnotify v1.6.0 // indirect
+	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/inconshreveable/mousetrap v1.0.1 // indirect
+	github.com/magiconair/properties v1.8.6 // indirect
+	github.com/mitchellh/mapstructure v1.5.0 // indirect
+	github.com/pelletier/go-toml v1.9.5 // indirect
+	github.com/pelletier/go-toml/v2 v2.0.5 // indirect
+	github.com/spf13/afero v1.9.2 // indirect
+	github.com/spf13/cast v1.5.0 // indirect
+	github.com/spf13/jwalterweatherman v1.1.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/spf13/viper v1.14.0 // indirect
+	github.com/subosito/gotenv v1.4.1 // indirect
+	golang.org/x/sys v0.0.0-20220908164124-27713097b956 // indirect
+	golang.org/x/text v0.4.0 // indirect
+	gopkg.in/ini.v1 v1.67.0 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )