update.go

// 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 update

import (
	"context"
	"os"

	"github.com/arduino/arduino-cli/cli/errorcodes"
	"github.com/arduino/arduino-cli/cli/feedback"
	"github.com/arduino/arduino-cli/cli/instance"
	"github.com/arduino/arduino-cli/cli/output"
	"github.com/arduino/arduino-cli/commands"
	"github.com/arduino/arduino-cli/commands/outdated"
	"github.com/arduino/arduino-cli/i18n"
	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"
)

var tr = i18n.Tr

// NewCommand creates a new `update` command
func NewCommand() *cobra.Command {
	updateCommand := &cobra.Command{
		Use:     "update",
		Short:   tr("Updates the index of cores and libraries"),
		Long:    tr("Updates the index of cores and libraries to the latest versions."),
		Example: "  " + os.Args[0] + " update",
		Args:    cobra.NoArgs,
		Run:     runUpdateCommand,
	}
	updateCommand.Flags().BoolVar(&updateFlags.showOutdated, "show-outdated", false, tr("Show outdated cores and libraries after index update"))
	return updateCommand
}

var updateFlags struct {
	showOutdated bool
}

func runUpdateCommand(cmd *cobra.Command, args []string) {
	inst := instance.CreateInstanceAndRunFirstUpdate()
	logrus.Info("Executing `arduino-cli update`")

	err := commands.UpdateCoreLibrariesIndex(context.Background(),
		&rpc.UpdateCoreLibrariesIndexRequest{Instance: inst},
		output.ProgressBar())
	if err != nil {
		feedback.Errorf(tr("Error updating core and libraries index: %v"), err)
		os.Exit(errorcodes.ErrGeneric)
	}

	if updateFlags.showOutdated {
		// To show outdated platforms and libraries we need to initialize our instance
		// otherwise nothing would be shown
		for _, err := range instance.Init(inst) {
			feedback.Errorf(tr("Error initializing instance: %v"), err)
		}

		outdatedResp, err := outdated.Outdated(context.Background(), &rpc.OutdatedRequest{
			Instance: inst,
		})
		if err != nil {
			feedback.Errorf(tr("Error retrieving outdated cores and libraries: %v"), err)
		}

		// Prints outdated cores
		tab := table.New()
		tab.SetHeader(tr("Core name"), tr("Installed version"), tr("New version"))
		if len(outdatedResp.OutdatedPlatforms) > 0 {
			for _, p := range outdatedResp.OutdatedPlatforms {
				tab.AddRow(p.Name, p.Installed, p.Latest)
			}
			feedback.Print(tab.Render())
		}

		// Prints outdated libraries
		tab = table.New()
		tab.SetHeader(tr("Library name"), tr("Installed version"), tr("New version"))
		if len(outdatedResp.OutdatedLibraries) > 0 {
			for _, l := range outdatedResp.OutdatedLibraries {
				tab.AddRow(l.Library.Name, l.Library.Version, l.Release.Version)
			}
			feedback.Print(tab.Render())
		}
	}

	logrus.Info("Done")
}