Renamed function to better reflect his behaviour

arduino · cmaglie · Aug 2, 2024 · Jul 30, 2024 · Jul 30, 2024 · Jul 30, 2024
commit d72a2c2eb303c79c8f0a1ec7225d64b2929a9f2c
diff --git a/internal/cli/configuration/configuration.go b/internal/cli/configuration/configuration.go
@@ -101,10 +101,10 @@ func getDefaultUserDir() string {
 	}
 }

-// FindConfigFileInArgsFallbackOnEnv returns the config file path using the
+// FindConfigFlagsInArgsOrFallbackOnEnv returns the config file path using the
 // argument '--config-file' (if specified), if empty looks for the ARDUINO_CONFIG_FILE env,
 // or looking in the current working dir
-func FindConfigFileInArgsFallbackOnEnv(args []string) string {
+func FindConfigFlagsInArgsOrFallbackOnEnv(args []string) string {
 	// Look for '--config-dir' argument
 	for i, arg := range args {
 		if arg == "--config-dir" {

diff --git a/internal/cli/configuration/configuration_test.go b/internal/cli/configuration/configuration_test.go
@@ -43,23 +43,23 @@ func TestInit(t *testing.T) {

 func TestFindConfigFile(t *testing.T) {
 	defaultConfigFile := filepath.Join(getDefaultArduinoDataDir(), "arduino-cli.yaml")
-	configFile := FindConfigFileInArgsFallbackOnEnv([]string{"--config-file"})
+	configFile := FindConfigFlagsInArgsOrFallbackOnEnv([]string{"--config-file"})
 	require.Equal(t, defaultConfigFile, configFile)

-	configFile = FindConfigFileInArgsFallbackOnEnv([]string{"--config-file", "some/path/to/config"})
+	configFile = FindConfigFlagsInArgsOrFallbackOnEnv([]string{"--config-file", "some/path/to/config"})
 	require.Equal(t, "some/path/to/config", configFile)

-	configFile = FindConfigFileInArgsFallbackOnEnv([]string{"--config-file", "some/path/to/config/arduino-cli.yaml"})
+	configFile = FindConfigFlagsInArgsOrFallbackOnEnv([]string{"--config-file", "some/path/to/config/arduino-cli.yaml"})
 	require.Equal(t, "some/path/to/config/arduino-cli.yaml", configFile)

-	configFile = FindConfigFileInArgsFallbackOnEnv([]string{})
+	configFile = FindConfigFlagsInArgsOrFallbackOnEnv([]string{})
 	require.Equal(t, defaultConfigFile, configFile)

 	t.Setenv("ARDUINO_CONFIG_FILE", "some/path/to/config")
-	configFile = FindConfigFileInArgsFallbackOnEnv([]string{})
+	configFile = FindConfigFlagsInArgsOrFallbackOnEnv([]string{})
 	require.Equal(t, "some/path/to/config", configFile)

 	// when both env and flag are specified flag takes precedence
-	configFile = FindConfigFileInArgsFallbackOnEnv([]string{"--config-file", "flag/path"})
+	configFile = FindConfigFlagsInArgsOrFallbackOnEnv([]string{"--config-file", "flag/path"})
 	require.Equal(t, "flag/path", configFile)
 }
diff --git a/main.go b/main.go
@@ -38,7 +38,7 @@ func main() {
 	logrus.SetOutput(io.Discard)

 	// Search for the configuration file in the command line arguments and in the environment
-	configFile := configuration.FindConfigFileInArgsFallbackOnEnv(os.Args)
+	configFile := configuration.FindConfigFlagsInArgsOrFallbackOnEnv(os.Args)
 	ctx := config.SetConfigFile(context.Background(), configFile)

 	// Create a new ArduinoCoreServer