Ensure types from other files can be reported

Author: JoelSpeed

pkg/analysis/optionalfields/analyzer.go

@@ -26,6 +26,7 @@ import (
 	"sigs.k8s.io/kube-api-linter/pkg/analysis/helpers/extractjsontags"
 	"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/config"
 	"sigs.k8s.io/kube-api-linter/pkg/markers"
 
@@ -231,28 +232,28 @@ func (a *analyzer) checkFieldPointersPreferenceWhenRequired(pass *analysis.Pass,
 		return
 	}
 
-	if ident.Obj != nil {
-		// The field is not a simple type, check the object if it is a type spec.
-		decl, ok := ident.Obj.Decl.(*ast.TypeSpec)
-		if !ok {
-			return
-		}
-
-		a.checkFieldPointersPreferenceWhenRequiredIdentObj(pass, field, fieldName, isStarExpr, decl, markersAccess, jsonTags)
-
-		return
-	}
-
 	switch ident.Name {
 	case "int", "int8", "int16", "int32", "int64", "uint", "uint8", "uint16", "uint32", "uint64":
 		a.checkFieldPointersPreferenceWhenRequiredInteger(pass, field, fieldName, isStarExpr, markersAccess, jsonTags)
+		return
 	case "string":
 		a.checkFieldPointersPreferenceWhenRequiredString(pass, field, fieldName, isStarExpr, markersAccess, jsonTags)
+		return
 	case "bool":
 		a.checkFieldPointersPreferenceWhenRequiredBool(pass, field, fieldName, isStarExpr, jsonTags)
+		return
 	case "float32", "float64":
 		a.checkFieldPointersPreferenceWhenRequiredFloat(pass, field, fieldName, isStarExpr, markersAccess, jsonTags)
+		return
 	}
+
+	// The field is not a simple type in our switch, so try looking up the type spec.
+	typeSpec, ok := utils.LookupTypeSpec(pass, ident)
+	if !ok {
+		return
+	}
+
+	a.checkFieldPointersPreferenceWhenRequiredIdentObj(pass, field, fieldName, isStarExpr, typeSpec, markersAccess, jsonTags)
 }
 
 func (a *analyzer) checkFieldPointersPreferenceWhenRequiredIdentObj(pass *analysis.Pass, field *ast.Field, fieldName string, isStarExpr bool, decl *ast.TypeSpec, markersAccess markershelper.Markers, jsonTags extractjsontags.FieldTagInfo) {

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

@@ -74,6 +74,11 @@ type A struct {
 	// +optional
 	PointerStringAlias *StringAlias `json:"pointerStringAlias,omitempty"`
 
+	// PointerStringAliasFromAnotherFile is a pointer string alias field.
+	// It proves that we can use types defined in other files.
+	// +optional
+	StringAliasFromAnotherFile *StringAliasFromAnotherFile `json:"pointerStringAliasFromAnotherFile,omitempty"`
+
 	// PointerIntAlias is a pointer int alias field.
 	// +optional
 	PointerIntAlias *IntAlias `json:"pointerIntAlias,omitempty"`

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

@@ -74,6 +74,11 @@ type A struct {
 	// +optional
 	PointerStringAlias *StringAlias `json:"pointerStringAlias,omitempty"`
 
+    // PointerStringAliasFromAnotherFile is a pointer string alias field.
+	// It proves that we can use types defined in other files.
+	// +optional
+	StringAliasFromAnotherFile *StringAliasFromAnotherFile `json:"pointerStringAliasFromAnotherFile,omitempty"`
+
 	// PointerIntAlias is a pointer int alias field.
 	// +optional
 	PointerIntAlias *IntAlias `json:"pointerIntAlias,omitempty"`

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

@@ -0,0 +1,3 @@
+package a
+
+type StringAliasFromAnotherFile string

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

@@ -179,6 +179,10 @@ type A struct {
 	// +optional
 	StructWithRequiredFields C `json:"structWithRequiredFields,omitempty"` // want "field StructWithRequiredFields is optional, but contains required field\\(s\\) and should be a pointer"
 
+	// structWithRequiredFieldsFromAnotherFile is a struct field.
+	// +optional
+	StructWithRequiredFieldsFromAnotherFile StructWithRequiredField `json:"structWithRequiredFields,omitempty"` // want "field StructWithRequiredFieldsFromAnotherFile is optional, but contains required field\\(s\\) and should be a pointer"
+
 	// pointerStructWithOptionalFields is a pointer struct field.
 	// +optional
 	PointerStructWithOptionalFields *B `json:"pointerStructWithOptionalFields,omitempty"` // want "field PointerStructWithOptionalFields is optional, and contains no required field\\(s\\) and does not need to be a pointer"
@@ -187,6 +191,10 @@ type A struct {
 	// +optional
 	PointerStructWithRequiredFields *C `json:"pointerStructWithRequiredFields,omitempty"`
 
+	// pointerStructWithRequiredFromAnotherFile is a pointer struct field.
+	// +optional
+	PointerStructWithRequiredFromAnotherFile *StructWithRequiredField `json:"pointerStructWithRequiredFromAnotherFile,omitempty"`
+
 	// bool is a boolean field.
 	// +optional
 	Bool bool `json:"bool,omitempty"` // want "field Bool is an optional boolean and should be a pointer"

pkg/analysis/optionalfields/testdata/src/b/a.go.golden

@@ -180,6 +180,10 @@ type A struct {
 	// +optional
 	StructWithRequiredFields *C `json:"structWithRequiredFields,omitempty"` // want "field StructWithRequiredFields is optional, but contains required field\\(s\\) and should be a pointer"
 
+    // structWithRequiredFieldsFromAnotherFile is a struct field.
+	// +optional
+	StructWithRequiredFieldsFromAnotherFile *StructWithRequiredField `json:"structWithRequiredFields,omitempty"` // want "field StructWithRequiredFieldsFromAnotherFile is optional, but contains required field\\(s\\) and should be a pointer"
+
 	// pointerStructWithOptionalFields is a pointer struct field.
 	// +optional
 	PointerStructWithOptionalFields B `json:"pointerStructWithOptionalFields,omitempty"` // want "field PointerStructWithOptionalFields is optional, and contains no required field\\(s\\) and does not need to be a pointer"
@@ -188,6 +192,10 @@ type A struct {
 	// +optional
 	PointerStructWithRequiredFields *C `json:"pointerStructWithRequiredFields,omitempty"`
 
+    // pointerStructWithRequiredFromAnotherFile is a pointer struct field.
+	// +optional
+	PointerStructWithRequiredFromAnotherFile *StructWithRequiredField `json:"pointerStructWithRequiredFromAnotherFile,omitempty"`
+
     // bool is a boolean field.
 	// +optional
 	Bool *bool `json:"bool,omitempty"` // want "field Bool is an optional boolean and should be a pointer"

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

@@ -0,0 +1,7 @@
+package a
+
+type StructWithRequiredField struct {
+	// tsring is a string field.
+	// +required
+	String string `json:"string"`
+}