added info logging in every command for consistency

umbynos · umbynos · commit c316b3860e28 · 2021-11-19T12:32:49.000+01:00
diff --git a/cli/board/attach.go b/cli/board/attach.go
@@ -27,6 +27,7 @@ import (
 	"github.com/arduino/arduino-cli/cli/output"
 	"github.com/arduino/arduino-cli/commands/board"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
@@ -51,6 +52,8 @@ func initAttachCommand() *cobra.Command {
 func runAttachCommand(cmd *cobra.Command, args []string) {
 	instance := instance.CreateAndInit()
 
+	logrus.Info("Executing `arduino-cli board attach`")
+
 	path := ""
 	if len(args) > 1 {
 		path = args[1]
diff --git a/cli/board/details.go b/cli/board/details.go
@@ -28,6 +28,7 @@ import (
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/arduino-cli/table"
 	"github.com/fatih/color"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
@@ -58,6 +59,8 @@ func initDetailsCommand() *cobra.Command {
 func runDetailsCommand(cmd *cobra.Command, args []string) {
 	inst := instance.CreateAndInit()
 
+	logrus.Info("Executing `arduino-cli board details`")
+
 	// remove once `board details <fqbn>` is removed
 	if fqbn.String() == "" && len(args) > 0 {
 		fqbn.Set(args[0])
diff --git a/cli/board/list.go b/cli/board/list.go
@@ -28,6 +28,7 @@ import (
 	"github.com/arduino/arduino-cli/commands/board"
 	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"
 )
 
@@ -57,6 +58,9 @@ func initListCommand() *cobra.Command {
 // runListCommand detects and lists the connected arduino boards
 func runListCommand(cmd *cobra.Command, args []string) {
 	inst := instance.CreateAndInit()
+
+	logrus.Info("Executing `arduino-cli board list`")
+
 	if watch {
 		watchList(cmd, inst)
 		os.Exit(0)
diff --git a/cli/board/listall.go b/cli/board/listall.go
@@ -27,6 +27,7 @@ import (
 	"github.com/arduino/arduino-cli/commands/board"
 	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"
 )
 
@@ -52,6 +53,8 @@ for a specific board if you specify the board name`),
 func runListAllCommand(cmd *cobra.Command, args []string) {
 	inst := instance.CreateAndInit()
 
+	logrus.Info("Executing `arduino-cli board listall`")
+
 	list, err := board.ListAll(context.Background(), &rpc.BoardListAllRequest{
 		Instance:            inst,
 		SearchArgs:          args,
diff --git a/cli/board/search.go b/cli/board/search.go
@@ -28,6 +28,7 @@ import (
 	"github.com/arduino/arduino-cli/commands/board"
 	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"
 )
 
@@ -50,6 +51,8 @@ for a specific board if you specify the board name`),
 func runSearchCommand(cmd *cobra.Command, args []string) {
 	inst := instance.CreateAndInit()
 
+	logrus.Info("Executing `arduino-cli board search`")
+
 	res, err := board.Search(context.Background(), &rpc.BoardSearchRequest{
 		Instance:            inst,
 		SearchArgs:          strings.Join(args, " "),
diff --git a/cli/burnbootloader/burnbootloader.go b/cli/burnbootloader/burnbootloader.go
@@ -26,6 +26,7 @@ import (
 	"github.com/arduino/arduino-cli/commands/upload"
 	"github.com/arduino/arduino-cli/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
@@ -64,6 +65,8 @@ func NewCommand() *cobra.Command {
 func runBootloaderCommand(command *cobra.Command, args []string) {
 	instance := instance.CreateAndInit()
 
+	logrus.Info("Executing `arduino-cli burn-bootloader`")
+
 	// We don't need a Sketch to upload a board's bootloader
 	discoveryPort, err := port.GetPort(instance, nil)
 	if err != nil {
diff --git a/cli/cache/clean.go b/cli/cache/clean.go
@@ -38,7 +38,7 @@ func initCleanCommand() *cobra.Command {
 }
 
 func runCleanCommand(cmd *cobra.Command, args []string) {
-	logrus.Info("Executing `arduino cache clean`")
+	logrus.Info("Executing `arduino-cli cache clean`")
 
 	cachePath := configuration.Settings.GetString("directories.Downloads")
 	err := os.RemoveAll(cachePath)
diff --git a/cli/compile/compile.go b/cli/compile/compile.go
@@ -26,6 +26,7 @@ import (
 	"github.com/arduino/arduino-cli/cli/output"
 	"github.com/arduino/arduino-cli/configuration"
 	"github.com/arduino/arduino-cli/i18n"
+	"github.com/sirupsen/logrus"
 
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/instance"
@@ -123,6 +124,8 @@ func NewCommand() *cobra.Command {
 func runCompileCommand(cmd *cobra.Command, args []string) {
 	inst := instance.CreateAndInit()
 
+	logrus.Info("Executing `arduino-cli compile`")
+
 	path := ""
 	if len(args) > 0 {
 		path = args[0]
diff --git a/cli/completion/completion.go b/cli/completion/completion.go
@@ -21,6 +21,7 @@ import (
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/i18n"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
@@ -47,6 +48,7 @@ func NewCommand() *cobra.Command {
 }
 
 func runCompletionCommand(cmd *cobra.Command, args []string) {
+	logrus.Info("Executing `arduino-cli completion`")
 	if completionNoDesc && (args[0] == "powershell") {
 		feedback.Errorf(tr("Error: command description is not supported by %v"), args[0])
 		os.Exit(errorcodes.ErrGeneric)
diff --git a/cli/config/add.go b/cli/config/add.go
@@ -22,6 +22,7 @@ import (
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/configuration"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
@@ -43,6 +44,7 @@ func initAddCommand() *cobra.Command {
 }
 
 func runAddCommand(cmd *cobra.Command, args []string) {
+	logrus.Info("Executing `arduino-cli config add`")
 	key := args[0]
 	kind := validateKey(key)
 
diff --git a/cli/config/delete.go b/cli/config/delete.go
@@ -22,6 +22,7 @@ import (
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/configuration"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
@@ -44,6 +45,7 @@ func initDeleteCommand() *cobra.Command {
 }
 
 func runDeleteCommand(cmd *cobra.Command, args []string) {
+	logrus.Info("Executing `arduino-cli config delete`")
 	toDelete := args[0]
 
 	keys := []string{}
diff --git a/cli/config/dump.go b/cli/config/dump.go
@@ -38,7 +38,7 @@ func initDumpCommand() *cobra.Command {
 }
 
 func runDumpCommand(cmd *cobra.Command, args []string) {
-	logrus.Info("Executing `arduino config dump`")
+	logrus.Info("Executing `arduino-cli config dump`")
 	feedback.PrintResult(dumpResult{configuration.Settings.AllSettings()})
 }
 
diff --git a/cli/config/init.go b/cli/config/init.go
@@ -59,6 +59,7 @@ func initInitCommand() *cobra.Command {
 }
 
 func runInitCommand(cmd *cobra.Command, args []string) {
+	logrus.Info("Executing `arduino-cli config init`")
 
 	var configFileAbsPath *paths.Path
 	var absPath *paths.Path
diff --git a/cli/config/remove.go b/cli/config/remove.go
@@ -22,6 +22,7 @@ import (
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/configuration"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
@@ -43,6 +44,7 @@ func initRemoveCommand() *cobra.Command {
 }
 
 func runRemoveCommand(cmd *cobra.Command, args []string) {
+	logrus.Info("Executing `arduino-cli config remove`")
 	key := args[0]
 	kind := validateKey(key)
 
diff --git a/cli/config/set.go b/cli/config/set.go
@@ -23,6 +23,7 @@ import (
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/configuration"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
@@ -46,6 +47,7 @@ func initSetCommand() *cobra.Command {
 }
 
 func runSetCommand(cmd *cobra.Command, args []string) {
+	logrus.Info("Executing `arduino-cli config set`")
 	key := args[0]
 	kind := validateKey(key)
 
diff --git a/cli/core/download.go b/cli/core/download.go
@@ -51,7 +51,7 @@ func initDownloadCommand() *cobra.Command {
 func runDownloadCommand(cmd *cobra.Command, args []string) {
 	inst := instance.CreateAndInit()
 
-	logrus.Info("Executing `arduino core download`")
+	logrus.Info("Executing `arduino-cli core download`")
 
 	platformsRefs, err := arguments.ParseReferences(args, true)
 	if err != nil {
diff --git a/cli/core/install.go b/cli/core/install.go
@@ -59,7 +59,7 @@ func initInstallCommand() *cobra.Command {
 
 func runInstallCommand(cmd *cobra.Command, args []string) {
 	inst := instance.CreateAndInit()
-	logrus.Info("Executing `arduino core install`")
+	logrus.Info("Executing `arduino-cli core install`")
 
 	platformsRefs, err := arguments.ParseReferences(args, true)
 	if err != nil {
diff --git a/cli/core/list.go b/cli/core/list.go
@@ -50,7 +50,7 @@ func initListCommand() *cobra.Command {
 
 func runListCommand(cmd *cobra.Command, args []string) {
 	inst := instance.CreateAndInit()
-	logrus.Info("Executing `arduino core list`")
+	logrus.Info("Executing `arduino-cli core list`")
 
 	platforms, err := core.GetPlatforms(&rpc.PlatformListRequest{
 		Instance:      inst,
diff --git a/cli/core/search.go b/cli/core/search.go
@@ -82,7 +82,7 @@ func runSearchCommand(cmd *cobra.Command, args []string) {
 	}
 
 	arguments := strings.ToLower(strings.Join(args, " "))
-	logrus.Infof("Executing `arduino core search` with args: '%s'", arguments)
+	logrus.Infof("Executing `arduino-cli core search` with args: '%s'", arguments)
 
 	resp, err := core.PlatformSearch(&rpc.PlatformSearchRequest{
 		Instance:    inst,
diff --git a/cli/core/uninstall.go b/cli/core/uninstall.go
@@ -48,7 +48,7 @@ func initUninstallCommand() *cobra.Command {
 
 func runUninstallCommand(cmd *cobra.Command, args []string) {
 	inst := instance.CreateAndInit()
-	logrus.Info("Executing `arduino core uninstall`")
+	logrus.Info("Executing `arduino-cli core uninstall`")
 
 	platformsRefs, err := arguments.ParseReferences(args, true)
 	if err != nil {
diff --git a/cli/core/update_index.go b/cli/core/update_index.go
@@ -42,8 +42,8 @@ func initUpdateIndexCommand() *cobra.Command {
 }
 
 func runUpdateIndexCommand(cmd *cobra.Command, args []string) {
-	logrus.Info("Executing `arduino core update-index`")
 	inst := instance.CreateInstanceAndRunFirstUpdate()
+	logrus.Info("Executing `arduino-cli core update-index`")
 
 	_, err := commands.UpdateIndex(context.Background(), &rpc.UpdateIndexRequest{
 		Instance: inst,
diff --git a/cli/core/upgrade.go b/cli/core/upgrade.go
@@ -51,7 +51,7 @@ func initUpgradeCommand() *cobra.Command {
 
 func runUpgradeCommand(cmd *cobra.Command, args []string) {
 	inst := instance.CreateAndInit()
-	logrus.Info("Executing `arduino core upgrade`")
+	logrus.Info("Executing `arduino-cli core upgrade`")
 
 	// if no platform was passed, upgrade allthethings
 	if len(args) == 0 {
diff --git a/cli/daemon/daemon.go b/cli/daemon/daemon.go
@@ -67,6 +67,7 @@ func NewCommand() *cobra.Command {
 }
 
 func runDaemonCommand(cmd *cobra.Command, args []string) {
+	logrus.Info("Executing `arduino-cli daemon`")
 
 	if configuration.Settings.GetBool("metrics.enabled") {
 		metrics.Activate("daemon")
diff --git a/cli/debug/debug.go b/cli/debug/debug.go
@@ -31,6 +31,7 @@ import (
 	"github.com/arduino/arduino-cli/table"
 	"github.com/arduino/go-properties-orderedmap"
 	"github.com/fatih/color"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
@@ -67,6 +68,7 @@ func NewCommand() *cobra.Command {
 
 func runDebugCommand(command *cobra.Command, args []string) {
 	instance := instance.CreateAndInit()
+	logrus.Info("Executing `arduino-cli debug`")
 
 	path := ""
 	if len(args) > 0 {
diff --git a/cli/generatedocs/generatedocs.go b/cli/generatedocs/generatedocs.go
@@ -58,6 +58,7 @@ func NewCommand() *cobra.Command {
 }
 
 func generateBashCompletions(cmd *cobra.Command, args []string) {
+	logrus.Info("Executing `arduino-cli generate-docs`")
 	if outputDir == "" {
 		outputDir = "docs/bash_completions"
 	}
diff --git a/cli/lib/check_deps.go b/cli/lib/check_deps.go
@@ -27,6 +27,7 @@ import (
 	"github.com/arduino/arduino-cli/commands/lib"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/fatih/color"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
@@ -49,6 +50,7 @@ func initDepsCommand() *cobra.Command {
 
 func runDepsCommand(cmd *cobra.Command, args []string) {
 	instance := instance.CreateAndInit()
+	logrus.Info("Executing `arduino-cli lib deps`")
 	libRef, err := ParseLibraryReferenceArgAndAdjustCase(instance, args[0])
 	if err != nil {
 		feedback.Errorf(tr("Arguments error: %v"), err)
diff --git a/cli/lib/download.go b/cli/lib/download.go
@@ -27,6 +27,7 @@ import (
 	"github.com/arduino/arduino-cli/cli/output"
 	"github.com/arduino/arduino-cli/commands/lib"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
@@ -49,6 +50,7 @@ func initDownloadCommand() *cobra.Command {
 
 func runDownloadCommand(cmd *cobra.Command, args []string) {
 	instance := instance.CreateAndInit()
+	logrus.Info("Executing `arduino-cli lib download`")
 	refs, err := ParseLibraryReferenceArgsAndAdjustCase(instance, args)
 	if err != nil {
 		feedback.Errorf(tr("Invalid argument passed: %v"), err)
diff --git a/cli/lib/examples.go b/cli/lib/examples.go
@@ -56,7 +56,7 @@ func initExamplesCommand() *cobra.Command {
 
 func runExamplesCommand(cmd *cobra.Command, args []string) {
 	instance := instance.CreateAndInit()
-	logrus.Info("Show examples for library")
+	logrus.Info("Executing `arduino-cli lib examples`")
 
 	name := ""
 	if len(args) > 0 {
diff --git a/cli/lib/install.go b/cli/lib/install.go
@@ -31,6 +31,7 @@ import (
 	"github.com/arduino/arduino-cli/configuration"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 	semver "go.bug.st/relaxed-semver"
 )
@@ -65,6 +66,7 @@ func initInstallCommand() *cobra.Command {
 
 func runInstallCommand(cmd *cobra.Command, args []string) {
 	instance := instance.CreateAndInit()
+	logrus.Info("Executing `arduino-cli lib install`")
 
 	if zipPath || gitURL {
 		if !configuration.Settings.GetBool("library.enable_unsafe_install") {
diff --git a/cli/lib/list.go b/cli/lib/list.go
@@ -58,7 +58,7 @@ not listed, they can be listed by adding the --all flag.`),
 
 func runListCommand(cmd *cobra.Command, args []string) {
 	instance := instance.CreateAndInit()
-	logrus.Info("Listing")
+	logrus.Info("Executing `arduino-cli lib list`")
 
 	name := ""
 	if len(args) > 0 {
diff --git a/cli/lib/search.go b/cli/lib/search.go
diff --git a/cli/lib/uninstall.go b/cli/lib/uninstall.go
diff --git a/cli/lib/update_index.go b/cli/lib/update_index.go
diff --git a/cli/lib/upgrade.go b/cli/lib/upgrade.go
diff --git a/cli/monitor/monitor.go b/cli/monitor/monitor.go
diff --git a/cli/outdated/outdated.go b/cli/outdated/outdated.go
diff --git a/cli/sketch/archive.go b/cli/sketch/archive.go
diff --git a/cli/sketch/new.go b/cli/sketch/new.go
diff --git a/cli/update/update.go b/cli/update/update.go
diff --git a/cli/upgrade/upgrade.go b/cli/upgrade/upgrade.go
diff --git a/cli/upload/upload.go b/cli/upload/upload.go
diff --git a/cli/version/version.go b/cli/version/version.go
diff --git a/commands/lib/download.go b/commands/lib/download.go

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ func initCleanCommand() *cobra.Command {`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`func runCleanCommand(cmd *cobra.Command, args []string) {`
`41`		- logrus.Info("Executing `arduino cache clean`")
	`41`	+ logrus.Info("Executing `arduino-cli cache clean`")
`42`	`42`
`43`	`43`	`cachePath := configuration.Settings.GetString("directories.Downloads")`
`44`	`44`	`err := os.RemoveAll(cachePath)`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ import (`
`21`	`21`	`"github.com/arduino/arduino-cli/cli/errorcodes"`
`22`	`22`	`"github.com/arduino/arduino-cli/cli/feedback"`
`23`	`23`	`"github.com/arduino/arduino-cli/i18n"`
	`24`	`+ "github.com/sirupsen/logrus"`
`24`	`25`	`"github.com/spf13/cobra"`
`25`	`26`	`)`
`26`	`27`
`@@ -47,6 +48,7 @@ func NewCommand() *cobra.Command {`
`47`	`48`	`}`
`48`	`49`
`49`	`50`	`func runCompletionCommand(cmd *cobra.Command, args []string) {`
	`51`	+ logrus.Info("Executing `arduino-cli completion`")
`50`	`52`	`if completionNoDesc && (args[0] == "powershell") {`
`51`	`53`	`feedback.Errorf(tr("Error: command description is not supported by %v"), args[0])`
`52`	`54`	`os.Exit(errorcodes.ErrGeneric)`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ import (`
`22`	`22`	`"github.com/arduino/arduino-cli/cli/errorcodes"`
`23`	`23`	`"github.com/arduino/arduino-cli/cli/feedback"`
`24`	`24`	`"github.com/arduino/arduino-cli/configuration"`
	`25`	`+ "github.com/sirupsen/logrus"`
`25`	`26`	`"github.com/spf13/cobra"`
`26`	`27`	`)`
`27`	`28`
`@@ -43,6 +44,7 @@ func initAddCommand() *cobra.Command {`
`43`	`44`	`}`
`44`	`45`
`45`	`46`	`func runAddCommand(cmd *cobra.Command, args []string) {`
	`47`	+ logrus.Info("Executing `arduino-cli config add`")
`46`	`48`	`key := args[0]`
`47`	`49`	`kind := validateKey(key)`
`48`	`50`