Merge pull request #50 from linuxfoundation/jme/LFXV2-1652

fix: allow underscores in parent field type fragment (LFXV2-1652)

Author: jordane

cmd/service/parent_regex_test.go

@@ -0,0 +1,44 @@
+// Copyright The Linux Foundation and each contributor to LFX.
+// SPDX-License-Identifier: MIT
+
+package service
+
+import (
+	"regexp"
+	"testing"
+)
+
+// parentPattern mirrors the Goa design pattern at design/query-svc.go.
+// This test exists to guard against accidental regex regression.
+const parentPattern = `^[a-zA-Z][a-zA-Z0-9_]*:[a-zA-Z0-9_-]+$`
+
+func TestParentPattern(t *testing.T) {
+	re := regexp.MustCompile(parentPattern)
+
+	valid := []string{
+		"project:123",
+		"past_meeting:98471391296-1765832400000",
+		"v1_meeting:abc-123",
+		"v1_past_meeting:foo_bar-baz",
+		"committee:abc",
+	}
+	for _, v := range valid {
+		if !re.MatchString(v) {
+			t.Errorf("expected %q to match parent pattern", v)
+		}
+	}
+
+	invalid := []string{
+		"past_meeting:",     // empty id fragment
+		":abc",             // empty type fragment
+		"_leading:abc",     // leading underscore in type
+		"past meeting:abc", // space in type
+		"project",          // missing colon
+		"",                 // empty
+	}
+	for _, v := range invalid {
+		if re.MatchString(v) {
+			t.Errorf("expected %q to NOT match parent pattern", v)
+		}
+	}
+}

design/query-svc.go

@@ -45,7 +45,7 @@ var _ = dsl.Service("query-svc", func() {
 			})
 			dsl.Attribute("parent", dsl.String, "Parent (for navigation; varies by object type)", func() {
 				dsl.Example("project:123")
-				dsl.Pattern(`^[a-zA-Z]+:[a-zA-Z0-9_-]+$`)
+				dsl.Pattern(`^[a-zA-Z][a-zA-Z0-9_]*:[a-zA-Z0-9_-]+$`)
 			})
 			dsl.Attribute("type", dsl.String, "Resource type to search", func() {
 				dsl.Example("committee")
@@ -145,6 +145,7 @@ var _ = dsl.Service("query-svc", func() {
 			})
 			dsl.Attribute("parent", dsl.String, "Parent (for navigation; varies by object type)", func() {
 				dsl.Example("project:123")
+				dsl.Pattern(`^[a-zA-Z][a-zA-Z0-9_]*:[a-zA-Z0-9_-]+$`)
 			})
 			dsl.Attribute("type", dsl.String, "Resource type to search", func() {
 				dsl.Example("committee")

gen/http/openapi.json

@@ -159,7 +159,7 @@ paths:
                   description: Parent (for navigation; varies by object type)
                   required: false
                   type: string
-                  pattern: ^[a-zA-Z]+:[a-zA-Z0-9_-]+$
+                  pattern: ^[a-zA-Z][a-zA-Z0-9_]*:[a-zA-Z0-9_-]+$
                 - name: type
                   in: query
                   description: Resource type to search
@@ -322,6 +322,7 @@ paths:
                   description: Parent (for navigation; varies by object type)
                   required: false
                   type: string
+                  pattern: ^[a-zA-Z][a-zA-Z0-9_]*:[a-zA-Z0-9_-]+$
                 - name: type
                   in: query
                   description: Resource type to search

gen/http/openapi.yaml

@@ -207,7 +207,7 @@ paths:
                     type: string
                     description: Parent (for navigation; varies by object type)
                     example: project:123
-                    pattern: ^[a-zA-Z]+:[a-zA-Z0-9_-]+$
+                    pattern: ^[a-zA-Z][a-zA-Z0-9_]*:[a-zA-Z0-9_-]+$
                   example: project:123
                 - name: type
                   in: query
@@ -484,6 +484,7 @@ paths:
                     type: string
                     description: Parent (for navigation; varies by object type)
                     example: project:123
+                    pattern: ^[a-zA-Z][a-zA-Z0-9_]*:[a-zA-Z0-9_-]+$
                   example: project:123
                 - name: type
                   in: query