Skip to content

refactor inspector helper to use iterators instead of callbacks #248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sivchari wants to merge 1 commit into
base: main
Choose a base branch
from
+243 −231
Open

refactor inspector helper to use iterators instead of callbacks #248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions pkg/analysis/arrayofstruct/analyzer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ import (
"golang.org/x/tools/go/analysis"

kalerrors "sigs.k8s.io/kube-api-linter/pkg/analysis/errors"
"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"
Expand Down Expand Up @@ -50,9 +49,9 @@ func run(pass *analysis.Pass) (any, error) {
return nil, kalerrors.ErrCouldNotGetInspector
}

inspect.InspectFields(func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, markersAccess markershelper.Markers, qualifiedFieldName string) {
checkField(pass, field, markersAccess, qualifiedFieldName)
})
for f := range inspect.Fields() {
checkField(pass, f.Field, f.Markers, f.QualifiedFieldName)
}

return nil, nil //nolint:nilnil
}
Expand Down
7 changes: 3 additions & 4 deletions pkg/analysis/commentstart/analyzer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ import (
kalerrors "sigs.k8s.io/kube-api-linter/pkg/analysis/errors"
"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"
)

const name = "commentstart"
Expand All @@ -45,9 +44,9 @@ func run(pass *analysis.Pass) (any, error) {
return nil, kalerrors.ErrCouldNotGetInspector
}

inspect.InspectFields(func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, _ markers.Markers, qualifiedFieldName string) {
checkField(pass, field, jsonTagInfo, qualifiedFieldName)
})
for f := range inspect.Fields() {
checkField(pass, f.Field, f.JSONTagInfo, f.QualifiedFieldName)
}

return nil, nil //nolint:nilnil
}
Expand Down
7 changes: 3 additions & 4 deletions pkg/analysis/conflictingmarkers/analyzer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ import (
"golang.org/x/tools/go/analysis"
"k8s.io/apimachinery/pkg/util/sets"
kalerrors "sigs.k8s.io/kube-api-linter/pkg/analysis/errors"
"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"
Expand Down Expand Up @@ -67,9 +66,9 @@ func (a *analyzer) run(pass *analysis.Pass) (any, error) {
return nil, kalerrors.ErrCouldNotGetInspector
}

inspect.InspectFields(func(field *ast.Field, _ extractjsontags.FieldTagInfo, markersAccess markers.Markers, qualifiedFieldName string) {
checkField(pass, field, markersAccess, a.conflictSets, qualifiedFieldName)
})
for f := range inspect.Fields() {
checkField(pass, f.Field, f.Markers, a.conflictSets, f.QualifiedFieldName)
}

return nil, nil //nolint:nilnil
}
Expand Down
6 changes: 3 additions & 3 deletions pkg/analysis/defaults/analyzer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,9 @@ func (a *analyzer) run(pass *analysis.Pass) (any, error) {
return nil, kalerrors.ErrCouldNotGetInspector
}

inspect.InspectFields(func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, markersAccess markershelper.Markers, qualifiedFieldName string) {
a.checkField(pass, field, jsonTagInfo, markersAccess, qualifiedFieldName)
})
for f := range inspect.Fields() {
a.checkField(pass, f.Field, f.JSONTagInfo, f.Markers, f.QualifiedFieldName)
}

