second draft of configs (arduino#65)

Author: saniales

cmd/arduino.go

@@ -37,6 +37,7 @@ import (
 	"github.com/bcmi-labs/arduino-cli/cmd/formatter"
 	"github.com/bcmi-labs/arduino-cli/cmd/output"
 	"github.com/bcmi-labs/arduino-cli/common"
+	"github.com/bcmi-labs/arduino-cli/configs"
 	"github.com/spf13/cobra"
 )
 
@@ -119,6 +120,9 @@ func InitFlags() {
 	arduinoCoreListCmd.ResetFlags()
 	arduinoCoreVersionCmd.ResetFlags()
 
+	arduinoConfigCmd.ResetFlags()
+	arduinoConfigInitCmd.ResetFlags()
+
 	ArduinoCmd.PersistentFlags().CountVarP(&GlobalFlags.Verbose, "verbose", "v", "enables verbose output (use more times for a higher level)")
 	ArduinoCmd.PersistentFlags().StringVar(&GlobalFlags.Format, "format", "invalid", "the output format, can be [text|json]")
 	ArduinoCmd.PersistentFlags().StringVar(&GlobalFlags.Home, "home", "", "the custom home (if not specified $HOME will be used)")
@@ -128,21 +132,27 @@ func InitFlags() {
 	arduinoLibCmd.Flags().BoolVar(&arduinoLibFlags.updateIndex, "update-index", false, "Updates the libraries index")
 
 	arduinoCoreCmd.Flags().BoolVar(&arduinoCoreFlags.updateIndex, "update-index", false, "Updates the index of cores to the latest version")
+
+	arduinoConfigInitCmd.Flags().BoolVar(&arduinoConfigInitFlags.Default, "default", false, "If omitted, ask questions to the user about setting configuration properties, otherwise use default configuration")
+	arduinoConfigInitCmd.Flags().StringVar(&arduinoConfigInitFlags.Location, "location", configs.DefaultLocation)
 }
 
 // InitCommands reinitialize commands (useful for testing too)
 func InitCommands() {
 	ArduinoCmd.ResetCommands()
 	arduinoLibCmd.ResetCommands()
 	arduinoCoreCmd.ResetCommands()
+	arduinoConfigCmd.ResetCommands()
 
-	ArduinoCmd.AddCommand(arduinoVersionCmd, arduinoLibCmd, arduinoCoreCmd)
+	ArduinoCmd.AddCommand(arduinoVersionCmd, arduinoLibCmd, arduinoCoreCmd, arduinoConfigCmd)
 
 	arduinoLibCmd.AddCommand(arduinoLibInstallCmd, arduinoLibUninstallCmd, arduinoLibSearchCmd,
 		arduinoLibVersionCmd, arduinoLibListCmd, arduinoLibDownloadCmd)
 
 	arduinoCoreCmd.AddCommand(arduinoCoreListCmd, arduinoCoreDownloadCmd, arduinoCoreVersionCmd,
 		arduinoCoreInstallCmd)
+
+	arduinoConfigCmd.AddCommand(arduinoConfigInitCmd)
 }
 
 func arduinoPreRun(cmd *cobra.Command, args []string) {

cmd/arduino_config.go

@@ -0,0 +1,77 @@
+/*
+ * This file is part of arduino-cli.
+ *
+ * arduino-cli is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2017 BCMI LABS SA (http://www.arduino.cc/)
+ */
+
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/bcmi-labs/arduino-cli/cmd/formatter"
+	"github.com/bcmi-labs/arduino-cli/configs"
+	"github.com/spf13/cobra"
+)
+
+var arduinoConfigCmd = &cobra.Command{
+	Use:     `config`,
+	Short:   `Configuration Commands`,
+	Long:    `Configuration Commands`,
+	Example: `arduino config init # Initializes a new config file into the default location`,
+}
+
+var arduinoConfigInitCmd = &cobra.Command{
+	Use:   `init`,
+	Short: `Initializes a new config file into the default location`,
+	Long:  `Initializes a new config file into the default location ($EXE_DIR/cli-config.yml)`,
+	Example: `arduino config init           # Creates a config file by asking questions to the user into the default location
+arduino config init --default # Creates a config file with default configuration into default location`,
+	Run: executeConfigInitCommand,
+}
+
+func executeConfigInitCommand(cmd *cobra.Command, args []string) {
+	var conf configs.Configs
+	if !arduinoConfigInitFlags.Default && formatter.IsCurrentFormat("text") {
+		conf = ConfigsFromQuestions()
+	} else {
+		conf = configs.Default()
+	}
+	err := conf.Serialize(arduinoConfigInitFlags.Location)
+	if err != nil {
+		formatter.PrintErrorMessage(fmt.Sprint("Config file creation error: ", err))
+	} else {
+		formatter.PrintResult("success")
+	}
+}
+
+// ConfigsFromQuestions asks some questions to the user to properly initialize configs.
+// It does not have much sense to use it in JSON formatting, though.
+func ConfigsFromQuestions() configs.Configs {
+	ret := configs.Default()
+	//Set of questions here
+	return ret
+}

cmd/flags.go

@@ -43,10 +43,16 @@ var rootCmdFlags struct {
 
 // arduinoLibFlags represents `arduino lib` flags.
 var arduinoLibFlags struct {
-	updateIndex bool
+	updateIndex bool // If true, update library index.
 }
 
 // arduinoCoreFlags represents `arduino core` flags.
 var arduinoCoreFlags struct {
-	updateIndex bool
+	updateIndex bool // If true, update package index.
+}
+
+// arduinoConfigInitFlags represents `arduino config init` flags.
+var arduinoConfigInitFlags struct {
+	Default  bool   // If false, ask questions to the user about setting configuration properties, otherwise use default configuration.
+	Location string // The custom location of the file to create.
 }

configs/configs.go

@@ -27,34 +27,51 @@
  * Copyright 2017 BCMI LABS SA (http://www.arduino.cc/)
  */
 
+/*
+ * Package configs contains all CLI configurations handling.
+ * It is done via a YAML file which can be in a custom location,
+ * but is defaulted to "$EXECUTABLE_DIR/cli-config.yaml"
+ */
 package configs
 
 import (
 	"io/ioutil"
 	"os"
+	"path/filepath"
 
 	"gopkg.in/yaml.v2"
 )
 
+// DefaultLocation represents the default location of the config file (same directory as executable)
+var DefaultLocation string
+
+func init() {
+	DefaultLocation, err := os.Getwd()
+	if err != nil {
+		DefaultLocation = "."
+	}
+	DefaultLocation = filepath.Join(DefaultLocation, "cli-config.yaml")
+}
+
 // Configs represents the possible configurations for the CLI.
 type Configs struct {
 	HTTPProxy      string `yaml:"HTTP_Proxy,omitempty"`
-	SketchBookPath string `yaml:"HTTP_Proxy,omitempty"`
+	SketchbookPath string `yaml:"sketchbook_path,omitempty"`
 	LibrariesPath  string `yaml:"HTTP_Proxy,omitempty"`
 	PackagesPath   string `yaml:"HTTP_Proxy,omitempty"`
 }
 
 // defaultConfig represents the default configuration.
 var defaultConfig = Configs{
 	HTTPProxy:      os.Getenv("HTTP_PROXY"),
-	SketchBookPath: "",
+	SketchbookPath: "",
 	LibrariesPath:  "",
 	PackagesPath:   "",
 }
 
 var envConfig = Configs{
 	HTTPProxy:      os.Getenv("HTTP_PROXY"),
-	SketchBookPath: os.Getenv("SKETCHBOOK_FOLDER"),
+	SketchbookPath: os.Getenv("SKETCHBOOK_FOLDER"),
 	LibrariesPath:  os.Getenv("LIBS_FOLDER"),
 	PackagesPath:   os.Getenv("PACKAGES_FOLDER"),
 }