mvoe types.ProgressStruct in a dedicated pkg

Author: alessio-perugini

arduino/builder/progress/progress.go

@@ -0,0 +1,29 @@
+package progress
+
+type Struct struct {
+	Progress   float32
+	StepAmount float32
+	Parent     *Struct
+}
+
+func (p *Struct) AddSubSteps(steps int) {
+	p.Parent = &Struct{
+		Progress:   p.Progress,
+		StepAmount: p.StepAmount,
+		Parent:     p.Parent,
+	}
+	if p.StepAmount == 0.0 {
+		p.StepAmount = 100.0
+	}
+	p.StepAmount /= float32(steps)
+}
+
+func (p *Struct) RemoveSubSteps() {
+	p.Progress = p.Parent.Progress
+	p.StepAmount = p.Parent.StepAmount
+	p.Parent = p.Parent.Parent
+}
+
+func (p *Struct) CompleteStep() {
+	p.Progress += p.StepAmount
+}

legacy/builder/types/progress_test.go renamed to arduino/builder/progress/progress_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 types
+package progress
 
 import (
 	"fmt"
@@ -23,7 +23,7 @@ import (
 )
 
 func TestProgress(t *testing.T) {
-	p := &ProgressStruct{}
+	p := &Struct{}
 	p.AddSubSteps(3)
 	require.Equal(t, float32(0.0), p.Progress)
 	require.InEpsilon(t, 33.33333, p.StepAmount, 0.00001)

legacy/builder/builder_utils/utils.go

@@ -26,12 +26,12 @@ import (
 	"sync"
 
 	"github.com/arduino/arduino-cli/arduino/builder"
+	"github.com/arduino/arduino-cli/arduino/builder/progress"
 	bUtils "github.com/arduino/arduino-cli/arduino/builder/utils"
 	"github.com/arduino/arduino-cli/arduino/globals"
 	"github.com/arduino/arduino-cli/executils"
 	"github.com/arduino/arduino-cli/i18n"
 	"github.com/arduino/arduino-cli/legacy/builder/constants"
-	"github.com/arduino/arduino-cli/legacy/builder/types"
 	"github.com/arduino/arduino-cli/legacy/builder/utils"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
@@ -79,7 +79,7 @@ func CompileFiles(
 	stdoutWriter, stderrWriter io.Writer,
 	verboseInfoFn func(msg string),
 	verboseStdoutFn, verboseStderrFn func(data []byte),
-	progress *types.ProgressStruct, progressCB rpc.TaskProgressCB,
+	progress *progress.Struct, progressCB rpc.TaskProgressCB,
 ) (paths.PathList, error) {
 	return compileFiles(
 		onlyUpdateCompilationDatabase,
@@ -108,7 +108,7 @@ func CompileFilesRecursive(
 	stdoutWriter, stderrWriter io.Writer,
 	verboseInfoFn func(msg string),
 	verboseStdoutFn, verboseStderrFn func(data []byte),
-	progress *types.ProgressStruct, progressCB rpc.TaskProgressCB,
+	progress *progress.Struct, progressCB rpc.TaskProgressCB,
 ) (paths.PathList, error) {
 	return compileFiles(
 		onlyUpdateCompilationDatabase,
@@ -139,7 +139,7 @@ func compileFiles(
 	stdoutWriter, stderrWriter io.Writer,
 	verboseInfoFn func(msg string),
 	verboseStdoutFn, verboseStderrFn func(data []byte),
-	progress *types.ProgressStruct,
+	progress *progress.Struct,
 	progressCB rpc.TaskProgressCB,
 ) (paths.PathList, error) {
 	validExtensions := []string{}

legacy/builder/phases/core_builder.go

@@ -25,13 +25,13 @@ import (
 
 	"github.com/arduino/arduino-cli/arduino/builder"
 	"github.com/arduino/arduino-cli/arduino/builder/cpp"
+	"github.com/arduino/arduino-cli/arduino/builder/progress"
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/buildcache"
 	"github.com/arduino/arduino-cli/i18n"
 	f "github.com/arduino/arduino-cli/internal/algorithms"
 	"github.com/arduino/arduino-cli/legacy/builder/builder_utils"
 	"github.com/arduino/arduino-cli/legacy/builder/constants"
-	"github.com/arduino/arduino-cli/legacy/builder/types"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
 	"github.com/arduino/go-properties-orderedmap"
@@ -54,7 +54,7 @@ func CoreBuilder(
 	stdoutWriter, stderrWriter io.Writer,
 	verboseInfoFn func(msg string),
 	verboseStdoutFn, verboseStderrFn func(data []byte),
-	progress *types.ProgressStruct, progressCB rpc.TaskProgressCB,
+	progress *progress.Struct, progressCB rpc.TaskProgressCB,
 ) (paths.PathList, *paths.Path, *paths.Path, error) {
 	if err := coreBuildPath.MkdirAll(); err != nil {
 		return nil, nil, coreBuildCachePath, errors.WithStack(err)
@@ -101,7 +101,7 @@ func compileCore(
 	stdoutWriter, stderrWriter io.Writer,
 	verboseInfoFn func(msg string),
 	verboseStdoutFn, verboseStderrFn func(data []byte),
-	progress *types.ProgressStruct, progressCB rpc.TaskProgressCB,
+	progress *progress.Struct, progressCB rpc.TaskProgressCB,
 ) (*paths.Path, paths.PathList, error) {
 	coreFolder := buildProperties.GetPath("build.core.path")
 	variantFolder := buildProperties.GetPath("build.variant.path")

legacy/builder/types/context.go

@@ -24,6 +24,7 @@ import (
 
 	"github.com/arduino/arduino-cli/arduino/builder"
 	"github.com/arduino/arduino-cli/arduino/builder/detector"
+	"github.com/arduino/arduino-cli/arduino/builder/progress"
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
 	"github.com/arduino/arduino-cli/arduino/sketch"
@@ -32,34 +33,6 @@ import (
 	properties "github.com/arduino/go-properties-orderedmap"
 )
 
-type ProgressStruct struct {
-	Progress   float32
-	StepAmount float32
-	Parent     *ProgressStruct
-}
-
-func (p *ProgressStruct) AddSubSteps(steps int) {
-	p.Parent = &ProgressStruct{
-		Progress:   p.Progress,
-		StepAmount: p.StepAmount,
-		Parent:     p.Parent,
-	}
-	if p.StepAmount == 0.0 {
-		p.StepAmount = 100.0
-	}
-	p.StepAmount /= float32(steps)
-}
-
-func (p *ProgressStruct) RemoveSubSteps() {
-	p.Progress = p.Parent.Progress
-	p.StepAmount = p.Parent.StepAmount
-	p.Parent = p.Parent.Parent
-}
-
-func (p *ProgressStruct) CompleteStep() {
-	p.Progress += p.StepAmount
-}
-
 // Context structure
 type Context struct {
 	Builder                 *builder.Builder
@@ -105,7 +78,7 @@ type Context struct {
 	Verbose bool
 
 	// Dry run, only create progress map
-	Progress ProgressStruct
+	Progress progress.Struct
 	// Send progress events to this callback
 	ProgressCB rpc.TaskProgressCB