return the Platform struct from the PlatformUpgrade commands

Author: alessio-perugini

Diff for: arduino/cores/packagemanager/install_uninstall.go

@@ -38,35 +38,35 @@ func (pme *Explorer) DownloadAndInstallPlatformUpgrades(
 	downloadCB rpc.DownloadProgressCB,
 	taskCB rpc.TaskProgressCB,
 	skipPostInstall bool,
-) error {
+) (*cores.PlatformRelease, error) {
 	if platformRef.PlatformVersion != nil {
-		return &arduino.InvalidArgumentError{Message: tr("Upgrade doesn't accept parameters with version")}
+		return nil, &arduino.InvalidArgumentError{Message: tr("Upgrade doesn't accept parameters with version")}
 	}
 
 	// Search the latest version for all specified platforms
 	platform := pme.FindPlatform(platformRef)
 	if platform == nil {
-		return &arduino.PlatformNotFoundError{Platform: platformRef.String()}
+		return nil, &arduino.PlatformNotFoundError{Platform: platformRef.String()}
 	}
 	installed := pme.GetInstalledPlatformRelease(platform)
 	if installed == nil {
-		return &arduino.PlatformNotFoundError{Platform: platformRef.String()}
+		return nil, &arduino.PlatformNotFoundError{Platform: platformRef.String()}
 	}
 	latest := platform.GetLatestRelease()
 	if !latest.Version.GreaterThan(installed.Version) {
-		return &arduino.PlatformAlreadyAtTheLatestVersionError{}
+		return latest, &arduino.PlatformAlreadyAtTheLatestVersionError{Platform: platformRef.String()}
 	}
 	platformRef.PlatformVersion = latest.Version
 
 	platformRelease, tools, err := pme.FindPlatformReleaseDependencies(platformRef)
 	if err != nil {
-		return &arduino.PlatformNotFoundError{Platform: platformRef.String()}
+		return platformRelease, &arduino.PlatformNotFoundError{Platform: platformRef.String()}
 	}
 	if err := pme.DownloadAndInstallPlatformAndTools(platformRelease, tools, downloadCB, taskCB, skipPostInstall); err != nil {
-		return err
+		return platformRelease, err
 	}
 
-	return nil
+	return platformRelease, nil
 }
 
 // DownloadAndInstallPlatformAndTools runs a full installation process for the given platform and tools.

Diff for: commands/core/upgrade.go

@@ -17,6 +17,7 @@ package core
 
 import (
 	"context"
+	"github.com/arduino/arduino-cli/arduino/cores"
 
 	"github.com/arduino/arduino-cli/arduino"
 	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
@@ -26,10 +27,10 @@ import (
 
 // PlatformUpgrade FIXMEDOC
 func PlatformUpgrade(ctx context.Context, req *rpc.PlatformUpgradeRequest, downloadCB rpc.DownloadProgressCB, taskCB rpc.TaskProgressCB) (*rpc.PlatformUpgradeResponse, error) {
-	upgrade := func() error {
+	upgrade := func() (*cores.PlatformRelease, error) {
 		pme, release := commands.GetPackageManagerExplorer(req)
 		if pme == nil {
-			return &arduino.InvalidInstanceError{}
+			return nil, &arduino.InvalidInstanceError{}
 		}
 		defer release()
 
@@ -38,18 +39,26 @@ func PlatformUpgrade(ctx context.Context, req *rpc.PlatformUpgradeRequest, downl
 			Package:              req.PlatformPackage,
 			PlatformArchitecture: req.Architecture,
 		}
-		if err := pme.DownloadAndInstallPlatformUpgrades(ref, downloadCB, taskCB, req.GetSkipPostInstall()); err != nil {
-			return err
+		platform, err := pme.DownloadAndInstallPlatformUpgrades(ref, downloadCB, taskCB, req.GetSkipPostInstall())
+		if err != nil {
+			return platform, err
 		}
 
-		return nil
+		return platform, nil
 	}
 
-	if err := upgrade(); err != nil {
-		return nil, err
+	var rpcPlatform *rpc.Platform
+
+	platformRelease, err := upgrade()
+	if platformRelease != nil {
+		rpcPlatform = commands.PlatformReleaseToRPC(platformRelease)
+	}
+	if err != nil {
+		return &rpc.PlatformUpgradeResponse{Platform: rpcPlatform}, err
 	}
 	if err := commands.Init(&rpc.InitRequest{Instance: req.Instance}, nil); err != nil {
 		return nil, err
 	}
-	return &rpc.PlatformUpgradeResponse{}, nil
+
+	return &rpc.PlatformUpgradeResponse{Platform: rpcPlatform}, nil
 }

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

@@ -78,6 +78,15 @@ func Upgrade(inst *rpc.Instance, args []string, skipPostInstall bool) {
 		}
 	}
 
+	warningMissingIndex := func(response *rpc.PlatformUpgradeResponse) {
+		if response == nil || response.Platform == nil {
+			return
+		}
+		if !response.Platform.Indexed || (response.Platform.MissingMetadata && !response.Platform.Indexed) {
+			feedback.Warning(tr("missing package index for %s, future updates cannot be guaranteed", response.Platform.Id))
+		}
+	}
+
 	// proceed upgrading, if anything is upgradable
 	platformsRefs, err := arguments.ParseReferences(args)
 	if err != nil {
@@ -98,7 +107,9 @@ func Upgrade(inst *rpc.Instance, args []string, skipPostInstall bool) {
 			Architecture:    platformRef.Architecture,
 			SkipPostInstall: skipPostInstall,
 		}
-		if _, err := core.PlatformUpgrade(context.Background(), r, feedback.ProgressBar(), feedback.TaskProgress()); err != nil {
+		response, err := core.PlatformUpgrade(context.Background(), r, feedback.ProgressBar(), feedback.TaskProgress())
+		warningMissingIndex(response)
+		if err != nil {
 			if errors.Is(err, &arduino.PlatformAlreadyAtTheLatestVersionError{}) {
 				feedback.Print(err.Error())
 				continue

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

@@ -1026,3 +1026,31 @@ func TestCoreBrokenDependency(t *testing.T) {
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "try contacting [email protected]")
 }
+
+func TestCoreUpgradeWarningWithPackageInstalledButNotIndexed(t *testing.T) {
+	env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
+	defer env.CleanUp()
+
+	url := env.HTTPServeFile(8000, paths.New("..", "testdata", "test_index.json")).String()
+
+	t.Run("missing additional-urls", func(t *testing.T) {
+		// update index
+		_, _, err := cli.Run("core", "update-index", "--additional-urls="+url)
+		require.NoError(t, err)
+		// install 3rd-party core outdated version
+		_, _, err = cli.Run("core", "install", "test:[email protected]", "--additional-urls="+url)
+		require.NoError(t, err)
+		//upgrade without index fires a warning
+		_, jsonStderr, _ := cli.Run("core", "upgrade", "test:x86", "--format", "json")
+		requirejson.Query(t, jsonStderr, ".warnings[]", `"missing package index for test:x86, future updates cannot be guaranteed"`)
+	})
+
+	// removing installed.json
+	installedJson := cli.DataDir().Join("packages", "test", "hardware", "x86", "1.0.0", "installed.json")
+	require.NoError(t, os.Remove(installedJson.String()))
+
+	t.Run("missing both installed.json and additional-urls", func(t *testing.T) {
+		_, jsonStderr, _ := cli.Run("core", "upgrade", "test:x86", "--format", "json")
+		requirejson.Query(t, jsonStderr, ".warnings[]", `"missing package index for test:x86, future updates cannot be guaranteed"`)
+	})
+}