feat: allow to show compilation properties without providing a sketch

Author: Luca Bianconi

commands/compile/compile.go

@@ -73,11 +73,14 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 		return nil, &arduino.MissingSketchPathError{}
 	}
 	sketchPath := paths.New(req.GetSketchPath())
-	sk, err := sketch.New(sketchPath)
-	if err != nil {
-		return nil, &arduino.CantOpenSketchError{Cause: err}
+	builderCtx := &types.Context{}
+	builderCtx.PackageManager = pme
+	if pme.GetProfile() != nil {
+		builderCtx.LibrariesManager = lm
 	}
 
+	sk, newSketchErr := sketch.New(sketchPath)
+
 	fqbnIn := req.GetFqbn()
 	if fqbnIn == "" && sk != nil {
 		fqbnIn = sk.GetDefaultFQBN()
@@ -111,13 +114,23 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 		securityKeysOverride = append(securityKeysOverride, "build.keys.keychain="+req.KeysKeychain, "build.keys.sign_key="+req.GetSignKey(), "build.keys.encrypt_key="+req.EncryptKey)
 	}
 
-	builderCtx := &types.Context{}
-	builderCtx.PackageManager = pme
-	if pme.GetProfile() != nil {
-		builderCtx.LibrariesManager = lm
-	}
 	builderCtx.UseCachedLibrariesResolution = req.GetSkipLibrariesDiscovery()
 	builderCtx.FQBN = fqbn
+	defer func() {
+		appendBuildProperties(r, builderCtx)
+	}()
+	r = &rpc.CompileResponse{}
+	if newSketchErr != nil {
+		if req.GetShowProperties() {
+			// Just get build properties and exit
+			compileErr := builder.RunParseHardware(builderCtx)
+			if compileErr != nil {
+				compileErr = &arduino.CompileFailedError{Message: compileErr.Error()}
+			}
+			return r, compileErr
+		}
+		return nil, &arduino.CantOpenSketchError{Cause: err}
+	}
 	builderCtx.Sketch = sk
 	builderCtx.ProgressCB = progressCB
 
@@ -183,7 +196,6 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 	builderCtx.OnlyUpdateCompilationDatabase = req.GetCreateCompilationDatabaseOnly()
 	builderCtx.SourceOverride = req.GetSourceOverride()
 
-	r = &rpc.CompileResponse{}
 	defer func() {
 		if p := builderCtx.BuildPath; p != nil {
 			r.BuildPath = p.String()
@@ -196,18 +208,6 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 		}
 	}()
 
-	defer func() {
-		buildProperties := builderCtx.BuildProperties
-		if buildProperties == nil {
-			return
-		}
-		keys := buildProperties.Keys()
-		sort.Strings(keys)
-		for _, key := range keys {
-			r.BuildProperties = append(r.BuildProperties, key+"="+buildProperties.Get(key))
-		}
-	}()
-
 	if req.GetShowProperties() {
 		// Just get build properties and exit
 		compileErr := builder.RunParseHardware(builderCtx)
@@ -227,16 +227,7 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 	}
 
 	defer func() {
-		importedLibs := []*rpc.Library{}
-		for _, lib := range builderCtx.ImportedLibraries {
-			rpcLib, err := lib.ToRPCLibrary()
-			if err != nil {
-				msg := tr("Error getting information for library %s", lib.Name) + ": " + err.Error() + "\n"
-				errStream.Write([]byte(msg))
-			}
-			importedLibs = append(importedLibs, rpcLib)
-		}
-		r.UsedLibraries = importedLibs
+		appendUserLibraries(r, builderCtx, errStream)
 	}()
 
 	// if it's a regular build, go on...
@@ -295,6 +286,32 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 	return r, nil
 }
 
