Better handling of 'core list' results

arduino · cmaglie · Oct 23, 2023 · Oct 6, 2023 · Oct 16, 2023 · Oct 16, 2023
commit f11b45d51fd0948d3774cd990a7b663f7e6830e0
diff --git a/.licenses/go/github.com/iancoleman/orderedmap.dep.yml b/.licenses/go/github.com/iancoleman/orderedmap.dep.yml
@@ -0,0 +1,32 @@
+---
+name: github.com/iancoleman/orderedmap
+version: v0.3.0
+type: go
+summary: 
+homepage: https://pkg.go.dev/github.com/iancoleman/orderedmap
+license: mit
+licenses:
+- sources: LICENSE
+  text: |
+    The MIT License (MIT)
+
+    Copyright (c) 2017 Ian Coleman
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, Subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or Substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE.
+notices: []
diff --git a/go.mod b/go.mod
@@ -20,6 +20,7 @@ require (
 	github.com/fatih/color v1.15.0
 	github.com/go-git/go-git/v5 v5.4.2
 	github.com/gofrs/uuid/v5 v5.0.0
+	github.com/iancoleman/orderedmap v0.3.0
 	github.com/leonelquinteros/gotext v1.4.0
 	github.com/mailru/easyjson v0.7.7
 	github.com/marcinbor85/gohex v0.0.0-20210308104911-55fb1c624d84

diff --git a/go.sum b/go.sum
@@ -255,6 +255,8 @@ github.com/hashicorp/logutils v1.0.0/go.mod h1:QIAnNjmIWmVIIkWDTG1z5v++HQmx9WQRO
 github.com/hashicorp/mdns v1.0.0/go.mod h1:tL+uN++7HEJ6SQLQ2/p+z2pH24WQKWjBPkE0mNTz8vQ=
 github.com/hashicorp/memberlist v0.1.3/go.mod h1:ajVTdAv/9Im8oMAAj5G31PhhMCZJV2pPBoIllUwCN7I=
 github.com/hashicorp/serf v0.8.2/go.mod h1:6hOLApaqBFA1NXqRQAsxw9QxuDEvNxSQRwA/JwenrHc=
+github.com/iancoleman/orderedmap v0.3.0 h1:5cbR2grmZR/DiVt+VJopEhtVs9YGInGIxAoMJn+Ichc=
+github.com/iancoleman/orderedmap v0.3.0/go.mod h1:XuLcCUkdL5owUCQeF2Ue9uuw1EptkJDkXXS7VoV7XGE=
 github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc=
 github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc=
 github.com/imdario/mergo v0.3.12 h1:b6R2BslTbIEToALKP7LxUvijTsNI9TAe80pLWN2g/HU=

diff --git a/internal/cli/core/list.go b/internal/cli/core/list.go
@@ -21,6 +21,7 @@ import (
 
 	"github.com/arduino/arduino-cli/commands/core"
 	"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/arduino/arduino-cli/table"
@@ -55,7 +56,7 @@ func runListCommand(args []string, all bool, updatableOnly bool) {
 // List gets and prints a list of installed platforms.
 func List(inst *rpc.Instance, all bool, updatableOnly bool) {
 	platforms := GetList(inst, all, updatableOnly)
-	feedback.PrintResult(installedResult{platforms})
+	feedback.PrintResult(newCoreListResult(platforms))
 }
 
 // GetList returns a list of installed platforms.
@@ -81,34 +82,44 @@ func GetList(inst *rpc.Instance, all bool, updatableOnly bool) []*rpc.PlatformSu
 	return result
 }
 
-// output from this command requires special formatting, let's create a dedicated
-// feedback.Result implementation
-type installedResult struct {
-	platforms []*rpc.PlatformSummary
+func newCoreListResult(in []*rpc.PlatformSummary) *coreListResult {
+	res := &coreListResult{}
+	for _, platformSummary := range in {
+		res.platforms = append(res.platforms, result.NewPlatformResult(platformSummary))
+	}
+	return res
+}
+
+type coreListResult struct {
+	platforms []*result.Platform
 }
 
-func (ir installedResult) Data() interface{} {
+// Data implements Result interface
+func (ir coreListResult) Data() interface{} {
 	return ir.platforms
 }
 
-func (ir installedResult) String() string {
+// String implements Result interface
+func (ir coreListResult) String() string {
 	if len(ir.platforms) == 0 {
 		return tr("No platforms installed.")
 	}
 	t := table.New()
 	t.SetHeader(tr("ID"), tr("Installed"), tr("Latest"), tr("Name"))
 	for _, platform := range ir.platforms {
-		installedRelease := platform.GetInstalledRelease()
-		latestRelease := platform.GetLatestRelease()
-
-		name := installedRelease.GetName()
+		name := ""
+		if installed := platform.GetLatestRelease(); installed != nil {
+			name = installed.Name
+		}
 		if name == "" {
-			name = latestRelease.GetName()
+			if latest := platform.GetLatestRelease(); latest != nil {
+				name = latest.Name
+			}
 		}
-		if platform.Metadata.Deprecated {
+		if platform.Deprecated {
 			name = fmt.Sprintf("[%s] %s", tr("DEPRECATED"), name)
 		}
-		t.AddRow(platform.Metadata.Id, platform.InstalledVersion, platform.LatestVersion, name)
+		t.AddRow(platform.Id, platform.InstalledVersion, platform.LatestVersion, name)
 	}
 
 	return t.Render()

diff --git a/internal/cli/feedback/result/rpc.go b/internal/cli/feedback/result/rpc.go
@@ -0,0 +1,146 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-cli.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to license@arduino.cc.
+
+package result
+
+import (
+	"slices"
+
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+	"github.com/iancoleman/orderedmap"
+	semver "go.bug.st/relaxed-semver"
+)
+
+// NewPlatformResult creates a new result.Platform from rpc.PlatformSummary
+func NewPlatformResult(in *rpc.PlatformSummary) *Platform {
+	meta := in.Metadata
+	res := &Platform{
+		Id:                meta.Id,
+		Maintainer:        meta.Maintainer,
+		Website:           meta.Website,
+		Email:             meta.Email,
+		ManuallyInstalled: meta.ManuallyInstalled,
+		Deprecated:        meta.Deprecated,
+		Indexed:           meta.Indexed,
+
+		Releases:         orderedmap.New(),
+		InstalledVersion: in.InstalledVersion,
+		LatestVersion:    in.LatestVersion,
+	}
+
+	for k, v := range in.Releases {
+		res.Releases.Set(k, NewPlatformReleaseResult(v))
+	}
+	res.Releases.SortKeys(func(keys []string) {
+		slices.SortFunc(keys, func(x, y string) int {
+			return semver.ParseRelaxed(x).CompareTo(semver.ParseRelaxed(y))
+		})
+	})
+
+	versions := []*semver.RelaxedVersion{}
+	for version := range in.Releases {
+		versions = append(versions, semver.ParseRelaxed(version))
+	}
+	slices.SortFunc(versions, (*semver.RelaxedVersion).CompareTo)
+	for _, version := range versions {
+		res.Releases.Set(version.String(), NewPlatformReleaseResult(in.Releases[version.String()]))
+	}
+	return res
+}
+
+// Platform maps a rpc.Platform
+type Platform struct {
+	Id                string `json:"id,omitempty"`
+	Maintainer        string `json:"maintainer,omitempty"`
+	Website           string `json:"website,omitempty"`
+	Email             string `json:"email,omitempty"`
+	ManuallyInstalled bool   `json:"manually_installed,omitempty"`
+	Deprecated        bool   `json:"deprecated,omitempty"`
+	Indexed           bool   `json:"indexed,omitempty"`
+
+	Releases *orderedmap.OrderedMap `json:"releases,omitempty"`
+
+	InstalledVersion string `json:"installed_version,omitempty"`
+	LatestVersion    string `json:"latest_version,omitempty"`
+}
+
+// GetLatestRelease returns the latest relase of this platform or nil if none available.
+func (p *Platform) GetLatestRelease() *PlatformRelease {
+	res, ok := p.Releases.Get(p.LatestVersion)
+	if !ok {
+		return nil
+	}
+	return res.(*PlatformRelease)
+}
+
+// GetInstalledRelease returns the installed relase of this platform or nil if none available.
+func (p *Platform) GetInstalledRelease() *PlatformRelease {
+	res, ok := p.Releases.Get(p.InstalledVersion)
+	if !ok {
+		return nil
+	}
+	return res.(*PlatformRelease)
+}
+
+// NewPlatformReleaseResult creates a new result.PlatformRelease from rpc.PlatformRelease
+func NewPlatformReleaseResult(in *rpc.PlatformRelease) *PlatformRelease {
+	var boards []*Board
+	for _, board := range in.Boards {
+		boards = append(boards, &Board{
+			Name: board.Name,
+			Fqbn: board.Fqbn,
+		})
+	}
+	var help *HelpResource
+	if in.Help != nil {
+		help = &HelpResource{
+			Online: in.Help.Online,
+		}
+	}
+	res := &PlatformRelease{
+		Name:            in.Name,
+		Version:         in.Version,
+		Type:            in.Type,
+		Installed:       in.Installed,
+		Boards:          boards,
+		Help:            help,
+		MissingMetadata: in.MissingMetadata,
+		Deprecated:      in.Deprecated,
+	}
+	return res
+}
+
+// PlatformRelease maps a rpc.PlatformRelease
+type PlatformRelease struct {
+	Name            string        `json:"name,omitempty"`
+	Version         string        `json:"version,omitempty"`
+	Type            []string      `json:"type,omitempty"`
+	Installed       bool          `json:"installed,omitempty"`
+	Boards          []*Board      `json:"boards,omitempty"`
+	Help            *HelpResource `json:"help,omitempty"`
+	MissingMetadata bool          `json:"missing_metadata,omitempty"`
+	Deprecated      bool          `json:"deprecated,omitempty"`
+}
+
+// Board maps a rpc.Board
+type Board struct {
+	Name string `json:"name,omitempty"`
+	Fqbn string `json:"fqbn,omitempty"`
+}
+
+// HelpResource maps a rpc.HelpResource
+type HelpResource struct {
+	Online string `json:"online,omitempty"`
+}