Added Context.ExecStdout/ExecStderr to easy redirect output of executed commands

Author: cmaglie

i18n/i18n.go

@@ -52,32 +52,45 @@ type Logger interface {
 	Flush() string
 }
 
-type LoggerToIoWriter struct {
-	Writer io.Writer
+type LoggerToCustomStreams struct {
+	Stdout io.Writer
+	Stderr io.Writer
 }
 
-func (s LoggerToIoWriter) Fprintln(w io.Writer, level string, format string, a ...interface{}) {
-	fmt.Fprintln(s.Writer, Format(format, a...))
+func (s LoggerToCustomStreams) Fprintln(w io.Writer, level string, format string, a ...interface{}) {
+	target := s.Stdout
+	if w == os.Stderr {
+		target = s.Stderr
+	}
+	fmt.Fprintln(target, Format(format, a...))
 }
 
-func (s LoggerToIoWriter) UnformattedFprintln(w io.Writer, str string) {
-	fmt.Fprintln(s.Writer, str)
+func (s LoggerToCustomStreams) UnformattedFprintln(w io.Writer, str string) {
+	target := s.Stdout
+	if w == os.Stderr {
+		target = s.Stderr
+	}
+	fmt.Fprintln(target, str)
 }
 
-func (s LoggerToIoWriter) UnformattedWrite(w io.Writer, data []byte) {
-	s.Writer.Write(data)
+func (s LoggerToCustomStreams) UnformattedWrite(w io.Writer, data []byte) {
+	target := s.Stdout
+	if w == os.Stderr {
+		target = s.Stderr
+	}
+	target.Write(data)
 }
 
-func (s LoggerToIoWriter) Println(level string, format string, a ...interface{}) {
+func (s LoggerToCustomStreams) Println(level string, format string, a ...interface{}) {
 	s.Fprintln(nil, level, format, a...)
 }
 
-func (s LoggerToIoWriter) Flush() string {
+func (s LoggerToCustomStreams) Flush() string {
 	return ""
 }
 
-func (s LoggerToIoWriter) Name() string {
-	return "LoggerToIoWriter"
+func (s LoggerToCustomStreams) Name() string {
+	return "LoggerToCustomStreams"
 }
 
 type NoopLogger struct{}

types/context.go

@@ -1,6 +1,7 @@
 package types
 
 import (
+	"io"
 	"strings"
 
 	"github.com/arduino/arduino-builder/i18n"
@@ -9,8 +10,8 @@ import (
 	"github.com/arduino/arduino-cli/arduino/libraries"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesmanager"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesresolver"
-	"github.com/arduino/go-paths-helper"
-	"github.com/arduino/go-properties-orderedmap"
+	paths "github.com/arduino/go-paths-helper"
+	properties "github.com/arduino/go-properties-orderedmap"
 )
 
 type ProgressStruct struct {
@@ -110,6 +111,10 @@ type Context struct {
 
 	// Experimental: use arduino-preprocessor to create prototypes
 	UseArduinoPreprocessor bool
+
+	// Out and Err stream to redirect all Exec commands
+	ExecStdout io.Writer
+	ExecStderr io.Writer
 }
 
 func (ctx *Context) ExtractBuildOptions() *properties.Map {

utils/utils.go

@@ -48,7 +48,7 @@ import (
 	"github.com/arduino/arduino-builder/gohasissues"
 	"github.com/arduino/arduino-builder/i18n"
 	"github.com/arduino/arduino-builder/types"
-	"github.com/arduino/go-paths-helper"
+	paths "github.com/arduino/go-paths-helper"
 	"golang.org/x/text/transform"
 	"golang.org/x/text/unicode/norm"
 )
@@ -288,6 +288,13 @@ const (
 )
 
 func ExecCommand(ctx *types.Context, command *exec.Cmd, stdout int, stderr int) ([]byte, []byte, error) {
+	if ctx.ExecStdout == nil {
+		ctx.ExecStdout = os.Stdout
+	}
+	if ctx.ExecStderr == nil {
+		ctx.ExecStderr = os.Stderr
+	}
+
 	if ctx.Verbose {
 		ctx.GetLogger().UnformattedFprintln(os.Stdout, PrintableCommand(command.Args))
 	}
@@ -296,14 +303,14 @@ func ExecCommand(ctx *types.Context, command *exec.Cmd, stdout int, stderr int)
 		buffer := &bytes.Buffer{}
 		command.Stdout = buffer
 	} else if stdout == Show || stdout == ShowIfVerbose && ctx.Verbose {
-		command.Stdout = os.Stdout
+		command.Stdout = ctx.ExecStdout
 	}
 
 	if stderr == Capture {
 		buffer := &bytes.Buffer{}
 		command.Stderr = buffer
 	} else if stderr == Show || stderr == ShowIfVerbose && ctx.Verbose {
-		command.Stderr = os.Stderr
+		command.Stderr = ctx.ExecStderr
 	}
 
 	err := command.Start()