Merge pull request #134 from sivchari/ignore-schemaless

Ignore field that has schemaless marker

Author: k8s-ci-robot

pkg/analysis/helpers/inspector/inspector.go

@@ -24,6 +24,7 @@ import (
 	"sigs.k8s.io/kube-api-linter/pkg/analysis/helpers/extractjsontags"
 	"sigs.k8s.io/kube-api-linter/pkg/analysis/helpers/markers"
 	"sigs.k8s.io/kube-api-linter/pkg/analysis/utils"
+	markersconsts "sigs.k8s.io/kube-api-linter/pkg/markers"
 )
 
 // Inspector is an interface that allows for the inspection of fields in structs.
@@ -65,58 +66,69 @@ func (i *inspector) InspectFields(inspectField func(field *ast.Field, stack []as
 			return false
 		}
 
-		if len(stack) < 3 {
-			return true
-		}
-
-		// The 0th node in the stack is the *ast.File.
-		// The 1st node in the stack is the *ast.GenDecl.
-		decl, ok := stack[1].(*ast.GenDecl)
-		if !ok {
-			// Make sure that we don't inspect structs within a function.
-			return false
+		field, ok := n.(*ast.Field)
+		if !ok || !i.shouldProcessField(stack) {
+			return ok
 		}
 
-		if decl.Tok != token.TYPE {
-			// Returning false here means we won't inspect non-type declarations (e.g. var, const, import).
+		if i.shouldSkipField(field) {
 			return false
 		}
 
-		structType, ok := stack[len(stack)-3].(*ast.StructType)
-		if !ok {
-			// A field within a struct has a FieldList parent and then a StructType parent.
-			// If we don't have a StructType parent, then we're not in a struct.
-			return false
-		}
+		i.processFieldWithRecovery(field, stack, inspectField)
 
-		if isItemsType(structType) {
-			// The field belongs to an items type, we don't need to report lint errors for this.
-			return false
-		}
+		return true
+	})
+}
 
-		field, ok := n.(*ast.Field)
-		if !ok {
-			return true
-		}
+// shouldProcessField checks if the field should be processed.
+func (i *inspector) shouldProcessField(stack []ast.Node) bool {
+	if len(stack) < 3 {
+		return false
+	}
 
-		tagInfo := i.jsonTags.FieldTags(field)
-		if tagInfo.Ignored {
-			// Returning false here means we won't inspect the children of an ignored field.
-			return false
-		}
+	// The 0th node in the stack is the *ast.File.
+	// The 1st node in the stack is the *ast.GenDecl.
+	decl, ok := stack[1].(*ast.GenDecl)
+	if !ok || decl.Tok != token.TYPE {
+		// Make sure that we don't inspect structs within a function or non-type declarations.
+		return false
+	}
 
-		defer func() {
-			if r := recover(); r != nil {
-				// If the inspectField function panics, we recover and log information that will help identify the issue.
-				debug := printDebugInfo(field)
-				panic(fmt.Sprintf("%s %v", debug, r)) // Re-panic to propagate the error.
-			}
-		}()
+	structType, ok := stack[len(stack)-3].(*ast.StructType)
+	if !ok || isItemsType(structType) {
+		// Not in a struct or belongs to an items type.
+		return false
+	}
 
-		inspectField(field, stack, tagInfo, i.markers)
+	return true
+}
 
+// shouldSkipField checks if a field should be skipped.
+func (i *inspector) shouldSkipField(field *ast.Field) bool {
+	tagInfo := i.jsonTags.FieldTags(field)
+	if tagInfo.Ignored {
 		return true
-	})
+	}
+
+	markerSet := i.markers.FieldMarkers(field)
+
+	return isSchemalessType(markerSet)
+}
+
+// processFieldWithRecovery processes a field with panic recovery.
+func (i *inspector) processFieldWithRecovery(field *ast.Field, stack []ast.Node, inspectField func(field *ast.Field, stack []ast.Node, jsonTagInfo extractjsontags.FieldTagInfo, markersAccess markers.Markers)) {
+	tagInfo := i.jsonTags.FieldTags(field)
+
+	defer func() {
+		if r := recover(); r != nil {
+			// If the inspectField function panics, we recover and log information that will help identify the issue.
+			debug := printDebugInfo(field)
+			panic(fmt.Sprintf("%s %v", debug, r)) // Re-panic to propagate the error.
+		}
+	}()
+
+	inspectField(field, stack, tagInfo, i.markers)
 }
 
 // InspectTypeSpec inspects the type spec and calls the provided inspectTypeSpec function.
@@ -163,6 +175,12 @@ func isItemsType(structType *ast.StructType) bool {
 	return true
 }
 
