Add ways to let users verify if new CLI released (#1416)

* Add ways to let users verify if new CLI released

* Code review fixes

Co-authored-by: per1234 <[email protected]>

* Enhance docs

Co-authored-by: per1234 <[email protected]>

* Fix version check for git-snapshots and nightlies

* Change method to request latest release

* Remove ansi library in favor of color

* Fix go mod errors

* Remove useless function

Co-authored-by: Cristian Maglie <[email protected]>

Co-authored-by: per1234 <[email protected]>
Co-authored-by: Cristian Maglie <[email protected]>

Author: 3 people

cli/cli.go

@@ -39,6 +39,7 @@ import (
 	"github.com/arduino/arduino-cli/cli/output"
 	"github.com/arduino/arduino-cli/cli/sketch"
 	"github.com/arduino/arduino-cli/cli/update"
+	"github.com/arduino/arduino-cli/cli/updater"
 	"github.com/arduino/arduino-cli/cli/upgrade"
 	"github.com/arduino/arduino-cli/cli/upload"
 	"github.com/arduino/arduino-cli/cli/version"
@@ -50,12 +51,14 @@ import (
 	"github.com/rifflock/lfshook"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
+	semver "go.bug.st/relaxed-semver"
 )
 
 var (
-	verbose      bool
-	outputFormat string
-	configFile   string
+	verbose            bool
+	outputFormat       string
+	configFile         string
+	updaterMessageChan chan *semver.Version = make(chan *semver.Version)
 )
 
 // NewCommand creates a new ArduinoCli command root
@@ -64,11 +67,12 @@ func NewCommand() *cobra.Command {
 
 	// ArduinoCli is the root command
 	arduinoCli := &cobra.Command{
-		Use:              "arduino-cli",
-		Short:            tr("Arduino CLI."),
-		Long:             tr("Arduino Command Line Interface (arduino-cli)."),
-		Example:          fmt.Sprintf("  %s <%s> [%s...]", os.Args[0], tr("command"), tr("flags")),
-		PersistentPreRun: preRun,
+		Use:               "arduino-cli",
+		Short:             tr("Arduino CLI."),
+		Long:              tr("Arduino Command Line Interface (arduino-cli)."),
+		Example:           fmt.Sprintf("  %s <%s> [%s...]", os.Args[0], tr("command"), tr("flags")),
+		PersistentPreRun:  preRun,
+		PersistentPostRun: postRun,
 	}
 
 	arduinoCli.SetUsageTemplate(usageTemplate)
@@ -151,6 +155,20 @@ func preRun(cmd *cobra.Command, args []string) {
 	feedback.SetOut(colorable.NewColorableStdout())
 	feedback.SetErr(colorable.NewColorableStderr())
 
+	updaterMessageChan = make(chan *semver.Version)
+	go func() {
+		if cmd.Name() == "version" {
+			// The version command checks by itself if there's a new available version
+			updaterMessageChan <- nil
+		}
+		// Starts checking for updates
+		currentVersion, err := semver.Parse(globals.VersionInfo.VersionString)
+		if err != nil {
+			updaterMessageChan <- nil
+		}
+		updaterMessageChan <- updater.CheckForUpdate(currentVersion)
+	}()
+
 	//
 	// Prepare logging
 	//
@@ -236,3 +254,11 @@ func preRun(cmd *cobra.Command, args []string) {
 		})
 	}
 }
+
+func postRun(cmd *cobra.Command, args []string) {
+	latestVersion := <-updaterMessageChan
+	if latestVersion != nil {
+		// Notify the user a new version is available
+		updater.NotifyNewVersionIsAvailable(latestVersion.String())
+	}
+}

cli/config/validate.go

@@ -36,6 +36,7 @@ var validMap = map[string]reflect.Kind{
 	"network.proxy":                 reflect.String,
 	"network.user_agent_ext":        reflect.String,
 	"output.no_color":               reflect.Bool,
+	"updater.enable_notification":   reflect.Bool,
 }
 
 func typeOf(key string) (reflect.Kind, error) {

cli/updater/updater.go

@@ -0,0 +1,134 @@
+// 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 updater
+
+import (
+	"os"
+	"strings"
+	"time"
+
+	"github.com/arduino/arduino-cli/cli/feedback"
+	"github.com/arduino/arduino-cli/cli/globals"
+	"github.com/arduino/arduino-cli/configuration"
+	"github.com/arduino/arduino-cli/httpclient"
+	"github.com/arduino/arduino-cli/i18n"
+	"github.com/arduino/arduino-cli/inventory"
+	"github.com/fatih/color"
+	semver "go.bug.st/relaxed-semver"
+)
+
+var tr = i18n.Tr
+
+// CheckForUpdate returns the latest available version if greater than
+// the one running and it makes sense to check for an update, nil in all other cases
+func CheckForUpdate(currentVersion *semver.Version) *semver.Version {
+	if !shouldCheckForUpdate(currentVersion) {
+		return nil
+	}
+
+	return ForceCheckForUpdate(currentVersion)
+}
+
+// ForceCheckForUpdate always returns the latest available version if greater than
+// the one running, nil in all other cases
+func ForceCheckForUpdate(currentVersion *semver.Version) *semver.Version {
+	defer func() {
+		// Always save the last time we checked for updates at the end
+		inventory.Store.Set("updater.last_check_time", time.Now())
+		inventory.WriteStore()
+	}()
+
+	latestVersion, err := semver.Parse(getLatestRelease())
+	if err != nil {
+		return nil
+	}
+
+	if currentVersion.GreaterThanOrEqual(latestVersion) {
+		// Current version is already good enough
+		return nil
+	}
+
+	return latestVersion
+}
+
+// NotifyNewVersionIsAvailable prints information about the new latestVersion
+func NotifyNewVersionIsAvailable(latestVersion string) {
+	feedback.Errorf("\n\n%s %s → %s\n%s",
+		color.YellowString(tr("A new release of Arduino CLI is available:")),
+		color.CyanString(globals.VersionInfo.VersionString),
+		color.CyanString(latestVersion),
+		color.YellowString("https://arduino.github.io/arduino-cli/latest/installation/#latest-packages"))
+}
+
+// shouldCheckForUpdate return true if it actually makes sense to check for new updates,
+// false in all other cases.
+func shouldCheckForUpdate(currentVersion *semver.Version) bool {
+	if strings.Contains(currentVersion.String(), "git-snapshot") || strings.Contains(currentVersion.String(), "nightly") {
+		// This is a dev build, no need to check for updates
+		return false
+	}
+
+	if !configuration.Settings.GetBool("updater.enable_notification") {
+		// Don't check if the user disabled the notification
+		return false
+	}
+
+	if inventory.Store.IsSet("updater.last_check_time") && time.Since(inventory.Store.GetTime("updater.last_check_time")).Hours() < 24 {
+		// Checked less than 24 hours ago, let's wait
+		return false
+	}
+
+	// Don't check when running on CI or on non interactive consoles
+	return !isCI() && configuration.IsInteractive && configuration.HasConsole
+}
+
+// based on https://github.com/watson/ci-info/blob/HEAD/index.js
+func isCI() bool {
+	return os.Getenv("CI") != "" || // GitHub Actions, Travis CI, CircleCI, Cirrus CI, GitLab CI, AppVeyor, CodeShip, dsari
+		os.Getenv("BUILD_NUMBER") != "" || // Jenkins, TeamCity
+		os.Getenv("RUN_ID") != "" // TaskCluster, dsari
+}
+
+// getLatestRelease queries the official Arduino download server for the latest release,
+// if there are no errors or issues a version string is returned, in all other case an empty string.
+func getLatestRelease() string {
+	client, err := httpclient.New()
+	if err != nil {
+		return ""
+	}
+
+	// We just use this URL to check if there's a new release available and
+	// never show it to the user, so it's fine to use the Linux one for all OSs.
+	URL := "https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_Linux_64bit.tar.gz"
+	res, err := client.Head(URL)
+	if err != nil {
+		// Yes, we ignore it
+		return ""
+	}
+
+	// Get redirected URL
+	location := res.Request.URL.String()
+
+	// The location header points to the the latest release of the CLI, it's supposed to be formatted like this:
+	// https://downloads.arduino.cc/arduino-cli/arduino-cli_0.18.3_Linux_64bit.tar.gz
+	// so we split it to get the version, if there are not enough splits something must have gone wrong.
+	split := strings.Split(location, "_")
+	if len(split) < 2 {
+		return ""
+	}
+
+	return split[1]
+}

cli/version/version.go

@@ -17,11 +17,15 @@ package version
 
 import (
 	"os"
+	"strings"
 
+	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/cli/globals"
+	"github.com/arduino/arduino-cli/cli/updater"
 	"github.com/arduino/arduino-cli/i18n"
 	"github.com/spf13/cobra"
+	semver "go.bug.st/relaxed-semver"
 )
 
 var tr = i18n.Tr
@@ -39,5 +43,29 @@ func NewCommand() *cobra.Command {
 }
 
 func run(cmd *cobra.Command, args []string) {
-	feedback.Print(globals.VersionInfo)
+	if strings.Contains(globals.VersionInfo.VersionString, "git-snapshot") || strings.Contains(globals.VersionInfo.VersionString, "nightly") {
+		// We're using a development version, no need to check if there's a
+		// new release available
+		feedback.Print(globals.VersionInfo)
+		return
+	}
+
+	currentVersion, err := semver.Parse(globals.VersionInfo.VersionString)
+	if err != nil {
+		feedback.Errorf("Error parsing current version: %s", err)
+		os.Exit(errorcodes.ErrGeneric)
+	}
+	latestVersion := updater.ForceCheckForUpdate(currentVersion)
+
+	versionInfo := globals.VersionInfo
+	if feedback.GetFormat() == feedback.JSON && latestVersion != nil {
+		// Set this only we managed to get the latest version
+		versionInfo.LatestVersion = latestVersion.String()
+	}
+
+	feedback.Print(versionInfo)
+
+	if feedback.GetFormat() == feedback.Text && latestVersion != nil {
+		updater.NotifyNewVersionIsAvailable(latestVersion.String())
+	}
 }

configuration/defaults.go

@@ -52,6 +52,9 @@ func SetDefaults(settings *viper.Viper) {
 	// output settings
 	settings.SetDefault("output.no_color", false)
 
+	// updater settings
+	settings.SetDefault("updater.enable_notification", true)
+
 	// Bind env vars
 	settings.SetEnvPrefix("ARDUINO")
 	settings.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))

docs/configuration.md

@@ -24,6 +24,8 @@
 - `sketch` - configuration options relating to [Arduino sketches][sketch specification].
   - `always_export_binaries` - set to `true` to make [`arduino-cli compile`][arduino-cli compile] always save binaries
     to the sketch folder. This is the equivalent of using the [`--export-binaries`][arduino-cli compile options] flag.
+- `updater` - configuration options related to Arduino CLI updates
+  - `enable_notification` - set to `false` to disable notifications of new Arduino CLI releases, defaults to `true`
 
 ## Configuration methods
 

docs/installation.md

@@ -40,6 +40,10 @@ as a parameter like this:
 curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | sh -s 0.9.0
 ```
 
+Arduino CLI checks for new releases every 24 hours. If you don't like this behaviour you can disable it by setting the
+[`updater.enable_notification` config](configuration.md#configuration-keys) or the
+[env var `ARDUINO_UPDATER_ENABLE_NOTIFICATION`](configuration.md#environment-variables) to `false`.
+
 ### Download
 
 Pre-built binaries for all the supported platforms are available for download from the links below.

i18n/data/en.po

@@ -13,7 +13,7 @@ msgstr " Not used: {0}"
 msgid " Used: {0}"
 msgstr " Used: {0}"
 
-#: version/version.go:54
+#: version/version.go:55
 msgid "%[1]s %[2]s Version: %[3]s Commit: %[4]s Date: %[5]s"
 msgstr "%[1]s %[2]s Version: %[3]s Commit: %[4]s Date: %[5]s"
 
@@ -111,6 +111,10 @@ msgstr "--git-url and --zip-path are disabled by default, for more information s
 msgid "--git-url and --zip-path flags allow installing untrusted files, use it at your own risk."
 msgstr "--git-url and --zip-path flags allow installing untrusted files, use it at your own risk."
 
+#: cli/updater/updater.go:70
+msgid "A new release of Arduino CLI is available:"
+msgstr "A new release of Arduino CLI is available:"
+
 #: commands/errors.go:181
 msgid "A programmer is required to upload"
 msgstr "A programmer is required to upload"
@@ -169,11 +173,11 @@ msgstr "Archiving built core (caching) in: {0}"
 msgid "Arduino CLI sketch commands."
 msgstr "Arduino CLI sketch commands."
 
-#: cli/cli.go:68
+#: cli/cli.go:71
 msgid "Arduino CLI."
 msgstr "Arduino CLI."
 
-#: cli/cli.go:69
+#: cli/cli.go:72
 msgid "Arduino Command Line Interface (arduino-cli)."
 msgstr "Arduino Command Line Interface (arduino-cli)."
 
@@ -389,7 +393,7 @@ msgstr "Checksum:"
 msgid "Clean caches."
 msgstr "Clean caches."
 
-#: cli/cli.go:107
+#: cli/cli.go:111
 msgid "Comma-separated list of additional URLs for the Boards Manager."
 msgstr "Comma-separated list of additional URLs for the Boards Manager."
 
@@ -1203,7 +1207,7 @@ msgstr "Internal error in cache"
 msgid "Invalid '%[1]s' property: %[2]s"
 msgstr "Invalid '%[1]s' property: %[2]s"
 
-#: cli/cli.go:234
+#: cli/cli.go:252
 msgid "Invalid Call : should show Help, but it is available only in TEXT mode."
 msgstr "Invalid Call : should show Help, but it is available only in TEXT mode."
 
@@ -1260,11 +1264,11 @@ msgstr "Invalid library"
 msgid "Invalid network.proxy '%[1]s': %[2]s"
 msgstr "Invalid network.proxy '%[1]s': %[2]s"
 
-#: cli/cli.go:195
+#: cli/cli.go:213
 msgid "Invalid option for --log-level: %s"
 msgstr "Invalid option for --log-level: %s"
 
-#: cli/cli.go:212
+#: cli/cli.go:230
 msgid "Invalid output format: %s"
 msgstr "Invalid output format: %s"
 
@@ -1429,7 +1433,7 @@ msgstr "Maintainer: %s"
 msgid "Max time to wait for port discovery, e.g.: 30s, 1m"
 msgstr "Max time to wait for port discovery, e.g.: 30s, 1m"
 
-#: cli/cli.go:102
+#: cli/cli.go:106
 msgid "Messages with this level and above will be logged. Valid levels are: %s, %s, %s, %s, %s, %s, %s"
 msgstr "Messages with this level and above will be logged. Valid levels are: %s, %s, %s, %s, %s, %s, %s"
 
@@ -1627,7 +1631,7 @@ msgstr "Package website:"
 msgid "Paragraph: %s"
 msgstr "Paragraph: %s"
 
-#: cli/cli.go:103
+#: cli/cli.go:107
 msgid "Path to the file where logs will be written."
 msgstr "Path to the file where logs will be written."
 
@@ -1713,7 +1717,7 @@ msgstr "Print details about a board."
 msgid "Print preprocessed code to stdout instead of compiling."
 msgstr "Print preprocessed code to stdout instead of compiling."
 
-#: cli/cli.go:101
+#: cli/cli.go:105
 msgid "Print the logs on the standard output."
 msgstr "Print the logs on the standard output."
 
@@ -1838,7 +1842,7 @@ msgid "Setting build path to {0}"
 msgstr "Setting build path to {0}"
 
 #: cli/config/delete.go:57
-#: cli/config/validate.go:44
+#: cli/config/validate.go:45
 msgid "Settings key doesn't exist"
 msgstr "Settings key doesn't exist"
 
@@ -1913,11 +1917,11 @@ msgstr "Shows the list of the examples for libraries."
 msgid "Shows the list of the examples for libraries. A name may be given as argument to search a specific library."
 msgstr "Shows the list of the examples for libraries. A name may be given as argument to search a specific library."
 
-#: cli/version/version.go:34
+#: cli/version/version.go:38
 msgid "Shows the version number of Arduino CLI which is installed on your system."
 msgstr "Shows the version number of Arduino CLI which is installed on your system."
 
-#: cli/version/version.go:33
+#: cli/version/version.go:37
 msgid "Shows version number of Arduino CLI."
 msgstr "Shows version number of Arduino CLI."
 
@@ -1995,7 +1999,7 @@ msgstr "The connected devices search timeout, raise it if your board doesn't sho
 msgid "The connected devices search timeout, raise it if your board doesn't show up e.g.: 10s"
 msgstr "The connected devices search timeout, raise it if your board doesn't show up e.g.: 10s"
 
-#: cli/cli.go:106
+#: cli/cli.go:110
 msgid "The custom config file (if not specified the default will be used)."
 msgstr "The custom config file (if not specified the default will be used)."
 
@@ -2015,11 +2019,11 @@ msgid "The key '%[1]v' is not a list of items, can't remove from it.\n"
 msgstr "The key '%[1]v' is not a list of items, can't remove from it.\n"
 "Maybe use '%[2]s'?"
 
-#: cli/cli.go:104
+#: cli/cli.go:108
 msgid "The output format for the logs, can be {%s|%s}."
 msgstr "The output format for the logs, can be {%s|%s}."
 
-#: cli/cli.go:105
+#: cli/cli.go:109
 msgid "The output format, can be {%s|%s}."
 msgstr "The output format, can be {%s|%s}."
 
@@ -2109,7 +2113,7 @@ msgstr "Unable to get Local App Data Folder: %v"
 msgid "Unable to get user home dir: %v"
 msgstr "Unable to get user home dir: %v"
 
-#: cli/cli.go:181
+#: cli/cli.go:199
 msgid "Unable to open file for logging: %s"
 msgstr "Unable to open file for logging: %s"
 
@@ -2469,7 +2473,7 @@ msgstr "checking local archive integrity"
 msgid "cleaning build path"
 msgstr "cleaning build path"
 
-#: cli/cli.go:70
+#: cli/cli.go:73
 msgid "command"
 msgstr "command"
 
@@ -2639,7 +2643,7 @@ msgstr "find abs path: %s"
 msgid "first message must contain monitor configuration, not data"
 msgstr "first message must contain monitor configuration, not data"
 
-#: cli/cli.go:70
+#: cli/cli.go:73
 msgid "flags"
 msgstr "flags"
 
@@ -2666,11 +2670,11 @@ msgstr "for the latest version."
 msgid "for the specific version."
 msgstr "for the specific version."
 
-#: inventory/inventory.go:67
+#: inventory/inventory.go:68
 msgid "generating installation.id: %w"
 msgstr "generating installation.id: %w"
 
-#: inventory/inventory.go:73
+#: inventory/inventory.go:74
 msgid "generating installation.secret: %w"
 msgstr "generating installation.secret: %w"
 
@@ -2803,11 +2807,11 @@ msgstr "invalid library location: %s"
 msgid "invalid option '%s'"
 msgstr "invalid option '%s'"
 
-#: inventory/inventory.go:85
+#: inventory/inventory.go:88
 msgid "invalid path creating config dir: %[1]s error: %[2]w"
 msgstr "invalid path creating config dir: %[1]s error: %[2]w"
 
-#: inventory/inventory.go:91
+#: inventory/inventory.go:94
 msgid "invalid path writing inventory file: %[1]s error: %[2]w"
 msgstr "invalid path writing inventory file: %[1]s error: %[2]w"
 
@@ -3095,7 +3099,7 @@ msgstr "reading file %[1]s: %[2]s"
 msgid "reading files: %v"
 msgstr "reading files: %v"
 
-#: inventory/inventory.go:57
+#: inventory/inventory.go:58
 msgid "reading inventory file: %w"
 msgstr "reading inventory file: %w"
 

i18n/rice-box.go

@@ -32,13 +32,14 @@ var (
 	// Type is the inventory file type
 	Type = "yaml"
 	// Name is the inventory file Name with Type as extension
-	Name = "inventory" + "." + Type
-	tr   = i18n.Tr
+	Name           = "inventory" + "." + Type
+	tr             = i18n.Tr
+	configFilePath string
 )
 
 // Init configures the Read Only config storage
 func Init(configPath string) error {
-	configFilePath := filepath.Join(configPath, Name)
+	configFilePath = filepath.Join(configPath, Name)
 	Store.SetConfigName(Name)
 	Store.SetConfigType(Type)
 	Store.AddConfigPath(configPath)
@@ -50,7 +51,7 @@ func Init(configPath string) error {
 			if err := generateInstallationData(); err != nil {
 				return err
 			}
-			if err := writeStore(configFilePath); err != nil {
+			if err := WriteStore(); err != nil {
 				return err
 			}
 		} else {
@@ -76,7 +77,9 @@ func generateInstallationData() error {
 	return nil
 }
 
-func writeStore(configFilePath string) error {
+// WriteStore writes the current information from Store to configFilePath.
+// Returns err if it fails.
+func WriteStore() error {
 	configPath := filepath.Dir(configFilePath)
 
 	// Create config dir if not present,

inventory/inventory.go

@@ -34,6 +34,7 @@ var (
 type Info struct {
 	Application   string `json:"Application"`
 	VersionString string `json:"VersionString"`
+	LatestVersion string `json:"LatestVersion,omitempty"`
 	Commit        string `json:"Commit"`
 	Status        string `json:"Status"`
 	Date          string `json:"Date"`