[skip-changelog] legacy: refactor (part 3) (#2302)

* refactor RecipeRunner in a function

* refactor CreateBuildOptionsMap in a function

* refactor LoadPreviousBuildOptionsMap in a function

* refactor StoreBuildOptionsMap in a function

* refactor WipeoutBuildPathIfBuildOptionsChanged in a function

* refactor ContainerBuildOptions in a function

* refactor MergeSketchWithBootloader in a function

* refactor PrintUsedLibrariesIfVerbose in a function

* refactor UnusedCompiledLibrariesRemover in a function

* refactor WarnAboutArchIncompatibleLibraries in a function

* refactor CreateMakeRule in a function

* move include finder with regex tests under detector

* move jobs properites in arduino/builder component

* remove sketch property from context

* apply CR suggestion

Author: alessio-perugini

arduino/builder/builder.go

@@ -26,6 +26,9 @@ type Builder struct {
 	sketch          *sketch.Sketch
 	buildProperties *properties.Map
 
+	// Parallel processes
+	jobs int
+
 	// core related
 	coreBuildCachePath *paths.Path
 }
@@ -37,6 +40,7 @@ func NewBuilder(
 	buildPath *paths.Path,
 	optimizeForDebug bool,
 	coreBuildCachePath *paths.Path,
+	jobs int,
 ) *Builder {
 	buildProperties := properties.NewMap()
 	if boardBuildProperties != nil {
@@ -64,10 +68,16 @@ func NewBuilder(
 		sketch:             sk,
 		buildProperties:    buildProperties,
 		coreBuildCachePath: coreBuildCachePath,
+		jobs:               jobs,
 	}
 }
 
 // GetBuildProperties returns the build properties for running this build
 func (b *Builder) GetBuildProperties() *properties.Map {
 	return b.buildProperties
 }
+
+// Jobs number of parallel processes
+func (b *Builder) Jobs() int {
+	return b.jobs
+}

legacy/builder/test/includes_finder_with_regexp_test.go renamed to arduino/builder/detector/detector_test.go

@@ -13,7 +13,7 @@
 // Arduino software without disclosing the source code of your own applications.
 // To purchase a commercial license, send an email to [email protected].
 
-package test
+package detector_test
 
 import (
 	"testing"

arduino/builder/sketch.go

@@ -21,6 +21,7 @@ import (
 	"regexp"
 
 	"github.com/arduino/arduino-cli/arduino/builder/cpp"
+	"github.com/arduino/arduino-cli/arduino/sketch"
 	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/go-paths-helper"
 
@@ -32,6 +33,11 @@ var (
 	tr               = i18n.Tr
 )
 
+// Sketch fixdoc
+func (b *Builder) Sketch() *sketch.Sketch {
+	return b.sketch
+}
+
 // PrepareSketchBuildPath copies the sketch source files in the build path.
 // The .ino files are merged together to create a .cpp file (by the way, the
 // .cpp file still needs to be Arduino-preprocessed to compile).

arduino/builder/sketch_test.go

@@ -48,7 +48,7 @@ func TestMergeSketchSources(t *testing.T) {
 	}
 	mergedSources := strings.ReplaceAll(string(mergedBytes), "%s", pathToGoldenSource)
 
-	b := NewBuilder(sk, nil, nil, false, nil)
+	b := NewBuilder(sk, nil, nil, false, nil, 0)
 	offset, source, err := b.sketchMergeSources(nil)
 	require.Nil(t, err)
 	require.Equal(t, 2, offset)
@@ -61,7 +61,7 @@ func TestMergeSketchSourcesArduinoIncluded(t *testing.T) {
 	require.NotNil(t, sk)
 
 	// ensure not to include Arduino.h when it's already there
-	b := NewBuilder(sk, nil, nil, false, nil)
+	b := NewBuilder(sk, nil, nil, false, nil, 0)
 	_, source, err := b.sketchMergeSources(nil)
 	require.Nil(t, err)
 	require.Equal(t, 1, strings.Count(source, "<Arduino.h>"))
@@ -76,7 +76,7 @@ func TestCopyAdditionalFiles(t *testing.T) {
 	sk1, err := sketch.New(paths.New("testdata", t.Name()))
 	require.Nil(t, err)
 	require.Equal(t, sk1.AdditionalFiles.Len(), 1)
-	b1 := NewBuilder(sk1, nil, nil, false, nil)
+	b1 := NewBuilder(sk1, nil, nil, false, nil, 0)
 
 	// copy the sketch over, create a fake main file we don't care about it
 	// but we need it for `SketchLoad` to succeed later

commands/compile/compile.go

@@ -169,7 +169,14 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 		coreBuildCachePath = buildCachePath.Join("core")
 	}
 
-	sketchBuilder := bldr.NewBuilder(sk, boardBuildProperties, buildPath, req.GetOptimizeForDebug(), coreBuildCachePath)
+	sketchBuilder := bldr.NewBuilder(
+		sk,
+		boardBuildProperties,
+		buildPath,
+		req.GetOptimizeForDebug(),
+		coreBuildCachePath,
+		int(req.GetJobs()),
+	)
 
 	buildProperties := sketchBuilder.GetBuildProperties()
 
@@ -197,7 +204,6 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 	builderCtx.BuildProperties = buildProperties
 	builderCtx.CustomBuildProperties = customBuildPropertiesArgs
 	builderCtx.FQBN = fqbn
-	builderCtx.Sketch = sk
 	builderCtx.BuildPath = buildPath
 	builderCtx.ProgressCB = progressCB
 
@@ -212,7 +218,6 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 	)
 
 	builderCtx.Verbose = req.GetVerbose()
-	builderCtx.Jobs = int(req.GetJobs())
 
 	builderCtx.WarningsLevel = req.GetWarnings()
 	if builderCtx.WarningsLevel == "" {
@@ -243,7 +248,7 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 	builderCtx.LibrariesBuildPath = librariesBuildPath
 	builderCtx.CoreBuildPath = coreBuildPath
 
-	if builderCtx.BuildPath.Canonical().EqualsTo(builderCtx.Sketch.FullPath.Canonical()) {
+	if builderCtx.BuildPath.Canonical().EqualsTo(sk.FullPath.Canonical()) {
 		return r, &arduino.CompileFailedError{
 			Message: tr("Sketch cannot be located in build path. Please specify a different build path"),
 		}
@@ -365,8 +370,13 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 		exportBinaries = false
 	}
 	if exportBinaries {
-		presaveHex := builder.RecipeByPrefixSuffixRunner{Prefix: "recipe.hooks.savehex.presavehex", Suffix: ".pattern"}
-		if err := presaveHex.Run(builderCtx); err != nil {
+		err := builder.RecipeByPrefixSuffixRunner(
+			"recipe.hooks.savehex.presavehex", ".pattern", false,
+			builderCtx.OnlyUpdateCompilationDatabase, builderCtx.Verbose,
+			builderCtx.BuildProperties, builderCtx.Stdout, builderCtx.Stderr,
+			func(msg string) { builderCtx.Info(msg) },
+		)
+		if err != nil {
 			return r, err
 		}
 
@@ -404,8 +414,13 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 			}
 		}
 
-		postsaveHex := builder.RecipeByPrefixSuffixRunner{Prefix: "recipe.hooks.savehex.postsavehex", Suffix: ".pattern"}
-		if err := postsaveHex.Run(builderCtx); err != nil {
+		err = builder.RecipeByPrefixSuffixRunner(
+			"recipe.hooks.savehex.postsavehex", ".pattern", false,
+			builderCtx.OnlyUpdateCompilationDatabase, builderCtx.Verbose,
+			builderCtx.BuildProperties, builderCtx.Stdout, builderCtx.Stderr,
+			func(msg string) { builderCtx.Info(msg) },
+		)
+		if err != nil {
 			return r, err
 		}
 	}