Merge pull request #183 from JoelSpeed/fix-preferred-markers

Fix conflicts between preferred markers and qualified name changes

Author: JoelSpeed

pkg/analysis/preferredmarkers/analyzer.go

@@ -74,8 +74,8 @@ 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.equivalentToPreferred)
+	inspect.InspectFields(func(field *ast.Field, _ extractjsontags.FieldTagInfo, markersAccess markers.Markers, qualifiedFieldName string) {
+		checkField(pass, field, markersAccess, a.equivalentToPreferred, qualifiedFieldName)
 	})
 
 	inspect.InspectTypeSpec(func(typeSpec *ast.TypeSpec, markersAccess markers.Markers) {
@@ -88,14 +88,14 @@ func (a *analyzer) run(pass *analysis.Pass) (any, error) {
 // checkField validates a single struct field for marker usage.
 // Only checks markers directly on the field, not inherited from type aliases,
 // since inherited markers are already reported at the type level.
-func checkField(pass *analysis.Pass, field *ast.Field, markersAccess markers.Markers, equivalentToPreferred map[string]string) {
+func checkField(pass *analysis.Pass, field *ast.Field, markersAccess markers.Markers, equivalentToPreferred map[string]string, qualifiedFieldName string) {
 	if field == nil || len(field.Names) == 0 {
 		return
 	}
 
 	markerSet := markersAccess.FieldMarkers(field)
 	check(markerSet, equivalentToPreferred, func(marks []markers.Marker, preferredIdentifier string, preferredExists bool) {
-		reportMarkers(pass, marks, preferredIdentifier, field.Names[0].Name, field.Pos(), "field", preferredExists)
+		reportMarkers(pass, marks, preferredIdentifier, qualifiedFieldName, field.Pos(), "field", preferredExists)
 	})
 }
 

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

@@ -44,35 +44,35 @@ type MultipleEquivalentMarkersType string // want `type MultipleEquivalentMarker
 type Test struct {
 	// Field with kubebuilder optional marker (should be k8s:optional)
 	// +kubebuilder:validation:Optional
-	OptionalFieldKubebuilder string `json:"optionalFieldKubebuilder"` // want `field OptionalFieldKubebuilder uses marker "kubebuilder:validation:Optional", should use preferred marker "k8s:optional" instead`
+	OptionalFieldKubebuilder string `json:"optionalFieldKubebuilder"` // want `field Test.OptionalFieldKubebuilder uses marker "kubebuilder:validation:Optional", should use preferred marker "k8s:optional" instead`
 
 	// Inherited from type alias (not reported since type is already checked)
 	OptionalFieldKubebuilderTypeAlias OptionalTypeKubebuilder `json:"optionalFieldKubebuilderTypeAlias"`
 
 	// Field with custom optional marker (should be k8s:optional)
 	// +custom:optional
-	OptionalFieldCustom string `json:"optionalFieldCustom"` // want `field OptionalFieldCustom uses marker "custom:optional", should use preferred marker "k8s:optional" instead`
+	OptionalFieldCustom string `json:"optionalFieldCustom"` // want `field Test.OptionalFieldCustom uses marker "custom:optional", should use preferred marker "k8s:optional" instead`
 
 	// Inherited from type alias (not reported since type is already checked)
 	OptionalFieldCustomTypeAlias OptionalTypeCustom `json:"optionalFieldCustomTypeAlias"`
 
 	// Field with kubebuilder required marker (should be k8s:required)
 	// +kubebuilder:validation:Required
-	RequiredFieldKubebuilder string `json:"requiredFieldKubebuilder"` // want `field RequiredFieldKubebuilder uses marker "kubebuilder:validation:Required", should use preferred marker "k8s:required" instead`
+	RequiredFieldKubebuilder string `json:"requiredFieldKubebuilder"` // want `field Test.RequiredFieldKubebuilder uses marker "kubebuilder:validation:Required", should use preferred marker "k8s:required" instead`
 
 	// Inherited from type alias (not reported since type is already checked)
 	RequiredFieldKubebuilderTypeAlias RequiredTypeKubebuilder `json:"requiredFieldKubebuilderTypeAlias"`
 
 	// Field with custom old marker (should be custom:preferred)
 	// +custom:old
-	CustomOldField string `json:"customOldField"` // want `field CustomOldField uses marker "custom:old", should use preferred marker "custom:preferred" instead`
+	CustomOldField string `json:"customOldField"` // want `field Test.CustomOldField uses marker "custom:old", should use preferred marker "custom:preferred" instead`
 
 	// Inherited from type alias (not reported since type is already checked)
 	CustomOldFieldTypeAlias CustomOldType `json:"customOldFieldTypeAlias"`
 
 	// Field with custom deprecated marker (should be custom:preferred)
 	// +custom:deprecated
-	CustomDeprecatedField string `json:"customDeprecatedField"` // want `field CustomDeprecatedField uses marker "custom:deprecated", should use preferred marker "custom:preferred" instead`
+	CustomDeprecatedField string `json:"customDeprecatedField"` // want `field Test.CustomDeprecatedField uses marker "custom:deprecated", should use preferred marker "custom:preferred" instead`
 
 	// Inherited from type alias (not reported since type is already checked)
 	CustomDeprecatedFieldTypeAlias CustomDeprecatedType `json:"customDeprecatedFieldTypeAlias"`
@@ -108,18 +108,18 @@ type Test struct {
 	// Field with multiple equivalent markers (both should be reported)
 	// +kubebuilder:validation:Optional
 	// +custom:optional
-	MultipleEquivalentMarkersField string `json:"multipleEquivalentMarkersField"` // want `field MultipleEquivalentMarkersField uses markers "custom:optional", "kubebuilder:validation:Optional", should use preferred marker "k8s:optional" instead`
+	MultipleEquivalentMarkersField string `json:"multipleEquivalentMarkersField"` // want `field Test.MultipleEquivalentMarkersField uses markers "custom:optional", "kubebuilder:validation:Optional", should use preferred marker "k8s:optional" instead`
 
 	// Inherited from type alias with multiple markers (not reported since type is already checked)
 	MultipleEquivalentMarkersFieldTypeAlias MultipleEquivalentMarkersType `json:"multipleEquivalentMarkersFieldTypeAlias"`
 
 	// Test marker with unnamed expression (should preserve expression)
 	// +kubebuilder:validation:Optional:=someValue
-	OptionalWithUnnamedExpression string `json:"optionalWithUnnamedExpression"` // want `field OptionalWithUnnamedExpression uses marker "kubebuilder:validation:Optional", should use preferred marker "k8s:optional" instead`
+	OptionalWithUnnamedExpression string `json:"optionalWithUnnamedExpression"` // want `field Test.OptionalWithUnnamedExpression uses marker "kubebuilder:validation:Optional", should use preferred marker "k8s:optional" instead`
 
 	// Test marker with named expressions (should preserve expressions)
 	// +custom:old:key1=val1,key2=val2
-	CustomWithNamedExpressions string `json:"customWithNamedExpressions"` // want `field CustomWithNamedExpressions uses marker "custom:old", should use preferred marker "custom:preferred" instead`
+	CustomWithNamedExpressions string `json:"customWithNamedExpressions"` // want `field Test.CustomWithNamedExpressions uses marker "custom:old", should use preferred marker "custom:preferred" instead`
 }
 
 // Type with unnamed expression (should preserve expression)
@@ -145,10 +145,10 @@ type EdgeCaseTest struct {
 	// Field with both preferred and equivalent markers (should only remove equivalent)
 	// +k8s:optional
 	// +kubebuilder:validation:Optional
-	FieldWithBothPreferredAndEquivalent string `json:"fieldWithBothPreferredAndEquivalent"` // want `field FieldWithBothPreferredAndEquivalent uses marker "kubebuilder:validation:Optional", should use preferred marker "k8s:optional" instead`
+	FieldWithBothPreferredAndEquivalent string `json:"fieldWithBothPreferredAndEquivalent"` // want `field EdgeCaseTest.FieldWithBothPreferredAndEquivalent uses marker "kubebuilder:validation:Optional", should use preferred marker "k8s:optional" instead`
 
 	// Field with both preferred and multiple equivalent markers (should remove all equivalents)
 	// +k8s:required
 	// +kubebuilder:validation:Required
-	FieldWithPreferredAndMultipleEquivalents string `json:"fieldWithPreferredAndMultipleEquivalents"` // want `field FieldWithPreferredAndMultipleEquivalents uses marker "kubebuilder:validation:Required", should use preferred marker "k8s:required" instead`
+	FieldWithPreferredAndMultipleEquivalents string `json:"fieldWithPreferredAndMultipleEquivalents"` // want `field EdgeCaseTest.FieldWithPreferredAndMultipleEquivalents uses marker "kubebuilder:validation:Required", should use preferred marker "k8s:required" instead`
 }

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

@@ -43,35 +43,35 @@ type MultipleEquivalentMarkersType string // want `type MultipleEquivalentMarker
 type Test struct {
 	// Field with kubebuilder optional marker (should be k8s:optional)
 	// +k8s:optional
-	OptionalFieldKubebuilder string `json:"optionalFieldKubebuilder"` // want `field OptionalFieldKubebuilder uses marker "kubebuilder:validation:Optional", should use preferred marker "k8s:optional" instead`
+	OptionalFieldKubebuilder string `json:"optionalFieldKubebuilder"` // want `field Test.OptionalFieldKubebuilder uses marker "kubebuilder:validation:Optional", should use preferred marker "k8s:optional" instead`
 
 	// Inherited from type alias (not reported since type is already checked)
 	OptionalFieldKubebuilderTypeAlias OptionalTypeKubebuilder `json:"optionalFieldKubebuilderTypeAlias"`
 
 	// Field with custom optional marker (should be k8s:optional)
 	// +k8s:optional
-	OptionalFieldCustom string `json:"optionalFieldCustom"` // want `field OptionalFieldCustom uses marker "custom:optional", should use preferred marker "k8s:optional" instead`
+	OptionalFieldCustom string `json:"optionalFieldCustom"` // want `field Test.OptionalFieldCustom uses marker "custom:optional", should use preferred marker "k8s:optional" instead`
 
 	// Inherited from type alias (not reported since type is already checked)
 	OptionalFieldCustomTypeAlias OptionalTypeCustom `json:"optionalFieldCustomTypeAlias"`
 
 	// Field with kubebuilder required marker (should be k8s:required)
 	// +k8s:required
-	RequiredFieldKubebuilder string `json:"requiredFieldKubebuilder"` // want `field RequiredFieldKubebuilder uses marker "kubebuilder:validation:Required", should use preferred marker "k8s:required" instead`
+	RequiredFieldKubebuilder string `json:"requiredFieldKubebuilder"` // want `field Test.RequiredFieldKubebuilder uses marker "kubebuilder:validation:Required", should use preferred marker "k8s:required" instead`
 
 	// Inherited from type alias (not reported since type is already checked)
 	RequiredFieldKubebuilderTypeAlias RequiredTypeKubebuilder `json:"requiredFieldKubebuilderTypeAlias"`
 
 	// Field with custom old marker (should be custom:preferred)
 	// +custom:preferred
-	CustomOldField string `json:"customOldField"` // want `field CustomOldField uses marker "custom:old", should use preferred marker "custom:preferred" instead`
+	CustomOldField string `json:"customOldField"` // want `field Test.CustomOldField uses marker "custom:old", should use preferred marker "custom:preferred" instead`
 
 	// Inherited from type alias (not reported since type is already checked)
 	CustomOldFieldTypeAlias CustomOldType `json:"customOldFieldTypeAlias"`
 
 	// Field with custom deprecated marker (should be custom:preferred)
 	// +custom:preferred
-	CustomDeprecatedField string `json:"customDeprecatedField"` // want `field CustomDeprecatedField uses marker "custom:deprecated", should use preferred marker "custom:preferred" instead`
+	CustomDeprecatedField string `json:"customDeprecatedField"` // want `field Test.CustomDeprecatedField uses marker "custom:deprecated", should use preferred marker "custom:preferred" instead`
 
 	// Inherited from type alias (not reported since type is already checked)
 	CustomDeprecatedFieldTypeAlias CustomDeprecatedType `json:"customDeprecatedFieldTypeAlias"`
@@ -106,18 +106,18 @@ type Test struct {
 
 	// Field with multiple equivalent markers (both should be reported)
 	// +k8s:optional
-	MultipleEquivalentMarkersField string `json:"multipleEquivalentMarkersField"` // want `field MultipleEquivalentMarkersField uses markers "custom:optional", "kubebuilder:validation:Optional", should use preferred marker "k8s:optional" instead`
+	MultipleEquivalentMarkersField string `json:"multipleEquivalentMarkersField"` // want `field Test.MultipleEquivalentMarkersField uses markers "custom:optional", "kubebuilder:validation:Optional", should use preferred marker "k8s:optional" instead`
 
 	// Inherited from type alias with multiple markers (not reported since type is already checked)
 	MultipleEquivalentMarkersFieldTypeAlias MultipleEquivalentMarkersType `json:"multipleEquivalentMarkersFieldTypeAlias"`
 
 	// Test marker with unnamed expression (should preserve expression)
 	// +k8s:optional=someValue
-	OptionalWithUnnamedExpression string `json:"optionalWithUnnamedExpression"` // want `field OptionalWithUnnamedExpression uses marker "kubebuilder:validation:Optional", should use preferred marker "k8s:optional" instead`
+	OptionalWithUnnamedExpression string `json:"optionalWithUnnamedExpression"` // want `field Test.OptionalWithUnnamedExpression uses marker "kubebuilder:validation:Optional", should use preferred marker "k8s:optional" instead`
 
 	// Test marker with named expressions (should preserve expressions)
 	// +custom:preferred:key1=val1,key2=val2
-	CustomWithNamedExpressions string `json:"customWithNamedExpressions"` // want `field CustomWithNamedExpressions uses marker "custom:old", should use preferred marker "custom:preferred" instead`
+	CustomWithNamedExpressions string `json:"customWithNamedExpressions"` // want `field Test.CustomWithNamedExpressions uses marker "custom:old", should use preferred marker "custom:preferred" instead`
 }
 
 // Type with unnamed expression (should preserve expression)
@@ -139,9 +139,9 @@ type TypeWithPreferredAndMultipleEquivalents string // want `type TypeWithPrefer
 type EdgeCaseTest struct {
 	// Field with both preferred and equivalent markers (should only remove equivalent)
 	// +k8s:optional
-	FieldWithBothPreferredAndEquivalent string `json:"fieldWithBothPreferredAndEquivalent"` // want `field FieldWithBothPreferredAndEquivalent uses marker "kubebuilder:validation:Optional", should use preferred marker "k8s:optional" instead`
+	FieldWithBothPreferredAndEquivalent string `json:"fieldWithBothPreferredAndEquivalent"` // want `field EdgeCaseTest.FieldWithBothPreferredAndEquivalent uses marker "kubebuilder:validation:Optional", should use preferred marker "k8s:optional" instead`
 
 	// Field with both preferred and multiple equivalent markers (should remove all equivalents)
 	// +k8s:required
-	FieldWithPreferredAndMultipleEquivalents string `json:"fieldWithPreferredAndMultipleEquivalents"` // want `field FieldWithPreferredAndMultipleEquivalents uses marker "kubebuilder:validation:Required", should use preferred marker "k8s:required" instead`
+	FieldWithPreferredAndMultipleEquivalents string `json:"fieldWithPreferredAndMultipleEquivalents"` // want `field EdgeCaseTest.FieldWithPreferredAndMultipleEquivalents uses marker "kubebuilder:validation:Required", should use preferred marker "k8s:required" instead`
 }