[core] Correct template error handling when a role is disabled

Author: teo

configuration/template/fields.go

@@ -27,6 +27,7 @@ package template
 import (
 	"bytes"
 	"encoding/json"
+	"errors"
 	"fmt"
 	"io"
 	"strings"
@@ -50,7 +51,13 @@ type Sequence map[Stage]Fields
 type BuildObjectStackFunc func(stage Stage) map[string]interface{}
 type StageCallbackFunc func(stage Stage, err error) error // called after each stage template processing, if err != nil the sequence bails
 
-type RoleDisabledError error
+type RoleDisabledError struct {
+	RolePath string
+}
+
+func (e *RoleDisabledError) Error() string {
+	return fmt.Sprintf("role %s disabled", e.RolePath)
+}
 
 func NullCallback(_ Stage, err error) error {
 	return err
@@ -106,7 +113,8 @@ func (sf Sequence) Execute(confSvc ConfigurationService,
 			err = fields.Execute(confSvc, parentPath, stagedStack, objectStack, stringTemplateCache, workflowRepo)
 			err = stageCallback(currentStage, err)
 			if err != nil {
-				if _, isRoleDisabled := err.(RoleDisabledError); isRoleDisabled {
+				var roleDisabledErrorType *RoleDisabledError
+				if isRoleDisabled := errors.As(err, &roleDisabledErrorType); isRoleDisabled {
 					return
 				}
 

core/integration/odc/plugin.go

@@ -377,6 +377,7 @@ func (p *Plugin) ObjectStack(varStack map[string]string) (stack map[string]inter
 			detectorsSlice, err := p.parseDetectors(pdpDetectorList)
 			if err != nil {
 				log.WithField("partition", envId).
+					WithField("detectorList", pdpDetectorList).
 					WithField("call", "GenerateEPNWorkflowScript").
 					Error("cannot parse general detector list")
 				return
@@ -403,6 +404,7 @@ func (p *Plugin) ObjectStack(varStack map[string]string) (stack map[string]inter
 			detectorsSlice, err := p.parseDetectors(pdpDetectorListQc)
 			if err != nil {
 				log.WithField("partition", envId).
+					WithField("detectorList", pdpDetectorListQc).
 					WithField("call", "GenerateEPNWorkflowScript").
 					Error("cannot parse general detector list")
 				return
@@ -429,6 +431,7 @@ func (p *Plugin) ObjectStack(varStack map[string]string) (stack map[string]inter
 			detectorsSlice, err := p.parseDetectors(pdpDetectorListCalib)
 			if err != nil {
 				log.WithField("partition", envId).
+					WithField("detectorList", pdpDetectorListCalib).
 					WithField("call", "GenerateEPNWorkflowScript").
 					Error("cannot parse general detector list")
 				return
@@ -898,6 +901,7 @@ func (p *Plugin) CallStack(data interface{}) (stack map[string]interface{}) {
 				arguments["detectors"] = strings.Join(detectorsSlice, ",")
 			} else {
 				log.WithField("partition", envId).
+					WithField("detectorList", detectorsSlice).
 					WithField("call", "Configure").
 					Warn("cannot parse general detector list")
 			}

core/workflow/aggregatorrole.go

@@ -127,7 +127,8 @@ func (r *aggregatorRole) ProcessTemplates(workflowRepo repos.IRepo, loadSubworkf
 		UserVars: r.UserVars,
 	}, r.makeBuildObjectStackFunc(), make(map[string]texttemplate.Template), workflowRepo, MakeDisabledRoleCallback(r))
 	if err != nil {
-		if _, isRoleDisabled := err.(template.RoleDisabledError); isRoleDisabled {
+		var roleDisabledErrorType *template.RoleDisabledError
+		if isRoleDisabled := errors.As(err, &roleDisabledErrorType); isRoleDisabled {
 			err = nil // we don't want a disabled role to be considered an error
 		} else {
 			return

core/workflow/callrole.go

@@ -177,7 +177,8 @@ func (t *callRole) ProcessTemplates(workflowRepo repos.IRepo, _ LoadSubworkflowF
 		MakeDisabledRoleCallback(t),
 	)
 	if err != nil {
-		if _, isRoleDisabled := err.(template.RoleDisabledError); isRoleDisabled {
+		var roleDisabledErrorType *template.RoleDisabledError
+		if isRoleDisabled := errors.As(err, &roleDisabledErrorType); isRoleDisabled {
 			err = nil // we don't want a disabled role to be considered an error
 		} else {
 			return

core/workflow/includerole.go

@@ -108,7 +108,8 @@ func (r *includeRole) ProcessTemplates(workflowRepo repos.IRepo, loadSubworkflow
 		UserVars: r.UserVars,
 	}, r.makeBuildObjectStackFunc(), make(map[string]texttemplate.Template), workflowRepo, MakeDisabledRoleCallback(r))
 	if err != nil {
-		if _, isRoleDisabled := err.(template.RoleDisabledError); isRoleDisabled {
+		var roleDisabledErrorType *template.RoleDisabledError
+		if isRoleDisabled := errors.As(err, &roleDisabledErrorType); isRoleDisabled {
 			err = nil // we don't want a disabled role to be considered an error
 		} else {
 			return

core/workflow/roleutils.go

@@ -25,8 +25,6 @@
 package workflow
 
 import (
-	"fmt"
-
 	"github.com/AliceO2Group/Control/configuration/template"
 	"github.com/AliceO2Group/Control/core/task/constraint"
 )
@@ -105,7 +103,7 @@ func MakeDisabledRoleCallback(r Role) func(stage template.Stage, err error) erro
 	return func(stage template.Stage, err error) error {
 		if stage == template.STAGE0 { // only `enabled` has been processed so far
 			if !r.IsEnabled() {
-				var rde template.RoleDisabledError = fmt.Errorf("role %s disabled", r.GetPath())
+				rde := &template.RoleDisabledError{RolePath: r.GetPath()}
 				return rde
 			}
 		}

core/workflow/taskrole.go

@@ -164,7 +164,8 @@ func (t *taskRole) ProcessTemplates(workflowRepo repos.IRepo, _ LoadSubworkflowF
 		UserVars: t.UserVars,
 	}, t.makeBuildObjectStackFunc(), make(map[string]texttemplate.Template), workflowRepo, MakeDisabledRoleCallback(t))
 	if err != nil {
-		if _, isRoleDisabled := err.(template.RoleDisabledError); isRoleDisabled {
+		var roleDisabledErrorType *template.RoleDisabledError
+		if isRoleDisabled := errors.As(err, &roleDisabledErrorType); isRoleDisabled {
 			err = nil // we don't want a disabled role to be considered an error
 		} else {
 			return