Added feedback functions to report warnings

Author: cmaglie

cli/arguments/sketch.go

@@ -16,6 +16,8 @@
 package arguments
 
 import (
+	"fmt"
+
 	"github.com/arduino/arduino-cli/arduino/sketch"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
@@ -54,9 +56,10 @@ func NewSketch(sketchPath *paths.Path) *sketch.Sketch {
 func WarnDeprecatedFiles(sketchPath *paths.Path) {
 	// .pde files are still supported but deprecated, this warning urges the user to rename them
 	if files := sketch.CheckForPdeFiles(sketchPath); len(files) > 0 {
-		feedback.Error(tr("Sketches with .pde extension are deprecated, please rename the following files to .ino:"))
+		msg := tr("Sketches with .pde extension are deprecated, please rename the following files to .ino:")
 		for _, f := range files {
-			feedback.Error(f)
+			msg += fmt.Sprintf("\n - %s", f)
 		}
+		feedback.Warning(msg)
 	}
 }

cli/board/list.go

@@ -69,10 +69,10 @@ func runListCommand(cmd *cobra.Command, args []string) {
 		Timeout:  timeoutArg.Get().Milliseconds(),
 	})
 	if err != nil {
-		feedback.Errorf(tr("Error detecting boards: %v"), err)
+		feedback.Warning(tr("Error detecting boards: %v", err))
 	}
 	for _, err := range discvoeryErrors {
-		feedback.Errorf(tr("Error starting discovery: %v"), err)
+		feedback.Warning(tr("Error starting discovery: %v", err))
 	}
 	feedback.PrintResult(result{ports})
 }

cli/compile/compile.go

@@ -272,9 +272,10 @@ func runCompileCommand(cmd *cobra.Command, args []string) {
 			libs += fmt.Sprintln("      - " + lib.GetName() + " (" + lib.GetVersion() + ")")
 		}
 		if hasVendoredLibs {
-			fmt.Println()
-			fmt.Println(tr("WARNING: The sketch is compiled using one or more custom libraries."))
-			fmt.Println(tr("Currently, Build Profiles only support libraries available through Arduino Library Manager."))
+			msg := "\n"
+			msg += tr("WARNING: The sketch is compiled using one or more custom libraries.") + "\n"
+			msg += tr("Currently, Build Profiles only support libraries available through Arduino Library Manager.")
+			feedback.Warning(msg)
 		}
 
 		newProfileName := "my_profile_name"

cli/core/upgrade.go

@@ -80,16 +80,16 @@ func Upgrade(inst *rpc.Instance, args []string, skipPostInstall bool) {
 	}
 
 	// proceed upgrading, if anything is upgradable
-	exitErr := false
 	platformsRefs, err := arguments.ParseReferences(args)
 	if err != nil {
 		feedback.Fatal(tr("Invalid argument passed: %v", err), errorcodes.ErrBadArgument)
 	}
 
