Moved RunCTags out of legacy package

Author: cmaglie

Diff for: legacy/builder/ctags_runner.go renamed to arduino/builder/preprocessor/ctags.go

@@ -1,6 +1,6 @@
 // This file is part of arduino-cli.
 //
-// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+// Copyright 2023 ARDUINO SA (http://www.arduino.cc/)
 //
 // This software is released under the GNU General Public License version 3,
 // which covers the main part of arduino-cli.
@@ -13,18 +13,23 @@
 // Arduino software without disclosing the source code of your own applications.
 // To purchase a commercial license, send an email to [email protected].
 
-package builder
+package preprocessor
 
 import (
-	"bytes"
+	"context"
+	"fmt"
 	"strings"
 
 	"github.com/arduino/arduino-cli/executils"
+	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/go-paths-helper"
-	properties "github.com/arduino/go-properties-orderedmap"
+	"github.com/arduino/go-properties-orderedmap"
 	"github.com/pkg/errors"
 )
 
+var tr = i18n.Tr
+
+// RunCTags performs a run of ctags on the given source file. Returns the ctags output and the stderr contents.
 func RunCTags(sourceFile *paths.Path, buildProperties *properties.Map) ([]byte, []byte, error) {
 	ctagsBuildProperties := properties.NewMap()
 	ctagsBuildProperties.Set("tools.ctags.path", "{runtime.tools.ctags.path}")
@@ -48,13 +53,10 @@ func RunCTags(sourceFile *paths.Path, buildProperties *properties.Map) ([]byte,
 	if err != nil {
 		return nil, nil, err
 	}
-	stdout := &bytes.Buffer{}
-	stderr := &bytes.Buffer{}
-	proc.RedirectStdoutTo(stdout)
-	proc.RedirectStderrTo(stderr)
-	if err = proc.Run(); err != nil {
-		return nil, nil, err
-	}
-	_, _ = stderr.WriteString(strings.Join(parts, " "))
-	return stdout.Bytes(), stderr.Bytes(), err
+	stdout, stderr, err := proc.RunAndCaptureOutput(context.Background())
+
+	// Append ctags arguments to stderr
+	args := fmt.Sprintln(strings.Join(parts, " "))
+	stderr = append([]byte(args), stderr...)
+	return stdout, stderr, err
 }

Diff for: legacy/builder/container_add_prototypes.go

@@ -24,6 +24,7 @@ import (
 	"strings"
 
 	bldr "github.com/arduino/arduino-cli/arduino/builder"
+	"github.com/arduino/arduino-cli/arduino/builder/preprocessor"
 	"github.com/arduino/arduino-cli/arduino/sketch"
 	"github.com/arduino/arduino-cli/legacy/builder/types"
 	"github.com/arduino/go-paths-helper"
@@ -66,7 +67,7 @@ func PreprocessSketchWithCtags(ctx *types.Context) error {
 		return err
 	}
 
-	ctagsStdout, ctagsStderr, err := RunCTags(targetFilePath, ctx.BuildProperties)
+	ctagsStdout, ctagsStderr, err := preprocessor.RunCTags(targetFilePath, ctx.BuildProperties)
 	if ctx.Verbose {
 		ctx.WriteStderr(ctagsStderr)
 	}

Diff for: legacy/builder/test/ctags_runner_test.go

@@ -20,6 +20,7 @@ import (
 	"testing"
 
 	bldr "github.com/arduino/arduino-cli/arduino/builder"
+	"github.com/arduino/arduino-cli/arduino/builder/preprocessor"
 	"github.com/arduino/arduino-cli/legacy/builder"
 	paths "github.com/arduino/go-paths-helper"
 	"github.com/stretchr/testify/require"
@@ -39,7 +40,7 @@ func ctagsRunnerTestTemplate(t *testing.T, sketchLocation *paths.Path) []byte {
 	target := ctx.BuildPath.Join("ctags_target.cpp")
 	NoError(t, target.WriteFile([]byte(source)))
 
-	ctagsOutput, _, err := builder.RunCTags(target, ctx.BuildProperties)
+	ctagsOutput, _, err := preprocessor.RunCTags(target, ctx.BuildProperties)
 	NoError(t, err)
 
 	return ctagsOutput