feat: [KEP-23] add toggle task (#1361)

* feat: add toggle task
* add discovery client in toggle task tests
* fix typo for toggle task in package.go
* regenerate the golden files for toggletask
* Update pkg/engine/task/task_toggle.go
* address PR comments
* Apply suggestions from code review
* fix error formatting
* add verify for param used in toggletask
* removed dead code
* fix linting
* Apply suggestions from code review
* fix linting
* address PR comments and use delegateTask
* e2e tests for ToggleTask
* Fixed duplicate resources field in CRDs for task spec
Adjusted IT again
* Moved toggle task test to e2e instead of IT
* Fixed param description in e2e test operator, removed assert for operatorversion which I added for debug

Signed-off-by: Zain Malik <zmalikshxil@gmail.com>
Co-authored-by: Aleksey Dukhovniy <adukhovniy@mesosphere.io>
Co-authored-by: Jan Schlicht <jan.schlicht+gh@gmail.com>
Co-authored-by: Ken Sipe <kensipe@gmail.com>
Co-authored-by: Andreas Neumann <aneumann@mesosphere.com>

config/crds/kudo.dev_operatorversions.yaml

@@ -224,6 +224,8 @@ spec:
                         type: boolean
                       fatal:
                         type: boolean
+                      parameter:
+                        type: string
                       pipe:
                         items:
                           description: PipeSpec describes how a file generated by

pkg/apis/kudo/v1beta1/operatorversion_types.go

@@ -135,6 +135,7 @@ type TaskSpec struct {
 	ResourceTaskSpec `json:",inline"`
 	DummyTaskSpec    `json:",inline"`
 	PipeTaskSpec     `json:",inline"`
+	ToggleTaskSpec   `json:",inline"`
 }
 
 // ResourceTaskSpec is referencing a list of resources
@@ -144,6 +145,12 @@ type ResourceTaskSpec struct {
 	Resources []string `json:"resources,omitempty"`
 }
 
+// ToggleTaskSpec is referencing a ResourceTaskSpec and a parameter
+type ToggleTaskSpec struct {
+	// +optional
+	Parameter string `json:"parameter,omitempty"`
+}
+
 // DummyTaskSpec can succeed or fail on demand and is very useful for testing operators
 type DummyTaskSpec struct {
 	// +optional

pkg/engine/task/task.go

@@ -44,6 +44,7 @@ const (
 	DeleteTaskKind = "Delete"
 	DummyTaskKind  = "Dummy"
 	PipeTaskKind   = "Pipe"
+	ToggleTaskKind = "Toggle"
 )
 
 var (
@@ -65,6 +66,8 @@ func Build(task *v1beta1.Task) (Tasker, error) {
 		return newDummy(task)
 	case PipeTaskKind:
 		return newPipe(task)
+	case ToggleTaskKind:
+		return newToggle(task)
 	default:
 		return nil, fmt.Errorf("unknown task kind %s", task.Kind)
 	}
@@ -126,6 +129,22 @@ func newPipe(task *v1beta1.Task) (Tasker, error) {
 	}, nil
 }
 
+func newToggle(task *v1beta1.Task) (Tasker, error) {
+	// validate if resources are present
+	if len(task.Spec.Resources) == 0 {
+		return nil, errors.New("task validation error: toggle task has an empty resource list. if that's what you need, use a Dummy task instead")
+	}
+	// validate if the parameter is present
+	if len(task.Spec.ToggleTaskSpec.Parameter) == 0 {
+		return nil, errors.New("task validation error: Missing parameter to evaluate the Toggle Task")
+	}
+	return ToggleTask{
+		Name:      task.Name,
+		Resources: task.Spec.ResourceTaskSpec.Resources,
+		Parameter: task.Spec.ToggleTaskSpec.Parameter,
+	}, nil
+}
+
 var (
 	pipeFileKeyRe = regexp.MustCompile(`^[a-zA-Z0-9_\-]+$`) //a-z, A-Z, 0-9, _ and - are allowed
 )

pkg/engine/task/task_toggle.go

@@ -0,0 +1,65 @@
+package task
+
+import (
+	"fmt"
+	"strconv"
+
+	"github.com/kudobuilder/kudo/pkg/apis/kudo/v1beta1"
+)
+
+const (
+	toggleTaskError = "ToggleTaskError"
+)
+
+// ToggleTask will apply or delete a set of given resources to the cluster based on value of Parameter. See Run method for more details.
+type ToggleTask struct {
+	Name      string
+	Parameter string
+	Resources []string
+}
+
+func (tt ToggleTask) Run(ctx Context) (bool, error) {
+	// 1. - Get the task to run
+	task, err := tt.delegateTask(ctx)
+	if err != nil {
+		return false, fatalExecutionError(err, toggleTaskError, ctx.Meta)
+	}
+	// 2. - Run the returned task
+	return task.Run(ctx)
+}
+
+func (tt ToggleTask) intermediateTaskSpec() v1beta1.TaskSpec {
+	return v1beta1.TaskSpec{
+		ResourceTaskSpec: v1beta1.ResourceTaskSpec{
+			Resources: tt.Resources,
+		},
+	}
+}
+
+func (tt ToggleTask) delegateTask(ctx Context) (Tasker, error) {
+	var task Tasker
+	// 1. - Get the parameter value
+	val, exists := ctx.Parameters[tt.Parameter]
+	if !exists {
+		return task, fmt.Errorf("no value for parameter %s found", tt.Parameter)
+	}
+	enabled, err := strconv.ParseBool(val)
+	if err != nil {
+		return task, fmt.Errorf("could not parse value of parameter %s: %v", tt.Parameter, err)
+	}
+	// 2. - Return the Apply or Delete task based on parameter value
+	if enabled {
+		task, err = newApply(&v1beta1.Task{
+			Name: tt.Name,
+			Kind: ApplyTaskKind,
+			Spec: tt.intermediateTaskSpec(),
+		})
+	} else {
+		task, err = newDelete(&v1beta1.Task{
+			Name: tt.Name,
+			Kind: DeleteTaskKind,
+			Spec: tt.intermediateTaskSpec(),
+		})
+	}
+	return task, err
+}