allow empty auth definitions in parser (#111)

spolti · lsytj0413 · web-flow · commit 02fbe11007e6 · 2022-11-14T11:41:42.000-03:00
* allow empty auth definitions in parser fixes #110 Signed-off-by: spolti <filippespolti@gmail.com> * allow empty auth definitions in parser fixes #110 fixes #126 Signed-off-by: spolti <filippespolti@gmail.com> * fix(*): use different types to auth validate Signed-off-by: lsytj0413 <511121939@qq.com> * small change Signed-off-by: spolti <filippespolti@gmail.com> Signed-off-by: spolti <filippespolti@gmail.com> Signed-off-by: lsytj0413 <511121939@qq.com> Co-authored-by: lsytj0413 <511121939@qq.com>
diff --git a/model/auth.go b/model/auth.go
@@ -17,35 +17,8 @@ package model
 import (
 	"encoding/json"
 	"fmt"
-	"reflect"
-
-	validator "github.com/go-playground/validator/v10"
-	val "github.com/serverlessworkflow/sdk-go/v2/validator"
 )
 
-func init() {
-	val.GetValidator().RegisterStructValidation(AuthDefinitionsStructLevelValidation, AuthDefinitions{})
-}
-
-// AuthDefinitionsStructLevelValidation custom validator for unique name of the auth methods
-func AuthDefinitionsStructLevelValidation(structLevel validator.StructLevel) {
-	authDefs := structLevel.Current().Interface().(AuthDefinitions)
-	dict := map[string]bool{}
-
-	for _, a := range authDefs.Defs {
-		if !dict[a.Name] {
-			dict[a.Name] = true
-		} else {
-			structLevel.ReportError(reflect.ValueOf(a.Name), "Name", "name", "reqnameunique", "")
-		}
-	}
-}
-
-// AuthDefinitions used to define authentication information applied to resources defined in the operation property of function definitions
-type AuthDefinitions struct {
-	Defs []Auth
-}
-
 // AuthType ...
 type AuthType string
 
@@ -92,44 +65,6 @@ type Auth struct {
 	Properties AuthProperties `json:"properties" validate:"required"`
 }
 
-// UnmarshalJSON implements json.Unmarshaler
-func (a *AuthDefinitions) UnmarshalJSON(b []byte) error {
-	if len(b) == 0 {
-		// TODO: Normalize error messages
-		return fmt.Errorf("no bytes to unmarshal")
-	}
-
-	// See if we can guess based on the first character
-	switch b[0] {
-	case '"':
-		return a.unmarshalFile(b)
-	case '[':
-		return a.unmarshalMany(b)
-	}
-
-	return fmt.Errorf("auth value '%s' is not supported, it must be an array or string", string(b))
-}
-
-func (a *AuthDefinitions) unmarshalFile(data []byte) error {
-	b, err := unmarshalFile(data)
-	if err != nil {
-		return fmt.Errorf("authDefinitions value '%s' is not supported, it must be an object or string", string(data))
-	}
-
-	return a.unmarshalMany(b)
-}
-
-func (a *AuthDefinitions) unmarshalMany(data []byte) error {
-	var auths []Auth
-	err := json.Unmarshal(data, &auths)
-	if err != nil {
-		return fmt.Errorf("authDefinitions value '%s' is not supported, it must be an object or string", string(data))
-	}
-
-	a.Defs = auths
-	return nil
-}
-
 // UnmarshalJSON Auth definition
 func (a *Auth) UnmarshalJSON(data []byte) error {
 	auth := make(map[string]json.RawMessage)
diff --git a/model/auth_test.go b/model/auth_test.go
@@ -19,81 +19,8 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
-
-	val "github.com/serverlessworkflow/sdk-go/v2/validator"
 )
 
-func TestAuthDefinitionsStructLevelValidation(t *testing.T) {
-	type testCase struct {
-		desp     string
-		authDefs AuthDefinitions
-		err      string
-	}
-	testCases := []testCase{
-		{
-			desp: "nil defs",
-			authDefs: AuthDefinitions{
-				Defs: nil,
-			},
-			err: ``,
-		},
-		{
-			desp: "zero length defs",
-			authDefs: AuthDefinitions{
-				Defs: []Auth{},
-			},
-			err: ``,
-		},
-		{
-			desp: "multi unique defs",
-			authDefs: AuthDefinitions{
-				Defs: []Auth{
-					{
-						Name: "1",
-					},
-					{
-						Name: "2",
-					},
-					{
-						Name: "3",
-					},
-				},
-			},
-			err: ``,
-		},
-		{
-			desp: "multi non-unique defs",
-			authDefs: AuthDefinitions{
-				Defs: []Auth{
-					{
-						Name: "1",
-					},
-					{
-						Name: "2",
-					},
-					{
-						Name: "1",
-					},
-				},
-			},
-			err: `Key: 'AuthDefinitions.Name' Error:Field validation for 'Name' failed on the 'reqnameunique' tag`,
-		},
-	}
-	for _, tc := range testCases {
-		t.Run(tc.desp, func(t *testing.T) {
-			err := val.GetValidator().Struct(tc.authDefs)
-
-			if tc.err != "" {
-				assert.Error(t, err)
-				assert.Regexp(t, tc.err, err)
-				return
-			}
-
-			assert.NoError(t, err)
-		})
-	}
-}
-
 func TestUnmarshalJSONMultipleAuthProperties(t *testing.T) {
 	t.Run("BearerAuthProperties", func(t *testing.T) {
 		a1JSON := `{
diff --git a/model/workflow.go b/model/workflow.go
@@ -57,6 +57,7 @@ const (
 
 func init() {
 	val.GetValidator().RegisterStructValidation(continueAsStructLevelValidation, ContinueAs{})
+	val.GetValidator().RegisterStructValidation(BaseWorkflowStructLevelValidation, BaseWorkflow{})
 }
 
 func continueAsStructLevelValidation(structLevel validator.StructLevel) {
@@ -108,7 +109,60 @@ type BaseWorkflow struct {
 	// Auth definitions can be used to define authentication information that should be applied to resources defined in the operation
 	// property of function definitions. It is not used as authentication information for the function invocation,
 	// but just to access the resource containing the function invocation information.
-	Auth AuthDefinitions `json:"auth,omitempty"`
+	Auth AuthArray `json:"auth,omitempty" validate:"omitempty"`
+}
+
+// BaseWorkflowStructLevelValidation custom validator for unique name of the auth methods
+func BaseWorkflowStructLevelValidation(structLevel validator.StructLevel) {
+	// NOTE: we cannot add the custom validation of auth to AuthArray
+	// because `RegisterStructValidation` only works with struct type
+	wf := structLevel.Current().Interface().(BaseWorkflow)
+	dict := map[string]bool{}
+
+	for _, a := range wf.Auth {
+		if !dict[a.Name] {
+			dict[a.Name] = true
+		} else {
+			structLevel.ReportError(reflect.ValueOf(a.Name), "Name", "name", "reqnameunique", "")
+		}
+	}
+}
+
+type AuthArray []Auth
+
+func (r *AuthArray) UnmarshalJSON(data []byte) error {
+	if len(data) == 0 {
+		return fmt.Errorf("no bytes to unmarshal")
+	}
+
+	switch data[0] {
+	case '"':
+		return r.unmarshalFile(data)
+	case '[':
+		return r.unmarshalMany(data)
+	}
+
+	return fmt.Errorf("auth value '%s' is not supported, it must be an array or string", string(data))
+}
+
+func (r *AuthArray) unmarshalFile(data []byte) error {
+	b, err := unmarshalFile(data)
+	if err != nil {
+		return fmt.Errorf("authDefinitions value '%s' is not supported, it must be an object or string", string(data))
+	}
+
+	return r.unmarshalMany(b)
+}
+
+func (r *AuthArray) unmarshalMany(data []byte) error {
+	var auths []Auth
+	err := json.Unmarshal(data, &auths)
+	if err != nil {
+		return fmt.Errorf("authDefinitions value '%s' is not supported, it must be an object or string", string(data))
+	}
+
+	*r = auths
+	return nil
 }
 
 // Workflow base definition
@@ -130,6 +184,7 @@ func (w *Workflow) UnmarshalJSON(data []byte) error {
 	if err := json.Unmarshal(data, &workflowMap); err != nil {
 		return err
 	}
+
 	var rawStates []json.RawMessage
 	if err := json.Unmarshal(workflowMap["states"], &rawStates); err != nil {
 		return err
diff --git a/parser/parser_test.go b/parser/parser_test.go
