fix(validation tags): handle spaces in enum values (#268)

This commit introduces management of spaces within enum values when using validation tags.
Spaces are handled by adding single quotes around the enum value

Relates to #267

Author: geoffreybauduin

pkg/codegen/generators/helpers.go

@@ -66,12 +66,18 @@ func GenerateValidateTags[T any](schema asyncapi.Validations[T], isPointer bool,
 	}
 }
 
+// singleQuote prepends and appends a single quote to the provided string.
+func singleQuote(s string) string {
+	return "'" + s + "'"
+}
+
 func appendEnumDirectives[T any](schema asyncapi.Validations[T], directives []string) []string {
 	if len(schema.Enum) > 0 {
 		var enumsStr []string
 		for _, e := range schema.Enum {
 			if eStr, ok := e.(string); ok {
-				enumsStr = append(enumsStr, eStr)
+				// single quotes are mandatory in order to handle values with spaces
+				enumsStr = append(enumsStr, singleQuote(eStr))
 			}
 		}
 

test/v2/issues/131/asyncapi.gen.go

@@ -24,5 +24,5 @@ func TestValidateOneOfExist(t *testing.T) {
 		}
 	}
 
-	assert.Equal(t, "oneof=API0 API1 API2 API3 API4", oneOfTag)
+	assert.Equal(t, "oneof='API0' 'API1' 'API2' 'API3' 'API4'", oneOfTag)
 }

test/v2/issues/137/asyncapi.gen.go

@@ -0,0 +1,24 @@
+asyncapi: 2.6.0
+info:
+  title: Sample App
+  version: 1.2.3
+
+channels:
+  v2.issue267.test:
+    subscribe:
+      message:
+        payload:
+          $ref: '#/components/schemas/Test'
+
+components:
+  schemas:
+    Test:
+      type: object
+      required:
+        - EnumProp
+      properties:
+        EnumProp:
+          type: string
+          enum:
+            - "nospaces"
+            - "has a space"

test/v2/issues/137/suite_test.go

@@ -0,0 +1,44 @@
+//go:generate go run ../../../../cmd/asyncapi-codegen -p issue267 -i ./asyncapi.yaml -o ./asyncapi.gen.go
+
+package issue267
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/go-playground/validator/v10"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/suite"
+)
+
+func TestSuite(t *testing.T) {
+	suite.Run(t, NewSuite())
+}
+
+type Suite struct {
+	suite.Suite
+}
+
+func NewSuite() *Suite {
+	return &Suite{}
+}
+
+func (suite *Suite) TestValidate_Valid() {
+	var res TestSchema
+	err := json.Unmarshal([]byte(`{
+		"EnumProp": "has a space"
+	}`), &res)
+	assert.NoError(suite.T(), err)
+	err = validator.New().Struct(res)
+	assert.NoError(suite.T(), err)
+}
+
+func (suite *Suite) TestValidate_Invalid() {
+	var res TestSchema
+	err := json.Unmarshal([]byte(`{
+		"EnumProp": "nospace"
+	}`), &res)
+	assert.NoError(suite.T(), err)
+	err = validator.New().Struct(res)
+	assert.Error(suite.T(), err)
+}

test/v2/issues/245/asyncapi.gen.go

@@ -24,5 +24,5 @@ func TestValidateOneOfExist(t *testing.T) {
 		}
 	}
 
-	assert.Equal(t, "oneof=API0 API1 API2 API3 API4", oneOfTag)
+	assert.Equal(t, "oneof='API0' 'API1' 'API2' 'API3' 'API4'", oneOfTag)
 }

test/v2/issues/267/asyncapi.gen.go

@@ -0,0 +1,31 @@
+asyncapi: 3.0.0
+
+channels:
+  test:
+    address: v3.issue267.test
+    messages:
+      test:
+        payload:
+          $ref: '#/components/schemas/Test'
+
+operations:
+  receiveTest:
+    action: receive
+    channel:
+      $ref: '#/channels/test'
+
+info:
+  title: Test
+  version: 1.0.0
+components:
+  schemas:
+    Test:
+      type: object
+      required:
+        - EnumProp
+      properties:
+        EnumProp:
+          type: string
+          enum:
+            - "nospaces"
+            - "has a space"

test/v2/issues/267/asyncapi.yaml

@@ -0,0 +1,44 @@
+//go:generate go run ../../../../cmd/asyncapi-codegen -p issue267 -i ./asyncapi.yaml -o ./asyncapi.gen.go
+
+package issue267
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/go-playground/validator/v10"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/suite"
+)
+
+func TestSuite(t *testing.T) {
+	suite.Run(t, NewSuite())
+}
+
+type Suite struct {
+	suite.Suite
+}
+
+func NewSuite() *Suite {
+	return &Suite{}
+}
+
+func (suite *Suite) TestValidate_Valid() {
+	var res TestSchema
+	err := json.Unmarshal([]byte(`{
+		"EnumProp": "has a space"
+	}`), &res)
+	assert.NoError(suite.T(), err)
+	err = validator.New().Struct(res)
+	assert.NoError(suite.T(), err)
+}
+
+func (suite *Suite) TestValidate_Invalid() {
+	var res TestSchema
+	err := json.Unmarshal([]byte(`{
+		"EnumProp": "nospace"
+	}`), &res)
+	assert.NoError(suite.T(), err)
+	err = validator.New().Struct(res)
+	assert.Error(suite.T(), err)
+}