Change how config file path is initialized

silvanocerza · silvanocerza · commit 8feb7ccbdc0d · 2020-10-01T13:08:37.000+02:00
diff --git a/cli/config/dump.go b/cli/config/dump.go
@@ -18,7 +18,6 @@ package config
 import (
 	"os"
 
-	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -60,21 +59,5 @@ func (dr dumpResult) String() string {
 
 func runDumpCommand(cmd *cobra.Command, args []string) {
 	logrus.Info("Executing `arduino config dump`")
-
-	configFlag := cmd.InheritedFlags().Lookup("config-file")
-	configFile := ""
-	if configFlag != nil {
-		configFile = configFlag.Value.String()
-	}
-
-	if configFile != "" {
-		viper.SetConfigFile(configFile)
-		err := viper.MergeInConfig()
-		if err != nil {
-			feedback.Errorf("Error reading config file: %s", configFile)
-			os.Exit(errorcodes.ErrBadArgument)
-		}
-	}
-
 	feedback.PrintResult(dumpResult{viper.AllSettings()})
 }
diff --git a/cli/config/init.go b/cli/config/init.go
@@ -26,8 +26,11 @@ import (
 	"github.com/spf13/viper"
 )
 
-var destDir string
-var overwrite bool
+var (
+	destDir   string
+	destFile  string
+	overwrite bool
+)
 
 const defaultFileName = "arduino-cli.yaml"
 
@@ -38,25 +41,21 @@ func initInitCommand() *cobra.Command {
 		Long:  "Creates or updates the configuration file in the data directory or custom directory with the current configuration settings.",
 		Example: "" +
 			"  # Writes current configuration to the configuration file in the data directory.\n" +
-			"  " + os.Args[0] + " config init",
+			"  " + os.Args[0] + " config init" +
+			"  " + os.Args[0] + " config init --dest-dir /home/user/MyDirectory" +
+			"  " + os.Args[0] + " config init --dest-file /home/user/MyDirectory/my_settings.yaml",
 		Args: cobra.NoArgs,
 		Run:  runInitCommand,
 	}
 	initCommand.Flags().StringVar(&destDir, "dest-dir", "", "Sets where to save the configuration file.")
+	initCommand.Flags().StringVar(&destFile, "dest-file", "", "Sets where to save the configuration file.")
 	initCommand.Flags().BoolVar(&overwrite, "overwrite", false, "Overwrite existing config file.")
 	return initCommand
 }
 
 func runInitCommand(cmd *cobra.Command, args []string) {
-	configFlag := cmd.InheritedFlags().Lookup("config-file")
-	configFilePath := ""
-
-	if configFlag != nil {
-		configFilePath = configFlag.Value.String()
-	}
-
-	if configFilePath != "" && destDir != "" {
-		feedback.Errorf("Can't use both --config-file and --dest-dir flags at the same time.")
+	if destFile != "" && destDir != "" {
+		feedback.Errorf("Can't use both --dest-file and --dest-dir flags at the same time.")
 		os.Exit(errorcodes.ErrGeneric)
 	}
 
@@ -65,8 +64,8 @@ func runInitCommand(cmd *cobra.Command, args []string) {
 	var err error
 
 	switch {
-	case configFilePath != "":
-		configFileAbsPath, err = paths.New(configFilePath).Abs()
+	case destFile != "":
+		configFileAbsPath, err = paths.New(destFile).Abs()
 		if err != nil {
 			feedback.Errorf("Cannot find absolute path: %v", err)
 			os.Exit(errorcodes.ErrGeneric)
diff --git a/commands/daemon/settings_test.go b/commands/daemon/settings_test.go
@@ -18,6 +18,7 @@ package daemon
 import (
 	"context"
 	"encoding/json"
+	"path/filepath"
 	"testing"
 
 	"github.com/spf13/viper"
@@ -30,12 +31,12 @@ import (
 var svc = SettingsService{}
 
 func init() {
-	configuration.Init("testdata")
+	configuration.Init(filepath.Join("testdata", "arduino-cli.yaml"))
 }
 
 func reset() {
 	viper.Reset()
-	configuration.Init("testdata")
+	configuration.Init(filepath.Join("testdata", "arduino-cli.yaml"))
 }
 
 func TestGetAll(t *testing.T) {
diff --git a/configuration/configuration.go b/configuration/configuration.go
@@ -35,15 +35,21 @@ import (
 func Init(configPath string) {
 	// Config file metadata
 	jww.SetStdoutThreshold(jww.LevelFatal)
-	viper.SetConfigName("arduino-cli")
+
+	configDir := paths.New(configPath)
+	if configDir != nil && !configDir.IsDir() {
+		viper.SetConfigName(strings.TrimSuffix(configDir.Base(), configDir.Ext()))
+	} else {
+		viper.SetConfigName("arduino-cli")
+	}
 
 	// Get default data path if none was provided
 	if configPath == "" {
 		configPath = getDefaultArduinoDataDir()
 	}
 
 	// Add paths where to search for a config file
-	viper.AddConfigPath(configPath)
+	viper.AddConfigPath(filepath.Dir(configPath))
 
 	// Bind env vars
 	viper.SetEnvPrefix("ARDUINO")
@@ -185,23 +191,37 @@ func IsBundledInDesktopIDE() bool {
 }
 
 // FindConfigFile returns the config file path using the argument '--config-file' if specified or via the current working dir
-func FindConfigFile() string {
-
+func FindConfigFile(args []string) string {
 	configFile := ""
-	for i, arg := range os.Args {
+	for i, arg := range args {
 		// 0 --config-file ss
 		if arg == "--config-file" {
-			if len(os.Args) > i+1 {
-				configFile = os.Args[i+1]
+			if len(args) > i+1 {
+				configFile = args[i+1]
 			}
 		}
 	}
 
 	if configFile != "" {
-		return filepath.Dir(configFile)
+		return configFile
+	}
+
+	return searchCwdForConfig()
+}
+
+func searchCwdForConfig() string {
+	cwd, err := os.Getwd()
+
+	if err != nil {
+		return ""
+	}
+
+	configFile := searchConfigTree(cwd)
+	if configFile == "" {
+		return configFile
 	}
 
-	return ""
+	return configFile + string(os.PathSeparator) + "arduino-cli.yaml"
 }
 
 func searchConfigTree(cwd string) string {
diff --git a/configuration/configuration_test.go b/configuration/configuration_test.go
@@ -71,3 +71,40 @@ func BenchmarkSearchConfigTree(b *testing.B) {
 	}
 	result = s
 }
+
+func TestFindConfigFile(t *testing.T) {
+	configFile := FindConfigFile([]string{"--config-file"})
+	require.Equal(t, "", configFile)
+
+	configFile = FindConfigFile([]string{"--config-file", "some/path/to/config"})
+	require.Equal(t, "some/path/to/config", configFile)
+
+	configFile = FindConfigFile([]string{"--config-file", "some/path/to/config/arduino-cli.yaml"})
+	require.Equal(t, "some/path/to/config/arduino-cli.yaml", configFile)
+
+	configFile = FindConfigFile([]string{})
+	require.Equal(t, "", configFile)
+
+	// Create temporary directories
+	tmp := tmpDirOrDie()
+	defer os.RemoveAll(tmp)
+	target := filepath.Join(tmp, "foo", "bar", "baz")
+	os.MkdirAll(target, os.ModePerm)
+	require.Nil(t, os.Chdir(target))
+
+	// Create a config file
+	f, err := os.Create(filepath.Join(target, "..", "..", "arduino-cli.yaml"))
+	require.Nil(t, err)
+	f.Close()
+
+	configFile = FindConfigFile([]string{})
+	require.Equal(t, filepath.Join(tmp, "foo", "arduino-cli.yaml"), configFile)
+
+	// Create another config file
+	f, err = os.Create(filepath.Join(target, "arduino-cli.yaml"))
+	require.Nil(t, err)
+	f.Close()
+
+	configFile = FindConfigFile([]string{})
+	require.Equal(t, filepath.Join(target, "arduino-cli.yaml"), configFile)
+}
diff --git a/main.go b/main.go
@@ -25,7 +25,7 @@ import (
 )
 
 func main() {
-	configuration.Init(configuration.FindConfigFile())
+	configuration.Init(configuration.FindConfigFile(os.Args))
 	i18n.Init()
 	arduinoCmd := cli.NewCommand()
 	if err := arduinoCmd.Execute(); err != nil {
diff --git a/test/test_config.py b/test/test_config.py
@@ -62,15 +62,15 @@ def test_init_dest_flag_with_overwrite_flag(run_command, working_dir):
 
 
 def test_init_dest_and_config_file_flags(run_command, working_dir):
-    result = run_command('config init --config-file "some_other_path" --dest-dir "some_path"')
+    result = run_command('config init --dest-file "some_other_path" --dest-dir "some_path"')
     assert result.failed
-    assert "Can't use both --config-file and --dest-dir flags at the same time." in result.stderr
+    assert "Can't use both --dest-file and --dest-dir flags at the same time." in result.stderr
 
 
 def test_init_config_file_flag_absolute_path(run_command, working_dir):
     config_file = Path(working_dir) / "config" / "test" / "config.yaml"
     assert not config_file.exists()
-    result = run_command(f'config init --config-file "{config_file}"')
+    result = run_command(f'config init --dest-file "{config_file}"')
     assert result.ok
     assert str(config_file) in result.stdout
     assert config_file.exists()
@@ -79,7 +79,7 @@ def test_init_config_file_flag_absolute_path(run_command, working_dir):
 def test_init_config_file_flag_relative_path(run_command, working_dir):
     config_file = Path(working_dir) / "config.yaml"
     assert not config_file.exists()
-    result = run_command('config init --config-file "config.yaml"')
+    result = run_command('config init --dest-file "config.yaml"')
     assert result.ok
     assert str(config_file) in result.stdout
     assert config_file.exists()
@@ -89,15 +89,15 @@ def test_init_config_file_flag_with_overwrite_flag(run_command, working_dir):
     config_file = Path(working_dir) / "config" / "test" / "config.yaml"
     assert not config_file.exists()
 
-    result = run_command(f'config init --config-file "{config_file}"')
+    result = run_command(f'config init --dest-file "{config_file}"')
     assert result.ok
     assert config_file.exists()
 
-    result = run_command(f'config init --config-file "{config_file}"')
+    result = run_command(f'config init --dest-file "{config_file}"')
     assert result.failed
     assert "Config file already exists, use --overwrite to discard the existing one." in result.stderr
 
-    result = run_command(f'config init --config-file "{config_file}" --overwrite')
+    result = run_command(f'config init --dest-file "{config_file}" --overwrite')
     assert result.ok
     assert str(config_file) in result.stdout
 
@@ -106,7 +106,7 @@ def test_dump(run_command, working_dir):
     # Create a config file first
     config_file = Path(working_dir) / "config" / "test" / "config.yaml"
     assert not config_file.exists()
-    result = run_command(f'config init --config-file "{config_file}"')
+    result = run_command(f'config init --dest-file "{config_file}"')
     assert result.ok
     assert config_file.exists()
 
@@ -120,7 +120,7 @@ def test_dump_with_config_file_flag(run_command, working_dir):
     # Create a config file first
     config_file = Path(working_dir) / "config" / "test" / "config.yaml"
     assert not config_file.exists()
-    result = run_command(f'config init --config-file "{config_file}" --additional-urls=https://example.com')
+    result = run_command(f'config init --dest-file "{config_file}" --additional-urls=https://example.com')
     assert result.ok
     assert config_file.exists()
 

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ import (`
`25`	`25`	`)`
`26`	`26`
`27`	`27`	`func main() {`
`28`		`- configuration.Init(configuration.FindConfigFile())`
	`28`	`+ configuration.Init(configuration.FindConfigFile(os.Args))`
`29`	`29`	`i18n.Init()`
`30`	`30`	`arduinoCmd := cli.NewCommand()`
`31`	`31`	`if err := arduinoCmd.Execute(); err != nil {`