Implementation of compile output parser in gRPC command

Author: cmaglie

arduino/builder/builder.go

@@ -37,6 +37,7 @@ import (
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
 	"github.com/arduino/go-properties-orderedmap"
+	"github.com/sirupsen/logrus"
 )
 
 // ErrSketchCannotBeLocatedInBuildPath fixdoc
@@ -95,6 +96,8 @@ type Builder struct {
 	// This is a function used to parse the output of the compiler
 	// It is used to extract errors and warnings
 	compilerOutputParser diagnostics.CompilerOutputParserCB
+	// and here are the diagnostics parsed from the compiler
+	compilerDiagnostics diagnostics.Diagnostics
 }
 
 // buildArtifacts contains the result of various build
@@ -194,7 +197,7 @@ func NewBuilder(
 		logger.Warn(string(verboseOut))
 	}
 
-	return &Builder{
+	b := &Builder{
 		sketch:                        sk,
 		buildProperties:               buildProperties,
 		buildPath:                     buildPath,
@@ -231,7 +234,26 @@ func NewBuilder(
 			buildProperties.GetPath("runtime.platform.path"),
 			buildProperties.GetPath("build.core.path"), // TODO can we buildCorePath ?
 		),
-	}, nil
+	}
+
+	b.compilerOutputParser = func(cmdline []string, out []byte) {
+		compiler := diagnostics.DetectCompilerFromCommandLine(
+			cmdline,
+			false, // at the moment compiler-probing is not required
+		)
+		if compiler == nil {
+			logrus.Warnf("Could not detect compiler from: %s", cmdline)
+			return
+		}
+		diags, err := diagnostics.ParseCompilerOutput(compiler, out)
+		if err != nil {
+			logrus.Warnf("Error parsing compiler output: %s", err)
+			return
+		}
+		b.compilerDiagnostics = append(b.compilerDiagnostics, diags...)
+	}
+
+	return b, nil
 }
 
 // GetBuildProperties returns the build properties for running this build
@@ -254,6 +276,11 @@ func (b *Builder) ImportedLibraries() libraries.List {
 	return b.libsDetector.ImportedLibraries()
 }
 
+// CompilerDiagnostics returns the parsed compiler diagnostics
+func (b *Builder) CompilerDiagnostics() diagnostics.Diagnostics {
+	return b.compilerDiagnostics
+}
+
 // Preprocess fixdoc
 func (b *Builder) Preprocess() ([]byte, error) {
 	b.Progress.AddSubSteps(6)

commands/compile/compile.go

@@ -177,6 +177,7 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 	if pme.GetProfile() != nil {
 		libsManager = lm
 	}
+
 	sketchBuilder, err := builder.NewBuilder(
 		sk,
 		boardBuildProperties,
@@ -218,6 +219,10 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 		}
 	}()
 
+	defer func() {
+		r.Diagnostics = sketchBuilder.CompilerDiagnostics().ToRPC()
+	}()
+
 	defer func() {
 		buildProperties := sketchBuilder.GetBuildProperties()
 		if buildProperties == nil {

internal/cli/compile/compile.go

@@ -345,6 +345,7 @@ func runCompileCommand(cmd *cobra.Command, args []string) {
 		BuilderResult:      compileRes,
 		UploadResult:       uploadRes,
 		ProfileOut:         profileOut,
+		Diagnostics:        compileRes.GetDiagnostics(),
 		Success:            compileError == nil,
 		showPropertiesMode: showProperties,
 		hideStats:          preprocess,
@@ -385,14 +386,14 @@ func runCompileCommand(cmd *cobra.Command, args []string) {
 }
 
 type compileResult struct {
-	CompilerOut   string               `json:"compiler_out"`
-	CompilerErr   string               `json:"compiler_err"`
-	BuilderResult *rpc.CompileResponse `json:"builder_result"`
-	UploadResult  *rpc.UploadResult    `json:"upload_result"`
-	Success       bool                 `json:"success"`
-	ProfileOut    string               `json:"profile_out,omitempty"`
-	Error         string               `json:"error,omitempty"`
-
+	CompilerOut        string                   `json:"compiler_out"`
+	CompilerErr        string                   `json:"compiler_err"`
+	BuilderResult      *rpc.CompileResponse     `json:"builder_result"`
+	UploadResult       *rpc.UploadResult        `json:"upload_result"`
+	Success            bool                     `json:"success"`
+	ProfileOut         string                   `json:"profile_out,omitempty"`
+	Error              string                   `json:"error,omitempty"`
+	Diagnostics        []*rpc.CompileDiagnostic `json:"diagnostics"`
 	showPropertiesMode arguments.ShowPropertiesMode
 	hideStats          bool
 }