Merge tag '0.3.6-alpha.preview' into daemon

Release 0.3.6-alpha.preview

Author: cmaglie

.cli-config_example.yml

@@ -3,5 +3,5 @@
 /main
 /.vscode/settings.json
 /cmd/formatter/debug.test
-/.cli-config.yml
+/arduino-cli.yaml
 /wiki

.gitignore

@@ -17,7 +17,7 @@ This is **not yet available** until the first stable version is released.
 #### Download the latest unstable "alpha" preview
 
 Please note that these are **preview** build, they may have bugs, some features may not work or may be changed without notice,
-the latest preview version is `0.3.4-alpha.preview`:
+the latest preview version is `0.3.6-alpha.preview`:
 
 - [Linux 64 bit](https://downloads.arduino.cc/arduino-cli/arduino-cli-latest-linux64.tar.bz2)
 - [Linux 32 bit](https://downloads.arduino.cc/arduino-cli/arduino-cli-latest-linux32.tar.bz2)
@@ -26,7 +26,7 @@ the latest preview version is `0.3.4-alpha.preview`:
 - [Windows](https://downloads.arduino.cc/arduino-cli/arduino-cli-latest-windows.zip)
 - [Mac OSX](https://downloads.arduino.cc/arduino-cli/arduino-cli-latest-osx.zip)
 
-Once downloaded, place the executable into a directory which is in your `PATH` environment variable. To use the tool as it is presented in the Getting started guide below (`arduino-cli`), you should rename the executable from _arduino-cli-0.2.2-alpha.preview-XYZ_ to _arduino-cli_.
+Once downloaded, place the executable into a directory which is in your `PATH` environment variable. To use the tool as it is presented in the Getting started guide below (`arduino-cli`), you should rename the executable from _arduino-cli-X.Y.Z-alpha.preview-XYZ_ to _arduino-cli_.
 
 ### Build the latest "bleeding-edge" from source
 
@@ -165,7 +165,7 @@ and the Board Name look good, we are ready to compile and upload the sketch
 
 #### Adding 3rd party cores
 
-To add 3rd party core packages add a link of the additional package to the file `.cli-config.yml`
+To add 3rd party core packages add a link of the additional package to the file `arduino-cli.yaml`
 
 If you want to add the ESP8266 core, for example:
 
@@ -174,9 +174,9 @@ If you want to add the ESP8266 core, for example:
         - http://arduino.esp8266.com/stable/package_esp8266com_index.json
 
 And then run:
-  
- arduino-cli core update-index
-arduino-cli core install esp8266:esp8266
+
+    arduino-cli core update-index
+    arduino-cli core install esp8266:esp8266
 
 ### Step 5. Compile the sketch
 
@@ -303,7 +303,7 @@ Flags:
   -h, --help   help for core
 
 Global Flags:
-      --config-file string   The custom config file (if not specified ./.cli-config.yml will be used). (default "/home/megabug/Workspace/go/src/github.com/arduino/arduino-cli/.cli-config.yml")
+      --config-file string   The custom config file (if not specified the default one will be used).
       --debug                Enables debug output (super verbose, used to debug the CLI).
       --format string        The output format, can be [text|json]. (default "text")
 

Gopkg.lock

@@ -49,7 +49,7 @@ const (
 )
 
 // Version is the current CLI version
-var Version = "0.3.4-alpha.preview"
+var Version = "0.3.6-alpha.preview"
 
 // ErrLogrus represents the logrus instance, which has the role to
 // log all non info messages.

README.md

@@ -74,6 +74,15 @@ func executeWithArgs(t *testing.T, args ...string) (int, []byte) {
 
 	// This closure is here because we won't that the defer are executed after the end of the "executeWithArgs" method
 	func() {
+		// Create an empty config for the CLI test
+		conf := paths.New("arduino-cli.yaml")
+		require.False(t, conf.Exist())
+		err := conf.WriteFile([]byte("board_manager:\n  additional_urls:\n"))
+		require.NoError(t, err)
+		defer func() {
+			require.NoError(t, conf.Remove())
+		}()
+
 		redirect := &stdOutRedirect{}
 		redirect.Open(t)
 		defer func() {
@@ -512,27 +521,33 @@ func TestCompileCommands(t *testing.T) {
 	require.True(t, paths.New(test1).Join("Test1.arduino.avr.nano.hex").Exist())
 
 	// Build sketch with --output path
-	require.NoError(t, os.Chdir(tmp))
-	exitCode, d = executeWithArgs(t, "compile", "-b", "arduino:avr:nano", "-o", "test", test1)
-	require.Zero(t, exitCode, "exit code")
-	require.Contains(t, string(d), "Sketch uses")
-	require.True(t, paths.New("test.hex").Exist())
-
-	exitCode, d = executeWithArgs(t, "compile", "-b", "arduino:avr:nano", "-o", "test2.hex", test1)
-	require.Zero(t, exitCode, "exit code")
-	require.Contains(t, string(d), "Sketch uses")
-	require.True(t, paths.New("test2.hex").Exist())
-	require.NoError(t, paths.New(tmp, "anothertest").MkdirAll())
-
-	exitCode, d = executeWithArgs(t, "compile", "-b", "arduino:avr:nano", "-o", "anothertest/test", test1)
-	require.Zero(t, exitCode, "exit code")
-	require.Contains(t, string(d), "Sketch uses")
-	require.True(t, paths.New("anothertest", "test.hex").Exist())
-
-	exitCode, d = executeWithArgs(t, "compile", "-b", "arduino:avr:nano", "-o", tmp+"/anothertest/test2", test1)
-	require.Zero(t, exitCode, "exit code")
-	require.Contains(t, string(d), "Sketch uses")
-	require.True(t, paths.New("anothertest", "test2.hex").Exist())
+	{
+		pwd, err := os.Getwd()
+		require.NoError(t, err)
+		defer func() { require.NoError(t, os.Chdir(pwd)) }()
+		require.NoError(t, os.Chdir(tmp))
+
+		exitCode, d = executeWithArgs(t, "compile", "-b", "arduino:avr:nano", "-o", "test", test1)
+		require.Zero(t, exitCode, "exit code")
+		require.Contains(t, string(d), "Sketch uses")
+		require.True(t, paths.New("test.hex").Exist())
+
+		exitCode, d = executeWithArgs(t, "compile", "-b", "arduino:avr:nano", "-o", "test2.hex", test1)
+		require.Zero(t, exitCode, "exit code")
+		require.Contains(t, string(d), "Sketch uses")
+		require.True(t, paths.New("test2.hex").Exist())
+		require.NoError(t, paths.New(tmp, "anothertest").MkdirAll())
+
+		exitCode, d = executeWithArgs(t, "compile", "-b", "arduino:avr:nano", "-o", "anothertest/test", test1)
+		require.Zero(t, exitCode, "exit code")
+		require.Contains(t, string(d), "Sketch uses")
+		require.True(t, paths.New("anothertest", "test.hex").Exist())
+
+		exitCode, d = executeWithArgs(t, "compile", "-b", "arduino:avr:nano", "-o", tmp+"/anothertest/test2", test1)
+		require.Zero(t, exitCode, "exit code")
+		require.Contains(t, string(d), "Sketch uses")
+		require.True(t, paths.New("anothertest", "test2.hex").Exist())
+	}
 }
 
 func TestInvalidCoreURL(t *testing.T) {
@@ -544,7 +559,7 @@ func TestInvalidCoreURL(t *testing.T) {
 	require.NoError(t, err, "making temporary dir")
 	defer tmp.RemoveAll()
 
-	configFile := tmp.Join("cli-config.yml")
+	configFile := tmp.Join("arduino-cli.yaml")
 	err = configFile.WriteFile([]byte(`
 board_manager:
   additional_urls:

cli/cli.go

@@ -18,6 +18,7 @@
 package root
 
 import (
+	"fmt"
 	"io/ioutil"
 	"os"
 
@@ -30,7 +31,6 @@ import (
 	"github.com/arduino/arduino-cli/cli/upload"
 	"github.com/arduino/arduino-cli/commands/config"
 	"github.com/arduino/arduino-cli/commands/generatedocs"
-
 	"github.com/arduino/arduino-cli/commands/sketch"
 	"github.com/arduino/arduino-cli/commands/version"
 	"github.com/arduino/arduino-cli/common/formatter"
@@ -53,7 +53,7 @@ func Init() *cobra.Command {
 	}
 	command.PersistentFlags().BoolVar(&cli.GlobalFlags.Debug, "debug", false, "Enables debug output (super verbose, used to debug the CLI).")
 	command.PersistentFlags().StringVar(&outputFormat, "format", "text", "The output format, can be [text|json].")
-	command.PersistentFlags().StringVar(&yamlConfigFile, "config-file", "", "The custom config file (if not specified ./.cli-config.yml will be used).")
+	command.PersistentFlags().StringVar(&yamlConfigFile, "config-file", "", "The custom config file (if not specified the default will be used).")
 	command.AddCommand(board.InitCommand())
 	command.AddCommand(compile.InitCommand())
 	command.AddCommand(config.InitCommand())
@@ -117,6 +117,7 @@ func preRun(cmd *cobra.Command, args []string) {
 
 // initConfigs initializes the configuration from the specified file.
 func initConfigs() {
+	// Start with default configuration
 	if conf, err := configs.NewConfiguration(); err != nil {
 		logrus.WithError(err).Error("Error creating default configuration")
 		formatter.PrintError(err, "Error creating default configuration")
@@ -125,14 +126,12 @@ func initConfigs() {
 		cli.Config = conf
 	}
 
-	if yamlConfigFile != "" {
-		cli.Config.ConfigFile = paths.New(yamlConfigFile)
+	// Read configuration from global config file
+	logrus.Info("Checking for config file in: " + cli.Config.ConfigFile.String())
+	if cli.Config.ConfigFile.Exist() {
+		readConfigFrom(cli.Config.ConfigFile)
 	}
 
-	logrus.Info("Initiating configuration")
-	if err := cli.Config.LoadFromYAML(cli.Config.ConfigFile); err != nil {
-		logrus.WithError(err).Warn("Did not manage to get config file, using default configuration")
-	}
 	if cli.Config.IsBundledInDesktopIDE() {
 		logrus.Info("CLI is bundled into the IDE")
 		err := cli.Config.LoadFromDesktopIDEPreferences()
@@ -142,6 +141,43 @@ func initConfigs() {
 	} else {
 		logrus.Info("CLI is not bundled into the IDE")
 	}
+
+	// Read configuration from parent folders (project config)
+	if pwd, err := paths.Getwd(); err != nil {
+		logrus.WithError(err).Warn("Did not manage to find current path")
+		if path := paths.New("arduino-cli.yaml"); path.Exist() {
+			readConfigFrom(path)
+		}
+	} else {
+		cli.Config.Navigate(pwd)
+	}
+
+	// Read configuration from old configuration file if found, but output a warning.
+	if old := paths.New(".cli-config.yml"); old.Exist() {
+		logrus.Errorf("Old configuration file detected: %s.", old)
+		logrus.Info("The name of this file has been changed to `arduino-cli.yaml`, please rename the file fix it.")
+		formatter.PrintError(
+			fmt.Errorf("WARNING: Old configuration file detected: %s", old),
+			"The name of this file has been changed to `arduino-cli.yaml`, in a future release we will not support"+
+				"the old name `.cli-config.yml` anymore. Please rename the file to `arduino-cli.yaml` to silence this warning.")
+		readConfigFrom(old)
+	}
+
+	// Read configuration from environment vars
 	cli.Config.LoadFromEnv()
+
+	// Read configuration from user specified file
+	if yamlConfigFile != "" {
+		cli.Config.ConfigFile = paths.New(yamlConfigFile)
+		readConfigFrom(cli.Config.ConfigFile)
+	}
+
 	logrus.Info("Configuration set")
 }
+
+func readConfigFrom(path *paths.Path) {
+	logrus.Infof("Reading configuration from %s", path)
+	if err := cli.Config.LoadFromYAML(path); err != nil {
+		logrus.WithError(err).Warnf("Could not read configuration from %s", path)
+	}
+}

cli/cli_test.go

@@ -42,7 +42,7 @@ func initInitCommand() *cobra.Command {
 	initCommand.Flags().BoolVar(&initFlags._default, "default", false,
 		"If omitted, ask questions to the user about setting configuration properties, otherwise use default configuration.")
 	initCommand.Flags().StringVar(&initFlags.location, "save-as", "",
-		"Sets where to save the configuration file [default is ./.cli-config.yml].")
+		"Sets where to save the configuration file [default is ./arduino-cli.yaml].")
 	return initCommand
 }
 
@@ -65,8 +65,13 @@ func runInitCommand(cmd *cobra.Command, args []string) {
 	if filepath == "" {
 		filepath = cli.Config.ConfigFile.String()
 	}
-	err := cli.Config.SaveToYAML(filepath)
-	if err != nil {
+
+	if err := cli.Config.ConfigFile.Parent().MkdirAll(); err != nil {
+		formatter.PrintError(err, "Cannot create config file.")
+		os.Exit(cli.ErrGeneric)
+	}
+
+	if err := cli.Config.SaveToYAML(filepath); err != nil {
 		formatter.PrintError(err, "Cannot create config file.")
 		os.Exit(cli.ErrGeneric)
 	}

cli/root/root.go

@@ -19,23 +19,37 @@ package configs
 
 import (
 	"fmt"
-	"os"
 	"os/user"
 	"runtime"
 
 	"github.com/arduino/go-paths-helper"
-
 	"github.com/arduino/go-win32-utils"
 )
 
-// getDefaultConfigFilePath returns the default path for .cli-config.yml,
-// this is the directory where the arduino-cli executable resides.
+// getDefaultConfigFilePath returns the default path for arduino-cli.yaml
 func getDefaultConfigFilePath() *paths.Path {
-	executablePath, err := os.Executable()
+	usr, err := user.Current()
 	if err != nil {
-		executablePath = "."
+		panic(fmt.Errorf("retrieving user home dir: %s", err))
 	}
-	return paths.New(executablePath).Parent().Join(".cli-config.yml")
+	arduinoDataDir := paths.New(usr.HomeDir)
+
+	switch runtime.GOOS {
+	case "linux":
+		arduinoDataDir = arduinoDataDir.Join(".arduino15")
+	case "darwin":
+		arduinoDataDir = arduinoDataDir.Join("Library", "arduino15")
+	case "windows":
+		localAppDataPath, err := win32.GetLocalAppDataFolder()
+		if err != nil {
+			panic(err)
+		}
+		arduinoDataDir = paths.New(localAppDataPath).Join("Arduino15")
+	default:
+		panic(fmt.Errorf("unsupported OS: %s", runtime.GOOS))
+	}
+
+	return arduinoDataDir.Join("arduino-cli.yaml")
 }
 
 func getDefaultArduinoDataDir() (*paths.Path, error) {