First working version of tasks in separate packages

Author: morestatic

tasks/builder.go renamed to builder/builder.go

@@ -1,4 +1,4 @@
-package tasks
+package builder
 
 import (
 	"errors"
@@ -8,7 +8,9 @@ import (
 	"github.com/sirupsen/logrus"
 	"gopkg.in/yaml.v2"
 
+	"github.com/realvnc-labs/tacoscript/builder/parser"
 	"github.com/realvnc-labs/tacoscript/conv"
+	"github.com/realvnc-labs/tacoscript/tasks"
 	"github.com/realvnc-labs/tacoscript/utils"
 )
 
@@ -17,29 +19,20 @@ const (
 )
 
 type Builder interface {
-	Build(typeName, path string, params interface{}) (Task, error)
+	Build(typeName, path string, params interface{}) (tasks.Task, error)
 }
 
 type BuildRouter struct {
 	Builders map[string]Builder
 }
 
-type taskFieldParseFn func(t Task, path string, val interface{}) error
-
-type taskField struct {
-	parseFn   taskFieldParseFn
-	fieldName string
-}
-
-type taskFieldsParserConfig map[string]taskField
-
 func NewBuilderRouter(builders map[string]Builder) BuildRouter {
 	return BuildRouter{
 		Builders: builders,
 	}
 }
 
-func (br BuildRouter) Build(typeName, path string, params interface{}) (Task, error) {
+func (br BuildRouter) Build(typeName, path string, params interface{}) (tasks.Task, error) {
 	builder, ok := br.Builders[typeName]
 	if !ok {
 		return nil, fmt.Errorf("no builders registered for task type '%s'", typeName)
@@ -49,27 +42,27 @@ func (br BuildRouter) Build(typeName, path string, params interface{}) (Task, er
 }
 
 func Build(
-	typeName, path string, inputFields interface{}, outputTask Task, taskFields taskFieldsParserConfig) (
+	typeName, path string, inputFields interface{}, outputTask tasks.Task, taskFields parser.TaskFieldsParserConfig) (
 	errs *utils.Errors) {
 	logrus.Debugf("Parsing task %s, %s", typeName, path)
 	errs = &utils.Errors{}
 
-	var mapper FieldNameMapper
-	var tracker FieldStatusTracker
+	var mapper tasks.FieldNameMapper
+	var tracker tasks.FieldStatusTracker
 
-	taskWithTracker, hasTracker := outputTask.(TaskWithFieldTracker)
+	taskWithTracker, hasTracker := outputTask.(tasks.TaskWithFieldTracker)
 
 	if hasTracker {
 		// if TrackWithFieldTracker then the task is using the field name mapper and the status tracker
 		// so we need to initialize those.
-		combinedFieldTracker := newFieldCombinedTracker()
+		combinedFieldTracker := tasks.NewFieldCombinedTracker()
 		tracker = combinedFieldTracker
 		mapper = combinedFieldTracker
 		taskWithTracker.SetMapper(combinedFieldTracker)
 		taskWithTracker.SetTracker(combinedFieldTracker)
 	} else {
 		// if just a regular task then we only need a local mapper for the reflection based value parsing
-		mapper = newFieldNameMapper()
+		mapper = tasks.NewFieldNameMapper()
 	}
 
 	mapper.BuildFieldMap(outputTask)
@@ -86,11 +79,11 @@ func Build(
 
 		if fieldName != "" {
 			if hasTracker {
-				tracker.SetFieldStatus(fieldName, FieldStatus{})
+				tracker.SetFieldStatus(fieldName, tasks.FieldStatus{})
 
 				// when unsetting a field then no need to parse value etc. just mark to clear and then
 				// continue to the next field.
-				if inputVal == UnsetKeyword && !sharedField(inputKey) && taskWithTracker.IsChangeField(fieldName) {
+				if inputVal == UnsetKeyword && !tasks.SharedField(inputKey) && taskWithTracker.IsChangeField(fieldName) {
 					err := tracker.SetClear(fieldName)
 					if err != nil {
 						errs.Add(errWithField(err, inputKey))
@@ -115,7 +108,7 @@ func Build(
 			}
 
 			if hasTracker {
-				if !sharedField(inputKey) && taskWithTracker.IsChangeField(fieldName) {
+				if !tasks.SharedField(inputKey) && taskWithTracker.IsChangeField(fieldName) {
 					err = tracker.SetHasNewValue(fieldName)
 					if err != nil {
 						errs.Add(errWithField(err, inputKey))
@@ -134,7 +127,7 @@ func Build(
 				continue
 			}
 
-			err := taskParam.parseFn(outputTask, path, inputVal)
+			err := taskParam.ParseFn(outputTask, path, inputVal)
 			if err != nil {
 				errs.Add(errWithField(err, inputKey))
 				continue

tasks/builder_test.go renamed to builder/builder_test.go

@@ -1,21 +1,24 @@
-package tasks
+package builder
 
 import (
 	"errors"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+
+	"github.com/realvnc-labs/tacoscript/tasks"
+	"github.com/realvnc-labs/tacoscript/tasks/cmdrun"
 )
 
 type BuilderMock struct {
 	TypeName     string
 	Path         string
 	Context      interface{}
-	TaskToReturn Task
+	TaskToReturn tasks.Task
 	ErrToReturn  error
 }
 
-func (bm *BuilderMock) Build(typeName, path string, ctx interface{}) (Task, error) {
+func (bm *BuilderMock) Build(typeName, path string, ctx interface{}) (tasks.Task, error) {
 	bm.TypeName = typeName
 	bm.Path = path
 	bm.Context = ctx
@@ -25,12 +28,12 @@ func (bm *BuilderMock) Build(typeName, path string, ctx interface{}) (Task, erro
 
 func TestBuildWithRouting(t *testing.T) {
 	successBuilder := &BuilderMock{
-		TaskToReturn: &CmdRunTask{TypeName: "successTask", Path: "someSuccessPath"},
+		TaskToReturn: &cmdrun.CmdRunTask{TypeName: "successTask", Path: "someSuccessPath"},
 		ErrToReturn:  nil,
 	}
 
 	failBuilder := &BuilderMock{
-		TaskToReturn: &CmdRunTask{TypeName: "failedTask", Path: "someFailedPath"},
+		TaskToReturn: &cmdrun.CmdRunTask{TypeName: "failedTask", Path: "someFailedPath"},
 		ErrToReturn:  errors.New("some error"),
 	}
 

builder/parser/parser.go

@@ -0,0 +1,12 @@
+package parser
+
+import "github.com/realvnc-labs/tacoscript/tasks"
+
+type TaskFieldParseFn func(t tasks.Task, path string, val interface{}) error
+
+type TaskField struct {
+	ParseFn   TaskFieldParseFn
+	FieldName string
+}
+
+type TaskFieldsParserConfig map[string]TaskField

pkgmanager/darwinContext.go

@@ -7,7 +7,7 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/realvnc-labs/tacoscript/tasks"
+	"github.com/realvnc-labs/tacoscript/tasks/pkgtask"
 )
 
 func BuildManagementCmdsProviders() ([]ManagementCmdsProvider, error) {
@@ -18,7 +18,7 @@ func BuildManagementCmdsProviders() ([]ManagementCmdsProvider, error) {
 
 type OsPackageManagerCmdProvider struct{}
 
-func (ecb OsPackageManagerCmdProvider) GetManagementCmds(t *tasks.PkgTask) (*ManagementCmds, error) {
+func (ecb OsPackageManagerCmdProvider) GetManagementCmds(t *pkgtask.PkgTask) (*ManagementCmds, error) {
 	rawCmds := t.Named.GetNames()
 	rawInstallCmds := make([]string, 0, len(rawCmds))
 	if t.Version != "" {

pkgmanager/manager.go

@@ -6,11 +6,11 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/realvnc-labs/tacoscript/tasks/pkgtask"
 	"github.com/realvnc-labs/tacoscript/utils"
 
 	"github.com/realvnc-labs/tacoscript/conv"
 	"github.com/realvnc-labs/tacoscript/exec"
-	"github.com/realvnc-labs/tacoscript/tasks"
 	"github.com/sirupsen/logrus"
 )
 
@@ -25,15 +25,15 @@ type ManagementCmds struct {
 }
 
 type ManagementCmdsProvider interface {
-	GetManagementCmds(t *tasks.PkgTask) (*ManagementCmds, error)
+	GetManagementCmds(t *pkgtask.PkgTask) (*ManagementCmds, error)
 }
 
 type PackageTaskManager struct {
 	Runner                          exec.Runner
 	ManagementCmdsProviderBuildFunc func() ([]ManagementCmdsProvider, error)
 }
 
-func (pm PackageTaskManager) ExecuteTask(ctx context.Context, t *tasks.PkgTask) (res *tasks.PackageManagerExecutionResult, err error) {
+func (pm PackageTaskManager) ExecuteTask(ctx context.Context, t *pkgtask.PkgTask) (res *pkgtask.PackageManagerExecutionResult, err error) {
 	managementCmdProviders, err := pm.ManagementCmdsProviderBuildFunc()
 	if err != nil {
 		return nil, err
@@ -44,7 +44,7 @@ func (pm PackageTaskManager) ExecuteTask(ctx context.Context, t *tasks.PkgTask)
 		return
 	}
 
-	res = &tasks.PackageManagerExecutionResult{}
+	res = &pkgtask.PackageManagerExecutionResult{}
 
 	var managementCmds *ManagementCmds
 	foundSupportedPackageManager := false
@@ -57,7 +57,7 @@ func (pm PackageTaskManager) ExecuteTask(ctx context.Context, t *tasks.PkgTask)
 
 		logrus.Debugf("will execute version command %s to check if package manager is installed", managementCmds.VersionCmd)
 
-		versionResult := &tasks.PackageManagerExecutionResult{}
+		versionResult := &pkgtask.PackageManagerExecutionResult{}
 		err = pm.run(ctx, t, versionResult, managementCmds.VersionCmd)
 		if err != nil {
 			triedCommands = append(triedCommands, fmt.Sprintf("%s: %v", managementCmds.VersionCmd, err))
@@ -104,24 +104,24 @@ func (pm PackageTaskManager) ExecuteTask(ctx context.Context, t *tasks.PkgTask)
 
 func (pm PackageTaskManager) executePackageMethod(
 	ctx context.Context,
-	t *tasks.PkgTask,
+	t *pkgtask.PkgTask,
 	managementCmds *ManagementCmds,
-	res *tasks.PackageManagerExecutionResult,
+	res *pkgtask.PackageManagerExecutionResult,
 ) (err error) {
 	switch t.ActionType {
-	case tasks.ActionInstall:
+	case pkgtask.ActionInstall:
 		err = pm.installPackages(ctx, t, managementCmds, res)
 		if err != nil {
 			return err
 		}
 		res.Comment = fmt.Sprintf("The following packages are ensured to be installed: %s", pm.getAffectedPackagesStr(t))
-	case tasks.ActionUninstall:
+	case pkgtask.ActionUninstall:
 		err = pm.uninstallPackages(ctx, t, managementCmds, res)
 		if err != nil {
 			return err
 		}
 		res.Comment = fmt.Sprintf("The following packages are ensured to be uninstalled: %s", pm.getAffectedPackagesStr(t))
-	case tasks.ActionUpdate:
+	case pkgtask.ActionUpdate:
 		err = pm.updatePackages(ctx, t, managementCmds, res)
 		if err != nil {
 			return err
@@ -137,7 +137,7 @@ func (pm PackageTaskManager) executePackageMethod(
 func (pm PackageTaskManager) getPackageDiff(
 	ctx context.Context,
 	managementCmds *ManagementCmds,
-	t *tasks.PkgTask,
+	t *pkgtask.PkgTask,
 	packagesListBefore []string,
 ) map[string]string {
 	res := map[string]string{}
@@ -163,7 +163,7 @@ func (pm PackageTaskManager) getPackageDiff(
 	return res
 }
 
-func (pm PackageTaskManager) getAffectedPackagesStr(t *tasks.PkgTask) string {
+func (pm PackageTaskManager) getAffectedPackagesStr(t *pkgtask.PkgTask) string {
 	packages := make([]string, 0, len(t.Named.Names)+1)
 	if t.Named.Name != "" {
 		packages = append(packages, t.Named.Name)
@@ -180,9 +180,9 @@ func (pm PackageTaskManager) getAffectedPackagesStr(t *tasks.PkgTask) string {
 
 func (pm PackageTaskManager) installPackages(
 	ctx context.Context,
-	t *tasks.PkgTask,
+	t *pkgtask.PkgTask,
 	mngtCmds *ManagementCmds,
-	res *tasks.PackageManagerExecutionResult,
+	res *pkgtask.PackageManagerExecutionResult,
 ) (err error) {
 	logrus.Debugf("will install packages by executing %s", conv.ConvertSourceToJSONStrIfPossible(mngtCmds.InstallCmds))
 
@@ -193,9 +193,9 @@ func (pm PackageTaskManager) installPackages(
 
 func (pm PackageTaskManager) uninstallPackages(
 	ctx context.Context,
-	t *tasks.PkgTask,
+	t *pkgtask.PkgTask,
 	mngtCmds *ManagementCmds,
-	res *tasks.PackageManagerExecutionResult,
+	res *pkgtask.PackageManagerExecutionResult,
 ) (err error) {
 	logrus.Debugf("will uninstall packages by executing %s", conv.ConvertSourceToJSONStrIfPossible(mngtCmds.UninstallCmds))
 
@@ -206,9 +206,9 @@ func (pm PackageTaskManager) uninstallPackages(
 
 func (pm PackageTaskManager) updatePackages(
 	ctx context.Context,
-	t *tasks.PkgTask,
+	t *pkgtask.PkgTask,
 	mngtCmds *ManagementCmds,
-	res *tasks.PackageManagerExecutionResult,
+	res *pkgtask.PackageManagerExecutionResult,
 ) (err error) {
 	logrus.Debugf("will upgrade packages by executing %s", conv.ConvertSourceToJSONStrIfPossible(mngtCmds.UpgradeCmds))
 
@@ -219,14 +219,14 @@ func (pm PackageTaskManager) updatePackages(
 
 func (pm PackageTaskManager) updatePkgManagerIfNeeded(
 	ctx context.Context,
-	t *tasks.PkgTask,
+	t *pkgtask.PkgTask,
 	mngtCmds *ManagementCmds,
 ) (err error) {
 	if !t.ShouldRefresh {
 		return
 	}
 
-	res := &tasks.PackageManagerExecutionResult{}
+	res := &pkgtask.PackageManagerExecutionResult{}
 	logrus.Debugf("will update package manager: %s", mngtCmds.UpgradeCmd)
 	err = pm.run(ctx, t, res, mngtCmds.UpgradeCmd)
 	if err != nil {
@@ -239,12 +239,12 @@ func (pm PackageTaskManager) updatePkgManagerIfNeeded(
 
 func (pm PackageTaskManager) getPackagesList(
 	ctx context.Context,
-	t *tasks.PkgTask,
+	t *pkgtask.PkgTask,
 	mngtCmds *ManagementCmds,
 ) (packagesList []string, err error) {
 	logrus.Debugf("will fetch packages list: %s", mngtCmds.ListCmd)
 
-	res := &tasks.PackageManagerExecutionResult{}
+	res := &pkgtask.PackageManagerExecutionResult{}
 
 	err = pm.run(ctx, t, res, mngtCmds.ListCmd)
 	if err != nil {
@@ -263,8 +263,8 @@ func (pm PackageTaskManager) getPackagesList(
 
 func (pm PackageTaskManager) run(
 	ctx context.Context,
-	t *tasks.PkgTask,
-	res *tasks.PackageManagerExecutionResult,
+	t *pkgtask.PkgTask,
+	res *pkgtask.PackageManagerExecutionResult,
 	rawCmds ...string,
 ) (err error) {
 	var stdoutBuf, stderrBuf bytes.Buffer