fix: log in feedback stream

Author: Bikappa

Diff for: arduino/cores/packagemanager/install_uninstall.go

@@ -16,6 +16,7 @@
 package packagemanager
 
 import (
+	"bytes"
 	"encoding/json"
 	"fmt"
 	"runtime"
@@ -27,7 +28,6 @@ import (
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
 	"github.com/pkg/errors"
-	"github.com/sirupsen/logrus"
 )
 
 // DownloadAndInstallPlatformUpgrades runs a full installation process to upgrade the given platform.
@@ -175,9 +175,13 @@ func (pme *Explorer) DownloadAndInstallPlatformAndTools(
 		if !platformRelease.IsInstalled() {
 			return errors.New(tr("platform not installed"))
 		}
-		if err := pme.RunPostInstallScript(platformRelease.InstallDir); err != nil {
+		stdout, stderr, err := pme.RunPostInstallScript(platformRelease.InstallDir)
+		skipEmptyMessageTaskProgressCB(taskCB)(&rpc.TaskProgress{Message: string(stdout)})
+		skipEmptyMessageTaskProgressCB(taskCB)(&rpc.TaskProgress{Message: string(stderr)})
+		if err != nil {
 			taskCB(&rpc.TaskProgress{Message: tr("WARNING cannot configure platform: %s", err)})
 		}
+
 	} else {
 		log.Info("Skipping platform configuration.")
 		taskCB(&rpc.TaskProgress{Message: tr("Skipping platform configuration.")})
@@ -227,7 +231,7 @@ func (pme *Explorer) cacheInstalledJSON(platformRelease *cores.PlatformRelease)
 
 // RunPostInstallScript runs the post_install.sh (or post_install.bat) script for the
 // specified platformRelease or toolRelease.
-func (pme *Explorer) RunPostInstallScript(installDir *paths.Path) error {
+func (pme *Explorer) RunPostInstallScript(installDir *paths.Path) ([]byte, []byte, error) {
 	postInstallFilename := "post_install.sh"
 	if runtime.GOOS == "windows" {
 		postInstallFilename = "post_install.bat"
@@ -236,23 +240,16 @@ func (pme *Explorer) RunPostInstallScript(installDir *paths.Path) error {
 	if postInstall.Exist() && postInstall.IsNotDir() {
 		cmd, err := executils.NewProcessFromPath(pme.GetEnvVarsForSpawnedProcess(), postInstall)
 		if err != nil {
-			return err
+			return []byte{}, []byte{}, err
 		}
-		logInfo := pme.log.WriterLevel(logrus.InfoLevel)
-		logErr := pme.log.WriterLevel(logrus.ErrorLevel)
-		defer func() {
-			logInfo.Close()
-			logErr.Close()
-		}()
-		cmd.RedirectStdoutTo(logInfo)
-		cmd.RedirectStderrTo(logErr)
-
+		cmdStdout, cmdStderr := bytes.NewBuffer([]byte{}), bytes.NewBuffer([]byte{})
+		cmd.RedirectStdoutTo(cmdStdout)
+		cmd.RedirectStderrTo(cmdStderr)
 		cmd.SetDirFromPath(installDir)
-		if err := cmd.Run(); err != nil {
-			return err
-		}
+		err = cmd.Run()
+		return cmdStdout.Bytes(), cmdStderr.Bytes(), err
 	}
-	return nil
+	return []byte{}, []byte{}, nil
 }
 
 // IsManagedPlatformRelease returns true if the PlatforRelease is managed by the PackageManager
@@ -344,7 +341,10 @@ func (pme *Explorer) InstallTool(toolRelease *cores.ToolRelease, taskCB rpc.Task
 	if !skipPostInstall {
 		log.Info("Running tool post_install script")
 		taskCB(&rpc.TaskProgress{Message: tr("Configuring tool.")})
-		if err := pme.RunPostInstallScript(toolRelease.InstallDir); err != nil {
+		stdout, stderr, err := pme.RunPostInstallScript(toolRelease.InstallDir)
+		skipEmptyMessageTaskProgressCB(taskCB)(&rpc.TaskProgress{Message: string(stdout)})
+		skipEmptyMessageTaskProgressCB(taskCB)(&rpc.TaskProgress{Message: string(stderr)})
+		if err != nil {
 			taskCB(&rpc.TaskProgress{Message: tr("WARNING cannot configure tool: %s", err)})
 		}
 	} else {
@@ -421,3 +421,12 @@ func (pme *Explorer) IsToolRequired(toolRelease *cores.ToolRelease) bool {
 	}
 	return false
 }
+
+func skipEmptyMessageTaskProgressCB(taskCB rpc.TaskProgressCB) rpc.TaskProgressCB {
+	return func(msg *rpc.TaskProgress) {
+		if msg != nil && len(msg.Message) == 0 {
+			return
+		}
+		taskCB(msg)
+	}
+}

Diff for: arduino/cores/packagemanager/package_manager_test.go

@@ -16,9 +16,7 @@
 package packagemanager_test
 
 import (
-	"bytes"
 	"fmt"
-	"io"
 	"net/url"
 	"os"
 	"runtime"
@@ -30,8 +28,6 @@ import (
 	"github.com/arduino/arduino-cli/configuration"
 	"github.com/arduino/go-paths-helper"
 	"github.com/arduino/go-properties-orderedmap"
-	"github.com/sirupsen/logrus"
-	"github.com/sirupsen/logrus/hooks/writer"
 	"github.com/stretchr/testify/require"
 	semver "go.bug.st/relaxed-semver"
 )
@@ -646,13 +642,7 @@ func TestLegacyPackageConversionToPluggableDiscovery(t *testing.T) {
 	}
 }
 
-type plainFormatter struct{}
-
-func (f *plainFormatter) Format(e *logrus.Entry) ([]byte, error) {
-	return []byte(e.Message), nil
-}
 func TestRunPostInstall(t *testing.T) {
-	logger := logrus.StandardLogger()
 	pmb := packagemanager.NewBuilder(nil, nil, nil, nil, "test")
 	pm := pmb.Build()
 	pme, release := pm.NewExplorer()
@@ -661,23 +651,6 @@ func TestRunPostInstall(t *testing.T) {
 	// prepare dummy post install script
 	dir := paths.New(t.TempDir())
 
-	// capture logs for inspection
-	infoBuffer, errorBuffer := bytes.NewBuffer([]byte{}), bytes.NewBuffer([]byte{})
-	logger.SetOutput(io.Discard)
-	logger.SetFormatter(&plainFormatter{})
-	logger.AddHook(&writer.Hook{
-		Writer: infoBuffer,
-		LogLevels: []logrus.Level{
-			logrus.InfoLevel,
-		},
-	})
-	logger.AddHook(&writer.Hook{
-		Writer: errorBuffer,
-		LogLevels: []logrus.Level{
-			logrus.ErrorLevel,
-		},
-	})
-
 	var scriptPath *paths.Path
 	var err error
 	if runtime.GOOS == "windows" {
@@ -697,9 +670,10 @@ func TestRunPostInstall(t *testing.T) {
 	require.NoError(t, err)
 	err = os.Chmod(scriptPath.String(), 0777)
 	require.NoError(t, err)
-	pme.RunPostInstallScript(dir)
-	// `HasPrefix` because windows seem to add a trailing space at the end
+	stdout, stderr, err := pme.RunPostInstallScript(dir)
+	require.NoError(t, err)
 
-	require.Equal(t, "sent in stdout", strings.Trim(infoBuffer.String(), "\n\r "))
-	require.Equal(t, "sent in stderr", strings.Trim(errorBuffer.String(), "\n\r "))
+	// `HasPrefix` because windows seem to add a trailing space at the end
+	require.Equal(t, "sent in stdout", strings.Trim(string(stdout), "\n\r "))
+	require.Equal(t, "sent in stderr", strings.Trim(string(stderr), "\n\r "))
 }