map log settings to config file

Author: Massimiliano Pippi

Diff for: cli/cli.go

@@ -57,16 +57,10 @@ var (
 	}
 
 	verbose      bool
-	logFile      string
-	logFormat    string
 	outputFormat string
 	configFile   string
 )
 
-const (
-	defaultLogLevel = "info"
-)
-
 // Init the cobra root command
 func init() {
 	createCliCommandTree(ArduinoCli)
@@ -86,9 +80,12 @@ func createCliCommandTree(cmd *cobra.Command) {
 	cmd.AddCommand(version.NewCommand())
 
 	cmd.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "Print the logs on the standard output.")
-	cmd.PersistentFlags().StringVar(&globals.LogLevel, "log-level", defaultLogLevel, "Messages with this level and above will be logged.")
-	cmd.PersistentFlags().StringVar(&logFile, "log-file", "", "Path to the file where logs will be written.")
-	cmd.PersistentFlags().StringVar(&logFormat, "log-format", "text", "The output format for the logs, can be [text|json].")
+	cmd.PersistentFlags().String("log-level", "", "Messages with this level and above will be logged.")
+	viper.BindPFlag("logging.level", cmd.PersistentFlags().Lookup("log-level"))
+	cmd.PersistentFlags().String("log-file", "", "Path to the file where logs will be written.")
+	viper.BindPFlag("logging.file", cmd.PersistentFlags().Lookup("log-file"))
+	cmd.PersistentFlags().String("log-format", "", "The output format for the logs, can be [text|json].")
+	viper.BindPFlag("logging.format", cmd.PersistentFlags().Lookup("log-format"))
 	cmd.PersistentFlags().StringVar(&outputFormat, "format", "text", "The output format, can be [text|json].")
 	cmd.PersistentFlags().StringVar(&configFile, "config-file", "", "The custom config file (if not specified the default will be used).")
 	cmd.PersistentFlags().StringSlice("additional-urls", []string{}, "Additional URLs for the board manager.")
@@ -121,13 +118,34 @@ func parseFormatString(arg string) (feedback.OutputFormat, bool) {
 }
 
 func preRun(cmd *cobra.Command, args []string) {
+	// before doing anything, decide whether we should log to stdout
+	if verbose {
+		// if we print on stdout, do it in full colors
+		logrus.SetOutput(colorable.NewColorableStdout())
+		logrus.SetFormatter(&logrus.TextFormatter{
+			ForceColors: true,
+		})
+	} else {
+		logrus.SetOutput(ioutil.Discard)
+	}
+
+	// setup the configuration system
+	configPath := ""
+	if configFile != "" {
+		// override the config path if --config-file was passed
+		configPath = filepath.Dir(configFile)
+	}
+	configuration.Init(configPath)
+
 	// normalize the format strings
 	outputFormat = strings.ToLower(outputFormat)
 	// configure the output package
 	output.OutputFormat = outputFormat
-	logFormat = strings.ToLower(logFormat)
+	// configure log format
+	logFormat := strings.ToLower(viper.GetString("logging.format"))
 
 	// should we log to file?
+	logFile := viper.GetString("log.file")
 	if logFile != "" {
 		file, err := os.OpenFile(logFile, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
 		if err != nil {
@@ -143,20 +161,9 @@ func preRun(cmd *cobra.Command, args []string) {
 		}
 	}
 
-	// should we log to stdout?
-	if verbose {
-		logrus.SetOutput(colorable.NewColorableStdout())
-		logrus.SetFormatter(&logrus.TextFormatter{
-			ForceColors: true,
-		})
-	} else {
-		// Discard logrus output if no writer was set
-		logrus.SetOutput(ioutil.Discard)
-	}
-
 	// configure logging filter
-	if lvl, found := toLogLevel(globals.LogLevel); !found {
-		fmt.Printf("Invalid option for --log-level: %s", globals.LogLevel)
+	if lvl, found := toLogLevel(viper.GetString("logging.level")); !found {
+		feedback.Errorf("Invalid option for --log-level: %s", viper.GetString("logging.level"))
 		os.Exit(errorcodes.ErrBadArgument)
 	} else {
 		logrus.SetLevel(lvl)
@@ -177,13 +184,6 @@ func preRun(cmd *cobra.Command, args []string) {
 	// use the output format to configure the Feedback
 	feedback.SetFormat(format)
 
-	// override the config path if --config-file was passed
-	configPath := ""
-	if configFile != "" {
-		configPath = filepath.Dir(configFile)
-	}
-	configuration.Init(configPath)
-
 	logrus.Info(globals.VersionInfo.Application + "-" + globals.VersionInfo.VersionString)
 	logrus.Info("Starting root command preparation (`arduino`)")
 

Diff for: cli/compile/compile.go

@@ -22,7 +22,6 @@ import (
 	"os"
 
 	"github.com/arduino/arduino-cli/cli/feedback"
-	"github.com/arduino/arduino-cli/cli/globals"
 
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/instance"
@@ -32,6 +31,7 @@ import (
 	"github.com/arduino/go-paths-helper"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
 )
 
 var (
@@ -107,7 +107,7 @@ func run(cmd *cobra.Command, args []string) {
 		Quiet:           quiet,
 		VidPid:          vidPid,
 		ExportFile:      exportFile,
-	}, os.Stdout, os.Stderr, globals.LogLevel == "debug")
+	}, os.Stdout, os.Stderr, viper.GetString("logging.level") == "debug")
 
 	if err != nil {
 		feedback.Errorf("Error during build: %v", err)

Diff for: cli/globals/globals.go

@@ -32,9 +32,6 @@ var (
 	VersionInfo = version.NewInfo(filepath.Base(os.Args[0]))
 	// DefaultIndexURL is the default index url
 	DefaultIndexURL = "https://downloads.arduino.cc/packages/package_index.json"
-	// LogLevel is temporarily exported because the compile command will
-	// forward this information to the underlying legacy package
-	LogLevel string
 )
 
 // NewHTTPClientHeader returns the http.Header object that must be used by the clients inside the downloaders

Diff for: configuration/defaults.go

@@ -22,7 +22,10 @@ import (
 )
 
 func setDefaults(dataDir, sketchBookDir string) {
-	// board manager settings
+	// logging
+	viper.SetDefault("logging.level", "info")
+	viper.SetDefault("logging.format", "text")
+	// board manager
 	viper.SetDefault("board_manager.additional_urls", []string{})
 
 	// arduino directories