refactor sketch path calculation

Author: umbynos

cli/arguments/sketch.go

@@ -18,8 +18,11 @@ package arguments
 import (
 	"os"
 
+	"github.com/arduino/arduino-cli/arduino/discovery"
+	"github.com/arduino/arduino-cli/arduino/sketch"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
 	"github.com/sirupsen/logrus"
 )
@@ -39,3 +42,54 @@ func InitSketchPath(sketchPath string) *paths.Path {
 	logrus.Infof("Reading sketch from dir: %s", wd)
 	return wd
 }
+
+// SketchPathCalculation creates the path of a sketch, optionally it warns the user when using pde files.
+// it also gets the port of a board
+// it returns the created sketch and the discovery port
+func SketchPathCalculation(path string, port Port, instance *rpc.Instance, warn bool) (*paths.Path, *sketch.Sketch, *discovery.Port) {
+	sketchPath := InitSketch(path, warn)
+	sketch := CreateSketch(sketchPath)
+	discoveryPort := GetDiscoveryPort(instance, port, sketch)
+	return sketchPath, sketch, discoveryPort
+}
+
+// InitSketch is a helper function useful to create the sketch path, optionally it warns the user when using pde files.
+func InitSketch(path string, warn bool) *paths.Path {
+	sketchPath := InitSketchPath(path)
+
+	if warn {
+		WarnDeprecatedPdeFiles(sketchPath)
+	}
+	return sketchPath
+}
+
+// CreateSketch is a helper function usefull to create a sketch
+func CreateSketch(sketchPath *paths.Path) *sketch.Sketch {
+	sketch, err := sketch.New(sketchPath)
+	if err != nil {
+		feedback.Errorf(tr("Error creating sketch: %v"), err)
+		os.Exit(errorcodes.ErrGeneric)
+	}
+	return sketch
+}
+
+// WarnDeprecatedPdeFiles warns the user that .pde files are deprecated
+func WarnDeprecatedPdeFiles(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:"))
+		for _, f := range files {
+			feedback.Error(f)
+		}
+	}
+}
+
+// GetDiscoveryPort is a helper function useful to get the port and handle possible errors
+func GetDiscoveryPort(instance *rpc.Instance, port Port, sk *sketch.Sketch) *discovery.Port {
+	discoveryPort, err := port.GetPort(instance, sk)
+	if err != nil {
+		feedback.Errorf(tr("Error discovering port: %v"), err)
+		os.Exit(errorcodes.ErrGeneric)
+	}
+	return discoveryPort
+}

cli/compile/compile.go

@@ -21,8 +21,6 @@ import (
 	"encoding/json"
 	"os"
 
-	"github.com/arduino/arduino-cli/arduino/discovery"
-	"github.com/arduino/arduino-cli/arduino/sketch"
 	"github.com/arduino/arduino-cli/cli/arguments"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/cli/output"
@@ -129,15 +127,8 @@ func run(cmd *cobra.Command, args []string) {
 	if len(args) > 0 {
 		path = args[0]
 	}
-	sketchPath := arguments.InitSketchPath(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:"))
-		for _, f := range files {
-			feedback.Error(f)
-		}
-	}
+	sketchPath := arguments.InitSketch(path, true)
 
 	var overrides map[string]string
 	if sourceOverrides != "" {
@@ -189,18 +180,8 @@ func run(cmd *cobra.Command, args []string) {
 	}
 
 	if compileError == nil && uploadAfterCompile {
-		var sk *sketch.Sketch
-		sk, err := sketch.New(sketchPath)
-		if err != nil {
-			feedback.Errorf(tr("Error during Upload: %v"), err)
-			os.Exit(errorcodes.ErrGeneric)
-		}
-		var discoveryPort *discovery.Port
-		discoveryPort, err = port.GetPort(inst, sk)
-		if err != nil {
-			feedback.Errorf(tr("Error during Upload: %v"), err)
-			os.Exit(errorcodes.ErrGeneric)
-		}
+		sk := arguments.CreateSketch(sketchPath)
+		discoveryPort := arguments.GetDiscoveryPort(inst, port, sk)
 
 		userFieldRes, err := upload.SupportedUserFields(context.Background(), &rpc.SupportedUserFieldsRequest{
 			Instance: inst,

cli/debug/debug.go

@@ -21,7 +21,6 @@ import (
 	"os/signal"
 	"sort"
 
-	"github.com/arduino/arduino-cli/arduino/sketch"
 	"github.com/arduino/arduino-cli/cli/arguments"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
@@ -81,17 +80,7 @@ func run(command *cobra.Command, args []string) {
 	if len(args) > 0 {
 		path = args[0]
 	}
-	sketchPath := arguments.InitSketchPath(path)
-	sk, err := sketch.New(sketchPath)
-	if err != nil {
-		feedback.Errorf(tr("Error during Debug: %v"), err)
-		os.Exit(errorcodes.ErrGeneric)
-	}
-	discoveryPort, err := port.GetPort(instance, sk)
-	if err != nil {
-		feedback.Errorf(tr("Error during Debug: %v"), err)
-		os.Exit(errorcodes.ErrGeneric)
-	}
+	sketchPath, _, discoveryPort := arguments.SketchPathCalculation(path, port, instance, false)
 	debugConfigRequested := &dbg.DebugConfigRequest{
 		Instance:    instance,
 		Fqbn:        fqbn,

cli/sketch/archive.go

@@ -20,7 +20,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/arduino/arduino-cli/arduino/sketch"
+	"github.com/arduino/arduino-cli/cli/arguments"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	sk "github.com/arduino/arduino-cli/commands/sketch"
@@ -61,13 +61,7 @@ func runArchiveCommand(cmd *cobra.Command, args []string) {
 		sketchPath = paths.New(args[0])
 	}
 
-	// .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:"))
-		for _, f := range files {
-			feedback.Error(f)
-		}
-	}
+	arguments.WarnDeprecatedPdeFiles(sketchPath)
 
 	archivePath := ""
 	if len(args) == 2 {

cli/upload/upload.go

@@ -19,7 +19,6 @@ import (
 	"context"
 	"os"
 
-	"github.com/arduino/arduino-cli/arduino/sketch"
 	"github.com/arduino/arduino-cli/cli/arguments"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
@@ -86,27 +85,7 @@ func run(command *cobra.Command, args []string) {
 	if len(args) > 0 {
 		path = args[0]
 	}
-	sketchPath := arguments.InitSketchPath(path)
-
-	// .pde files are still supported but deprecated, this warning urges the user to rename them
-	if files := sketch.CheckForPdeFiles(sketchPath); len(files) > 0 && importDir == "" && importFile == "" {
-		feedback.Error(tr("Sketches with .pde extension are deprecated, please rename the following files to .ino:"))
-		for _, f := range files {
-			feedback.Error(f)
-		}
-	}
-
-	sk, err := sketch.New(sketchPath)
-	if err != nil && importDir == "" && importFile == "" {
-		feedback.Errorf(tr("Error during Upload: %v"), err)
-		os.Exit(errorcodes.ErrGeneric)
-	}
-
-	discoveryPort, err := port.GetPort(instance, sk)
-	if err != nil {
-		feedback.Errorf(tr("Error during Upload: %v"), err)
-		os.Exit(errorcodes.ErrGeneric)
-	}
+	sketchPath, sk, discoveryPort := arguments.SketchPathCalculation(path, port, instance, true)
 
 	if fqbn == "" && sk != nil && sk.Metadata != nil {
 		// If the user didn't specify an FQBN and a sketch.json file is present