Skip to content

🐛 Handle omitzero in OneOf constraint validation#1375

Open
HadrienPatte wants to merge 1 commit intokubernetes-sigs:mainfrom
HadrienPatte:omitzero
Open

🐛 Handle omitzero in OneOf constraint validation#1375
HadrienPatte wants to merge 1 commit intokubernetes-sigs:mainfrom
HadrienPatte:omitzero

Conversation

@HadrienPatte
Copy link
Copy Markdown

The OneOf/AtMostOneOf/AtLeastOneOf constraint validation rejects fields that lack the omitempty json tag, since such fields would be marked as required, conflicting with being part of a OneOf group.

However, omitzero (supported since Go 1.24 via encoding/json) serves the same serialization purpose: the field is omitted when it holds its zero value. The current check does not recognize omitzero, causing a false positive error for valid field declarations.

Example false positive error:

field endpointSelector is part of OneOf constraint and must have omitempty tag

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: HadrienPatte
Once this PR has been reviewed and has the lgtm label, please assign alvaroaleman for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 8, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Welcome @HadrienPatte!

It looks like this is your first PR to kubernetes-sigs/controller-tools 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/controller-tools has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Apr 8, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Hi @HadrienPatte. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Apr 8, 2026
Copy link
Copy Markdown
Contributor

@JoelSpeed JoelSpeed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change seems reasonable to me, but can you please add some tests to demonstrate the new behaviour and prevent future regressions

The `OneOf`/`AtMostOneOf`/`AtLeastOneOf` constraint validation rejects
fields that lack the `omitempty` json tag, since such fields would be
marked as required, conflicting with being part of a `OneOf` group.

However, `omitzero` (supported since [Go 1.24](https://go.dev/doc/go1.24#encodingjsonpkgencodingjson)
via `encoding/json`) serves the same serialization purpose: the field is
omitted when it holds its zero value. The current check does not
recognize `omitzero`, causing a false positive error for valid field
declarations.

Example false positive error:
```
field endpointSelector is part of OneOf constraint and must have omitempty tag
```
Signed-off-by: Hadrien Patte <[email protected]>
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 8, 2026
@HadrienPatte
Copy link
Copy Markdown
Author

Updated to add tests

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants