first iteration - deepcopy (#131)

* first iteration - deepcopy

Signed-off-by: spolti <[email protected]>

* review additions

Signed-off-by: spolti <[email protected]>

* add builders for the object types

Signed-off-by: spolti <[email protected]>

Signed-off-by: spolti <[email protected]>

Author: spolti

.github/workflows/Go-SDK-PR-Check.yaml

@@ -57,6 +57,10 @@ jobs:
           make addheaders
           changed_files=$(git status -s | grep -v 'go.mod\|go.sum\|tools.mod\|tools.sum' || :)
           [[ -z "$changed_files" ]] ||  (printf "Some files are missing the headers: \n$changed_files\n Did you run 'make lint' before sending the PR" && exit 1)
+      - name: Check DeepCopy Generation
+        run: |
+          export GOPATH=$(go env GOPATH)
+          make deepcopy
       - name: Check Formatting
         run: |
           make fmt

.lift.toml

@@ -0,0 +1,3 @@
+ignoreFiles = """
+model/zz_generated.deepcopy.go
+"""

Makefile

@@ -14,6 +14,10 @@ lint:
 
 .PHONY: test
 coverage="false"
-test:
+test: deepcopy
 	make lint
 	@go test ./...
+
+.PHONY: deepcopy
+deepcopy: $(DEEPCOPY_GEN) ## Download deeepcopy-gen locally if necessary.
+	./hack/deepcopy-gen.sh deepcopy

go.mod

@@ -7,6 +7,7 @@ require (
 	github.com/pkg/errors v0.9.1
 	github.com/senseyeio/duration v0.0.0-20180430131211-7c2a214ada46
 	github.com/stretchr/testify v1.7.0
+	gopkg.in/yaml.v3 v3.0.1
 	k8s.io/apimachinery v0.25.1
 	sigs.k8s.io/yaml v1.3.0
 )
@@ -24,7 +25,6 @@ require (
 	golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f // indirect
 	golang.org/x/text v0.3.7 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
-	gopkg.in/yaml.v3 v3.0.1 // indirect
 	k8s.io/klog/v2 v2.70.1 // indirect
 	sigs.k8s.io/json v0.0.0-20220713155537-f223a00ba0e2 // indirect
 )

hack/boilerplate.txt

@@ -0,0 +1,13 @@
+// Copyright 2022 The Serverless Workflow Specification Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.

hack/deepcopy-gen.sh

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+# Copyright 2022 The Serverless Workflow Specification Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# retrieved from https://github.com/kubernetes/code-generator/blob/master/generate-internal-groups.sh
+# and adapted to only install and run the deepcopy-gen
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+SCRIPT_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
+echo "Script root is $SCRIPT_ROOT"
+
+GENS="$1"
+shift 1
+
+(
+  # To support running this script from anywhere, first cd into this directory,
+  # and then install with forced module mode on and fully qualified name.
+  # make sure your GOPATH env is properly set.
+  # it will go under $GOPATH/bin
+  cd "$(dirname "${0}")"
+  GO111MODULE=on go install k8s.io/code-generator/cmd/deepcopy-gen@latest
+)
+
+function codegen::join() { local IFS="$1"; shift; echo "$*"; }
+
+if [ "${GENS}" = "all" ] || grep -qw "deepcopy" <<<"${GENS}"; then
+  echo "Generating deepcopy funcs"
+  export GO111MODULE=on
+  # for debug purposes, increase the log level by updating the -v flag to higher numbers, e.g. -v 4
+  "${GOPATH}/bin/deepcopy-gen" -v 1 \
+      --input-dirs ./model -O zz_generated.deepcopy \
+      --go-header-file "${SCRIPT_ROOT}/hack/boilerplate.txt" \
+      "$@"
+fi

model/action.go

@@ -69,11 +69,10 @@ type FunctionRef struct {
 	RefName string `json:"refName" validate:"required"`
 	// Function arguments
 	// TODO: validate it as required if function type is graphql
-	Arguments map[string]interface{} `json:"arguments,omitempty"`
+	Arguments map[string]Object `json:"arguments,omitempty"`
 	// String containing a valid GraphQL selection set
 	// TODO: validate it as required if function type is graphql
 	SelectionSet string `json:"selectionSet,omitempty"`
-
 	// Invoke specifies if the subflow should be invoked sync or async.
 	// Defaults to sync.
 	Invoke InvokeKind `json:"invoke,omitempty" validate:"required,oneof=async sync"`

model/auth.go

@@ -110,6 +110,9 @@ type AuthProperties interface {
 	GetMetadata() *Metadata
 	// GetSecret ...
 	GetSecret() string
+	// DeepCopyAuthProperties fixes in.Properties.DeepCopyAuthProperties undefined (type AuthProperties has no
+	// field or method DeepCopyAuthProperties)
+	DeepCopyAuthProperties() AuthProperties
 }
 
 // BaseAuthProperties ...
@@ -148,6 +151,10 @@ func (b *BaseAuthProperties) GetSecret() string {
 	return b.Secret
 }
 
+func (b *BasicAuthProperties) DeepCopyAuthProperties() AuthProperties {
+	return b
+}
+
 // BasicAuthProperties Basic Auth Info
 type BasicAuthProperties struct {
 	BaseAuthProperties
@@ -186,6 +193,10 @@ type BearerAuthProperties struct {
 	Token string `json:"token" validate:"required"`
 }
 
+func (b *BearerAuthProperties) DeepCopyAuthProperties() AuthProperties {
+	return b
+}
+
 // UnmarshalJSON ...
 func (b *BearerAuthProperties) UnmarshalJSON(data []byte) error {
 	properties := make(map[string]json.RawMessage)
@@ -232,6 +243,10 @@ type OAuth2AuthProperties struct {
 	RequestedIssuer string `json:"requestedIssuer,omitempty" validate:"omitempty,min=1"`
 }
 
+func (b *OAuth2AuthProperties) DeepCopyAuthProperties() AuthProperties {
+	return b
+}
+
 // TODO: use reflection to unmarshal the keys and think on a generic approach to handle them
 
 // UnmarshalJSON ...

model/callback_state.go

@@ -28,6 +28,10 @@ type CallbackState struct {
 	EventDataFilter EventDataFilter `json:"eventDataFilter,omitempty"`
 }
 
+func (in *CallbackState) DeepCopyState() State {
+	return in
+}
+
 // CallbackStateTimeout defines timeout settings for callback state
 type CallbackStateTimeout struct {
 	StateExecTimeout  *StateExecTimeout `json:"stateExecTimeout,omitempty"`

model/common.go

@@ -21,4 +21,4 @@ type Common struct {
 }
 
 // Metadata information
-type Metadata map[string]interface{}
+type Metadata map[string]Object

model/delay_state.go

@@ -20,3 +20,7 @@ type DelayState struct {
 	// Amount of time (ISO 8601 format) to delay
 	TimeDelay string `json:"timeDelay" validate:"required,iso8601duration"`
 }
+
+func (in *DelayState) DeepCopyState() State {
+	return in
+}

model/doc.go

@@ -0,0 +1,18 @@
+// Copyright 2022 The Serverless Workflow Specification Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package model
+
+// +k8s:deepcopy-gen=package
+// +k8s:deepcopy-gen:nonpointer-interfaces=true

model/event.go

@@ -30,7 +30,7 @@ const (
 	// EventKindConsumed means the event continuation of workflow instance execution
 	EventKindConsumed EventKind = "consumed"
 
-	// EventKindProduced means the event was created during worflow instance execution
+	// EventKindProduced means the event was created during workflow instance execution
 	EventKindProduced EventKind = "produced"
 )
 
@@ -98,13 +98,11 @@ type EventRef struct {
 	ResultEventRef string `json:"resultEventRef" validate:"required"`
 	// ResultEventTimeout defines maximum amount of time (ISO 8601 format) to wait for the result event. If not defined it be set to the actionExecutionTimeout
 	ResultEventTimeout string `json:"resultEventTimeout,omitempty" validate:"omitempty,iso8601duration"`
-	// TODO: create StringOrMap structure
 	// If string type, an expression which selects parts of the states data output to become the data (payload) of the event referenced by 'triggerEventRef'.
 	// If object type, a custom object to become the data (payload) of the event referenced by 'triggerEventRef'.
-	Data interface{} `json:"data,omitempty"`
+	Data Object `json:"data,omitempty"`
 	// Add additional extension context attributes to the produced event
-	ContextAttributes map[string]interface{} `json:"contextAttributes,omitempty"`
-
+	ContextAttributes map[string]Object `json:"contextAttributes,omitempty"`
 	// Invoke specifies if the subflow should be invoked sync or async.
 	// Defaults to sync.
 	Invoke InvokeKind `json:"invoke,omitempty" validate:"required,oneof=async sync"`

model/event_state.go

@@ -34,6 +34,10 @@ type EventState struct {
 	Timeouts *EventStateTimeout `json:"timeouts,omitempty"`
 }
 
+func (e *EventState) DeepCopyState() State {
+	return e
+}
+
 type eventStateForUnmarshal EventState
 
 // UnmarshalJSON unmarshal EventState object from json bytes
@@ -50,7 +54,7 @@ func (e *EventState) UnmarshalJSON(data []byte) error {
 	return nil
 }
 
-// OnEvents define which actions are be be performed for the one or more events.
+// OnEvents define which actions are be performed for the one or more events.
 type OnEvents struct {
 	// References one or more unique event names in the defined workflow events
 	EventRefs []string `json:"eventRefs" validate:"required,min=1"`

model/foreach_state.go

@@ -61,6 +61,10 @@ type ForEachState struct {
 	Mode ForEachModeType `json:"mode,omitempty"`
 }
 
+func (f *ForEachState) DeepCopyState() State {
+	return f
+}
+
 type forEachStateForUnmarshal ForEachState
 
 func (f *ForEachState) UnmarshalJSON(data []byte) error {

model/inject_state.go

@@ -18,11 +18,15 @@ package model
 type InjectState struct {
 	BaseState
 	// JSON object which can be set as states data input and can be manipulated via filters
-	Data map[string]interface{} `json:"data" validate:"required,min=1"`
+	Data map[string]Object `json:"data" validate:"required,min=1"`
 	// State specific timeouts
 	Timeouts *InjectStateTimeout `json:"timeouts,omitempty"`
 }
 
+func (in *InjectState) DeepCopyState() State {
+	return in
+}
+
 // InjectStateTimeout defines timeout settings for inject state
 type InjectStateTimeout struct {
 	StateExecTimeout *StateExecTimeout `json:"stateExecTimeout,omitempty"`