Merge pull request #166 from saschagrunert/arrayofstruct-followup

arrayofstruct: follow-up on review

Author: k8s-ci-robot

pkg/analysis/arrayofstruct/analyzer.go

@@ -25,7 +25,6 @@ import (
 	"sigs.k8s.io/kube-api-linter/pkg/analysis/helpers/inspector"
 	markershelper "sigs.k8s.io/kube-api-linter/pkg/analysis/helpers/markers"
 	"sigs.k8s.io/kube-api-linter/pkg/analysis/utils"
-	"sigs.k8s.io/kube-api-linter/pkg/markers"
 )
 
 const name = "arrayofstruct"
@@ -119,7 +118,7 @@ func reportArrayOfStructIssue(pass *analysis.Pass, field *ast.Field) {
 		prefix = fieldName
 	}
 
-	message := fmt.Sprintf("%s is an array of structs, but the struct has no required fields. At least one field should be marked as %s to prevent ambiguous YAML configurations", prefix, markers.RequiredMarker)
+	message := fmt.Sprintf("%s is an array of structs, but the struct has no required fields. At least one field should be marked as required to prevent ambiguous YAML configurations", prefix)
 
 	pass.Report(analysis.Diagnostic{
 		Pos:     field.Pos(),
@@ -166,6 +165,11 @@ func getStructType(pass *analysis.Pass, expr ast.Expr) *ast.StructType {
 		// Inline struct definition
 		return et
 	case *ast.Ident:
+		// Check if it's a basic type - exit condition for recursion
+		if utils.IsBasicType(pass, et) {
+			return nil
+		}
+
 		// Named struct type or type alias
 		typeSpec, ok := utils.LookupTypeSpec(pass, et)
 		if !ok {
@@ -197,12 +201,7 @@ func hasRequiredField(structType *ast.StructType, markersAccess markershelper.Ma
 	}
 
 	for _, field := range structType.Fields.List {
-		fieldMarkers := markersAccess.FieldMarkers(field)
-
-		// Check for any of the required markers
-		if fieldMarkers.Has(markers.RequiredMarker) ||
-			fieldMarkers.Has(markers.KubebuilderRequiredMarker) ||
-			fieldMarkers.Has(markers.K8sRequiredMarker) {
+		if utils.IsFieldRequired(field, markersAccess) {
 			return true
 		}
 	}

pkg/analysis/arrayofstruct/testdata/src/a/a.go

@@ -57,7 +57,7 @@ type ValidPrimitiveArray struct {
 // Invalid cases - arrays of structs without any required fields
 
 type InvalidStruct struct {
-	Items []InvalidItem // want "InvalidStruct.Items is an array of structs, but the struct has no required fields"
+	Items []InvalidItem // want "InvalidStruct.Items is an array of structs, but the struct has no required fields. At least one field should be marked as required to prevent ambiguous YAML configurations"
 }
 
 type InvalidItem struct {
@@ -69,7 +69,7 @@ type InvalidItem struct {
 }
 
 type InvalidStructWithPointer struct {
-	Items []*InvalidPointerItem // want "InvalidStructWithPointer.Items is an array of structs, but the struct has no required fields"
+	Items []*InvalidPointerItem // want "InvalidStructWithPointer.Items is an array of structs, but the struct has no required fields. At least one field should be marked as required to prevent ambiguous YAML configurations"
 }
 
 type InvalidPointerItem struct {
@@ -79,7 +79,7 @@ type InvalidPointerItem struct {
 
 type InvalidStructWithInlineStruct struct {
 	// Inline struct definitions should also be checked
-	Items []struct { // want "InvalidStructWithInlineStruct.Items is an array of structs, but the struct has no required fields"
+	Items []struct { // want "InvalidStructWithInlineStruct.Items is an array of structs, but the struct has no required fields. At least one field should be marked as required to prevent ambiguous YAML configurations"
 		// +optional
 		Name string
 	}
@@ -88,7 +88,7 @@ type InvalidStructWithInlineStruct struct {
 // Invalid case - struct with no markers at all
 
 type InvalidStructNoMarkers struct {
-	Items []InvalidItemNoMarkers // want "InvalidStructNoMarkers.Items is an array of structs, but the struct has no required fields"
+	Items []InvalidItemNoMarkers // want "InvalidStructNoMarkers.Items is an array of structs, but the struct has no required fields. At least one field should be marked as required to prevent ambiguous YAML configurations"
 }
 
 type InvalidItemNoMarkers struct {
@@ -115,20 +115,38 @@ type AllRequiredItem struct {
 type ItemAlias = InvalidItem
 
 type InvalidStructWithAlias struct {
-	Items []ItemAlias // want "InvalidStructWithAlias.Items is an array of structs, but the struct has no required fields"
+	Items []ItemAlias // want "InvalidStructWithAlias.Items is an array of structs, but the struct has no required fields. At least one field should be marked as required to prevent ambiguous YAML configurations"
 }
 
 // Test with array type alias
 
 type ArrayAlias = []InvalidItem
 
 type InvalidStructWithArrayAlias struct {
-	Items ArrayAlias // want "InvalidStructWithArrayAlias.Items is an array of structs, but the struct has no required fields"
+	Items ArrayAlias // want "InvalidStructWithArrayAlias.Items is an array of structs, but the struct has no required fields. At least one field should be marked as required to prevent ambiguous YAML configurations"
 }
 
 // Valid case with multiple array fields
 
 type ValidMultipleArrays struct {
 	ValidItems   []ValidItem
-	InvalidItems []InvalidItem // want "ValidMultipleArrays.InvalidItems is an array of structs, but the struct has no required fields"
+	InvalidItems []InvalidItem // want "ValidMultipleArrays.InvalidItems is an array of structs, but the struct has no required fields. At least one field should be marked as required to prevent ambiguous YAML configurations"
+}
+
+// Valid case - type alias to basic type (should not trigger linter)
+
+type StringAlias = string
+
+type ValidStructWithBasicTypeAlias struct {
+	// This should not trigger the linter because StringAlias resolves to string, a basic type
+	Items []StringAlias
+}
+
+// Valid case - custom type wrapping basic type (should not trigger linter)
+
+type CustomString string
+
+type ValidStructWithCustomBasicType struct {
+	// This should not trigger the linter because CustomString is based on string, a basic type
+	Items []CustomString
 }