Merge pull request #92 from JoelSpeed/debug-panic

Fix panic when files do not start with package

Author: k8s-ci-robot

pkg/analysis/helpers/inspector/inspector.go

@@ -16,12 +16,14 @@ limitations under the License.
 package inspector
 
 import (
+	"fmt"
 	"go/ast"
 	"go/token"
 
 	astinspector "golang.org/x/tools/go/ast/inspector"
 	"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"
 )
 
 // Inspector is an interface that allows for the inspection of fields in structs.
@@ -103,6 +105,14 @@ func (i *inspector) InspectFields(inspectField func(field *ast.Field, stack []as
 			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.
+			}
+		}()
+
 		inspectField(field, stack, tagInfo, i.markers)
 
 		return true
@@ -152,3 +162,13 @@ func isItemsType(structType *ast.StructType) bool {
 
 	return true
 }
+
+// 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 {
+	var debug string
+
+	debug += fmt.Sprintf("Panic observed while inspecting field: %v (type: %v)\n", utils.FieldName(field), field.Type)
+
+	return debug
+}

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

@@ -1,3 +1,22 @@
+/*
+Copyright 2025 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
 package a
 
-type StructFromAnotherFile struct{}
+type StructFromAnotherFile struct {
+	// OptionalStringField is a string field that is optional.
+	// +optional
+	OptionalStringField string `json:"optionalStringField,omitempty"`
+}

pkg/analysis/utils/utils.go

@@ -106,7 +106,7 @@ func getFilesForType(pass *analysis.Pass, ident *ast.Ident) (*token.File, *ast.F
 	tokenFile := pass.Fset.File(namedType.Obj().Pos())
 
 	for _, astFile := range pass.Files {
-		if astFile.Package == token.Pos(tokenFile.Base()) {
+		if astFile.FileStart == token.Pos(tokenFile.Base()) {
 			return tokenFile, astFile
 		}
 	}