Merge pull request #137230 from lalitc375/support-subresource

k8s-publishing-bot · k8s-publishing-bot · commit 63e8cd8e75e5 · 2026-02-27T20:51:41.000Z
Convert {is,supports}SubResource to modern tag parsing

Kubernetes-commit: fe943aff0ce4be7f2fc93c3e8c1e2b34e5044513
diff --git a/cmd/validation-gen/output_tests/tags/supported_resources/issubresource/doc.go b/cmd/validation-gen/output_tests/tags/supported_resources/issubresource/doc.go
@@ -28,7 +28,7 @@ var localSchemeBuilder = testscheme.New()
 
 // Root resource is supported by default
 
-// +k8s:isSubresource=/scale
+// +k8s:isSubresource="/scale"
 
 // T1 is a test type
 type T1 struct {
diff --git a/cmd/validation-gen/output_tests/tags/supported_resources/subresource/doc.go b/cmd/validation-gen/output_tests/tags/supported_resources/subresource/doc.go
@@ -28,9 +28,9 @@ var localSchemeBuilder = testscheme.New()
 
 // Root resource is supported by default
 
-// +k8s:supportsSubresource=/status
-// +k8s:supportsSubresource=/scale
-// +k8s:supportsSubresource=/x/y
+// +k8s:supportsSubresource="/status"
+// +k8s:supportsSubresource="/scale"
+// +k8s:supportsSubresource="/x/y"
 
 // T1 is a test type
 type T1 struct {
diff --git a/cmd/validation-gen/targets.go b/cmd/validation-gen/targets.go
@@ -35,8 +35,8 @@ import (
 
 // These are the comment tags that carry parameters for validation generation.
 const (
-	tagName               = "k8s:validation-gen"
-	inputTagName          = "k8s:validation-gen-input"
+	mainTagName           = "k8s:validation-gen"                 // defines which types to generate validation for
+	inputTagName          = "k8s:validation-gen-input"           // indicates that input types are in a different package
 	schemeRegistryTagName = "k8s:validation-gen-scheme-registry" // defaults to k8s.io/apimachinery/pkg.runtime.Scheme
 	testFixtureTagName    = "k8s:validation-gen-test-fixture"    // if set, generate go test files for test fixtures.  Supported values: "validateFalse".
 
@@ -55,12 +55,31 @@ var (
 	listMetaType = types.Name{Package: metav1Pkg, Name: "ListMeta"}
 )
 
-func extractTag(comments []string) ([]string, bool) {
-	tags, err := gengo.ExtractFunctionStyleCommentTags("+", []string{tagName}, comments)
+// extractAndParseTag extracts all the values for a given tag, according to the
+// tag grammar.
+func extractAndParseTag(tagName string, comments []string) ([]codetags.Tag, error) {
+	extracted := codetags.Extract("+", comments)
+	var tags []codetags.Tag
+	for key, lines := range extracted {
+		if key != tagName {
+			continue
+		}
+		t, err := codetags.ParseAll(lines)
+		if err != nil {
+			return nil, fmt.Errorf("failed to parse tags: %w: %s", err, lines)
+		}
+		tags = append(tags, t...)
+	}
+	return tags, nil
+}
+
+func extractMainTag(comments []string) ([]string, bool) {
+	// TODO: convert to extractAndParseTag() and update all callers to use quoted values
+	tags, err := gengo.ExtractFunctionStyleCommentTags("+", []string{mainTagName}, comments)
 	if err != nil {
 		klog.Fatalf("Failed to extract tags: %v", err)
 	}
-	values, found := tags[tagName]
+	values, found := tags[mainTagName]
 	if !found || len(values) == 0 {
 		return nil, false
 	}
@@ -73,6 +92,7 @@ func extractTag(comments []string) ([]string, bool) {
 }
 
 func extractInputTag(comments []string) []string {
+	// TODO: convert to extractAndParseTag() and update all callers to use quoted values
 	tags, err := gengo.ExtractFunctionStyleCommentTags("+", []string{inputTagName}, comments)
 	if err != nil {
 		klog.Fatalf("Failed to extract input tags: %v", err)
@@ -89,12 +109,14 @@ func extractInputTag(comments []string) []string {
 	return result
 }
 
-func checkTag(comments []string, require ...string) bool {
-	tags, err := gengo.ExtractFunctionStyleCommentTags("+", []string{tagName}, comments)
+// TODO: this can just accept a single bool
+func checkMainTag(comments []string, require ...string) bool {
+	// TODO: convert to extractAndParseTag() and update all callers to use quoted values
+	tags, err := gengo.ExtractFunctionStyleCommentTags("+", []string{mainTagName}, comments)
 	if err != nil {
 		klog.Fatalf("Failed to extract tags: %v", err)
 	}
-	values, found := tags[tagName]
+	values, found := tags[mainTagName]
 	if !found {
 		return false
 	}
@@ -112,6 +134,7 @@ func checkTag(comments []string, require ...string) bool {
 }
 
 func schemeRegistryTag(pkg *types.Package) types.Name {
+	// TODO: convert to extractAndParseTag() and update all callers to use quoted values
 	tags, err := gengo.ExtractFunctionStyleCommentTags("+", []string{schemeRegistryTagName}, pkg.Comments)
 	if err != nil {
 		klog.Fatalf("Failed to extract scheme registry tags: %v", err)
@@ -130,34 +153,32 @@ func isSubresourceTag(t *types.Type) (string, bool) {
 	var comments []string
 	comments = append(comments, t.SecondClosestCommentLines...)
 	comments = append(comments, t.CommentLines...)
-	tags, err := gengo.ExtractFunctionStyleCommentTags("+", []string{isSubresourceTagName}, comments)
+	tags, err := extractAndParseTag(isSubresourceTagName, comments)
 	if err != nil {
 		klog.Fatalf("Failed to extract isSubresource tags: %v", err)
 	}
-	values, found := tags[isSubresourceTagName]
-	if !found || len(values) == 0 {
+	if len(tags) == 0 {
 		return "", false
 	}
-	if len(values) > 1 {
+	if len(tags) > 1 {
 		panic(fmt.Sprintf("Type %q contains more than one usage of %q", t.Name.String(), isSubresourceTagName))
 	}
-	return values[0].Value, true
+	return tags[0].Value, true
 }
 
 func supportedSubresourceTags(t *types.Type) sets.Set[string] {
 	var comments []string
 	comments = append(comments, t.SecondClosestCommentLines...)
 	comments = append(comments, t.CommentLines...)
-	tags, err := gengo.ExtractFunctionStyleCommentTags("+", []string{supportsSubresourceTagName}, comments)
+	tags, err := extractAndParseTag(supportsSubresourceTagName, comments)
 	if err != nil {
 		klog.Fatalf("Failed to extract supportedSubresource tags: %v", err)
 	}
-	values, found := tags[supportsSubresourceTagName]
-	if !found || len(values) == 0 {
+	if len(tags) == 0 {
 		return sets.New[string]()
 	}
 	subresources := sets.New[string]()
-	for _, tag := range values {
+	for _, tag := range tags {
 		subresources.Insert(tag.Value)
 	}
 	return subresources
@@ -167,6 +188,7 @@ var testFixtureTagValues = sets.New("validateFalse")
 
 func testFixtureTag(pkg *types.Package) sets.Set[string] {
 	result := sets.New[string]()
+	// TODO: convert to extractAndParseTag() and update all callers to use quoted values
 	tags, err := gengo.ExtractFunctionStyleCommentTags("+", []string{testFixtureTagName}, pkg.Comments)
 	if err != nil {
 		klog.Fatalf("Failed to extract test fixture tags: %v", err)
@@ -305,21 +327,21 @@ func GetTargets(context *generator.Context, args *Args) []generator.Target {
 
 		schemeRegistry := schemeRegistryTag(pkg)
 
-		typesWith, found := extractTag(pkg.Comments)
+		typesWith, found := extractMainTag(pkg.Comments)
 		if !found {
-			klog.V(2).InfoS("  did not find required tag", "tag", tagName)
+			klog.V(2).InfoS("  did not find required tag", "tag", mainTagName)
 			continue
 		}
 		if len(typesWith) == 1 && typesWith[0] == "" {
-			klog.Fatalf("found package tag %q with no value", tagName)
+			klog.Fatalf("found package tag %q with no value", mainTagName)
 		}
 		shouldCreateObjectValidationFn := func(t *types.Type) bool {
 			// opt-out
-			if checkTag(t.SecondClosestCommentLines, "false") {
+			if checkMainTag(t.SecondClosestCommentLines, "false") {
 				return false
 			}
 			// opt-in
-			if checkTag(t.SecondClosestCommentLines, "true") {
+			if checkMainTag(t.SecondClosestCommentLines, "true") {
 				return true
 			}
 
diff --git a/go.mod b/go.mod
@@ -13,7 +13,7 @@ require (
 	github.com/spf13/pflag v1.0.9
 	go.yaml.in/yaml/v2 v2.4.3
 	golang.org/x/text v0.33.0
-	k8s.io/apimachinery v0.0.0-20260227163238-b6415d345084
+	k8s.io/apimachinery v0.0.0-20260227203245-48224b4d1ddb
 	k8s.io/gengo/v2 v2.0.0-20250922181213-ec3ebc5fd46b
 	k8s.io/klog/v2 v2.130.1
 	k8s.io/kube-openapi v0.0.0-20260127142750-a19766b6e2d4
diff --git a/go.sum b/go.sum
@@ -130,8 +130,8 @@ gopkg.in/inf.v0 v0.9.1/go.mod h1:cWUDdTG/fYaXco+Dcufb5Vnc6Gp2YChqWtbxRZE0mXw=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-k8s.io/apimachinery v0.0.0-20260227163238-b6415d345084 h1:vRyPwew4b3Yiq7mwOpqX+o8qxkT//RhS9FQLN5ziq1A=
-k8s.io/apimachinery v0.0.0-20260227163238-b6415d345084/go.mod h1:zqp0Kd80VeQZHyQ4j0VW/sn9zTHYeXFd/brJe5Po20w=
+k8s.io/apimachinery v0.0.0-20260227203245-48224b4d1ddb h1:0MWXuP1Qkr2TJBSQ2qYrHARDtTXH4TeTZ9q8OPHOQFM=
+k8s.io/apimachinery v0.0.0-20260227203245-48224b4d1ddb/go.mod h1:zqp0Kd80VeQZHyQ4j0VW/sn9zTHYeXFd/brJe5Po20w=
 k8s.io/gengo/v2 v2.0.0-20250922181213-ec3ebc5fd46b h1:gMplByicHV/TJBizHd9aVEsTYoJBnnUAT5MHlTkbjhQ=
 k8s.io/gengo/v2 v2.0.0-20250922181213-ec3ebc5fd46b/go.mod h1:CgujABENc3KuTrcsdpGmrrASjtQsWCT7R99mEV4U/fM=
 k8s.io/klog/v2 v2.130.1 h1:n9Xl7H1Xvksem4KFG4PYbdQCQxqc/tTUyrgXaOhHSzk=
