Merge pull request kubernetes-sigs#84 from JoelSpeed/types-from-other-files-duplicates-statusoptional

Account for types from other files in statusoptional/duplicatemarkers

Author: k8s-ci-robot

pkg/analysis/duplicatemarkers/analyzer.go

@@ -27,6 +27,7 @@ import (
 	"sigs.k8s.io/kube-api-linter/pkg/analysis/helpers/extractjsontags"
 	"sigs.k8s.io/kube-api-linter/pkg/analysis/helpers/inspector"
 	"sigs.k8s.io/kube-api-linter/pkg/analysis/helpers/markers"
+	"sigs.k8s.io/kube-api-linter/pkg/analysis/utils"
 )
 
 const (
@@ -90,7 +91,7 @@ func collectMarkers(pass *analysis.Pass, markersAccess markers.Markers, field *a
 		return markers
 	}
 
-	typeSpec, ok := ident.Obj.Decl.(*ast.TypeSpec)
+	typeSpec, ok := utils.LookupTypeSpec(pass, ident)
 	if !ok {
 		return markers
 	}

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

@@ -76,6 +76,11 @@ type DuplicateMarkerSpec struct { // want "DuplicateMarkerSpec has duplicated ma
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="replicas must be immutable"
 	// +kubebuilder:validation:XValidation:message="must be 1 to 5",rule="self >= 1 && self <= 3"
 	DuplicatedUnorderedValidationReplicas *int `json:"duplicatedUnorderedValidationReplicas"` // want "DuplicatedUnorderedValidationReplicas has duplicated markers kubebuilder:validation:XValidation:message=\"must be 1 to 5\",rule=\"self >= 1 && self <= 3\""
+
+	StringFromAnotherFile StringFromAnotherFile `json:"stringFromAnotherFile"`
+
+	// +kubebuilder:validation:MaxLength=10
+	StringFromAnotherFileWithMaxLength StringFromAnotherFile `json:"stringFromAnotherFileWithMaxLength"` // want "StringFromAnotherFileWithMaxLength has duplicated markers kubebuilder:validation:MaxLength=10"
 }
 
 type Map struct {

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

@@ -66,6 +66,10 @@ type DuplicateMarkerSpec struct { // want "DuplicateMarkerSpec has duplicated ma
 	// +kubebuilder:validation:XValidation:rule="self >= 1 && self <= 3",message="must be 1 to 5"
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="replicas must be immutable"
 	DuplicatedUnorderedValidationReplicas *int `json:"duplicatedUnorderedValidationReplicas"` // want "DuplicatedUnorderedValidationReplicas has duplicated markers kubebuilder:validation:XValidation:message=\"must be 1 to 5\",rule=\"self >= 1 && self <= 3\""
+
+    StringFromAnotherFile StringFromAnotherFile `json:"stringFromAnotherFile"`
+
+	StringFromAnotherFileWithMaxLength StringFromAnotherFile `json:"stringFromAnotherFileWithMaxLength"` // want "StringFromAnotherFileWithMaxLength has duplicated markers kubebuilder:validation:MaxLength=10"
 }
 
 type Map struct {

pkg/analysis/duplicatemarkers/testdata/src/a/b.go

@@ -0,0 +1,4 @@
+package a
+
+// +kubebuilder:validation:MaxLength=10
+type StringFromAnotherFile string

pkg/analysis/duplicatemarkers/testdata/src/a/go.mod

@@ -84,7 +84,7 @@ func (a *analyzer) run(pass *analysis.Pass) (any, error) {
 			return
 		}
 
-		statusStructType := getStructFromField(field)
+		statusStructType := getStructFromField(pass, field)
 		if statusStructType == nil {
 			return
 		}
@@ -114,7 +114,7 @@ func (a *analyzer) checkStatusStruct(pass *analysis.Pass, statusType *ast.Struct
 				continue
 			}
 			// Check embedded structs recursively
-			a.checkStatusStruct(pass, getStructFromField(childField), markersAccess, jsonTags)
+			a.checkStatusStruct(pass, getStructFromField(pass, childField), markersAccess, jsonTags)
 		default:
 			// Check if the field has the required optional markers
 			a.checkFieldOptionalMarker(pass, childField, fieldName, markersAccess)
@@ -240,13 +240,13 @@ func createMarkerRemovalEdits(fieldMarkers markershelper.MarkerSet) []analysis.T
 }
 
 // getStructFromField extracts the struct type from an AST Field.
-func getStructFromField(field *ast.Field) *ast.StructType {
+func getStructFromField(pass *analysis.Pass, field *ast.Field) *ast.StructType {
 	ident, ok := field.Type.(*ast.Ident)
 	if !ok {
 		return nil
 	}
 
-	typeSpec, ok := ident.Obj.Decl.(*ast.TypeSpec)
+	typeSpec, ok := utils.LookupTypeSpec(pass, ident)
 	if !ok {
 		return nil
 	}

pkg/analysis/duplicatemarkers/testdata/src/a/go.sum

@@ -20,6 +20,11 @@ type StatusWithEmbeddings struct {
 
 	// Pointer to non-inlined embed with omitempty
 	*PointerOmitEmptyEmbed `json:"pointerOmitEmpty,omitempty"` // want "status field \"PointerOmitEmptyEmbed\" must be marked as optional"
+
+	// NonInlinedStructFromAnotherFile imports a type from another file
+	NonInlinedStructFromAnotherFile StructFromAnotherFile `json:"nonInlinedStructFromAnotherFile"` // want "status field \"NonInlinedStructFromAnotherFile\" must be marked as optional"
+
+	StructFromAnotherFile `json:",inline"`
 }
 
 type InlineEmbed struct {

pkg/analysis/statusoptional/analyzer.go

@@ -24,6 +24,12 @@ type StatusWithEmbeddings struct {
 	// Pointer to non-inlined embed with omitempty
 	// +optional
 	*PointerOmitEmptyEmbed `json:"pointerOmitEmpty,omitempty"` // want "status field \"PointerOmitEmptyEmbed\" must be marked as optional"
+
+	// NonInlinedStructFromAnotherFile imports a type from another file
+    // +optional
+	NonInlinedStructFromAnotherFile StructFromAnotherFile `json:"nonInlinedStructFromAnotherFile"` // want "status field \"NonInlinedStructFromAnotherFile\" must be marked as optional"
+
+	StructFromAnotherFile `json:",inline"`
 }
 
 type InlineEmbed struct {

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

@@ -0,0 +1,3 @@
+package a
+
+type StructFromAnotherFile struct{}