Skip statussubresource linting for Kubernetes List types #177
+355
−60
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
do-not-merge/work-in-progress
k8s-ci-robot
added
the
size/L
saschagrunert
force-pushed
the
fix-issue-53-marker-spacing
branch
9 times, most recently
from
81acf4a to
05d83e6
Compare
k8s-ci-robot
removed
the
do-not-merge/work-in-progress
everettraven
approved these changes
Nov 5, 2025
Contributor
everettraven
left a comment
everettraven
left a comment
There was a problem hiding this comment.
Aside from one, non-blocking, question about the nolint:... usage, this looks good to me.
/lgtm
| } | ||
|
|
||
| func checkStruct(pass *analysis.Pass, sTyp *ast.StructType, name string, structMarkers markershelper.MarkerSet, jsonTags extractjsontags.StructFieldTags) { | ||
| func checkStruct(pass *analysis.Pass, sTyp *ast.StructType, name string, structMarkers markershelper.MarkerSet, jsonTags extractjsontags.StructFieldTags) { //nolint:cyclop |
Contributor
There was a problem hiding this comment.
What was the cyclomatic complexity here that required setting the nolint?
Member
Author
There was a problem hiding this comment.
Did some slight refactoring and kept the cyclo <=10.
k8s-ci-robot
added
the
lgtm
Contributor
|
Will need @JoelSpeed for proper approval |
JoelSpeed
reviewed
Nov 6, 2025
| // metav1.ListMeta `json:"metadata,omitempty"` | ||
| // Items []Foo `json:"items"` | ||
| // } | ||
| func isKubernetesListType(sTyp *ast.StructType, name string) bool { |
Contributor
There was a problem hiding this comment.
We have this kind of check in at least one other place don't we? The helper inspector? Should we centralise this knowledge into a util so as not to duplicate it?
Member
Author
There was a problem hiding this comment.
Yes, we can refactor the logic into a utility function IsKubernetesListType in pkg/analysis/utils/utils.go.
saschagrunert
force-pushed
the
fix-issue-53-marker-spacing
branch
from
05d83e6 to
133ab28
Compare
k8s-ci-robot
removed
the
lgtm
saschagrunert
force-pushed
the
fix-issue-53-marker-spacing
branch
2 times, most recently
from
c86522d to
b2aac8d
Compare
saschagrunert
commented
Nov 6, 2025
Comment on lines
-103
to
+136
| switch { | ||
| case (hasStatusSubresourceMarker && hasStatusField), (!hasStatusSubresourceMarker && !hasStatusField): | ||
| // acceptable state | ||
| case hasStatusSubresourceMarker && !hasStatusField: | ||
| // Might be able to have some suggested fixes here, but it is likely much more complex | ||
| // so for now leave it with a descriptive failure message. | ||
| // Both present or both absent is acceptable | ||
| if hasStatusSubresourceMarker == hasStatusField { | ||
| return | ||
| } | ||
|
|
||
| // Marker present but no status field | ||
| if hasStatusSubresourceMarker { | ||
| pass.Reportf(sTyp.Pos(), "root object type %q is marked to enable the status subresource with marker %q but has no status field", name, markers.KubebuilderStatusSubresourceMarker) | ||
| case !hasStatusSubresourceMarker && hasStatusField: | ||
| // In this case we can suggest the autofix to add the status subresource marker | ||
| pass.Report(analysis.Diagnostic{ | ||
| Pos: sTyp.Pos(), | ||
| Message: fmt.Sprintf("root object type %q has a status field but does not have the marker %q to enable the status subresource", name, markers.KubebuilderStatusSubresourceMarker), | ||
| SuggestedFixes: []analysis.SuggestedFix{ | ||
| { | ||
| Message: "should add the kubebuilder:subresource:status marker", | ||
| TextEdits: []analysis.TextEdit{ | ||
| // go one line above the struct and add the marker | ||
| { | ||
| // sTyp.Pos() is the beginning of the 'struct' keyword. Subtract | ||
| // the length of the struct name + 7 (2 for spaces surrounding type name, 4 for the 'type' keyword, | ||
| // and 1 for the newline) to position at the end of the line above the struct | ||
| // definition. | ||
| Pos: sTyp.Pos() - token.Pos(len(name)+7), | ||
| // prefix with a newline to ensure we aren't appending to a previous comment | ||
| NewText: []byte("\n// +kubebuilder:subresource:status"), | ||
| }, | ||
| return | ||
| } | ||
|
|
||
| // Status field present but no marker - suggest autofix | ||
| pass.Report(analysis.Diagnostic{ | ||
| Pos: sTyp.Pos(), | ||
| Message: fmt.Sprintf("root object type %q has a status field but does not have the marker %q to enable the status subresource", name, markers.KubebuilderStatusSubresourceMarker), | ||
| SuggestedFixes: []analysis.SuggestedFix{ | ||
| { | ||
| Message: "should add the kubebuilder:subresource:status marker", | ||
| TextEdits: []analysis.TextEdit{ | ||
| { | ||
| // sTyp.Pos() is the beginning of the 'struct' keyword. Subtract | ||
| // the length of the struct name + 7 (2 for spaces surrounding type name, 4 for the 'type' keyword, | ||
| // and 1 for the newline) to position at the end of the line above the struct | ||
| // definition. | ||
| Pos: sTyp.Pos() - token.Pos(len(name)+7), | ||
| // prefix with a newline to ensure we aren't appending to a previous comment | ||
| NewText: []byte("\n// +kubebuilder:subresource:status"), |
Member
Author
There was a problem hiding this comment.
Refactoring this keeps the cyclo <=10.
The statussubresource linter was incorrectly flagging Kubernetes List types that don't have a status field. List types follow a different pattern (TypeMeta, ListMeta, Items) and don't use the status subresource. Signed-off-by: Sascha Grunert <sgrunert@redhat.com>
saschagrunert
force-pushed
the
fix-issue-53-marker-spacing
branch
from
b2aac8d to
799c28e
Compare
Contributor
|
/approve |
k8s-ci-robot
added
the
lgtm
Contributor
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: everettraven, JoelSpeed, saschagrunert The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
statussubresourcelinter was incorrectly flagging Kubernetes List types that don't have a status field. List types follow a different pattern (TypeMeta, ListMeta, Items) and don't use the status subresource.Fixes #53