Print compile error and suggestions as part of the result

Author: cmaglie

internal/cli/compile/compile.go

@@ -305,15 +305,16 @@ func runCompileCommand(cmd *cobra.Command, args []string) {
 	}
 
 	stdIO := stdIORes()
-	feedback.PrintResult(&compileResult{
+	res := &compileResult{
 		CompilerOut:   stdIO.Stdout,
 		CompilerErr:   stdIO.Stderr,
 		BuilderResult: compileRes,
 		ProfileOut:    profileOut,
 		Success:       compileError == nil,
-	})
+	}
+
 	if compileError != nil {
-		msg := tr("Error during build: %v", compileError)
+		res.Error = tr("Error during build: %v", compileError)
 
 		// Check the error type to give the user better feedback on how
 		// to resolve it
@@ -333,17 +334,17 @@ func runCompileCommand(cmd *cobra.Command, args []string) {
 			release()
 
 			if profileArg.String() == "" {
-				msg += "\n"
 				if platform != nil {
 					suggestion := fmt.Sprintf("`%s core install %s`", version.VersionInfo.Application, platformErr.Platform)
-					msg += tr("Try running %s", suggestion)
+					res.Suggestion = tr("Try running %s", suggestion)
 				} else {
-					msg += tr("Platform %s is not found in any known index\nMaybe you need to add a 3rd party URL?", platformErr.Platform)
+					res.Suggestion = tr("Platform %s is not found in any known index\nMaybe you need to add a 3rd party URL?", platformErr.Platform)
 				}
 			}
 		}
-		feedback.Fatal(msg, feedback.ErrGeneric)
+		feedback.FatalResult(res, feedback.ErrGeneric)
 	}
+	feedback.PrintResult(res)
 }
 
 type compileResult struct {
@@ -352,6 +353,8 @@ type compileResult struct {
 	BuilderResult *rpc.CompileResponse `json:"builder_result"`
 	Success       bool                 `json:"success"`
 	ProfileOut    string               `json:"profile_out,omitempty"`
+	Error         string               `json:"error,omitempty"`
+	Suggestion    string               `json:"suggestion,omitempty"`
 }
 
 func (r *compileResult) Data() interface{} {
@@ -365,8 +368,8 @@ func (r *compileResult) String() string {
 	build := r.BuilderResult
 
 	res := "\n"
-	libraries := table.New()
 	if len(build.GetUsedLibraries()) > 0 {
+		libraries := table.New()
 		libraries.SetHeader(
 			table.NewCell(tr("Used library"), titleColor),
 			table.NewCell(tr("Version"), titleColor),
@@ -377,8 +380,8 @@ func (r *compileResult) String() string {
 				l.GetVersion(),
 				table.NewCell(l.GetInstallDir(), pathColor))
 		}
+		res += fmt.Sprintln(libraries.Render())
 	}
-	res += libraries.Render() + "\n"
 
 	if boardPlatform := build.GetBoardPlatform(); boardPlatform != nil {
 		platforms := table.New()
@@ -398,10 +401,16 @@ func (r *compileResult) String() string {
 				buildPlatform.GetVersion(),
 				table.NewCell(buildPlatform.GetInstallDir(), pathColor))
 		}
-		res += platforms.Render()
+		res += fmt.Sprintln(platforms.Render())
+	}
+	if r.Error != "" {
+		res += fmt.Sprintln(r.Error)
 	}
 	if r.ProfileOut != "" {
-		res += "\n" + fmt.Sprintln(r.ProfileOut)
+		res += fmt.Sprintln(r.ProfileOut)
+	}
+	if r.Suggestion != "" {
+		res += fmt.Sprintln(r.Suggestion)
 	}
-	return res
+	return strings.TrimRight(res, fmt.Sprintln())
 }

internal/cli/feedback/feedback.go

@@ -168,6 +168,12 @@ func FatalError(err error, exitCode ExitCode) {
 	Fatal(err.Error(), exitCode)
 }
 
+// FatalResult outputs the result and exits with status exitCode.
+func FatalResult(res Result, exitCode ExitCode) {
+	PrintResult(res)
+	os.Exit(int(exitCode))
+}
+
 // Fatal outputs the errorMsg and exits with status exitCode.
 func Fatal(errorMsg string, exitCode ExitCode) {
 	if format == Text {

internal/integrationtest/compile_2/compile_test.go

@@ -421,16 +421,16 @@ func TestCompileNonInstalledPlatformWithWrongPackagerAndArch(t *testing.T) {
 	require.NoError(t, err)
 
 	// Compile with wrong packager
-	_, stderr, err := cli.Run("compile", "-b", "wrong:avr:uno", sketchPath.String())
+	stdout, stderr, err := cli.Run("compile", "-b", "wrong:avr:uno", sketchPath.String())
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "Error during build: Platform 'wrong:avr' not found: platform not installed")
-	require.Contains(t, string(stderr), "Platform wrong:avr is not found in any known index")
+	require.Contains(t, string(stdout), "Platform wrong:avr is not found in any known index")
 
 	// Compile with wrong arch
-	_, stderr, err = cli.Run("compile", "-b", "arduino:wrong:uno", sketchPath.String())
+	stdout, stderr, err = cli.Run("compile", "-b", "arduino:wrong:uno", sketchPath.String())
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "Error during build: Platform 'arduino:wrong' not found: platform not installed")
-	require.Contains(t, string(stderr), "Platform arduino:wrong is not found in any known index")
+	require.Contains(t, string(stdout), "Platform arduino:wrong is not found in any known index")
 }
 
 func TestCompileWithKnownPlatformNotInstalled(t *testing.T) {
@@ -446,9 +446,9 @@ func TestCompileWithKnownPlatformNotInstalled(t *testing.T) {
 	require.NoError(t, err)
 
 	// Try to compile using a platform found in the index but not installed
-	_, stderr, err := cli.Run("compile", "-b", "arduino:avr:uno", sketchPath.String())
+	stdout, stderr, err := cli.Run("compile", "-b", "arduino:avr:uno", sketchPath.String())
 	require.Error(t, err)
 	require.Contains(t, string(stderr), "Error during build: Platform 'arduino:avr' not found: platform not installed")
 	// Verifies command to fix error is shown to user
-	require.Contains(t, string(stderr), "Try running `arduino-cli core install arduino:avr`")
+	require.Contains(t, string(stdout), "Try running `arduino-cli core install arduino:avr`")
 }