Remove global clients

config/config-default.ini

@@ -0,0 +1,10 @@
+gc = std  # Type of garbage collection. std = Normal garbage collection allowing system to decide (this has been known to cause a stop the world in the middle of a CNC job which can cause lost responses from the CNC controller and thus stalled jobs. use max instead to solve.), off = let memory grow unbounded (you have to send in the gc command manually to garbage collect or you will run out of RAM eventually), max = Force garbage collection on each recv or send on a serial port (this minimizes stop the world events and thus lost serial responses, but increases CPU usage)
+hostname = unknown-hostname  # Override the hostname we get from the OS
+regex = usb|acm|com  # Regular expression to filter serial port list
+v = true  # show debug logging
+appName = CreateAgent/Stable
+updateUrl = https://downloads.arduino.cc/
+origins = https://local.arduino.cc:8000
+#httpProxy = http://your.proxy:port # Proxy server for HTTP requests
+crashreport = false # enable crashreport logging
+autostartMacOS = true # the Arduino Create Agent is able to start automatically after login on macOS (launchd agent)

config/config.go

@@ -108,7 +108,7 @@
 	return paths.New(homeDir)
 }
 
-//go:embed config.ini
+//go:embed config-default.ini
 var configContent []byte
 
 // GenerateConfig function will take a directory path as an input
@@ -142,3 +142,41 @@
 	}
 	return nil
 }
+
+func GetConfigPath() *paths.Path {
+	// Let's handle the config
+	configDir := GetDefaultConfigDir()
+	var configPath *paths.Path
+
+	// see if the env var is defined, if it is take the config from there, this will override the default path
+	if envConfig := os.Getenv("ARDUINO_CREATE_AGENT_CONFIG"); envConfig != "" {
+		configPath = paths.New(envConfig)
+		if configPath.NotExist() {
+			log.Panicf("config from env var %s does not exists", envConfig)
+		}
+		log.Infof("using config from env variable: %s", configPath)
+	} else if defaultConfigPath := configDir.Join("config.ini"); defaultConfigPath.Exist() {
+		// by default take the config from the ~/.arduino-create/config.ini file
+		configPath = defaultConfigPath
+		log.Infof("using config from default: %s", configPath)
+	} else {
+		// Fall back to the old config.ini location
+		src, _ := os.Executable()
+		oldConfigPath := paths.New(src).Parent().Join("config.ini")
+		if oldConfigPath.Exist() {
+			err := oldConfigPath.CopyTo(defaultConfigPath)
+			if err != nil {
+				log.Errorf("cannot copy old %s, to %s, generating new config", oldConfigPath, configPath)
+			} else {
+				configPath = defaultConfigPath
+				log.Infof("copied old %s, to %s", oldConfigPath, configPath)
+			}
+		}
+	}
+	if configPath == nil {
+		configPath = GenerateConfig(configDir)
+	}
+
+	return configPath
+
+}

config/config_test.go

