WIP: Fix requiredfields linter to respect OmitEmpty Ignore policy #202
+79
−0
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
the
do-not-merge/work-in-progress
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: saschagrunert The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
k8s-ci-robot
added
size/M
saschagrunert
force-pushed
the
fix-195-omitempty-ignore-policy
branch
from
9d9985c to
56359ee
Compare
k8s-ci-robot
added
size/S
saschagrunert
force-pushed
the
fix-195-omitempty-ignore-policy
branch
from
56359ee to
25c08c5
Compare
k8s-ci-robot
added
size/M
saschagrunert
force-pushed
the
fix-195-omitempty-ignore-policy
branch
from
25c08c5 to
0304415
Compare
k8s-ci-robot
added
size/L
saschagrunert
force-pushed
the
fix-195-omitempty-ignore-policy
branch
2 times, most recently
from
189bf7b to
34a1c28
Compare
k8s-ci-robot
added
size/M
saschagrunert
changed the title
k8s-ci-robot
removed
the
do-not-merge/work-in-progress
saschagrunert
force-pushed
the
fix-195-omitempty-ignore-policy
branch
from
34a1c28 to
6f4488a
Compare
JoelSpeed
reviewed
Dec 10, 2025
| analysistest.RunWithSuggestedFixes(t, testdata, a, "b") | ||
| } | ||
|
|
||
| func TestWhenRequiredWithOmitEmptyIgnorePreferenceConfiguration(t *testing.T) { |
Contributor
There was a problem hiding this comment.
This test doesn't make sense anymore?
Comment on lines
185
to
187
| // Force the omitempty policy to suggest a fix. We can only get to this function when the policy is configured to Ignore. | ||
| // Since we absolutely have to add the omitempty tag, we can report it as a suggestion. | ||
| reportShouldAddOmitEmpty(pass, field, OmitEmptyPolicySuggestFix, qualifiedFieldName, "field %s does not allow the zero value. It must have the omitempty tag.", jsonTags) |
Contributor
There was a problem hiding this comment.
Are we sure this isn't a valid case?
| }), "pointers_when_required") | ||
| } | ||
|
|
||
| func TestPointersWhenRequiredOmitEmptyIgnore(t *testing.T) { |
The OmitEmpty Ignore policy is designed to suppress style-related omitempty suggestions, but it must still enforce correctness requirements. When a field doesn't allow the zero value (e.g., has MinLength=1 validation), the field absolutely requires the omitempty tag to function correctly - without it, unstructured clients will marshal the zero value which will fail validation. This is a correctness issue, not a style preference, so it must be reported even when the policy is set to Ignore. Changes: - Restored original behavior in checkFieldPropertiesWithoutOmitEmpty to always report fields that don't allow zero values - Force OmitEmptyPolicySuggestFix for these cases regardless of policy - Restored test cases that verify this behavior - Updated test expectations to match correct behavior Fixes kubernetes-sigs#195 Signed-off-by: Sascha Grunert <sgrunert@redhat.com>
saschagrunert
changed the title
k8s-ci-robot
added
the
do-not-merge/work-in-progress
saschagrunert
force-pushed
the
fix-195-omitempty-ignore-policy
branch
from
6f4488a to
543dfc4
Compare
Member
Author
|
Closing this one for now, I assume we don't have to fix anything if the behavior is intended. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
When the requiredfields linter is configured with omitempty policy set to 'Ignore', violations for missing omitempty tags were still reported because checkFieldPropertiesWithoutOmitEmpty was ignoring the configured policy.
The fix ensures that when omitEmptyPolicy is Ignore, all checks for fields without omitempty are skipped, respecting the user's configuration choice.
Fixes #195