Fix invalid JSON output for outdated command

Fixes issue #2104

The code for `internal/cli/core` and `internal/cli/lib` has been
refactored so that we can use only the `Get` functions from
`internal/cli/outdated` package and compose there the table and JSON
object.

For regular text output, the new table will have some extra fields that
either for platforms or for libraries will be blank.

For JSON output, the resulting object will be an array of two arrays:
the outdated platforms and the outdated libraries.

Signed-off-by: Lluís Martínez <lluis@tastaollet.es>

Author: lluiscampos

internal/cli/core/list.go

@@ -52,8 +52,14 @@ func runListCommand(args []string, all bool, updatableOnly bool) {
 	List(inst, all, updatableOnly)
 }
 
-// List print a list of installed platforms.
+// List gets and prints a list of installed platforms.
 func List(inst *rpc.Instance, all bool, updatableOnly bool) {
+	platforms := GetList(inst, all, updatableOnly)
+	PrintList(platforms)
+}
+
+// GetList returns a list of installed platforms.
+func GetList(inst *rpc.Instance, all bool, updatableOnly bool) []*rpc.Platform {
 	platforms, err := core.GetPlatforms(&rpc.PlatformListRequest{
 		Instance:      inst,
 		UpdatableOnly: updatableOnly,
@@ -62,7 +68,11 @@ func List(inst *rpc.Instance, all bool, updatableOnly bool) {
 	if err != nil {
 		feedback.Fatal(tr("Error listing platforms: %v", err), feedback.ErrGeneric)
 	}
+	return platforms
+}
 
+// PrintList prints a list of installed platforms.
+func PrintList(platforms []*rpc.Platform) {
 	feedback.PrintResult(installedResult{platforms})
 }
 

internal/cli/lib/list.go

@@ -60,8 +60,20 @@ func runListCommand(args []string, all bool, updatable bool) {
 	List(instance, args, all, updatable)
 }
 
-// List lists all the installed libraries.
+// List gets and prints a list of installed libraries.
 func List(instance *rpc.Instance, args []string, all bool, updatable bool) {
+	installedLibs := GetList(instance, args, all, updatable)
+	PrintList(updatable, installedLibs)
+	logrus.Info("Done")
+}
+
+// GetList returns a list of installed libraries.
+func GetList(
+	instance *rpc.Instance,
+	args []string,
+	all bool,
+	updatable bool,
+) []*rpc.InstalledLibrary {
 	name := ""
 	if len(args) > 0 {
 		name = args[0]
@@ -95,11 +107,15 @@ func List(instance *rpc.Instance, args []string, all bool, updatable bool) {
 		libs = []*rpc.InstalledLibrary{}
 	}
 
+	return libs
+}
+
+// PrintList prints a list of installed libraries.
+func PrintList(updatable bool, libs []*rpc.InstalledLibrary) {
 	feedback.PrintResult(installedResult{
 		onlyUpdates:   updatable,
 		installedLibs: libs,
 	})
-	logrus.Info("Done")
 }
 
 // output from this command requires special formatting, let's create a dedicated

internal/cli/outdated/outdated.go

@@ -16,13 +16,18 @@
 package outdated
 
 import (
+	"fmt"
 	"os"
+	"sort"
+	"strings"
 
 	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/arduino-cli/internal/cli/core"
+	"github.com/arduino/arduino-cli/internal/cli/feedback"
 	"github.com/arduino/arduino-cli/internal/cli/instance"
 	"github.com/arduino/arduino-cli/internal/cli/lib"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+	"github.com/arduino/arduino-cli/table"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
@@ -49,8 +54,97 @@ func runOutdatedCommand(cmd *cobra.Command, args []string) {
 	Outdated(inst)
 }
 
-// Outdated returns a list of outdated platforms and libraries
+// Outdated prints a list of outdated platforms and libraries
 func Outdated(inst *rpc.Instance) {
-	core.List(inst, false, true)
-	lib.List(inst, []string{}, false, true)
+	feedback.PrintResult(
+		outdatedResult{core.GetList(inst, false, true), lib.GetList(inst, []string{}, false, true)},
+	)
+}
+
+// output from this command requires special formatting, let's create a dedicated
+// feedback.Result implementation
+type outdatedResult struct {
+	platforms     []*rpc.Platform
+	installedLibs []*rpc.InstalledLibrary
+}
+
+func (ir outdatedResult) Data() interface{} {
+	return []interface{}{ir.platforms, ir.installedLibs}
+}
+
+func (ir outdatedResult) String() string {
+	if len(ir.platforms) == 0 && len(ir.installedLibs) == 0 {
+		return tr("No outdated platforms or libraries found.")
+	}
+
+	// A table useful both for platforms and libraries, where some of the fields will be blank.
+	t := table.New()
+	t.SetHeader(
+		tr("ID"),
+		tr("Name"),
+		tr("Installed"),
+		tr("Latest"),
+		tr("Location"),
+		tr("Description"),
+	)
+	t.SetColumnWidthMode(2, table.Average)
+	t.SetColumnWidthMode(3, table.Average)
+	t.SetColumnWidthMode(5, table.Average)
+
+	// Based on internal/cli/core/list.go
+	for _, p := range ir.platforms {
+		name := p.Name
+		if p.Deprecated {
+			name = fmt.Sprintf("[%s] %s", tr("DEPRECATED"), name)
+		}
+		t.AddRow(p.Id, name, p.Installed, p.Latest, "", "")
+	}
+
+	// Based on internal/cli/lib/list.go
+	sort.Slice(ir.installedLibs, func(i, j int) bool {
+		return strings.ToLower(
+			ir.installedLibs[i].Library.Name,
+		) < strings.ToLower(
+			ir.installedLibs[j].Library.Name,
+		) ||
+			strings.ToLower(
+				ir.installedLibs[i].Library.ContainerPlatform,
+			) < strings.ToLower(
+				ir.installedLibs[j].Library.ContainerPlatform,
+			)
+	})
+	lastName := ""
+	for _, libMeta := range ir.installedLibs {
+		lib := libMeta.GetLibrary()
+		name := lib.Name
+		if name == lastName {
+			name = ` "`
+		} else {
+			lastName = name
+		}
+
+		location := lib.GetLocation().String()
+		if lib.ContainerPlatform != "" {
+			location = lib.GetContainerPlatform()
+		}
+
+		available := ""
+		sentence := ""
+		if libMeta.GetRelease() != nil {
+			available = libMeta.GetRelease().GetVersion()
+			sentence = lib.Sentence
+		}
+
+		if available == "" {
+			available = "-"
+		}
+		if sentence == "" {
+			sentence = "-"
+		} else if len(sentence) > 40 {
+			sentence = sentence[:37] + "..."
+		}
+		t.AddRow("", name, lib.Version, available, location, sentence)
+	}
+
+	return t.Render()
 }

internal/integrationtest/update/update_test.go

@@ -67,7 +67,7 @@ func TestUpdateShowingOutdated(t *testing.T) {
 	require.Contains(t, lines[0], "Downloading index: library_index.tar.bz2 downloaded")
 	require.Contains(t, lines[1], "Downloading index: package_index.tar.bz2 downloaded")
 	require.Contains(t, lines[3], "Arduino AVR Boards")
-	require.Contains(t, lines[6], "USBHost")
+	require.Contains(t, lines[4], "USBHost")
 }
 
 func TestUpdateWithUrlNotFound(t *testing.T) {

internal/integrationtest/upgrade/upgrade_test.go

@@ -50,15 +50,15 @@ func TestUpgrade(t *testing.T) {
 	require.NoError(t, err)
 	lines := strings.Split(string(stdout), "\n")
 	require.Contains(t, lines[1], "Arduino AVR Boards")
-	require.Contains(t, lines[4], "USBHost")
+	require.Contains(t, lines[2], "USBHost")
 
 	_, _, err = cli.Run("upgrade")
 	require.NoError(t, err)
 
 	// Verifies cores and libraries have been updated
 	stdout, _, err = cli.Run("outdated")
 	require.NoError(t, err)
-	require.Contains(t, string(stdout), "No libraries update is available.")
+	require.Contains(t, string(stdout), "No outdated platforms or libraries found.")
 }
 
 func TestUpgradeUsingLibraryWithInvalidVersion(t *testing.T) {