+func appendUserLibraries(r *rpc.CompileResponse, builderCtx *types.Context, errStream io.Writer) {
+	importedLibs := []*rpc.Library{}
+	for _, lib := range builderCtx.ImportedLibraries {
+		rpcLib, err := lib.ToRPCLibrary()
+		if err != nil {
+			msg := tr("Error getting information for library %s", lib.Name) + ": " + err.Error() + "\n"
+			errStream.Write([]byte(msg))
+		}
+		importedLibs = append(importedLibs, rpcLib)
+	}
+	r.UsedLibraries = importedLibs
+}
+
+func appendBuildProperties(r *rpc.CompileResponse, builderCtx *types.Context) bool {
+	buildProperties := builderCtx.BuildProperties
+	if buildProperties == nil {
+		return true
+	}
+	keys := buildProperties.Keys()
+	sort.Strings(keys)
+	for _, key := range keys {
+		r.BuildProperties = append(r.BuildProperties, key+"="+buildProperties.Get(key))
+	}
+	return false
+}
+
 // maybePurgeBuildCache runs the build files cache purge if the policy conditions are met.
 func maybePurgeBuildCache() {
 

internal/cli/arguments/sketch.go

@@ -43,7 +43,13 @@ func InitSketchPath(path string) (sketchPath *paths.Path) {
 }
 
 // NewSketch is a helper function useful to create a sketch instance
-func NewSketch(sketchPath *paths.Path) *sketch.Sketch {
+func NewSketch(sketchPath *paths.Path) (*sketch.Sketch, error) {
+	return sketch.New(sketchPath)
+}
+
+// MustNewSketch is a helper function useful to create a sketch instance, exits if the
+// initialization fails
+func MustNewSketch(sketchPath *paths.Path) *sketch.Sketch {
 	sketch, err := sketch.New(sketchPath)
 	if err != nil {
 		feedback.Fatal(tr("Error opening sketch: %v", err), feedback.ErrGeneric)

internal/cli/board/attach.go

@@ -50,7 +50,7 @@ func initAttachCommand() *cobra.Command {
 
 func runAttachCommand(path string, port *arguments.Port, fqbn string) {
 	sketchPath := arguments.InitSketchPath(path)
-	sk := arguments.NewSketch(sketchPath)
+	sk := arguments.MustNewSketch(sketchPath)
 
 	var currentPort *boardAttachPortResult
 	if currentAddress, currentProtocol := sk.GetDefaultPortAddressAndProtocol(); currentAddress != "" {

internal/cli/compile/compile.go

@@ -180,14 +180,29 @@ func runCompileCommand(cmd *cobra.Command, args []string) {
 			feedback.Fatal(tr("You cannot use the %s flag while compiling with a profile.", "--library"), feedback.ErrBadArgument)
 		}
 	}
+	showPropertiesM, err := parseShowPropertiesMode(showProperties)
+	if err != nil {
+		feedback.Fatal(tr("Error parsing --show-properties flag: %v", err), feedback.ErrGeneric)
+	}
 
 	path := ""
 	if len(args) > 0 {
 		path = args[0]
 	}
 
 	sketchPath := arguments.InitSketchPath(path)
-	sk := arguments.NewSketch(sketchPath)
+	sk, err := arguments.NewSketch(sketchPath)
+
+	if err != nil {
+		showPropertiesWithEmptySketchPath := path == "" && showPropertiesM != showPropertiesModeDisabled
+		if showPropertiesWithEmptySketchPath {
+			// properties were requested and no sketch path was provided
+			// let's use an empty sketch struct and hope for the best
+			sk = nil
+		} else {
+			feedback.Fatal(tr("Error opening sketch: %v", err), feedback.ErrGeneric)
+		}
+	}
 
 	inst, profile := instance.CreateAndInitWithProfile(profileArg.Get(), sketchPath)
 	if fqbnArg.String() == "" {
@@ -215,11 +230,6 @@ func runCompileCommand(cmd *cobra.Command, args []string) {
 		overrides = o.Overrides
 	}
 
-	showPropertiesM, err := parseShowPropertiesMode(showProperties)
-	if err != nil {
-		feedback.Fatal(tr("Error parsing --show-properties flag: %v", err), feedback.ErrGeneric)
-	}
-
 	var stdOut, stdErr io.Writer
 	var stdIORes func() *feedback.OutputStreamsResult
 	if showPropertiesM != showPropertiesModeDisabled {

internal/cli/debug/debug.go

@@ -75,7 +75,7 @@ func runDebugCommand(command *cobra.Command, args []string) {
 	}
 
 	sketchPath := arguments.InitSketchPath(path)
-	sk := arguments.NewSketch(sketchPath)
+	sk := arguments.MustNewSketch(sketchPath)
 	fqbn, port := arguments.CalculateFQBNAndPort(&portArgs, &fqbnArg, instance, sk)
 	debugConfigRequested := &dbg.DebugConfigRequest{
 		Instance:    instance,

legacy/builder/fail_if_buildpath_equals_sketchpath.go

@@ -23,6 +23,9 @@ import (
 type FailIfBuildPathEqualsSketchPath struct{}
 
 func (s *FailIfBuildPathEqualsSketchPath) Run(ctx *types.Context) error {
+	if ctx.BuildPath == nil || ctx.Sketch == nil {
+		return nil
+	}
 	buildPath := ctx.BuildPath.Canonical()
 	sketchPath := ctx.Sketch.FullPath.Canonical()
 	if buildPath.EqualsTo(sketchPath) {

legacy/builder/setup_build_properties.go

@@ -109,7 +109,9 @@ func (s *SetupBuildProperties) Run(ctx *types.Context) error {
 		buildProperties.Set("software", DEFAULT_SOFTWARE)
 	}
 
-	buildProperties.SetPath("build.source.path", ctx.Sketch.FullPath)
+	if ctx.Sketch != nil {
+		buildProperties.SetPath("build.source.path", ctx.Sketch.FullPath)
+	}
 
 	now := time.Now()
 	buildProperties.Set("extra.time.utc", strconv.FormatInt(now.Unix(), 10))