JSON or as a YAML file: workflow.states must be int32 (#178)

* JSON or as a YAML file: workflow.states must be int32

Fixes #177

Signed-off-by: Spolti <filippespolti@gmail.com>

* add a full test scenario with the compensate workflow

Signed-off-by: Spolti <filippespolti@gmail.com>

* move workflow to testdata directory

Signed-off-by: Spolti <filippespolti@gmail.com>

---------

Signed-off-by: Spolti <filippespolti@gmail.com>

Author: spolti

model/object.go

@@ -33,10 +33,11 @@ import (
 //
 // +kubebuilder:validation:Type=object
 type Object struct {
-	Type     Type            `json:"type,inline"`
-	IntVal   int32           `json:"intVal,inline"`
-	StrVal   string          `json:"strVal,inline"`
-	RawValue json.RawMessage `json:"rawValue,inline"`
+	Type      Type            `json:"type,inline"`
+	IntVal    int32           `json:"intVal,inline"`
+	StrVal    string          `json:"strVal,inline"`
+	RawValue  json.RawMessage `json:"rawValue,inline"`
+	BoolValue bool            `json:"boolValue,inline"`
 }
 
 type Type int64
@@ -45,6 +46,7 @@ const (
 	Integer Type = iota
 	String
 	Raw
+	Boolean
 )
 
 func FromInt(val int) Object {
@@ -58,6 +60,10 @@ func FromString(val string) Object {
 	return Object{Type: String, StrVal: val}
 }
 
+func FromBool(val bool) Object {
+	return Object{Type: Boolean, BoolValue: val}
+}
+
 func FromRaw(val interface{}) Object {
 	custom, err := json.Marshal(val)
 	if err != nil {
@@ -73,6 +79,9 @@ func (obj *Object) UnmarshalJSON(data []byte) error {
 	if data[0] == '"' {
 		obj.Type = String
 		return json.Unmarshal(data, &obj.StrVal)
+	} else if data[0] == 't' || data[0] == 'f' {
+		obj.Type = Boolean
+		return json.Unmarshal(data, &obj.BoolValue)
 	} else if data[0] == '{' {
 		obj.Type = Raw
 		return json.Unmarshal(data, &obj.RawValue)
@@ -86,6 +95,8 @@ func (obj Object) MarshalJSON() ([]byte, error) {
 	switch obj.Type {
 	case String:
 		return []byte(fmt.Sprintf(`%q`, obj.StrVal)), nil
+	case Boolean:
+		return []byte(fmt.Sprintf(`%t`, obj.BoolValue)), nil
 	case Integer:
 		return []byte(fmt.Sprintf(`%d`, obj.IntVal)), nil
 	case Raw:

parser/parser_test.go

@@ -16,7 +16,6 @@ package parser
 
 import (
 	"encoding/json"
-	"fmt"
 	"os"
 	"path/filepath"
 	"strings"
@@ -526,7 +525,8 @@ func TestFromFile(t *testing.T) {
 				// Inject state
 				assert.Equal(t, "HelloInject", w.States[7].Name)
 				assert.Equal(t, model.StateTypeInject, w.States[7].Type)
-				assert.Equal(t, map[string]model.Object{"result": model.FromString("Hello World, last state!")}, w.States[7].InjectState.Data)
+				assert.Equal(t, model.FromString("Hello World, last state!"), w.States[7].InjectState.Data["result"])
+				assert.Equal(t, model.FromBool(false), w.States[7].InjectState.Data["boolValue"])
 				assert.Equal(t, "PT11M", w.States[7].InjectState.Timeouts.StateExecTimeout.Total)
 				assert.Equal(t, "PT22M", w.States[7].InjectState.Timeouts.StateExecTimeout.Single)
 
@@ -930,10 +930,8 @@ states:
     terminate: true
 `))
 		assert.Nil(t, err)
-		fmt.Println(err)
 		assert.NotNil(t, workflow)
 		b, err := json.Marshal(workflow)
-
 		assert.Nil(t, err)
 
 		// workflow and auth metadata
@@ -1023,4 +1021,17 @@ states:
 		assert.Regexp(t, `validation for \'DataConditions\' failed on the \'required\' tag`, err)
 		assert.Nil(t, workflow)
 	})
+
+	t.Run("Test complex workflow with compensate transitions", func(t *testing.T) {
+		workflow, err := FromFile("./testdata/workflows/compensate.sw.json")
+
+		assert.Nil(t, err)
+		assert.NotNil(t, workflow)
+		b, err := json.Marshal(workflow)
+		assert.Nil(t, err)
+
+		workflow = nil
+		err = json.Unmarshal(b, &workflow)
+		assert.Nil(t, err)
+	})
 }

parser/testdata/workflows/compensate.sw.json

@@ -0,0 +1,99 @@
+{
+  "id": "compensation",
+  "version": "1.0",
+  "name": "Workflow Error example",
+  "description": "An example of how compensation works",
+  "specVersion": "0.8",
+  "start": "printStatus",
+  "functions": [
+    {
+      "name": "PrintOutput",
+      "type": "custom",
+      "operation": "sysout"
+    }
+  ],
+  "states": [
+    {
+      "name": "printStatus",
+      "type": "inject",
+      "data": {
+        "compensated": false
+      },
+      "compensatedBy": "compensating",
+      "transition": "branch"
+    },
+    {
+      "name": "branch",
+      "type": "switch",
+      "dataConditions": [
+        {
+          "condition": ".shouldCompensate==true",
+          "transition": {
+            "nextState": "finish_compensate",
+            "compensate": true
+          }
+        },
+        {
+          "condition": ".shouldCompensate==false",
+          "transition": {
+            "nextState": "finish_not_compensate",
+            "compensate": false
+          }
+        }
+      ],
+      "defaultCondition": {
+        "end": true
+      }
+    },
+    {
+      "name": "compensating",
+      "usedForCompensation": true,
+      "type": "inject",
+      "data": {
+        "compensated": true
+      },
+      "transition": "compensating_more"
+    },
+    {
+      "name": "compensating_more",
+      "usedForCompensation": true,
+      "type": "inject",
+      "data": {
+        "compensating_more": "Real Betis Balompie"
+      },
+      "end": true
+    },
+    {
+      "name": "finish_compensate",
+      "type": "operation",
+      "actions": [
+        {
+          "name": "finish_compensate_sysout",
+          "functionRef": {
+            "refName": "PrintOutput",
+            "arguments": {
+              "message": "completed"
+            }
+          }
+        }
+      ],
+      "end": true
+    },
+    {
+      "name": "finish_not_compensate",
+      "type": "operation",
+      "actions": [
+        {
+          "name": "finish_not_compensate_sysout",
+          "functionRef": {
+            "refName": "PrintOutput",
+            "arguments": {
+              "message": "completed"
+            }
+          }
+        }
+      ],
+      "end": true
+    }
+  ]
+}

parser/testdata/workflows/greetings-v08-spec.sw.yaml

@@ -170,6 +170,7 @@ states:
     type: inject
     data:
       result: Hello World, last state!
+      boolValue: false
     timeouts:
       stateExecTimeout:
         total: PT11M