refactor MergeSketchWithBootloader in a function

Author: alessio-perugini

legacy/builder/builder.go

@@ -197,7 +197,14 @@ func (s *Builder) Run(ctx *types.Context) error {
 			return recipeByPrefixSuffixRunner(ctx, "recipe.hooks.objcopy.postobjcopy", ".pattern", true)
 		}),
 
-		&MergeSketchWithBootloader{},
+		types.BareCommand(func(ctx *types.Context) error {
+			return MergeSketchWithBootloader(
+				ctx.OnlyUpdateCompilationDatabase, ctx.Verbose,
+				ctx.BuildPath, ctx.Sketch, ctx.BuildProperties,
+				func(s string) { ctx.Info(s) },
+				func(s string) { ctx.Warn(s) },
+			)
+		}),
 
 		types.BareCommand(func(ctx *types.Context) error {
 			return recipeByPrefixSuffixRunner(ctx, "recipe.hooks.postbuild", ".pattern", true)

legacy/builder/merge_sketch_with_bootloader.go

@@ -20,29 +20,30 @@ import (
 	"strconv"
 	"strings"
 
+	"github.com/arduino/arduino-cli/arduino/sketch"
 	"github.com/arduino/arduino-cli/legacy/builder/constants"
-	"github.com/arduino/arduino-cli/legacy/builder/types"
 	"github.com/arduino/go-paths-helper"
+	"github.com/arduino/go-properties-orderedmap"
 	"github.com/marcinbor85/gohex"
 	"github.com/pkg/errors"
 )
 
-type MergeSketchWithBootloader struct{}
-
-func (s *MergeSketchWithBootloader) Run(ctx *types.Context) error {
-	if ctx.OnlyUpdateCompilationDatabase {
+func MergeSketchWithBootloader(
+	onlyUpdateCompilationDatabase, verbose bool,
+	buildPath *paths.Path,
+	sketch *sketch.Sketch,
+	buildProperties *properties.Map,
+	printInfoFn, printWarnFn func(string),
+) error {
+	if onlyUpdateCompilationDatabase {
 		return nil
 	}
 
-	buildProperties := ctx.BuildProperties
 	if !buildProperties.ContainsKey(constants.BUILD_PROPERTIES_BOOTLOADER_NOBLINK) && !buildProperties.ContainsKey(constants.BUILD_PROPERTIES_BOOTLOADER_FILE) {
 		return nil
 	}
 
-	buildPath := ctx.BuildPath
-	sketch := ctx.Sketch
 	sketchFileName := sketch.MainFile.Base()
-
 	sketchInBuildPath := buildPath.Join(sketchFileName + ".hex")
 	sketchInSubfolder := buildPath.Join(constants.FOLDER_SKETCH, sketchFileName+".hex")
 
@@ -65,8 +66,8 @@ func (s *MergeSketchWithBootloader) Run(ctx *types.Context) error {
 
 	bootloaderPath := buildProperties.GetPath("runtime.platform.path").Join(constants.FOLDER_BOOTLOADERS, bootloader)
 	if bootloaderPath.NotExist() {
-		if ctx.Verbose {
-			ctx.Warn(tr("Bootloader file specified but missing: %[1]s", bootloaderPath))
+		if verbose {
+			printWarnFn(tr("Bootloader file specified but missing: %[1]s", bootloaderPath))
 		}
 		return nil
 	}
@@ -75,13 +76,13 @@ func (s *MergeSketchWithBootloader) Run(ctx *types.Context) error {
 
 	// Ignore merger errors for the first iteration
 	maximumBinSize := 16000000
-	if uploadMaxSize, ok := ctx.BuildProperties.GetOk("upload.maximum_size"); ok {
+	if uploadMaxSize, ok := buildProperties.GetOk("upload.maximum_size"); ok {
 		maximumBinSize, _ = strconv.Atoi(uploadMaxSize)
 		maximumBinSize *= 2
 	}
 	err := merge(builtSketchPath, bootloaderPath, mergedSketchPath, maximumBinSize)
-	if err != nil && ctx.Verbose {
-		ctx.Info(err.Error())
+	if err != nil && verbose {
+		printInfoFn(err.Error())
 	}
 
 	return nil

legacy/builder/test/merge_sketch_with_bootloader_test.go

@@ -69,14 +69,13 @@ func TestMergeSketchWithBootloader(t *testing.T) {
 	err = buildPath.Join("sketch", "sketch1.ino.hex").WriteFile([]byte(fakeSketchHex))
 	require.NoError(t, err)
 
-	commands := []types.Command{
-		&builder.MergeSketchWithBootloader{},
-	}
-
-	for _, command := range commands {
-		err := command.Run(ctx)
-		require.NoError(t, err)
-	}
+	err = builder.MergeSketchWithBootloader(
+		ctx.OnlyUpdateCompilationDatabase, ctx.Verbose,
+		ctx.BuildPath, ctx.Sketch, ctx.BuildProperties,
+		func(s string) { ctx.Info(s) },
+		func(s string) { ctx.Warn(s) },
+	)
+	require.NoError(t, err)
 
 	bytes, err := buildPath.Join("sketch", "sketch1.ino.with_bootloader.hex").ReadFile()
 	require.NoError(t, err)
@@ -127,14 +126,13 @@ func TestMergeSketchWithBootloaderSketchInBuildPath(t *testing.T) {
 	err = buildPath.Join("sketch1.ino.hex").WriteFile([]byte(fakeSketchHex))
 	require.NoError(t, err)
 
-	commands := []types.Command{
-		&builder.MergeSketchWithBootloader{},
-	}
-
-	for _, command := range commands {
-		err := command.Run(ctx)
-		require.NoError(t, err)
-	}
+	err = builder.MergeSketchWithBootloader(
+		ctx.OnlyUpdateCompilationDatabase, ctx.Verbose,
+		ctx.BuildPath, ctx.Sketch, ctx.BuildProperties,
+		func(s string) { ctx.Info(s) },
+		func(s string) { ctx.Warn(s) },
+	)
+	require.NoError(t, err)
 
 	bytes, err := buildPath.Join("sketch1.ino.with_bootloader.hex").ReadFile()
 	require.NoError(t, err)
@@ -154,8 +152,12 @@ func TestMergeSketchWithBootloaderWhenNoBootloaderAvailable(t *testing.T) {
 	buildProperties.Remove(constants.BUILD_PROPERTIES_BOOTLOADER_NOBLINK)
 	buildProperties.Remove(constants.BUILD_PROPERTIES_BOOTLOADER_FILE)
 
-	command := &builder.MergeSketchWithBootloader{}
-	err := command.Run(ctx)
+	err := builder.MergeSketchWithBootloader(
+		ctx.OnlyUpdateCompilationDatabase, ctx.Verbose,
+		ctx.BuildPath, ctx.Sketch, ctx.BuildProperties,
+		func(s string) { ctx.Info(s) },
+		func(s string) { ctx.Warn(s) },
+	)
 	require.NoError(t, err)
 
 	exist, err := buildPath.Join("sketch.ino.with_bootloader.hex").ExistCheck()
@@ -210,14 +212,13 @@ func TestMergeSketchWithBootloaderPathIsParameterized(t *testing.T) {
 	err = buildPath.Join("sketch", "sketch1.ino.hex").WriteFile([]byte(fakeSketchHex))
 	require.NoError(t, err)
 
-	commands := []types.Command{
-		&builder.MergeSketchWithBootloader{},
-	}
-
-	for _, command := range commands {
-		err := command.Run(ctx)
-		require.NoError(t, err)
-	}
+	err = builder.MergeSketchWithBootloader(
+		ctx.OnlyUpdateCompilationDatabase, ctx.Verbose,
+		ctx.BuildPath, ctx.Sketch, ctx.BuildProperties,
+		func(s string) { ctx.Info(s) },
+		func(s string) { ctx.Warn(s) },
+	)
+	require.NoError(t, err)
 
 	bytes, err := buildPath.Join("sketch", "sketch1.ino.with_bootloader.hex").ReadFile()
 	require.NoError(t, err)