feat: description_validator now correctly parses stringvalidator.OneOf arguments with commas and appends possible values to string attribute descriptions.

Author: hanneshayashi

internal/convert/description_validator.go

@@ -9,7 +9,18 @@ import (
 // oneOfRegex matches "stringvalidator.OneOf(...)" and captures the content inside.
 var oneOfRegex = regexp.MustCompile(`stringvalidator\.OneOf\(([\s\S]*?)\)`)
 
-// AppendValidators appends possible values from validators to the description.
+// stringLiteralRegex matches a Go string literal (double-quoted).
+// It handles escaped quotes.
+var stringLiteralRegex = regexp.MustCompile(`"((?:[^"\\]|\\.)*)"`)
+
+// AppendValidators parses stringvalidator.OneOf validators from the provided Validators object
+// and appends the possible values to the Description.
+//
+// It currently supports:
+// - stringvalidator.OneOf
+//
+// Arguments inside OneOf are expected to be string literals.
+// Commas inside quotes are preserved.
 func (d *Description) AppendValidators(v Validators) {
 	if d.description == nil {
 		empty := ""
@@ -22,31 +33,43 @@ func (d *Description) AppendValidators(v Validators) {
 		}
 
 		// Check for stringvalidator.OneOf
-		matches := oneOfRegex.FindStringSubmatch(custom.SchemaDefinition)
-		if len(matches) > 1 {
-			// matches[1] contains the arguments inside OneOf(...)
-			// e.g. " \"a\", \"b\", " or "\n\"a\",\n\"b\",\n"
-
-			// Simple extraction: verify it looks like a list of strings
-			args := matches[1]
-
-			// Split by comma
-			parts := strings.Split(args, ",")
-			var values []string
-			for _, p := range parts {
-				p = strings.TrimSpace(p)
-				p = strings.Trim(p, "\"") // remove quotes
-				if p != "" {
-					values = append(values, fmt.Sprintf("`%s`", p))
+		// Note: This regex might match multiple times if there are multiple OneOf calls,
+		// though typically there's only one per validator set.
+		allMatches := oneOfRegex.FindAllStringSubmatch(custom.SchemaDefinition, -1)
+
+		for _, matches := range allMatches {
+			if len(matches) > 1 {
+				// matches[1] contains the arguments inside OneOf(...)
+				args := matches[1]
+
+				// Parse string literals from the arguments
+				// This avoids issues with commas inside quotes
+				literalMatches := stringLiteralRegex.FindAllStringSubmatch(args, -1)
+
+				var values []string
+				for _, lm := range literalMatches {
+					if len(lm) > 1 {
+						// lm[1] is the content inside the quotes
+						// We re-wrap it in backticks for markdown display, escaping backticks if needed
+						val := lm[1]
+						val = strings.ReplaceAll(val, "`", "` + \"`\" + `") // unlikely but safe
+						values = append(values, fmt.Sprintf("`%s`", val))
+					}
 				}
-			}
 
-			if len(values) > 0 {
-				suffix := fmt.Sprintf("Possible values: %s", strings.Join(values, ", "))
-				if *d.description != "" {
-					*d.description += "\n"
+				if len(values) > 0 {
+					suffix := fmt.Sprintf("Possible values: %s", strings.Join(values, ", "))
+
+					// Avoid appending if already present (simple duplicate check)
+					if strings.Contains(*d.description, suffix) {
+						continue
+					}
+
+					if *d.description != "" {
+						*d.description += "\n"
+					}
+					*d.description += suffix
 				}
-				*d.description += suffix
 			}
 		}
 	}

internal/convert/description_validator_test.go

@@ -47,6 +47,16 @@ func TestDescription_AppendValidators(t *testing.T) {
 			}),
 			expectedDesc: "Desc\nPossible values: `val1`, `val2`",
 		},
+		{
+			name:        "Commas inside quotes",
+			initialDesc: stringPtr("Desc"),
+			validators: NewValidators(ValidatorTypeString, specschema.CustomValidators{
+				{
+					SchemaDefinition: `stringvalidator.OneOf("a,b", "c")`,
+				},
+			}),
+			expectedDesc: "Desc\nPossible values: `a,b`, `c`",
+		},
 		{
 			name:        "No OneOf",
 			initialDesc: stringPtr("Desc"),
@@ -57,6 +67,20 @@ func TestDescription_AppendValidators(t *testing.T) {
 			}),
 			expectedDesc: "Desc",
 		},
+		{
+			name:        "Multiple OneOf (should append both)",
+			initialDesc: stringPtr("Desc"),
+			validators: NewValidators(ValidatorTypeString, specschema.CustomValidators{
+				{
+					SchemaDefinition: `stringvalidator.OneOf("a", "b")`,
+				},
+				{
+					// This case is artificial, usually there's only one OneOf, but good to test behavior
+					SchemaDefinition: `stringvalidator.OneOf("c", "d")`,
+				},
+			}),
+			expectedDesc: "Desc\nPossible values: `a`, `b`\nPossible values: `c`, `d`",
+		},
 	}
 
 	for _, tt := range tests {

internal/datasource/string_attribute.go

@@ -41,6 +41,8 @@ func NewGeneratorStringAttribute(name string, a *datasource.StringAttribute) (Ge
 
 	v := convert.NewValidators(convert.ValidatorTypeString, a.Validators.CustomValidators())
 
+	d.AppendValidators(v)
+
 	return GeneratorStringAttribute{
 		AssociatedExternalType:   schema.NewAssocExtType(a.AssociatedExternalType),
 		ComputedOptionalRequired: c,