+	hasBadArguments := false
 	for i, platformRef := range platformsRefs {
 		if platformRef.Version != "" {
-			feedback.Errorf(tr("Invalid item %s"), args[i])
-			exitErr = true
+			feedback.Warning(tr("Invalid item %s", args[i]))
+			hasBadArguments = true
 			continue
 		}
 
@@ -99,7 +99,6 @@ 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 {
 			if errors.Is(err, &arduino.PlatformAlreadyAtTheLatestVersionError{}) {
 				feedback.Print(err.Error())
@@ -110,7 +109,7 @@ func Upgrade(inst *rpc.Instance, args []string, skipPostInstall bool) {
 		}
 	}
 
-	if exitErr {
-		os.Exit(errorcodes.ErrBadArgument)
+	if hasBadArguments {
+		feedback.Fatal(tr("Some upgrades failed, please check the output for details."), errorcodes.ErrBadArgument)
 	}
 }

cli/feedback/feedback.go

@@ -20,15 +20,13 @@ package feedback
 import (
 	"bytes"
 	"encoding/json"
-	"errors"
 	"fmt"
 	"io"
 	"os"
 
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/i18n"
 	"github.com/sirupsen/logrus"
-	"google.golang.org/grpc/status"
 	"gopkg.in/yaml.v2"
 )
 
@@ -76,6 +74,7 @@ var (
 	feedbackErr    io.Writer
 	bufferOut      *bytes.Buffer
 	bufferErr      *bytes.Buffer
+	bufferWarnings []string
 	format         OutputFormat
 	formatSelected bool
 )
@@ -92,6 +91,7 @@ func reset() {
 	feedbackErr = os.Stderr
 	bufferOut = &bytes.Buffer{}
 	bufferErr = &bytes.Buffer{}
+	bufferWarnings = nil
 	format = Text
 	formatSelected = false
 }
@@ -135,6 +135,7 @@ func SetFormat(f OutputFormat) {
 	} else {
 		feedbackOut = bufferOut
 		feedbackErr = bufferErr
+		bufferWarnings = nil
 	}
 }
 
@@ -153,27 +154,14 @@ func Print(v string) {
 	fmt.Fprintln(feedbackOut, v)
 }
 
-// Errorf behaves like fmt.Printf but writes on the error writer and adds a
-// newline. It also logs the error.
-func Errorf(format string, v ...interface{}) {
-	// Unbox grpc status errors
-	for i := range v {
-		if s, isStatus := v[i].(*status.Status); isStatus {
-			v[i] = errors.New(s.Message())
-		} else if err, isErr := v[i].(error); isErr {
-			if s, isStatus := status.FromError(err); isStatus {
-				v[i] = errors.New(s.Message())
-			}
-		}
+// Warning outputs a warning message.
+func Warning(msg string) {
+	if format == Text {
+		fmt.Fprintln(feedbackErr, msg)
+	} else {
+		bufferWarnings = append(bufferWarnings, msg)
 	}
-	Error(fmt.Sprintf(format, v...))
-}
-
-// Error behaves like fmt.Print but writes on the error writer and adds a
-// newline. It also logs the error.
-func Error(v ...interface{}) {
-	fmt.Fprintln(stdErr, v...)
-	logrus.Error(fmt.Sprint(v...))
+	logrus.Warning(msg)
 }
 
 // FatalError outputs the error and exits with status exitCode.
@@ -213,26 +201,44 @@ func Fatal(errorMsg string, exitCode int) {
 	os.Exit(exitCode)
 }
 
+func augment(data interface{}) interface{} {
+	if len(bufferWarnings) == 0 {
+		return data
+	}
+	d, err := json.Marshal(data)
+	if err != nil {
+		return data
+	}
+	var res interface{}
+	if err := json.Unmarshal(d, &res); err != nil {
+		return data
+	}
+	if m, ok := res.(map[string]interface{}); ok {
+		m["warnings"] = bufferWarnings
+	}
+	return res
+}
+
 // PrintResult is a convenient wrapper to provide feedback for complex data,
 // where the contents can't be just serialized to JSON but requires more
 // structure.
 func PrintResult(res Result) {
 	var data string
 	switch format {
 	case JSON:
-		d, err := json.MarshalIndent(res.Data(), "", "  ")
+		d, err := json.MarshalIndent(augment(res.Data()), "", "  ")
 		if err != nil {
 			Fatal(fmt.Sprintf("Error during JSON encoding of the output: %v", err), errorcodes.ErrGeneric)
 		}
 		data = string(d)
 	case MinifiedJSON:
-		d, err := json.Marshal(res.Data())
+		d, err := json.Marshal(augment(res.Data()))
 		if err != nil {
 			Fatal(fmt.Sprintf("Error during JSON encoding of the output: %v", err), errorcodes.ErrGeneric)
 		}
 		data = string(d)
 	case YAML:
-		d, err := yaml.Marshal(res.Data())
+		d, err := yaml.Marshal(augment(res.Data()))
 		if err != nil {
 			Fatal(fmt.Sprintf("Error during YAML encoding of the output: %v", err), errorcodes.ErrGeneric)
 		}

cli/instance/instance.go

@@ -74,7 +74,7 @@ func Init(instance *rpc.Instance) {
 func InitWithProfile(instance *rpc.Instance, profileName string, sketchPath *paths.Path) *rpc.Profile {
 	// In case the CLI is executed for the first time
 	if err := FirstUpdate(instance); err != nil {
-		feedback.Errorf(tr("Error initializing instance: %v"), err)
+		feedback.Warning(tr("Error initializing instance: %v", err))
 		return nil
 	}
 
@@ -89,7 +89,7 @@ func InitWithProfile(instance *rpc.Instance, profileName string, sketchPath *pat
 	var profile *rpc.Profile
 	err := commands.Init(initReq, func(res *rpc.InitResponse) {
 		if st := res.GetError(); st != nil {
-			feedback.Errorf(tr("Error initializing instance: %v"), st.Message)
+			feedback.Warning(tr("Error initializing instance: %v", st.Message))
 		}
 
 		if progress := res.GetInitProgress(); progress != nil {
@@ -106,7 +106,7 @@ func InitWithProfile(instance *rpc.Instance, profileName string, sketchPath *pat
 		}
 	})
 	if err != nil {
-		feedback.Errorf(tr("Error initializing instance: %v"), err)
+		feedback.Warning(tr("Error initializing instance: %v", err))
 	}
 
 	return profile

cli/monitor/monitor.go

@@ -155,14 +155,18 @@ func runMonitorCmd(cmd *cobra.Command, args []string) {
 	go func() {
 		_, err := io.Copy(tty, portProxy)
 		if err != nil && !errors.Is(err, io.EOF) {
-			feedback.Error(tr("Port closed:"), err)
+			if !quiet {
+				feedback.Print(tr("Port closed: %v", err))
+			}
 		}
 		cancel()
 	}()
 	go func() {
 		_, err := io.Copy(portProxy, tty)
 		if err != nil && !errors.Is(err, io.EOF) {
-			feedback.Error(tr("Port closed:"), err)
+			if !quiet {
+				feedback.Print(tr("Port closed: %v", err))
+			}
 		}
 		cancel()
 	}()

cli/updater/updater.go

@@ -16,6 +16,7 @@
 package updater
 
 import (
+	"fmt"
 	"os"
 	"strings"
 	"time"
@@ -66,11 +67,12 @@ func ForceCheckForUpdate(currentVersion *semver.Version) *semver.Version {
 
 // NotifyNewVersionIsAvailable prints information about the new latestVersion
 func NotifyNewVersionIsAvailable(latestVersion string) {
-	feedback.Errorf("\n\n%s %s → %s\n%s",
+	msg := fmt.Sprintf("\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"))
+	feedback.Warning(msg)
 }
 
 // shouldCheckForUpdate return true if it actually makes sense to check for new updates,

configuration/configuration.go

@@ -65,7 +65,7 @@ func Init(configFile string) *viper.Viper {
 		// ConfigFileNotFoundError is acceptable, anything else
 		// should be reported to the user
 		if _, ok := err.(viper.ConfigFileNotFoundError); !ok {
-			feedback.Errorf(tr("Error reading config file: %v"), err)
+			feedback.Warning(tr("Error reading config file: %v", err))
 		}
 	}
 
@@ -85,7 +85,7 @@ func BindFlags(cmd *cobra.Command, settings *viper.Viper) {
 func getDefaultArduinoDataDir() string {
 	userHomeDir, err := os.UserHomeDir()
 	if err != nil {
-		feedback.Errorf(tr("Unable to get user home dir: %v"), err)
+		feedback.Warning(tr("Unable to get user home dir: %v", err))
 		return "."
 	}
 
@@ -97,7 +97,7 @@ func getDefaultArduinoDataDir() string {
 	case "windows":
 		localAppDataPath, err := win32.GetLocalAppDataFolder()
 		if err != nil {
-			feedback.Errorf(tr("Unable to get Local App Data Folder: %v"), err)
+			feedback.Warning(tr("Unable to get Local App Data Folder: %v", err))
 			return "."
 		}
 		return filepath.Join(localAppDataPath, "Arduino15")
@@ -110,7 +110,7 @@ func getDefaultArduinoDataDir() string {
 func getDefaultUserDir() string {
 	userHomeDir, err := os.UserHomeDir()
 	if err != nil {
-		feedback.Errorf(tr("Unable to get user home dir: %v"), err)
+		feedback.Warning(tr("Unable to get user home dir: %v", err))
 		return "."
 	}
 
@@ -122,7 +122,7 @@ func getDefaultUserDir() string {
 	case "windows":
 		documentsPath, err := win32.GetDocumentsFolder()
 		if err != nil {
-			feedback.Errorf(tr("Unable to get Documents Folder: %v"), err)
+			feedback.Warning(tr("Unable to get Documents Folder: %v", err))
 			return "."
 		}
 		return filepath.Join(documentsPath, "Arduino")