Added additional index URLx flags to ease plugin development

Author: cmaglie

Diff for: cli/cli.go

@@ -24,6 +24,7 @@ import (
 	"os"
 
 	"github.com/arduino/arduino-fwuploader/cli/certificates"
+	"github.com/arduino/arduino-fwuploader/cli/common"
 	"github.com/arduino/arduino-fwuploader/cli/firmware"
 	"github.com/arduino/arduino-fwuploader/cli/version"
 
@@ -36,11 +37,13 @@ import (
 )
 
 var (
-	outputFormat string
-	verbose      bool
-	logFile      string
-	logFormat    string
-	logLevel     string
+	outputFormat           string
+	verbose                bool
+	logFile                string
+	logFormat              string
+	logLevel               string
+	additionalFirmwareURLs []string
+	additionalPackageURLs  []string
 )
 
 func NewCommand() *cobra.Command {
@@ -63,7 +66,8 @@ func NewCommand() *cobra.Command {
 	rootCmd.PersistentFlags().StringVar(&logFormat, "log-format", "", "The output format for the logs, can be {text|json}.")
 	rootCmd.PersistentFlags().StringVar(&logLevel, "log-level", "info", "Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic")
 	rootCmd.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "Print the logs on the standard output.")
-
+	rootCmd.PersistentFlags().StringArrayVarP(&additionalFirmwareURLs, "additional-fw-index", "F", nil, "Additional firmwares index URLs (useful for testing purposes)")
+	rootCmd.PersistentFlags().StringArrayVarP(&additionalPackageURLs, "additional-packages-index", "P", nil, "Additional packages index URLs (useful for testing purposes)")
 	return rootCmd
 }
 
@@ -84,7 +88,6 @@ func toLogLevel(s string) (t logrus.Level, found bool) {
 }
 
 func preRun(cmd *cobra.Command, args []string) {
-
 	// Prepare the Feedback system
 	// check the right output format was passed
 	format, found := feedback.ParseOutputFormat(outputFormat)
@@ -132,4 +135,8 @@ func preRun(cmd *cobra.Command, args []string) {
 	}
 
 	logrus.Info(v.VersionInfo)
+
+	// Setup additional indexes
+	common.AdditionalPackageIndexURLs = append(common.AdditionalPackageIndexURLs, additionalPackageURLs...)
+	common.AdditionalFirmwareIndexURLs = append(common.AdditionalFirmwareIndexURLs, additionalFirmwareURLs...)
 }

Diff for: cli/common/common.go

@@ -37,18 +37,40 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
+// AdditionalPackageIndexURLs is a list of additional package_index.json URLs that
+// are loaded together with the main index.
+var AdditionalPackageIndexURLs []string
+
+// AdditionalFirmwareIndexURLs is a list of additional firwamre_index.json URLs that
+// are loaded together with the main index.
+var AdditionalFirmwareIndexURLs []string
+
 // InitIndexes downloads and parses the package_index.json and firmwares_index.json
 func InitIndexes() (*packagemanager.PackageManager, *firmwareindex.Index) {
 	// Load main package index and optional additional indexes
 	pmbuilder := packagemanager.NewBuilder(nil, nil, nil, nil, "")
 	if err := indexes.GetPackageIndex(pmbuilder, globals.PackageIndexGZURL); err != nil {
 		feedback.Fatal(fmt.Sprintf("Can't load package index: %s", err), feedback.ErrGeneric)
 	}
+	for _, indexURL := range AdditionalPackageIndexURLs {
+		if err := indexes.GetPackageIndex(pmbuilder, indexURL); err != nil {
+			feedback.Fatal(fmt.Sprintf("Can't load firmware index: %s", err), feedback.ErrGeneric)
+		}
+	}
 
-	firmwareIndex, err := indexes.GetFirmwareIndex()
+	// Load main firmware index and optional additional indexes
+	firmwareIndex, err := indexes.GetFirmwareIndex(globals.ModuleFirmwareIndexGZURL)
 	if err != nil {
 		feedback.Fatal(fmt.Sprintf("Can't load firmware index: %s", err), feedback.ErrGeneric)
 	}
+	for _, additionalURL := range AdditionalFirmwareIndexURLs {
+		additionalIndex, err := indexes.GetFirmwareIndex(additionalURL)
+		if err != nil {
+			feedback.Fatal(fmt.Sprintf("Can't load firmware index: %s", err), feedback.ErrGeneric)
+		}
+		firmwareIndex.MergeWith(additionalIndex)
+	}
+
 	return pmbuilder.Build(), firmwareIndex
 }
 

Diff for: cli/firmware/list.go

@@ -22,8 +22,8 @@ import (
 	"os"
 
 	"github.com/arduino/arduino-cli/table"
+	"github.com/arduino/arduino-fwuploader/cli/common"
 	"github.com/arduino/arduino-fwuploader/cli/feedback"
-	"github.com/arduino/arduino-fwuploader/indexes"
 	"github.com/spf13/cobra"
 	semver "go.bug.st/relaxed-semver"
 )
@@ -56,10 +56,7 @@ type FirmwareResult struct {
 type FirmwareListResult []*FirmwareResult
 
 func list(fqbn string) {
-	firmwareIndex, err := indexes.GetFirmwareIndex()
-	if err != nil {
-		feedback.FatalError(err, feedback.ErrGeneric)
-	}
+	_, firmwareIndex := common.InitIndexes()
 
 	res := FirmwareListResult{}
 	for _, board := range firmwareIndex.Boards {

Diff for: indexes/firmwareindex/firmwareindex.go

@@ -125,6 +125,13 @@ func LoadIndexNoSign(jsonIndexFile *paths.Path) (*Index, error) {
 	return &index, nil
 }
 
+// MergeWith merge this index with the other given index (the boards from the other index)
+// are added to this one.
+func (i *Index) MergeWith(j *Index) {
+	i.Boards = append(i.Boards, j.Boards...)
+	i.IsTrusted = i.IsTrusted && j.IsTrusted
+}
+
 // GetBoard returns the IndexBoard for the given FQBN
 func (i *Index) GetBoard(fqbn string) *IndexBoard {
 	for _, b := range i.Boards {

Diff for: indexes/indexes.go

@@ -23,7 +23,6 @@ import (
 
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
-	"github.com/arduino/arduino-fwuploader/cli/globals"
 	"github.com/arduino/arduino-fwuploader/indexes/download"
 	"github.com/arduino/arduino-fwuploader/indexes/firmwareindex"
 	"github.com/sirupsen/logrus"
@@ -58,13 +57,16 @@ func GetPackageIndex(pmbuilder *packagemanager.Builder, indexURL string) error {
 		logrus.Error(err)
 		return err
 	}
-	pmbuilder.LoadPackageIndexFromFile(indexPath)
-	return nil
+	_, err = pmbuilder.LoadPackageIndexFromFile(indexPath)
+	if err != nil {
+		logrus.Error(err)
+	}
+	return err
 }
 
 // GetFirmwareIndex downloads and loads the arduino-fwuploader module_firmware_index.json
-func GetFirmwareIndex() (*firmwareindex.Index, error) {
-	indexPath, err := download.DownloadIndex(globals.ModuleFirmwareIndexGZURL)
+func GetFirmwareIndex(indexUrl string) (*firmwareindex.Index, error) {
+	indexPath, err := download.DownloadIndex(indexUrl)
 	if err != nil {
 		logrus.Error(err)
 		return nil, err

Diff for: indexes/indexes_test.go

@@ -21,30 +21,19 @@ package indexes
 import (
 	"testing"
 
-	"github.com/arduino/arduino-cli/arduino/cores/packageindex"
-	"github.com/arduino/go-paths-helper"
+	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
+	"github.com/arduino/arduino-fwuploader/cli/globals"
 	"github.com/stretchr/testify/require"
 )
 
-func TestGetToolRelease(t *testing.T) {
-	indexFile := paths.New("testdata/package_index.json")
-	index, err := packageindex.LoadIndexNoSign(indexFile)
-	require.NoError(t, err)
-	toolRelease := GetToolRelease(index, "arduino:[email protected]")
-
-	require.Equal(t, toolRelease.Version.String(), "1.7.0-arduino3")
-	require.Equal(t, toolRelease.Tool.Name, "bossac")
-	require.NotEmpty(t, toolRelease.Flavors)
-}
-
 func TestGetPackageIndex(t *testing.T) {
-	index, err := GetPackageIndex()
+	pmb := packagemanager.NewBuilder(nil, nil, nil, nil, "")
+	err := GetPackageIndex(pmb, globals.PackageIndexGZURL)
 	require.NoError(t, err)
-	require.NotNil(t, index)
 }
 
 func TestGetFirmwareIndex(t *testing.T) {
-	index, err := GetFirmwareIndex()
+	index, err := GetFirmwareIndex(globals.ModuleFirmwareIndexGZURL)
 	require.NoError(t, err)
 	require.NotNil(t, index)
 }