allow the tools endpoint to install and list available tools from default package_index.json only

and fix/adapt tests

Author: umbynos

main_test.go

@@ -135,7 +135,7 @@ func TestInstallToolV2(t *testing.T) {
 	tests := []test{
 		{bossacInstallURLOK, http.StatusOK, "ok"},
 		{bossacInstallWrongSig, http.StatusInternalServerError, "verification error"},
-		{bossacInstallNoURL, http.StatusBadRequest, "tool not found"}, //because the index is not added
+		{bossacInstallNoURL, http.StatusOK, "ok"},
 	}
 
 	for _, test := range tests {

v2/pkgs/tools.go

@@ -29,8 +29,10 @@ import (
 	"path/filepath"
 	"runtime"
 	"strings"
+	"time"
 
 	"github.com/arduino/arduino-create-agent/gen/tools"
+	"github.com/arduino/arduino-create-agent/index"
 	"github.com/arduino/arduino-create-agent/utilities"
 	"github.com/codeclysm/extract/v3"
 )
@@ -55,25 +57,29 @@ type Tools struct {
 
 // Available crawles the downloaded package index files and returns a list of tools that can be installed.
 func (c *Tools) Available(ctx context.Context) (res tools.ToolCollection, err error) {
-	list, err := c.Indexes.List(ctx)
+	if !c.Index.IndexFile.Exist() || time.Since(c.Index.LastRefresh) > 1*time.Hour {
+		// Download the file again and save it
+		err := c.Index.DownloadAndVerify()
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	body, err := os.ReadFile(c.Index.IndexFile.String())
 	if err != nil {
 		return nil, err
 	}
 
-	for _, url := range list {
-		index, err := c.Indexes.Get(ctx, url)
-		if err != nil {
-			return nil, err
-		}
+	var index Index
+	json.Unmarshal(body, &index)
 
-		for _, packager := range index.Packages {
-			for _, tool := range packager.Tools {
-				res = append(res, &tools.Tool{
-					Packager: packager.Name,
-					Name:     tool.Name,
-					Version:  tool.Version,
-				})
-			}
+	for _, packager := range index.Packages {
+		for _, tool := range packager.Tools {
+			res = append(res, &tools.Tool{
+				Packager: packager.Name,
+				Name:     tool.Name,
+				Version:  tool.Version,
+			})
 		}
 	}
 
@@ -142,31 +148,35 @@ func (c *Tools) Install(ctx context.Context, payload *tools.ToolPayload) (*tools
 		return c.install(ctx, path, *payload.URL, *payload.Checksum)
 	}
 
-	// otherwise we install from the loaded indexes
-	list, err := c.Indexes.List(ctx)
+	// otherwise we install from the default index
+	if !c.Index.IndexFile.Exist() || time.Since(c.Index.LastRefresh) > 1*time.Hour {
+		// Download the file again and save it
+		err := c.Index.DownloadAndVerify()
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	body, err := os.ReadFile(c.Index.IndexFile.String())
 	if err != nil {
 		return nil, err
 	}
 
-	for _, url := range list {
-		index, err := c.Indexes.Get(ctx, url)
-		if err != nil {
-			return nil, err
-		}
+	var index Index
+	json.Unmarshal(body, &index)
 
-		for _, packager := range index.Packages {
-			if packager.Name != payload.Packager {
-				continue
-			}
+	for _, packager := range index.Packages {
+		if packager.Name != payload.Packager {
+			continue
+		}
 
-			for _, tool := range packager.Tools {
-				if tool.Name == payload.Name &&
-					tool.Version == payload.Version {
+		for _, tool := range packager.Tools {
+			if tool.Name == payload.Name &&
+				tool.Version == payload.Version {
 
-					sys := tool.GetFlavourCompatibleWith(runtime.GOOS, runtime.GOARCH)
+				sys := tool.GetFlavourCompatibleWith(runtime.GOOS, runtime.GOARCH)
 
-					return c.install(ctx, path, sys.URL, sys.Checksum)
-				}
+				return c.install(ctx, path, sys.URL, sys.Checksum)
 			}
 		}
 	}

v2/pkgs/tools_test.go

@@ -17,60 +17,45 @@ package pkgs_test
 
 import (
 	"context"
-	"net/http"
-	"net/http/httptest"
 	"os"
 	"runtime"
 	"strings"
 	"testing"
 
-	"github.com/arduino/arduino-create-agent/gen/indexes"
+	"github.com/arduino/arduino-create-agent/config"
 	"github.com/arduino/arduino-create-agent/gen/tools"
+	"github.com/arduino/arduino-create-agent/index"
 	"github.com/arduino/arduino-create-agent/v2/pkgs"
 	"github.com/stretchr/testify/require"
 )
 
 // TestTools performs a series of operations about tools, ensuring it behaves as expected.
 // This test depends on the internet so it could fail unexpectedly
 func TestTools(t *testing.T) {
-	// Use local file as index
-	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		http.ServeFile(w, r, "testdata/package_index.json")
-	}))
-	defer ts.Close()
-
 	// Initialize indexes with a temp folder
 	tmp, err := os.MkdirTemp("", "")
 	if err != nil {
 		t.Fatal(err)
 	}
 	defer os.RemoveAll(tmp)
 
-	indexesClient := pkgs.Indexes{
-		Folder: tmp,
-	}
+	indexURL := "https://downloads.arduino.cc/packages/package_staging_index.json"
+	// Instantiate Index
+	Index := index.Init(indexURL, config.GetDataDir())
 
 	service := pkgs.Tools{
-		Folder:  tmp,
-		Indexes: &indexesClient,
+		Folder: tmp,
+		Index:  Index,
 	}
 
 	ctx := context.Background()
 
-	// Add a new index
-	_, err = indexesClient.Add(ctx, &indexes.IndexPayload{URL: ts.URL})
-	if err != nil {
-		t.Fatal(err)
-	}
-
 	// List available tools
 	available, err := service.Available(ctx)
 	if err != nil {
 		t.Fatal(err)
 	}
-	if len(available) != 61 {
-		t.Fatalf("expected %d == %d (%s)", len(available), 61, "len(available)")
-	}
+	require.NotEmpty(t, available)
 
 	// Try to install a non-existent tool
 	_, err = service.Install(ctx, &tools.ToolPayload{})