return nil, nil //nolint:nilnil
}
Expand Down
15 changes: 7 additions & 8 deletions pkg/analysis/dependenttags/analyzer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ import (
"golang.org/x/tools/go/analysis"

kalerrors "sigs.k8s.io/kube-api-linter/pkg/analysis/errors"
"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"
Expand Down Expand Up @@ -65,26 +64,26 @@ func (a *analyzer) run(pass *analysis.Pass) (any, error) {
return nil, kalerrors.ErrCouldNotGetInspector
}

inspect.InspectFields(func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, markersAccess markers.Markers, qualifiedFieldName string) {
if field.Doc == nil {
return
for f := range inspect.Fields() {
if f.Field.Doc == nil {
continue
}

fieldMarkers := utils.TypeAwareMarkerCollectionForField(pass, markersAccess, field)
fieldMarkers := utils.TypeAwareMarkerCollectionForField(pass, f.Markers, f.Field)

for _, rule := range a.cfg.Rules {
if _, ok := fieldMarkers[rule.Identifier]; ok {
switch rule.Type {
case DependencyTypeAny:
handleAny(pass, field, rule, fieldMarkers, qualifiedFieldName)
handleAny(pass, f.Field, rule, fieldMarkers, f.QualifiedFieldName)
case DependencyTypeAll:
handleAll(pass, field, rule, fieldMarkers, qualifiedFieldName)
handleAll(pass, f.Field, rule, fieldMarkers, f.QualifiedFieldName)
default:
panic(fmt.Sprintf("unknown dependency type %s", rule.Type))
}
}
}
})
}

return nil, nil //nolint:nilnil
}
Expand Down
13 changes: 6 additions & 7 deletions pkg/analysis/duplicatemarkers/analyzer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ import (
"golang.org/x/tools/go/analysis"

kalerrors "sigs.k8s.io/kube-api-linter/pkg/analysis/errors"
"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"
Expand All @@ -48,13 +47,13 @@ func run(pass *analysis.Pass) (any, error) {
return nil, kalerrors.ErrCouldNotGetInspector
}

inspect.InspectFields(func(field *ast.Field, _ extractjsontags.FieldTagInfo, markersAccess markers.Markers, qualifiedFieldName string) {
checkField(pass, field, markersAccess, qualifiedFieldName)
})
for f := range inspect.Fields() {
checkField(pass, f.Field, f.Markers, f.QualifiedFieldName)
}

inspect.InspectTypeSpec(func(typeSpec *ast.TypeSpec, markersAccess markers.Markers) {
checkTypeSpec(pass, typeSpec, markersAccess)
})
for ts := range inspect.TypeSpecs() {
checkTypeSpec(pass, ts.TypeSpec, ts.Markers)
}

return nil, nil //nolint:nilnil
}
Expand Down
13 changes: 6 additions & 7 deletions pkg/analysis/forbiddenmarkers/analyzer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ import (

"golang.org/x/tools/go/analysis"
kalerrors "sigs.k8s.io/kube-api-linter/pkg/analysis/errors"
"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"
Expand Down Expand Up @@ -61,13 +60,13 @@ func (a *analyzer) run(pass *analysis.Pass) (any, error) {
return nil, kalerrors.ErrCouldNotGetInspector
}

inspect.InspectFields(func(field *ast.Field, _ extractjsontags.FieldTagInfo, markersAccess markers.Markers, qualifiedFieldName string) {
checkField(pass, field, markersAccess, a.forbiddenMarkers, qualifiedFieldName)
})
for f := range inspect.Fields() {
checkField(pass, f.Field, f.Markers, a.forbiddenMarkers, f.QualifiedFieldName)
}

inspect.InspectTypeSpec(func(typeSpec *ast.TypeSpec, markersAccess markers.Markers) {
checkType(pass, typeSpec, markersAccess, a.forbiddenMarkers)
})
for ts := range inspect.TypeSpecs() {
checkType(pass, ts.TypeSpec, ts.Markers, a.forbiddenMarkers)
}

return nil, nil //nolint:nilnil
}
Expand Down
13 changes: 5 additions & 8 deletions pkg/analysis/helpers/inspector/analyzer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,11 @@ package inspector_test

import (
"errors"
"go/ast"
"testing"

"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/analysis/analysistest"
"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"
)

Expand All @@ -49,13 +46,13 @@ func run(pass *analysis.Pass) (any, error) {
return nil, errCouldNotGetInspector
}

inspect.InspectFields(func(field *ast.Field, jsonTagInfo extractjsontags.FieldTagInfo, _ markers.Markers, _ string) {
pass.Reportf(field.Pos(), "field: %v", utils.FieldName(field))
for f := range inspect.Fields() {
pass.Reportf(f.Field.Pos(), "field: %v", utils.FieldName(f.Field))

if jsonTagInfo.Name != "" {
pass.Reportf(field.Pos(), "json tag: %v", jsonTagInfo.Name)
if f.JSONTagInfo.Name != "" {
pass.Reportf(f.Field.Pos(), "json tag: %v", f.JSONTagInfo.Name)
}
})
}

return nil, nil //nolint:nilnil
}
Loading
Loading