maxlength:Fix byte slice suggestion, string alias map keys, and comments

Author: itzPranshul

pkg/analysis/maxlength/analyzer.go

@@ -166,13 +166,17 @@ func (a *analyzer) checkArrayType(pass *analysis.Pass, arrayType *ast.ArrayType,
 			if ident.Name == "byte" {
 				// byte slices are a special case as they are treated as strings.
 				// Pretend the ident is a string so that checkString can process it as expected.
-				// In DV, +k8s:maxBytes (not +k8s:maxLength) is the correct tag for []byte fields,
+				// In DV, k8s:maxBytes (not k8s:maxLength) is the correct tag for []byte fields,
 				// as it constrains byte count rather than Unicode character count.
 				i := &ast.Ident{
 					NamePos: ident.NamePos,
 					Name:    "string",
 				}
-				checkString(pass, i, node, aliases, markersAccess, prefix, a.preferredMaxLengthMarker, a.needsByteSliceMaxLength)
+				suggestedMarker := a.preferredMaxLengthMarker
+				if suggestedMarker == markers.K8sMaxLengthMarker {
+					suggestedMarker = markers.K8sMaxBytesMarker
+				}
+				checkString(pass, i, node, aliases, markersAccess, prefix, suggestedMarker, a.needsByteSliceMaxLength)
 
 				return
 			}
@@ -189,12 +193,12 @@ func (a *analyzer) checkArrayType(pass *analysis.Pass, arrayType *ast.ArrayType,
 }
 
 // checkMapType checks that map[string]V fields have a maximum properties marker.
-// Only string-keyed maps are checked, mirroring the DV constraint that +k8s:maxProperties
-// applies to map[string]V types only.
+// Only string-keyed maps are checked, mirroring the constraint that maxProperties
+// validation only applies to map[string]V types.
 func (a *analyzer) checkMapType(pass *analysis.Pass, mapType *ast.MapType, node ast.Node, aliases []*ast.TypeSpec, markersAccess markershelper.Markers, prefix string) {
-	// DV +k8s:maxProperties only supports string-keyed maps.
+	// Map maxProperties validation only supports string-keyed maps.
 	// Skip non-string-keyed maps (e.g. map[int]string) to avoid false positives.
-	if keyIdent, ok := mapType.Key.(*ast.Ident); !ok || keyIdent.Name != "string" {
+	if !utils.IsStringType(pass, mapType.Key) {
 		return
 	}
 
@@ -267,7 +271,7 @@ func (a *analyzer) needsStringMaxLength(markerSet markershelper.MarkerSet) bool
 }
 
 // needsByteSliceMaxLength is like needsStringMaxLength but enforces that for DV markers,
-// +k8s:maxBytes is used instead of +k8s:maxLength (which counts characters).
+// k8s:maxBytes is used instead of k8s:maxLength (which counts characters).
 func (a *analyzer) needsByteSliceMaxLength(markerSet markershelper.MarkerSet) bool {
 	switch {
 	case markerSet.Has(markers.KubebuilderMaxLengthMarker),

pkg/analysis/maxlength/testdata/src/a/c.go

@@ -58,14 +58,21 @@ type DVMaxLength struct {
 	MapWithNoMaxProperties map[string]string // want `field DVMaxLength.MapWithNoMaxProperties must have a maximum properties, add kubebuilder:validation:MaxProperties marker`
 
 	// Non-string-keyed map — should NOT lint.
-	// DV +k8s:maxProperties only supports string-keyed maps; linter mirrors this constraint.
+	// Map maxProperties validation only supports string-keyed maps; linter mirrors this constraint.
 	MapWithIntKey map[int]string
 
 	// DV maxLength applied to []byte — SHOULD lint.
-	// +k8s:maxLength (counts chars) is not the correct DV tag for []byte;
-	// +k8s:maxBytes (counts bytes) should be used instead.
+	// k8s:maxLength (counts chars) is not the correct DV tag for []byte;
+	// k8s:maxBytes (counts bytes) should be used instead.
 	// +k8s:maxLength=256
 	ByteSliceWithWrongDVMarker []byte // want `field DVMaxLength.ByteSliceWithWrongDVMarker must have a maximum length, add kubebuilder:validation:MaxLength marker`
+
+	// Map with string-alias key — should lint for maxProperties.
+	MapWithStringAliasKey map[StringAliasDVMaxLength]string // want `field DVMaxLength.MapWithStringAliasKey must have a maximum properties, add kubebuilder:validation:MaxProperties marker`
+
+	// Map with string-alias key with marker — should NOT lint.
+	// +kubebuilder:validation:MaxProperties:=16
+	MapWithStringAliasKeyAndMarker map[StringAliasDVMaxLength]string
 }
 
 // StringAliasDVMaxLength is a string type with the DV maxLength marker on the alias.

pkg/analysis/maxlength/testdata/src/b/b.go

@@ -15,7 +15,7 @@ type DVPreferredMaxLength struct {
 	// +k8s:maxBytes=512
 	ByteSliceWithDVMaxBytes []byte // satisfied by k8s:maxBytes — no lint
 
-	ByteSliceWithoutMax []byte // want `field DVPreferredMaxLength.ByteSliceWithoutMax must have a maximum length, add k8s:maxLength marker`
+	ByteSliceWithoutMax []byte // want `field DVPreferredMaxLength.ByteSliceWithoutMax must have a maximum length, add k8s:maxBytes marker`
 
 	// +k8s:maxItems=128
 	ArrayWithDVMaxItems []int // satisfied by k8s:maxItems — no lint
@@ -60,10 +60,10 @@ type DVPreferredMaxLength struct {
 	// +kubebuilder:validation:Format:=duration
 	KubebuilderDurationString string // kubebuilder format also exempts in DV-preferred mode — no lint
 
-	// +k8s:maxLength=256 on a []byte field is the WRONG DV marker; +k8s:maxBytes should be used.
+	// k8s:maxLength=256 on a []byte field is the WRONG DV marker; k8s:maxBytes should be used.
 	// The linter must still report the field as missing a valid max-length constraint.
 	// +k8s:maxLength=256
-	ByteSliceWithWrongDVMarker []byte // want `field DVPreferredMaxLength.ByteSliceWithWrongDVMarker must have a maximum length, add k8s:maxLength marker`
+	ByteSliceWithWrongDVMarker []byte // want `field DVPreferredMaxLength.ByteSliceWithWrongDVMarker must have a maximum length, add k8s:maxBytes marker`
 
 	// Raw []string — needs both MaxItems and items:MaxLength.
 	// +k8s:maxItems=16
@@ -74,6 +74,13 @@ type DVPreferredMaxLength struct {
 	StringArrayWithMaxItemsWithoutElementLength []string // want `field DVPreferredMaxLength.StringArrayWithMaxItemsWithoutElementLength array element must have a maximum length, add kubebuilder:validation:items:MaxLength`
 
 	StringArrayWithoutMaxItemsOrElementLength []string // want `field DVPreferredMaxLength.StringArrayWithoutMaxItemsOrElementLength must have a maximum items, add k8s:maxItems marker` `field DVPreferredMaxLength.StringArrayWithoutMaxItemsOrElementLength array element must have a maximum length, add kubebuilder:validation:items:MaxLength`
+
+	// Map with string-alias key — should lint for maxProperties.
+	MapWithStringAliasKey map[StringAliasDVMaxLength]string // want `field DVPreferredMaxLength.MapWithStringAliasKey must have a maximum properties, add k8s:maxProperties marker`
+
+	// Map with string-alias key with marker — should NOT lint.
+	// +k8s:maxProperties=16
+	MapWithStringAliasKeyAndMarker map[StringAliasDVMaxLength]string
 }
 
 // StringAliasDVMaxLength is a string alias carrying a DV maxLength marker.