+func isSchemalessType(markerSet markers.MarkerSet) bool {
+	// Check if the field is marked as schemaless.
+	schemalessMarker := markerSet.Get(markersconsts.KubebuilderSchemaLessMarker)
+	return len(schemalessMarker) > 0
+}
+
 // printDebugInfo prints debug information about the field that caused a panic during inspection.
 // This function is designed to allow us to help identify which fields are causing issues during inspection.
 func printDebugInfo(field *ast.Field) string {

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

@@ -86,6 +86,11 @@ type MaxLength struct {
 
 		StringWithoutMaxLength string // want "field StringWithoutMaxLength must have a maximum length, add kubebuilder:validation:MaxLength marker"
 	} `json:"struct"`
+
+	// +optional
+	// +kubebuilder:pruning:PreserveUnknownFields
+	// +kubebuilder:validation:Schemaless
+	AllOf []JSONSchemaProps `json:"allOf,omitempty"`
 }
 
 // StringAlias is a string without a MaxLength.
@@ -105,3 +110,6 @@ type ByteSliceAlias []byte
 // ByteSliceAliasWithMaxLength is a byte slice with a MaxLength.
 // +kubebuilder:validation:MaxLength:=512
 type ByteSliceAliasWithMaxLength []byte
+
+// JSONSchemaProps is a placeholder for the JSON schema properties.
+type JSONSchemaProps struct{}

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

@@ -190,4 +190,12 @@ type SSATagsTestSpec struct {
 	// Byte array with markers - should be ignored even if markers are present
 	// +listType=atomic
 	ByteArrayWithMarker []byte `json:"byteArrayWithMarker,omitempty"` // want "ByteArrayWithMarker is a byte array, which does not support the listType marker. Remove the listType marker"
+
+	// +optional
+	// +kubebuilder:pruning:PreserveUnknownFields
+	// +kubebuilder:validation:Schemaless
+	AllOf []JSONSchemaProps `json:"allOf,omitempty"`
 }
+
+// JSONSchemaProps is a placeholder for the JSON schema properties.
+type JSONSchemaProps struct{}

pkg/analysis/ssatags/testdata/src/a/a.go.golden

@@ -189,4 +189,12 @@ type SSATagsTestSpec struct {
 
 	// Byte array with markers - should be ignored even if markers are present
 	ByteArrayWithMarker []byte `json:"byteArrayWithMarker,omitempty"` // want "ByteArrayWithMarker is a byte array, which does not support the listType marker. Remove the listType marker"
+
+	// +optional
+	// +kubebuilder:pruning:PreserveUnknownFields
+	// +kubebuilder:validation:Schemaless
+	AllOf []JSONSchemaProps `json:"allOf,omitempty"`
 }
+
+// JSONSchemaProps is a placeholder for the JSON schema properties.
+type JSONSchemaProps struct{}

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

@@ -185,4 +185,12 @@ type SSATagsTestSpec struct {
 	// Byte array with markers - should be ignored even if markers are present
 	// +listType=atomic
 	ByteArrayWithMarker []byte `json:"byteArrayWithMarker,omitempty"` // want "ByteArrayWithMarker is a byte array, which does not support the listType marker. Remove the listType marker"
+
+	// +optional
+	// +kubebuilder:pruning:PreserveUnknownFields
+	// +kubebuilder:validation:Schemaless
+	AllOf []JSONSchemaProps `json:"allOf,omitempty"`
 }
+
+// JSONSchemaProps is a placeholder for the JSON schema properties.
+type JSONSchemaProps struct{}

pkg/analysis/ssatags/testdata/src/b/b.go.golden

@@ -184,5 +184,12 @@ type SSATagsTestSpec struct {
 
 	// Byte array with markers - should be ignored even if markers are present
 	ByteArrayWithMarker []byte `json:"byteArrayWithMarker,omitempty"` // want "ByteArrayWithMarker is a byte array, which does not support the listType marker. Remove the listType marker"
+
+	// +optional
+	// +kubebuilder:pruning:PreserveUnknownFields
+	// +kubebuilder:validation:Schemaless
+	AllOf []JSONSchemaProps `json:"allOf,omitempty"`
 }
 
+// JSONSchemaProps is a placeholder for the JSON schema properties.
+type JSONSchemaProps struct{}

pkg/markers/markers.go

@@ -155,6 +155,9 @@ const (
 
 	// KubebuilderListMapKeyMarker is the marker used to specify the key field for map-type lists.
 	KubebuilderListMapKeyMarker = "listMapKey"
+
+	// KubebuilderSchemaLessMarker is the marker that indicates that a struct is schemaless.
+	KubebuilderSchemaLessMarker = "kubebuilder:validation:Schemaless"
 )
 
 const (