feat(config): add default configuration file and update config handling

Author: dido18

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 @@ func GetDefaultHomeDir() *paths.Path {
 	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

config/config_test.go

@@ -1,9 +1,9 @@
 package config
 
 import (
-	"fmt"
 	"os"
 	"testing"
+	"time"
 
 	"github.com/arduino/go-paths-helper"
 	"github.com/sirupsen/logrus"
@@ -38,24 +38,52 @@ func TestGetConfigPath(t *testing.T) {
 		GetConfigPath()
 	})
 
-	t.Run("read config.ini from $HOME", func(t *testing.T) {
+	t.Run("read config.ini from $HOME/.config/ArduinoCreateAgent folder", func(t *testing.T) {
 		os.Setenv("HOME", "./testdata/home")
 		defer os.Unsetenv("HOME")
 		configPath := GetConfigPath()
 		assert.Equal(t, "testdata/home/.config/ArduinoCreateAgent/config.ini", configPath.String())
 	})
 
-	t.Run("fallback old : read config.ini where the binary is launched", func(t *testing.T) {
-		src, _ := os.Executable()
-		paths.New(src).Parent().Join("config.ini").Create() // create a config.ini in the same directory as the binary
-		// The fallback path is the directory where the binary is launched
-		fmt.Println(src)
-		os.Setenv("HOME", "./testdata/noconfig") // force to not have a config in the home directory
+	t.Run("legacy config are copied to new location", func(t *testing.T) {
+
+		createLegacyConfig := func() string {
+			// Create a "legacy" config.ini in the same directory as the binary executable
+			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
+			c := "hostname = legacy-config-file-" + time.Now().String()
+			n, err := legacyConfigPath.WriteString(c)
+			if err != nil || n <= 0 {
+				t.Fatalf("Failed to write legacy config file: %v", err)
+			}
+			return c
+		}
+
+		wantContent := createLegacyConfig()
+
+		// Expectation: it copies the "legacy" config.ini into the location pointed by $HOME
+		os.Setenv("HOME", "./testdata/fromlegacy")
 		defer os.Unsetenv("HOME")
 
-		// expect it creates a config.ini in the same directory as the binary
+		// 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)
+		}
+
 		configPath := GetConfigPath()
-		assert.Equal(t, "testdata/home/.config/ArduinoCreateAgent/config.ini", configPath.String())
+		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, wantContent, string(given))
 	})
 
 }

config/testdata/fromlegacy/.gitignore

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