feat: templating: add 'state' property

Signed-off-by: Romain Beuque <[email protected]>

Author: rbeuque74

README.md

@@ -171,6 +171,7 @@ A user can be allowed to resolve a task in three ways:
 - `.step.[STEP_NAME].metadata.HTTPStatus`: field `HTTPStatus` from the metadata of a named step
 - `.step.[STEP_NAME].children`: the collection of results from a 'foreach' step
 - `.step.[STEP_NAME].error`: error message from a failed step
+- `.step.[STEP_NAME].state`: current state of the given step
 - `.config.[CONFIG_ITEM].bar`: field `bar` from a config item (configstore, see above)
 - `.iterator.foo`: field `foo` from the iterator in a loop (see `foreach` steps below)
 

engine/engine.go

@@ -349,6 +349,7 @@ func resolve(dbp zesty.DBProvider, res *resolution.Resolution, t *task.Task, deb
 			res.Values.SetMetadata(s.Name, s.Metadata)
 			res.Values.SetChildren(s.Name, s.Children)
 			res.Values.SetError(s.Name, s.Error)
+			res.Values.SetState(s.Name, s.State)
 
 			// call after-run step logic
 			modifiedSteps := map[string]bool{
@@ -823,7 +824,9 @@ func resolutionStateSetter(res *resolution.Resolution, modifiedSteps map[string]
 	return func(step, state, message string) {
 		if _, ok := res.Steps[step]; ok {
 			res.Steps[step].State = state
+			res.Values.SetState(step, state)
 			res.Steps[step].Error = message
+			res.Values.SetError(step, message)
 			modifiedSteps[step] = true
 		}
 	}

engine/engine_test.go

@@ -370,6 +370,8 @@ func TestStepConditionStates(t *testing.T) {
 	assert.Equal(t, 2, res.Steps["stepOne"].TryCount)
 
 	assert.Equal(t, "REGEXP_MATCH", res.Steps["stepTwo"].State)
+	assert.Equal(t, "FOO", res.Steps["stepThree"].State)
+	assert.Equal(t, "changed state matched correctly", res.Steps["stepThree"].Error)
 }
 
 func TestResolutionStateCrashed(t *testing.T) {

engine/templates_tests/stepCondition.yaml

@@ -41,3 +41,38 @@ steps:
               then:
                   this: REGEXP_MATCH
               message: email address belongs to example.com 
+    stepThree:
+        dependencies: [stepTwo:ANY]
+        description: multiple conditions changing state
+        custom_states: [FOO, BAR]
+        action:
+            type: echo
+            configuration: {output: {foo: bar}}
+        conditions:
+            - type: check
+              if:
+                  - value:    '{{.step.this.output.foo}}'
+                    operator: EQ
+                    expected: barrrr
+              then:
+                  this: CLIENT_ERROR
+              message: should not have matched
+            - type: check
+              if:
+                  - value:    '{{.step.this.output.foo}}'
+                    operator: EQ
+                    expected: bar
+                  - value:    '{{.step.this.state}}'
+                    operator: EQ
+                    expected: DONE
+              then:
+                  this: BAR
+              message: matching is correct
+            - type: check
+              if:
+                  - value:    '{{.step.this.state}}'
+                    operator: EQ
+                    expected: BAR
+              then:
+                  this: FOO
+              message: changed state matched correctly

engine/values/values.go

@@ -23,6 +23,7 @@ const (
 	VarKey           = "var"
 	IteratorKey      = "iterator" // reserved for transient one-off values, set/unset when applying values to template
 
+	StateKey    = "state"
 	OutputKey   = "output"
 	MetadataKey = "metadata"
 	ChildrenKey = "children"
@@ -140,6 +141,21 @@ func (v *Values) UnsetError(stepName string) {
 	v.unsetStepData(stepName, ErrorKey)
 }
 
+// GetState returns the state of a step
+func (v *Values) GetState(stepName string) interface{} {
+	return v.getStepData(stepName, StateKey)
+}
+
+// SetState stores the state of a step
+func (v *Values) SetState(stepName string, value interface{}) {
+	v.setStepData(stepName, StateKey, value)
+}
+
+// UnsetState empties the state of a step
+func (v *Values) UnsetState(stepName string) {
+	v.unsetStepData(stepName, StateKey)
+}
+
 func (v *Values) getStepData(stepName, field string) interface{} {
 	stepmap := v.m[StepKey].(map[string]interface{})
 	if stepmap[stepName] == nil {
@@ -232,6 +248,9 @@ func (v *Values) Apply(templateStr string, item interface{}, stepName string) ([
 
 		v.SetError(utask.This, v.GetError(stepName))
 		defer v.UnsetError(utask.This)
+
+		v.SetState(utask.This, v.GetState(stepName))
+		defer v.UnsetState(utask.This)
 	}
 
 	err = tmpl.Execute(b, v.m)

models/resolution/resolution.go

@@ -479,6 +479,7 @@ func (r *Resolution) setSteps(st map[string]*step.Step) {
 		r.Values.SetMetadata(name, s.Metadata)
 		r.Values.SetChildren(name, s.Children)
 		r.Values.SetError(s.Name, s.Error)
+		r.Values.SetState(s.Name, s.State)
 	}
 }