move config.go to it's own package and make functions public.

This way we have a single source of truth.

Author: umbynos

.gitignore

@@ -10,6 +10,8 @@ public/
 artifacts*
 logs/
 
+config/config.ini
+
 # IDEs config 
 .idea
 .vscode

certificates.go

@@ -23,6 +23,7 @@ import (
 	"text/template"
 	"time"
 
+	"github.com/arduino/arduino-create-agent/config"
 	"github.com/arduino/go-paths-helper"
 	"github.com/gin-gonic/gin"
 	log "github.com/sirupsen/logrus"
@@ -271,7 +272,7 @@ func certHandler(c *gin.Context) {
 }
 
 func deleteCertHandler(c *gin.Context) {
-	DeleteCertificates(getCertificatesDir())
+	DeleteCertificates(config.GetCertificatesDir())
 }
 
 // DeleteCertificates will delete the certificates

config.go renamed to config/config.go

@@ -13,7 +13,7 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
-package main
+package config
 
 import (
 	_ "embed"
@@ -23,13 +23,13 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
-// getCertificatesDir return the directory where SSL certificates are saved
-func getCertificatesDir() *paths.Path {
-	return getDataDir()
+// GetCertificatesDir return the directory where SSL certificates are saved
+func GetCertificatesDir() *paths.Path {
+	return GetDataDir()
 }
 
-// getDataDir returns the full path to the default Arduino Create Agent data directory.
-func getDataDir() *paths.Path {
+// GetDataDir returns the full path to the default Arduino Create Agent data directory.
+func GetDataDir() *paths.Path {
 	userDir, err := os.UserHomeDir()
 	if err != nil {
 		log.Panicf("Could not get user dir: %s", err)
@@ -41,17 +41,17 @@ func getDataDir() *paths.Path {
 	return dataDir
 }
 
-// getLogsDir return the directory where logs are saved
-func getLogsDir() *paths.Path {
-	logsDir := getDataDir().Join("logs")
+// GetLogsDir return the directory where logs are saved
+func GetLogsDir() *paths.Path {
+	logsDir := GetDataDir().Join("logs")
 	if err := logsDir.MkdirAll(); err != nil {
 		log.Panicf("Can't create logs dir: %s", err)
 	}
 	return logsDir
 }
 
-// getDefaultConfigDir returns the full path to the default Arduino Create Agent configuration directory.
-func getDefaultConfigDir() *paths.Path {
+// GetDefaultConfigDir returns the full path to the default Arduino Create Agent configuration directory.
+func GetDefaultConfigDir() *paths.Path {
 	// UserConfigDir returns the default root directory to use
 	// for user-specific configuration data. Users should create
 	// their own application-specific subdirectory within this
@@ -79,13 +79,16 @@ func getDefaultConfigDir() *paths.Path {
 	return agentConfigDir
 }
 
+// https://github.com/golang/go/issues/46056
+//
+//go:generate cp -r ../config.ini config.ini
 //go:embed config.ini
 var configContent []byte
 
-// generateConfig function will take a directory path as an input
+// GenerateConfig function will take a directory path as an input
 // and will write the default config,ini file to that directory,
 // it will panic if something goes wrong
-func generateConfig(destDir *paths.Path) *paths.Path {
+func GenerateConfig(destDir *paths.Path) *paths.Path {
 	configPath := destDir.Join("config.ini")
 
 	// generate the config.ini file directly in destDir

hub.go

@@ -26,6 +26,7 @@ import (
 	"strconv"
 	"strings"
 
+	"github.com/arduino/arduino-create-agent/config"
 	"github.com/arduino/arduino-create-agent/upload"
 	log "github.com/sirupsen/logrus"
 )
@@ -182,7 +183,7 @@ func checkCmd(m []byte) {
 	} else if strings.HasPrefix(sl, "downloadtool") {
 		// Always delete root certificates when we receive a downloadtool command
 		// Useful if the install procedure was not followed strictly (eg. manually)
-		DeleteCertificates(getCertificatesDir())
+		DeleteCertificates(config.GetCertificatesDir())
 		go func() {
 			args := strings.Split(s, " ")
 			var tool, toolVersion, pack, behaviour string

main.go

@@ -31,6 +31,7 @@ import (
 	"time"
 
 	cors "github.com/andela/gin-cors"
+	"github.com/arduino/arduino-create-agent/config"
 	"github.com/arduino/arduino-create-agent/systray"
 	"github.com/arduino/arduino-create-agent/tools"
 	"github.com/arduino/arduino-create-agent/updater"
@@ -127,17 +128,17 @@ func main() {
 
 	// Generate certificates
 	if *genCert {
-		generateCertificates(getCertificatesDir())
+		generateCertificates(config.GetCertificatesDir())
 		os.Exit(0)
 	}
 	// Check if certificates made with Agent <=1.2.7 needs to be moved over the new location
-	migrateCertificatesGeneratedWithOldAgentVersions(getCertificatesDir())
+	migrateCertificatesGeneratedWithOldAgentVersions(config.GetCertificatesDir())
 
 	// Launch main loop in a goroutine
 	go loop()
 
 	// SetupSystray is the main thread
-	configDir := getDefaultConfigDir()
+	configDir := config.GetDefaultConfigDir()
 	Systray = systray.Systray{
 		Hibernate: *hibernate,
 		Version:   version + "-" + commit,
@@ -167,7 +168,7 @@ func loop() {
 
 	// Instantiate Tools
 	Tools = tools.Tools{
-		Directory: getDataDir().String(),
+		Directory: config.GetDataDir().String(),
 		IndexURL:  *indexURL,
 		Logger: func(msg string) {
 			mapD := map[string]string{"DownloadStatus": "Pending", "Msg": msg}
@@ -178,7 +179,7 @@ func loop() {
 	Tools.Init(requiredToolsAPILevel)
 
 	// Let's handle the config
-	configDir := getDefaultConfigDir()
+	configDir := config.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
@@ -207,7 +208,7 @@ func loop() {
 		}
 	}
 	if configPath == nil {
-		configPath = generateConfig(configDir)
+		configPath = config.GenerateConfig(configDir)
 	}
 
 	// Parse the config.ini
@@ -316,7 +317,7 @@ func loop() {
 	if *crashreport {
 		logFilename := "crashreport_" + time.Now().Format("20060102150405") + ".log"
 		// handle logs directory creation
-		logsDir := getLogsDir()
+		logsDir := config.GetLogsDir()
 		logFile, err := os.OpenFile(logsDir.Join(logFilename).String(), os.O_WRONLY|os.O_CREATE|os.O_SYNC|os.O_APPEND, 0644)
 		if err != nil {
 			log.Print("Cannot create file used for crash-report")
@@ -376,12 +377,12 @@ func loop() {
 	r.POST("/update", updateHandler)
 
 	// Mount goa handlers
-	goa := v2.Server(getDataDir().String())
+	goa := v2.Server(config.GetDataDir().String())
 	r.Any("/v2/*path", gin.WrapH(goa))
 
 	go func() {
 		// check if certificates exist; if not, use plain http
-		certsDir := getCertificatesDir()
+		certsDir := config.GetCertificatesDir()
 		if certsDir.Join("cert.pem").NotExist() {
 			log.Error("Could not find HTTPS certificate. Using plain HTTP only.")
 			return

systray/systray_real.go

@@ -21,12 +21,11 @@ package systray
 
 import (
 	"os"
-	"os/user"
 
 	log "github.com/sirupsen/logrus"
 
+	"github.com/arduino/arduino-create-agent/config"
 	"github.com/arduino/arduino-create-agent/icon"
-	"github.com/arduino/go-paths-helper"
 	"github.com/getlantern/systray"
 	"github.com/go-ini/ini"
 	"github.com/skratchdot/open-golang/open"
@@ -104,13 +103,13 @@ func (s *Systray) updateMenuItem(item *systray.MenuItem, disable bool) {
 
 // CrashesIsEmpty checks if the folder containing crash-reports is empty
 func (s *Systray) CrashesIsEmpty() bool {
-	logsDir := getLogsDir()
+	logsDir := config.GetLogsDir()
 	return logsDir.NotExist() // if the logs directory is empty we assume there are no crashreports
 }
 
 // RemoveCrashes removes the crash-reports from `logs` folder
 func (s *Systray) RemoveCrashes() {
-	logsDir := getLogsDir()
+	logsDir := config.GetLogsDir()
 	pathErr := logsDir.RemoveAll()
 	if pathErr != nil {
 		log.Errorf("Cannot remove crashreports: %s", pathErr)
@@ -119,14 +118,6 @@ func (s *Systray) RemoveCrashes() {
 	}
 }
 
-// getLogsDir simply returns the folder containing the logs
-func getLogsDir() *paths.Path {
-	usr, _ := user.Current()
-	usrDir := paths.New(usr.HomeDir) // The user folder, on linux/macos /home/<usr>/
-	agentDir := usrDir.Join(".arduino-create")
-	return agentDir.Join("logs")
-}
-
 // starthibernate creates a systray icon with menu options to resume/quit the agent
 func (s *Systray) startHibernate() {
 	systray.SetIcon(icon.GetIconHiber())