remove globas tools and index

Author: dido18

config/config.ini

@@ -7,4 +7,4 @@ 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)
+autostartMacOS = true # the Arduino Create Agent is able to start automatically after login on macOS (launchd agent)

conn.go

@@ -27,6 +27,7 @@ import (
 	"os"
 	"path/filepath"
 
+	"github.com/arduino/arduino-create-agent/tools"
 	"github.com/arduino/arduino-create-agent/upload"
 	"github.com/arduino/arduino-create-agent/utilities"
 	"github.com/gin-gonic/gin"
@@ -80,7 +81,7 @@ type Upload struct {
 
 var uploadStatusStr = "ProgrammerStatus"
 
-func uploadHandler(h *hub, pubKey *rsa.PublicKey) func(*gin.Context) {
+func uploadHandler(h *hub, pubKey *rsa.PublicKey, tools *tools.Tools) func(*gin.Context) {
 	return func(c *gin.Context) {
 		data := new(Upload)
 		if err := c.BindJSON(data); err != nil {
@@ -162,7 +163,7 @@ func uploadHandler(h *hub, pubKey *rsa.PublicKey) func(*gin.Context) {
 
 		go func() {
 			// Resolve commandline
-			commandline, err := upload.PartiallyResolve(data.Board, filePath, tmpdir, data.Commandline, data.Extra, Tools)
+			commandline, err := upload.PartiallyResolve(data.Board, filePath, tmpdir, data.Commandline, data.Extra, tools)
 			if err != nil {
 				send(h, map[string]string{uploadStatusStr: "Error", "Msg": err.Error()})
 				return

hub.go

@@ -25,6 +25,7 @@ import (
 	"strconv"
 	"strings"
 
+	"github.com/arduino/arduino-create-agent/tools"
 	"github.com/arduino/arduino-create-agent/upload"
 	log "github.com/sirupsen/logrus"
 )
@@ -50,9 +51,11 @@ type hub struct {
 	serialHub *serialhub
 
 	serialPortList *serialPortList
+
+	tools *tools.Tools
 }
 
-func newHub(serialhub *serialhub, serialList *serialPortList) *hub {
+func newHub(serialhub *serialhub, serialList *serialPortList, tools *tools.Tools) *hub {
 	hub := &hub{
 		broadcast:      make(chan []byte, 1000),
 		broadcastSys:   make(chan []byte, 1000),
@@ -61,6 +64,7 @@ func newHub(serialhub *serialhub, serialList *serialPortList) *hub {
 		connections:    make(map[*connection]bool),
 		serialHub:      serialhub,
 		serialPortList: serialList,
+		tools:          tools,
 	}
 
 	hub.serialHub.OnRegister = func(port *serport) {
@@ -235,7 +239,12 @@ func (h *hub) checkCmd(m []byte) {
 				behaviour = args[4]
 			}
 
-			err := Tools.Download(pack, tool, toolVersion, behaviour)
+			reportPendingProgress := func(msg string) {
+				mapD := map[string]string{"DownloadStatus": "Pending", "Msg": msg}
+				mapB, _ := json.Marshal(mapD)
+				h.broadcastSys <- mapB
+			}
+			err := h.tools.Download(pack, tool, toolVersion, behaviour, reportPendingProgress)
 			if err != nil {
 				mapD := map[string]string{"DownloadStatus": "Error", "Msg": err.Error()}
 				mapB, _ := json.Marshal(mapD)

main.go

@@ -20,7 +20,6 @@ package main
 
 import (
 	_ "embed"
-	"encoding/json"
 	"flag"
 	"html/template"
 	"io"
@@ -100,13 +99,6 @@ var homeTemplate = template.Must(template.New("home").Parse(homeTemplateHTML))
 //go:embed home.html
 var homeTemplateHTML string
 
-// global clients
-var (
-	Tools   *tools.Tools
-	Systray systray.Systray
-	Index   *index.Resource
-)
-
 // FIXME; the loggerWS is useind in the multiwrite in the hub
 // type logWriter struct{}
 
@@ -160,9 +152,9 @@ func main() {
 	if src, err := os.Executable(); err != nil {
 		panic(err)
 	} else if restartPath := updater.Start(src); restartPath != "" {
-		Systray.RestartWith(restartPath)
+		stray.RestartWith(restartPath)
 	} else {
-		Systray.Start()
+		stray.Start()
 	}
 }
 
@@ -183,15 +175,21 @@ func loop(stray *systray.Systray) {
 		os.Exit(0)
 	}
 
-	serialPorts := newSerialPortList()
+	// Instantiate Index and Tools
+	index := index.Init(*indexURL, config.GetDataDir())
+	if signatureKey == nil || len(*signatureKey) == 0 {
+		log.Panicf("signature public key should be set")
+	}
+	signaturePubKey, err := utilities.ParseRsaPublicKey([]byte(*signatureKey))
+	if err != nil {
+		log.Panicf("cannot parse signature key '%s'. %s", *signatureKey, err)
+	}
+	tools := tools.New(config.GetDataDir(), index, signaturePubKey)
+
+	serialPorts := newSerialPortList(tools)
 	serialHub := newSerialHub()
-	hub := newHub(serialHub, serialPorts)
 
-	logger := func(msg string) {
-		mapD := map[string]string{"DownloadStatus": "Pending", "Msg": msg}
-		mapB, _ := json.Marshal(mapD)
-		hub.broadcastSys <- mapB
-	}
+	hub := newHub(serialHub, serialPorts, tools)
 
 	// Let's handle the config
 	configDir := config.GetDefaultConfigDir()
@@ -263,7 +261,7 @@ func loop(stray *systray.Systray) {
 	if err != nil {
 		log.Panicf("cannot parse arguments: %s", err)
 	}
-	Systray.SetCurrentConfigFile(configPath)
+	stray.SetCurrentConfigFile(configPath)
 
 	// Parse additional ini config if defined
 	if len(*additionalConfig) > 0 {
@@ -283,18 +281,6 @@ func loop(stray *systray.Systray) {
 		}
 	}
 
-	if signatureKey == nil || len(*signatureKey) == 0 {
-		log.Panicf("signature public key should be set")
-	}
-	signaturePubKey, err := utilities.ParseRsaPublicKey([]byte(*signatureKey))
-	if err != nil {
-		log.Panicf("cannot parse signature key '%s'. %s", *signatureKey, err)
-	}
-
-	// Instantiate Index and Tools
-	Index = index.Init(*indexURL, config.GetDataDir())
-	Tools = tools.New(config.GetDataDir(), Index, logger, signaturePubKey)
-
 	// see if we are supposed to wait 5 seconds
 	if *isLaunchSelf {
 		launchSelfLater()
@@ -467,7 +453,7 @@ func loop(stray *systray.Systray) {
 	r.LoadHTMLFiles("templates/nofirefox.html")
 
 	r.GET("/", homeHandler)
-	r.POST("/upload", uploadHandler(hub, signaturePubKey))
+	r.POST("/upload", uploadHandler(hub, signaturePubKey, tools))
 	r.GET("/socket.io/", socketHandler)
 	r.POST("/socket.io/", socketHandler)
 	r.Handle("WS", "/socket.io/", socketHandler)
@@ -477,7 +463,7 @@ func loop(stray *systray.Systray) {
 	r.POST("/update", updateHandler(stray))
 
 	// Mount goa handlers
-	goa := v2.Server(config.GetDataDir().String(), Index, signaturePubKey)
+	goa := v2.Server(config.GetDataDir().String(), index, signaturePubKey)
 	r.Any("/v2/*path", gin.WrapH(goa))
 
 	go func() {

main_test.go

@@ -29,9 +29,10 @@ import (
 	"testing"
 
 	"github.com/arduino/arduino-create-agent/config"
-	"github.com/arduino/arduino-create-agent/gen/tools"
+	genTools "github.com/arduino/arduino-create-agent/gen/tools"
 	"github.com/arduino/arduino-create-agent/globals"
 	"github.com/arduino/arduino-create-agent/index"
+	"github.com/arduino/arduino-create-agent/tools"
 	"github.com/arduino/arduino-create-agent/upload"
 	"github.com/arduino/arduino-create-agent/utilities"
 	v2 "github.com/arduino/arduino-create-agent/v2"
@@ -56,7 +57,15 @@ func TestValidSignatureKey(t *testing.T) {
 
 func TestUploadHandlerAgainstEvilFileNames(t *testing.T) {
 	r := gin.New()
-	r.POST("/", uploadHandler(newHub(newSerialHub(), newSerialPortList()), utilities.MustParseRsaPublicKey([]byte(globals.ArduinoSignaturePubKey))))
+
+	index := index.Init(*indexURL, config.GetDataDir())
+	signaturePubKey, err := utilities.ParseRsaPublicKey([]byte(*signatureKey))
+	require.NoError(t, err)
+	tools := tools.New(config.GetDataDir(), index, signaturePubKey)
+	hub := newHub(newSerialHub(), newSerialPortList(tools), tools)
+	pubkey := utilities.MustParseRsaPublicKey([]byte(globals.ArduinoSignaturePubKey))
+
+	r.POST("/", uploadHandler(hub, pubkey, tools))
 	ts := httptest.NewServer(r)
 
 	uploadEvilFileName := Upload{
@@ -93,7 +102,14 @@ func TestUploadHandlerAgainstEvilFileNames(t *testing.T) {
 func TestUploadHandlerAgainstBase64WithoutPaddingMustFail(t *testing.T) {
 	r := gin.New()
 
-	r.POST("/", uploadHandler(newHub(newSerialHub(), newSerialPortList()), utilities.MustParseRsaPublicKey([]byte(globals.ArduinoSignaturePubKey))))
+	index := index.Init(*indexURL, config.GetDataDir())
+	signaturePubKey, err := utilities.ParseRsaPublicKey([]byte(*signatureKey))
+	require.NoError(t, err)
+	tools := tools.New(config.GetDataDir(), index, signaturePubKey)
+	hub := newHub(newSerialHub(), newSerialPortList(tools), tools)
+	pubkey := utilities.MustParseRsaPublicKey([]byte(globals.ArduinoSignaturePubKey))
+
+	r.POST("/", uploadHandler(hub, pubkey, tools))
 	ts := httptest.NewServer(r)
 	defer ts.Close()
 
@@ -127,15 +143,15 @@ func TestInstallToolV2(t *testing.T) {
 	ts := httptest.NewServer(r)
 
 	type test struct {
-		request      tools.ToolPayload
+		request      genTools.ToolPayload
 		responseCode int
 		responseBody string
 	}
 
 	bossacURL := "http://downloads.arduino.cc/tools/bossac-1.7.0-arduino3-linux64.tar.gz"
 	bossacChecksum := "SHA-256:1ae54999c1f97234a5c603eb99ad39313b11746a4ca517269a9285afa05f9100"
 	bossacSignature := "382898a97b5a86edd74208f10107d2fecbf7059ffe9cc856e045266fb4db4e98802728a0859cfdcda1c0b9075ec01e42dbea1f430b813530d5a6ae1766dfbba64c3e689b59758062dc2ab2e32b2a3491dc2b9a80b9cda4ae514fbe0ec5af210111b6896976053ab76bac55bcecfcececa68adfa3299e3cde6b7f117b3552a7d80ca419374bb497e3c3f12b640cf5b20875416b45e662fc6150b99b178f8e41d6982b4c0a255925ea39773683f9aa9201dc5768b6fc857c87ff602b6a93452a541b8ec10ca07f166e61a9e9d91f0a6090bd2038ed4427af6251039fb9fe8eb62ec30d7b0f3df38bc9de7204dec478fb86f8eb3f71543710790ee169dce039d3e0"
-	bossacInstallURLOK := tools.ToolPayload{
+	bossacInstallURLOK := genTools.ToolPayload{
 		Name:      "bossac",
 		Version:   "1.7.0-arduino3",
 		Packager:  "arduino",
@@ -147,7 +163,7 @@ func TestInstallToolV2(t *testing.T) {
 	esptoolURL := "https://github.com/earlephilhower/esp-quick-toolchain/releases/download/2.5.0-3/x86_64-linux-gnu.esptool-f80ae31.tar.gz"
 	esptoolChecksum := "SHA-256:bded1dca953377838b6086a9bcd40a1dc5286ba5f69f2372c22a1d1819baad24"
 	esptoolSignature := "852b58871419ce5e5633ecfaa72c0f0fa890ceb51164b362b8133bc0e3e003a21cec48935b8cdc078f4031219cbf17fb7edd9d7c9ca8ed85492911c9ca6353c9aa4691eb91fda99563a6bd49aeca0d9981fb05ec76e45c6024f8a6822862ad1e34ddc652fbbf4fa909887a255d4f087398ec386577efcec523c21203be3d10fc9e9b0f990a7536875a77dc2bc5cbffea7734b62238e31719111b718bacccebffc9be689545540e81d23b81caa66214376f58a0d6a45cf7efc5d3af62ab932b371628162fffe403906f41d5534921e5be081c5ac2ecc9db5caec03a105cc44b00ce19a95ad079843501eb8182e0717ce327867380c0e39d2b48698547fc1d0d66"
-	esptoolInstallURLOK := tools.ToolPayload{
+	esptoolInstallURLOK := genTools.ToolPayload{
 		Name:      "esptool",
 		Version:   "2.5.0-3-20ed2b9",
 		Packager:  "esp8266",
@@ -157,7 +173,7 @@ func TestInstallToolV2(t *testing.T) {
 	}
 
 	wrongSignature := "wr0ngs1gn4tur3"
-	bossacInstallWrongSig := tools.ToolPayload{
+	bossacInstallWrongSig := genTools.ToolPayload{
 		Name:      "bossac",
 		Version:   "1.7.0-arduino3",
 		Packager:  "arduino",
@@ -167,7 +183,7 @@ func TestInstallToolV2(t *testing.T) {
 	}
 
 	wrongChecksum := "wr0ngch3cksum"
-	bossacInstallWrongCheck := tools.ToolPayload{
+	bossacInstallWrongCheck := genTools.ToolPayload{
 		Name:      "bossac",
 		Version:   "1.7.0-arduino3",
 		Packager:  "arduino",
@@ -176,7 +192,7 @@ func TestInstallToolV2(t *testing.T) {
 		Signature: &bossacSignature,
 	}
 
-	bossacInstallNoURL := tools.ToolPayload{
+	bossacInstallNoURL := genTools.ToolPayload{
 		Name:     "bossac",
 		Version:  "1.7.0-arduino3",
 		Packager: "arduino",

serial.go

@@ -25,6 +25,7 @@ import (
 	"sync"
 	"time"
 
+	"github.com/arduino/arduino-create-agent/tools"
 	discovery "github.com/arduino/pluggable-discovery-protocol-handler/v2"
 	"github.com/sirupsen/logrus"
 )
@@ -45,15 +46,17 @@ func newSerialHub() *serialhub {
 }
 
 type serialPortList struct {
+	tools *tools.Tools
+
 	Ports     []*SpPortItem
 	portsLock sync.Mutex
 
 	OnList func([]byte) `json:"-"`
 	OnErr  func(string) `json:"-"`
 }
 
-func newSerialPortList() *serialPortList {
-	return &serialPortList{}
+func newSerialPortList(tools *tools.Tools) *serialPortList {
+	return &serialPortList{tools: tools}
 }
 
 // SpPortItem is the serial port item
@@ -130,11 +133,12 @@ func (sp *serialPortList) Run() {
 
 func (sp *serialPortList) runSerialDiscovery() {
 	// First ensure that all the discoveries are available
-	if err := Tools.Download("builtin", "serial-discovery", "latest", "keep"); err != nil {
+	noOpProgress := func(msg string) {}
+	if err := sp.tools.Download("builtin", "serial-discovery", "latest", "keep", noOpProgress); err != nil {
 		logrus.Errorf("Error downloading serial-discovery: %s", err)
 		panic(err)
 	}
-	sd, err := Tools.GetLocation("serial-discovery")
+	sd, err := sp.tools.GetLocation("serial-discovery")
 	if err != nil {
 		logrus.Errorf("Error downloading serial-discovery: %s", err)
 		panic(err)

tools/download.go

@@ -42,7 +42,7 @@ import (
 // If version is not "latest" and behaviour is "replace", it will download the
 // version again. If instead behaviour is "keep" it will not download the version
 // if it already exists.
-func (t *Tools) Download(pack, name, version, behaviour string) error {
+func (t *Tools) Download(pack, name, version, behaviour string, report func(msg string)) error {
 
 	t.tools.SetBehaviour(behaviour)
 	_, err := t.tools.Install(context.Background(), &tools.ToolPayload{Name: name, Version: version, Packager: pack})
@@ -58,24 +58,24 @@ func (t *Tools) Download(pack, name, version, behaviour string) error {
 
 	// if the tool contains a post_install script, run it: it means it is a tool that needs to install drivers
 	// AFAIK this is only the case for the windows-driver tool
-	err = t.installDrivers(safePath)
+	err = t.installDrivers(safePath, report)
 	if err != nil {
 		return err
 	}
 
 	// Ensure that the files are executable
-	t.logger("Ensure that the files are executable")
+	report("Ensure that the files are executable")
 
 	// Update the tool map
-	t.logger("Updating map with location " + safePath)
+	report("Updating map with location " + safePath)
 
 	t.setMapValue(name, safePath)
 	t.setMapValue(name+"-"+version, safePath)
 
 	return nil
 }
 
-func (t *Tools) installDrivers(location string) error {
+func (t *Tools) installDrivers(location string, report func(msg string)) error {
 	OkPressed := 6
 	extension := ".bat"
 	// add .\ to force locality
@@ -86,11 +86,11 @@ func (t *Tools) installDrivers(location string) error {
 		preamble = "./"
 	}
 	if _, err := os.Stat(filepath.Join(location, "post_install"+extension)); err == nil {
-		t.logger("Installing drivers")
+		report("Installing drivers")
 		ok := MessageBox("Installing drivers", "We are about to install some drivers needed to use Arduino/Genuino boards\nDo you want to continue?")
 		if ok == OkPressed {
 			os.Chdir(location)
-			t.logger(preamble + "post_install" + extension)
+			report(preamble + "post_install" + extension)
 			oscmd := exec.Command(preamble + "post_install" + extension)
 			if runtime.GOOS != "linux" {
 				// spawning a shell could be the only way to let the user type his password