Added json output to 'core update index'

Author: cmaglie

Diff for: internal/cli/core/update_index.go

@@ -21,6 +21,7 @@ import (
 
 	"github.com/arduino/arduino-cli/commands"
 	"github.com/arduino/arduino-cli/internal/cli/feedback"
+	"github.com/arduino/arduino-cli/internal/cli/feedback/result"
 	"github.com/arduino/arduino-cli/internal/cli/instance"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/sirupsen/logrus"
@@ -42,13 +43,28 @@ func initUpdateIndexCommand() *cobra.Command {
 func runUpdateIndexCommand(cmd *cobra.Command, args []string) {
 	inst := instance.CreateAndInit()
 	logrus.Info("Executing `arduino-cli core update-index`")
-	UpdateIndex(inst)
+	resp := UpdateIndex(inst)
+
+	feedback.PrintResult(&updateIndexResult{result.NewUpdateIndexResponse_ResultResult(resp)})
 }
 
 // UpdateIndex updates the index of platforms.
-func UpdateIndex(inst *rpc.Instance) {
-	_, err := commands.UpdateIndex(context.Background(), &rpc.UpdateIndexRequest{Instance: inst}, feedback.ProgressBar())
+func UpdateIndex(inst *rpc.Instance) *rpc.UpdateIndexResponse_Result {
+	res, err := commands.UpdateIndex(context.Background(), &rpc.UpdateIndexRequest{Instance: inst}, feedback.ProgressBar())
 	if err != nil {
 		feedback.FatalError(err, feedback.ErrGeneric)
 	}
+	return res
+}
+
+type updateIndexResult struct {
+	*result.UpdateIndexResponse_ResultResult
+}
+
+func (r *updateIndexResult) Data() interface{} {
+	return r
+}
+
+func (r *updateIndexResult) String() string {
+	return ""
 }

Diff for: internal/cli/feedback/result/rpc.go

@@ -1065,3 +1065,52 @@ func NewIsDebugSupportedResponse(resp *rpc.IsDebugSupportedResponse) *IsDebugSup
 		DebugFQBN:          resp.GetDebugFqbn(),
 	}
 }
+
+type UpdateIndexResponse_ResultResult struct {
+	UpdatedIndexes []*IndexUpdateReportResult `json:"updated_indexes,omitempty"`
+}
+
+func NewUpdateIndexResponse_ResultResult(resp *rpc.UpdateIndexResponse_Result) *UpdateIndexResponse_ResultResult {
+	return &UpdateIndexResponse_ResultResult{
+		UpdatedIndexes: f.Map(resp.GetUpdatedIndexes(), NewIndexUpdateReportResult),
+	}
+}
+
+type IndexUpdateReportResult struct {
+	IndexURL string                   `json:"index_url"`
+	Status   IndexUpdateReport_Status `json:"status"`
+}
+
+func NewIndexUpdateReportResult(resp *rpc.IndexUpdateReport) *IndexUpdateReportResult {
+	return &IndexUpdateReportResult{
+		IndexURL: resp.GetIndexUrl(),
+		Status:   NewIndexUpdateReport_Status(resp.GetStatus()),
+	}
+}
+
+type IndexUpdateReport_Status string
+
+const (
+	IndexUpdateReport_StatusUnspecified     IndexUpdateReport_Status = "unspecified"
+	IndexUpdateReport_StatusAlreadyUpToDate IndexUpdateReport_Status = "already-up-to-date"
+	IndexUpdateReport_StatusFailed          IndexUpdateReport_Status = "failed"
+	IndexUpdateReport_StatusSkipped         IndexUpdateReport_Status = "skipped"
+	IndexUpdateReport_StatusUpdated         IndexUpdateReport_Status = "updated"
+)
+
+func NewIndexUpdateReport_Status(r rpc.IndexUpdateReport_Status) IndexUpdateReport_Status {
+	switch r {
+	case rpc.IndexUpdateReport_STATUS_UNSPECIFIED:
+		return IndexUpdateReport_StatusUnspecified
+	case rpc.IndexUpdateReport_STATUS_UPDATED:
+		return IndexUpdateReport_StatusUpdated
+	case rpc.IndexUpdateReport_STATUS_ALREADY_UP_TO_DATE:
+		return IndexUpdateReport_StatusAlreadyUpToDate
+	case rpc.IndexUpdateReport_STATUS_FAILED:
+		return IndexUpdateReport_StatusFailed
+	case rpc.IndexUpdateReport_STATUS_SKIPPED:
+		return IndexUpdateReport_StatusSkipped
+	default:
+		return IndexUpdateReport_StatusUnspecified
+	}
+}

Diff for: internal/cli/feedback/result/rpc_test.go

@@ -221,6 +221,14 @@ func TestAllFieldAreMapped(t *testing.T) {
 	isDebugSupportedResponseRpc := &rpc.IsDebugSupportedResponse{}
 	isDebugSupportedResponseResult := result.NewIsDebugSupportedResponse(isDebugSupportedResponseRpc)
 	mustContainsAllPropertyOfRpcStruct(t, isDebugSupportedResponseRpc, isDebugSupportedResponseResult)
+
+	updateIndexResponse_ResultRpc := &rpc.UpdateIndexResponse_Result{}
+	updateIndexResponse_ResultResult := result.NewUpdateIndexResponse_ResultResult(updateIndexResponse_ResultRpc)
+	mustContainsAllPropertyOfRpcStruct(t, updateIndexResponse_ResultRpc, updateIndexResponse_ResultResult)
+
+	indexUpdateReportRpc := &rpc.IndexUpdateReport{}
+	indexUpdateReportResult := result.NewIndexUpdateReportResult(indexUpdateReportRpc)
+	mustContainsAllPropertyOfRpcStruct(t, indexUpdateReportRpc, indexUpdateReportResult)
 }
 
 func TestEnumsMapsEveryRpcCounterpart(t *testing.T) {
@@ -251,6 +259,15 @@ func TestEnumsMapsEveryRpcCounterpart(t *testing.T) {
 		require.Len(t, results, len(rpc.LibrarySearchStatus_name))
 		require.True(t, isUnique(results))
 	})
+	t.Run("IndexUpdateReport_Status enums maps every element", func(t *testing.T) {
+		results := make([]result.IndexUpdateReport_Status, 0, len(rpc.IndexUpdateReport_Status_name))
+		for key := range rpc.IndexUpdateReport_Status_name {
+			results = append(results, result.NewIndexUpdateReport_Status(rpc.IndexUpdateReport_Status(key)))
+		}
+		require.NotEmpty(t, results)
+		require.Len(t, results, len(rpc.IndexUpdateReport_Status_name))
+		require.True(t, isUnique(results))
+	})
 }
 
 func isUnique[T comparable](s []T) bool {

Diff for: internal/integrationtest/core/core_test.go

@@ -445,9 +445,9 @@ func TestCoreUpdateWithLocalUrl(t *testing.T) {
 		testIndex = "/" + strings.ReplaceAll(testIndex, "\\", "/")
 	}
 
-	stdout, _, err := cli.Run("core", "update-index", "--additional-urls=file://"+testIndex)
+	stdout, _, err := cli.Run("core", "update-index", "--additional-urls=file://"+testIndex, "--format", "json")
 	require.NoError(t, err)
-	require.Contains(t, string(stdout), "Downloading index: test_index.json downloaded")
+	requirejson.Parse(t, stdout).MustContain(`{"updated_indexes":[{"index_url":"file://` + testIndex + `","status":"skipped"}]}`)
 }
 
 func TestCoreSearchManuallyInstalledCoresNotPrinted(t *testing.T) {