@@ -0,0 +1,94 @@
+package config
+
+import (
+	"os"
+	"testing"
+	"time"
+
+	"github.com/arduino/go-paths-helper"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestGetConfigPathFromXDG_CONFIG_HOME(t *testing.T) {
+	// read config from $XDG_CONFIG_HOME/ArduinoCreateAgent/config.ini
+	os.Setenv("XDG_CONFIG_HOME", "./testdata/fromxdghome")
+	defer os.Unsetenv("XDG_CONFIG_HOME")
+	configPath := GetConfigPath()
+	assert.Equal(t, "testdata/fromxdghome/ArduinoCreateAgent/config.ini", configPath.String())
+}
+
+func TestGetConfigPathFromHOME(t *testing.T) {
+	// Test case 2: read config from $HOME/.config/ArduinoCreateAgent/config.ini "
+	os.Setenv("HOME", "./testdata/fromhome")
+	defer os.Unsetenv("HOME")
+	configPath := GetConfigPath()
+	assert.Equal(t, "testdata/fromhome/.config/ArduinoCreateAgent/config.ini", configPath.String())
+
+}
+
+func TestGetConfigPathFromARDUINO_CREATE_AGENT_CONFIG(t *testing.T) {
+	// read config from ARDUINO_CREATE_AGENT_CONFIG/config.ini"
+	os.Setenv("HOME", "./fromhome")
+	os.Setenv("ARDUINO_CREATE_AGENT_CONFIG", "./testdata/fromenv/config.ini")
+	defer os.Unsetenv("ARDUINO_CREATE_AGENT_CONFIG")
+
+	configPath := GetConfigPath()
+	assert.Equal(t, "./testdata/fromenv/config.ini", configPath.String())
+}
+
+func TestGetConfigPathFromLegacyConfig(t *testing.T) {
+	// If no config is found, copy the legacy config to the new location
+	src, err := os.Executable()
+	if err != nil {
+		t.Fatal(err)
+	}
+	legacyConfigPath, err := paths.New(src).Parent().Join("config.ini").Create()
+	if err != nil {
+		t.Fatal(err)
+	}
+	// adding a timestamp to the content to make it unique
+	legacyContent := "hostname = legacy-config-file-" + time.Now().String()
+	n, err := legacyConfigPath.WriteString(legacyContent)
+	if err != nil || n <= 0 {
+		t.Fatalf("Failed to write legacy config file: %v", err)
+	}
+
+	// remove any existing config.ini in the into the location pointed by $HOME
+	err = os.Remove("./testdata/fromlegacy/.config/ArduinoCreateAgent/config.ini")
+	if err != nil && !os.IsNotExist(err) {
+		t.Fatal(err)
+	}
+
+	// Expectation: it copies the "legacy" config.ini into the location pointed by $HOME
+	os.Setenv("HOME", "./testdata/fromlegacy")
+	defer os.Unsetenv("HOME")
+
+	configPath := GetConfigPath()
+	assert.Equal(t, "testdata/fromlegacy/.config/ArduinoCreateAgent/config.ini", configPath.String())
+
+	given, err := paths.New(configPath.String()).ReadFile()
+	assert.Nil(t, err)
+	assert.Equal(t, legacyContent, string(given))
+}
+
+// func TestGetConfigPathCreateDefaultConfig(t *testing.T) {
+// 	os.Setenv("HOME", "./testdata/noconfig")
+// 	os.Unsetenv("ARDUINO_CREATE_AGENT_CONFIG")
+
+// 	// ensure the config.ini does not exist in HOME directory
+// 	os.Remove("./testdata/noconfig/.config/ArduinoCreateAgent/config.ini")
+// 	// ensure the config.ini does not exist in target directory
+// 	os.Remove("./testdata/fromdefault/.config/ArduinoCreateAgent/config.ini")
+
+// 	configPath := GetConfigPath()
+
+// 	assert.Equal(t, "testdata/fromdefault/.config/ArduinoCreateAgent/config.ini", configPath.String())
+
+// 	givenContent, err := paths.New(configPath.String()).ReadFile()
+// 	if err != nil {
+// 		t.Fatal(err)
+// 	}
+
+// 	assert.Equal(t, string(configContent), string(givenContent))
+
+// }

config/testdata/fromdefault/.gitignore

@@ -0,0 +1 @@
+config.ini

config/testdata/fromenv/config.ini

@@ -0,0 +1,8 @@
+gc = std
+hostname = this-is-a-config-file-from-home-dir-from-ARDUINO_CREATE_AGENT_CONFIG-env
+regex = usb|acm|com
+v = true
+appName = CreateAgent/Stable
+updateUrl = https://downloads.arduino.cc/
+origins = https://local.arduino.cc:8000, https://local.arduino.cc:8001, https://create-dev.arduino.cc, https://*.sparklyunicorn.cc, https://*.iot-cloud-arduino-cc.pages.dev, https://cloud.oniudra.cc, https://app.oniudra.cc,https://*.iot-cloud-arduino-cc.pages.dev
+crashreport = false

config/testdata/fromhome/.config/ArduinoCreateAgent/config.ini

@@ -0,0 +1,8 @@
+gc = std
+hostname = this-is-a-config-file-from-home-dir
+regex = usb|acm|com
+v = true
+appName = config-from-home-dir
+updateUrl = https://downloads.arduino.cc/
+origins = https://local.arduino.cc:8000, https://local.arduino.cc:8001, https://*.iot-cloud-arduino-cc.pages.dev
+crashreport = false

config/testdata/fromlegacy/.gitignore

@@ -0,0 +1,2 @@
+# ingore because this config file
+config.ini

config/testdata/fromxdghome/ArduinoCreateAgent/config.ini

@@ -0,0 +1,10 @@
+gc = std  # Type of garbage collection. std = Normal garbage collection allowing system to decide (this has been known to cause a stop the world in the middle of a CNC job which can cause lost responses from the CNC controller and thus stalled jobs. use max instead to solve.), off = let memory grow unbounded (you have to send in the gc command manually to garbage collect or you will run out of RAM eventually), max = Force garbage collection on each recv or send on a serial port (this minimizes stop the world events and thus lost serial responses, but increases CPU usage)
+hostname = unknown-hostname  # Override the hostname we get from the OS
+regex = usb|acm|com  # Regular expression to filter serial port list
+v = true  # show debug logging
+appName = CreateAgent/Stable
+updateUrl = https://downloads.arduino.cc/
+origins = https://local.arduino.cc:8000
+#httpProxy = http://your.proxy:port # Proxy server for HTTP requests
+crashreport = false # enable crashreport logging
+autostartMacOS = true # the Arduino Create Agent is able to start automatically after login on macOS (launchd agent)

config/testdata/home/.config/ArduinoCreateAgent/config.ini

@@ -0,0 +1,8 @@
+gc = std
+hostname = this-is-a-config-file-from-home-dir
+regex = usb|acm|com
+v = true
+appName = config-from-home-dir
+updateUrl = https://downloads.arduino.cc/
+origins = https://local.arduino.cc:8000, https://local.arduino.cc:8001, https://*.iot-cloud-arduino-cc.pages.dev
+crashreport = false

config/testdata/noconfig/.config/ArduinoCreateAgent/config.ini

@@ -0,0 +1,10 @@
+gc = std  # Type of garbage collection. std = Normal garbage collection allowing system to decide (this has been known to cause a stop the world in the middle of a CNC job which can cause lost responses from the CNC controller and thus stalled jobs. use max instead to solve.), off = let memory grow unbounded (you have to send in the gc command manually to garbage collect or you will run out of RAM eventually), max = Force garbage collection on each recv or send on a serial port (this minimizes stop the world events and thus lost serial responses, but increases CPU usage)
+hostname = unknown-hostname  # Override the hostname we get from the OS
+regex = usb|acm|com  # Regular expression to filter serial port list
+v = true  # show debug logging
+appName = CreateAgent/Stable
+updateUrl = https://downloads.arduino.cc/
+origins = https://local.arduino.cc:8000
+#httpProxy = http://your.proxy:port # Proxy server for HTTP requests
+crashreport = false # enable crashreport logging
+autostartMacOS = true # the Arduino Create Agent is able to start automatically after login on macOS (launchd agent)