Print qualified field name in error messages

Author: Karthik-K-N

pkg/analysis/arrayofstruct/analyzer.go

@@ -44,14 +44,14 @@ func run(pass *analysis.Pass) (any, error) {
 		return nil, kalerrors.ErrCouldNotGetInspector
 	}
 
-	inspect.InspectFields(func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, markersAccess markershelper.Markers) {
-		checkField(pass, field, markersAccess)
+	inspect.InspectFields(func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, markersAccess markershelper.Markers, qualifiedFieldName string) {
+		checkField(pass, field, markersAccess, qualifiedFieldName)
 	})
 
 	return nil, nil //nolint:nilnil
 }
 
-func checkField(pass *analysis.Pass, field *ast.Field, markersAccess markershelper.Markers) {
+func checkField(pass *analysis.Pass, field *ast.Field, markersAccess markershelper.Markers, qualifiedFieldName string) {
 	// Get the element type of the array
 	elementType := getArrayElementType(pass, field)
 	if elementType == nil {
@@ -79,7 +79,7 @@ func checkField(pass *analysis.Pass, field *ast.Field, markersAccess markershelp
 		return
 	}
 
-	reportArrayOfStructIssue(pass, field)
+	reportArrayOfStructIssue(pass, field, qualifiedFieldName)
 }
 
 // getArrayElementType extracts the element type from an array field.
@@ -107,19 +107,8 @@ func getArrayElementType(pass *analysis.Pass, field *ast.Field) ast.Expr {
 }
 
 // reportArrayOfStructIssue reports a diagnostic for an array of structs without required fields.
-func reportArrayOfStructIssue(pass *analysis.Pass, field *ast.Field) {
-	fieldName := utils.FieldName(field)
-	structName := utils.GetStructNameForField(pass, field)
-
-	var prefix string
-	if structName != "" {
-		prefix = fmt.Sprintf("%s.%s", structName, fieldName)
-	} else {
-		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 required to prevent ambiguous YAML configurations", prefix)
-
+func reportArrayOfStructIssue(pass *analysis.Pass, field *ast.Field, qualifiedFieldName string) {
+	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", qualifiedFieldName)
 	pass.Report(analysis.Diagnostic{
 		Pos:     field.Pos(),
 		Message: message,

pkg/analysis/commentstart/analyzer.go

@@ -47,7 +47,7 @@ func run(pass *analysis.Pass) (any, error) {
 		return nil, kalerrors.ErrCouldNotGetInspector
 	}
 
-	inspect.InspectFields(func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, _ markers.Markers) {
+	inspect.InspectFields(func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, _ markers.Markers, _ string) {
 		checkField(pass, field, jsonTagInfo)
 	})
 

pkg/analysis/conflictingmarkers/analyzer.go

@@ -67,26 +67,26 @@ func (a *analyzer) run(pass *analysis.Pass) (any, error) {
 		return nil, kalerrors.ErrCouldNotGetInspector
 	}
 
-	inspect.InspectFields(func(field *ast.Field, _ extractjsontags.FieldTagInfo, markersAccess markers.Markers) {
-		checkField(pass, field, markersAccess, a.conflictSets)
+	inspect.InspectFields(func(field *ast.Field, _ extractjsontags.FieldTagInfo, markersAccess markers.Markers, qualifiedFieldName string) {
+		checkField(pass, field, markersAccess, a.conflictSets, qualifiedFieldName)
 	})
 
 	return nil, nil //nolint:nilnil
 }
 
-func checkField(pass *analysis.Pass, field *ast.Field, markersAccess markers.Markers, conflictSets []ConflictSet) {
+func checkField(pass *analysis.Pass, field *ast.Field, markersAccess markers.Markers, conflictSets []ConflictSet, qualifiedFieldName string) {
 	if field == nil || len(field.Names) == 0 {
 		return
 	}
 
 	markers := utils.TypeAwareMarkerCollectionForField(pass, markersAccess, field)
 
 	for _, conflictSet := range conflictSets {
-		checkConflict(pass, field, markers, conflictSet)
+		checkConflict(pass, field, markers, conflictSet, qualifiedFieldName)
 	}
 }
 
-func checkConflict(pass *analysis.Pass, field *ast.Field, markers markers.MarkerSet, conflictSet ConflictSet) {
+func checkConflict(pass *analysis.Pass, field *ast.Field, markers markers.MarkerSet, conflictSet ConflictSet, qualifiedFieldName string) {
 	// Track which sets have markers present
 	conflictingMarkers := make([]sets.Set[string], 0)
 
@@ -106,11 +106,11 @@ func checkConflict(pass *analysis.Pass, field *ast.Field, markers markers.Marker
 
 	// If two or more sets have markers, report the conflict
 	if len(conflictingMarkers) >= 2 {
-		reportConflict(pass, field, conflictSet, conflictingMarkers)
+		reportConflict(pass, field, conflictSet, conflictingMarkers, qualifiedFieldName)
 	}
 }
 
-func reportConflict(pass *analysis.Pass, field *ast.Field, conflictSet ConflictSet, conflictingMarkers []sets.Set[string]) {
+func reportConflict(pass *analysis.Pass, field *ast.Field, conflictSet ConflictSet, conflictingMarkers []sets.Set[string], qualifiedFieldName string) {
 	// Build a descriptive message showing which sets conflict
 	setDescriptions := make([]string, 0, len(conflictingMarkers))
 
@@ -119,15 +119,8 @@ func reportConflict(pass *analysis.Pass, field *ast.Field, conflictSet ConflictS
 		setDescriptions = append(setDescriptions, fmt.Sprintf("%v", markersList))
 	}
 
-	fieldName := utils.FieldName(field)
-	structName := utils.GetStructNameForField(pass, field)
-
-	if structName != "" {
-		fieldName = structName + "." + fieldName
-	}
-
 	message := fmt.Sprintf("field %s has conflicting markers: %s: {%s}. %s",
-		fieldName,
+		qualifiedFieldName,
 		conflictSet.Name,
 		strings.Join(setDescriptions, ", "),
 		conflictSet.Description)

pkg/analysis/duplicatemarkers/analyzer.go

@@ -48,7 +48,7 @@ func run(pass *analysis.Pass) (any, error) {
 		return nil, kalerrors.ErrCouldNotGetInspector
 	}
 
-	inspect.InspectFields(func(field *ast.Field, _ extractjsontags.FieldTagInfo, markersAccess markers.Markers) {
+	inspect.InspectFields(func(field *ast.Field, _ extractjsontags.FieldTagInfo, markersAccess markers.Markers, _ string) {
 		checkField(pass, field, markersAccess)
 	})
 

pkg/analysis/forbiddenmarkers/analyzer.go

@@ -61,7 +61,7 @@ func (a *analyzer) run(pass *analysis.Pass) (any, error) {
 		return nil, kalerrors.ErrCouldNotGetInspector
 	}
 
-	inspect.InspectFields(func(field *ast.Field, _ extractjsontags.FieldTagInfo, markersAccess markers.Markers) {
+	inspect.InspectFields(func(field *ast.Field, _ extractjsontags.FieldTagInfo, markersAccess markers.Markers, _ string) {
 		checkField(pass, field, markersAccess, a.forbiddenMarkers)
 	})
 

pkg/analysis/helpers/inspector/analyzer_test.go

@@ -49,7 +49,7 @@ func run(pass *analysis.Pass) (any, error) {
 		return nil, errCouldNotGetInspector
 	}
 
-	inspect.InspectFields(func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, _ markers.Markers) {
+	inspect.InspectFields(func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, _ markers.Markers, _ string) {
 		pass.Reportf(field.Pos(), "field: %v", utils.FieldName(field))
 
 		if jsonTagInfo.Name != "" {

pkg/analysis/helpers/inspector/inspector.go

@@ -19,6 +19,7 @@ import (
 	"fmt"
 	"go/ast"
 	"go/token"
+	"slices"
 
 	astinspector "golang.org/x/tools/go/ast/inspector"
 	"sigs.k8s.io/kube-api-linter/pkg/analysis/helpers/extractjsontags"
@@ -30,10 +31,10 @@ import (
 // Inspector is an interface that allows for the inspection of fields in structs.
 type Inspector interface {
 	// InspectFields is a function that iterates over fields in structs.
-	InspectFields(func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, markersAccess markers.Markers))
+	InspectFields(func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, markersAccess markers.Markers, qualifiedFieldName string))
 
 	// InspectFieldsIncludingListTypes is a function that iterates over fields in structs, including list types.
-	InspectFieldsIncludingListTypes(func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, markersAccess markers.Markers))
+	InspectFieldsIncludingListTypes(func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, markersAccess markers.Markers, qualifiedFieldName string))
 
 	// InspectTypeSpec is a function that inspects the type spec and calls the provided inspectTypeSpec function.
 	InspectTypeSpec(func(typeSpec *ast.TypeSpec, markersAccess markers.Markers))
@@ -58,19 +59,19 @@ func newInspector(astinspector *astinspector.Inspector, jsonTags extractjsontags
 // InspectFields iterates over fields in structs, ignoring any struct that is not a type declaration, and any field that is ignored and
 // therefore would not be included in the CRD spec.
 // For the remaining fields, it calls the provided inspectField function to apply analysis logic.
-func (i *inspector) InspectFields(inspectField func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, markersAccess markers.Markers)) {
+func (i *inspector) InspectFields(inspectField func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, markersAccess markers.Markers, qualifiedFieldName string)) {
 	i.inspectFields(inspectField, true)
 }
 
 // InspectFieldsIncludingListTypes iterates over fields in structs, including list types.
 // Unlike InspectFields, this method does not skip fields in list type structs.
-func (i *inspector) InspectFieldsIncludingListTypes(inspectField func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, markersAccess markers.Markers)) {
+func (i *inspector) InspectFieldsIncludingListTypes(inspectField func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, markersAccess markers.Markers, qualifiedFieldName string)) {
 	i.inspectFields(inspectField, false)
 }
 
 // inspectFields is a shared implementation for field iteration.
 // The skipListTypes parameter controls whether list type structs should be skipped.
-func (i *inspector) inspectFields(inspectField func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, markersAccess markers.Markers), skipListTypes bool) {
+func (i *inspector) inspectFields(inspectField func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, markersAccess markers.Markers, qualifiedFieldName string), skipListTypes bool) {
 	// Filter to fields so that we can iterate over fields in a struct.
 	nodeFilter := []ast.Node{
 		(*ast.Field)(nil),
@@ -90,7 +91,21 @@ func (i *inspector) inspectFields(inspectField func(field *ast.Field, jsonTagInf
 			return false
 		}
 
-		i.processFieldWithRecovery(field, inspectField)
+		var structName string
+
+		qualifiedFieldName := utils.FieldName(field)
+
+		// The 0th node in the stack is the *ast.File.
+		file, ok := stack[0].(*ast.File)
+		if ok {
+			structName = getStructName(file, field)
+		}
+
+		if structName != "" {
+			qualifiedFieldName = fmt.Sprintf("%s.%s", structName, qualifiedFieldName)
+		}
+
+		i.processFieldWithRecovery(field, qualifiedFieldName, inspectField)
 
 		return true
 	})
@@ -138,7 +153,7 @@ func (i *inspector) shouldSkipField(field *ast.Field) bool {
 }
 
 // processFieldWithRecovery processes a field with panic recovery.
-func (i *inspector) processFieldWithRecovery(field *ast.Field, inspectField func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, markersAccess markers.Markers)) {
+func (i *inspector) processFieldWithRecovery(field *ast.Field, qualifiedFieldName string, inspectField func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, markersAccess markers.Markers, qualifiedFieldName string)) {
 	tagInfo := i.jsonTags.FieldTags(field)
 
 	defer func() {
@@ -149,7 +164,7 @@ func (i *inspector) processFieldWithRecovery(field *ast.Field, inspectField func
 		}
 	}()
 
-	inspectField(field, tagInfo, i.markers)
+	inspectField(field, tagInfo, i.markers, qualifiedFieldName)
 }
 
 // InspectTypeSpec inspects the type spec and calls the provided inspectTypeSpec function.
@@ -183,3 +198,45 @@ func printDebugInfo(field *ast.Field) string {
 
 	return debug
 }
+
+func getStructName(file *ast.File, field *ast.Field) string {
+	var (
+		structName string
+		found      bool
+	)
+
+	ast.Inspect(file, func(n ast.Node) bool {
+		if found {
+			return false
+		}
+
+		typeSpec, ok := n.(*ast.TypeSpec)
+		if !ok {
+			return true
+		}
+
+		structType, ok := typeSpec.Type.(*ast.StructType)
+		if !ok {
+			return true
+		}
+
+		structName = typeSpec.Name.Name
+
+		if structType.Fields == nil {
+			return true
+		}
+
+		if slices.Contains(structType.Fields.List, field) {
+			found = true
+			return false
+		}
+
+		return true
+	})
+
+	if found {
+		return structName
+	}
+
+	return ""
+}

pkg/analysis/jsontags/analyzer.go

@@ -71,7 +71,7 @@ func (a *analyzer) run(pass *analysis.Pass) (any, error) {
 		return nil, kalerrors.ErrCouldNotGetInspector
 	}
 
-	inspect.InspectFieldsIncludingListTypes(func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, _ markers.Markers) {
+	inspect.InspectFieldsIncludingListTypes(func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, _ markers.Markers, _ string) {
 		a.checkField(pass, field, jsonTagInfo)
 	})
 

pkg/analysis/maxlength/analyzer.go

@@ -47,7 +47,7 @@ func run(pass *analysis.Pass) (any, error) {
 		return nil, kalerrors.ErrCouldNotGetInspector
 	}
 
-	inspect.InspectFields(func(field *ast.Field, _ extractjsontags.FieldTagInfo, markersAccess markershelper.Markers) {
+	inspect.InspectFields(func(field *ast.Field, _ extractjsontags.FieldTagInfo, markersAccess markershelper.Markers, _ string) {
 		checkField(pass, field, markersAccess)
 	})
 

pkg/analysis/minlength/analyzer.go

@@ -47,7 +47,7 @@ func run(pass *analysis.Pass) (any, error) {
 		return nil, kalerrors.ErrCouldNotGetInspector
 	}
 
-	inspect.InspectFields(func(field *ast.Field, _ extractjsontags.FieldTagInfo, markersAccess markershelper.Markers) {
+	inspect.InspectFields(func(field *ast.Field, _ extractjsontags.FieldTagInfo, markersAccess markershelper.Markers, _ string) {
 		checkField(pass, field, markersAccess)
 	})