[core] Add support for enabling/disabling roles at deployment time

Author: teo

core/workflow/aggregatorrole.go

@@ -26,6 +26,7 @@ package workflow
 
 import (
 	"errors"
+	"strings"
 	texttemplate "text/template"
 
 	"github.com/AliceO2Group/Control/core/repos"
@@ -91,9 +92,10 @@ func (r *aggregatorRole) ProcessTemplates(workflowRepo *repos.Repo) (err error)
 		template.STAGE3: template.Fields{
 			template.WrapPointer(&r.Name),
 		},
-		template.STAGE4: append(
+		template.STAGE4: append(append(
 			template.WrapConstraints(r.Constraints),
 			r.wrapConnectFields()...),
+			template.WrapPointer(&r.Enabled)),
 	}
 
 	// TODO: push cached templates here
@@ -116,13 +118,27 @@ func (r *aggregatorRole) ProcessTemplates(workflowRepo *repos.Repo) (err error)
 		r.Vars.Set(k, v)
 	}
 
+	r.Enabled = strings.TrimSpace(r.Enabled)
+
+	// Process templates for child roles
 	for _, role := range r.Roles {
 		role.setParent(r)
 		err = role.ProcessTemplates(workflowRepo)
 		if err != nil {
 			return
 		}
 	}
+
+	// If any child is not Enabled after template resolution,
+	// we filter it out of existence
+	enabledRoles := make([]Role, 0)
+	for _, role := range r.Roles {
+		if role.IsEnabled() {
+			enabledRoles = append(enabledRoles, role)
+		}
+	}
+	r.Roles = enabledRoles
+
 	return
 }
 

core/workflow/iteratorrole.go

@@ -139,12 +139,24 @@ func (i *iteratorRole) ProcessTemplates(workflowRepo *repos.Repo) (err error) {
 		return
 	}
 
+	// Process templates for child roles
 	for _, role := range i.Roles {
 		err = role.ProcessTemplates(workflowRepo)
 		if err != nil {
 			return
 		}
 	}
+
+	// If any child is not Enabled after template resolution,
+	// we filter it out of existence
+	enabledRoles := make([]Role, 0)
+	for _, role := range i.Roles {
+		if role.IsEnabled() {
+			enabledRoles = append(enabledRoles, role)
+		}
+	}
+	i.Roles = enabledRoles
+
 	return
 }
 
@@ -220,6 +232,13 @@ func (i *iteratorRole) GetState() task.State {
 	panic("implement me")
 }
 
+func (i *iteratorRole) IsEnabled() bool {
+	if i == nil || i.template == nil {
+		return false
+	}
+	return i.template.IsEnabled()
+}
+
 func (i *iteratorRole) setParent(role Updatable) {
 	i.template.setParent(role)
 	for _, v := range i.Roles {

core/workflow/role.go

@@ -58,6 +58,7 @@ type Role interface {
 	SetRuntimeVar(key string, value string)
 	SetRuntimeVars(kv map[string]string)
 	GetHooksForTrigger(trigger string) task.Tasks
+	IsEnabled() bool
 }
 
 type Updatable interface {

core/workflow/rolebase.go

@@ -26,6 +26,7 @@ package workflow
 
 import (
 	"fmt"
+	"strings"
 
 	"github.com/AliceO2Group/Control/common/gera"
 	"github.com/AliceO2Group/Control/common/logger"
@@ -59,6 +60,13 @@ type roleBase struct {
 	UserVars   *gera.StringWrapMap		`yaml:"-"`
 	Locals     map[string]string        `yaml:"-"` // only used for passing iterator from template to new role
 	Bind       []channel.Inbound        `yaml:"bind,omitempty"`
+	Enabled    string                   `yaml:"enabled,omitempty"`
+}
+
+func (r *roleBase) IsEnabled() bool {
+	// Only valid after ProcessTemplates
+	trimmed := strings.ToLower(strings.TrimSpace(r.Enabled))
+	return trimmed == "true" || trimmed == "1"
 }
 
 func (r *roleBase) SetRuntimeVar(key string, value string) {
@@ -171,6 +179,7 @@ func (r *roleBase) UnmarshalYAML(unmarshal func(interface{}) error) (err error)
 		Locals: make(map[string]string),
 		status: SafeStatus{status:task.INACTIVE},
 		state:  SafeState{state:task.STANDBY},
+		Enabled: "true",
 	}
 	err = unmarshal(&role)
 	if err == nil {
@@ -208,6 +217,7 @@ func (r *roleBase) copy() copyable {
 		status: r.status,
 		state: r.state,
 		Bind: make([]channel.Inbound, len(r.Bind)),
+		Enabled: r.Enabled,
 	}
 
 	copied := copy(rCopy.Connect, r.Connect)

core/workflow/taskrole.go

@@ -26,6 +26,7 @@ package workflow
 
 import (
 	"errors"
+	"strings"
 	texttemplate "text/template"
 	"time"
 
@@ -115,9 +116,10 @@ func (t *taskRole) ProcessTemplates(workflowRepo *repos.Repo) (err error) {
 			template.WrapPointer(&t.Timeout),
 			template.WrapPointer(&t.Trigger),
 		},
-		template.STAGE4: append(
+		template.STAGE4: append(append(
 			template.WrapConstraints(t.Constraints),
 			t.wrapConnectFields()...),
+			template.WrapPointer(&t.Enabled)),
 	}
 
 	// FIXME: push cached templates here
@@ -140,6 +142,8 @@ func (t *taskRole) ProcessTemplates(workflowRepo *repos.Repo) (err error) {
 		t.Vars.Set(k, v)
 	}
 
+	t.Enabled = strings.TrimSpace(t.Enabled)
+
 	t.resolveTaskClassIdentifier(workflowRepo)
 
 	return