✨Implement opaque declarative validation marker#1360
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: itzPranshul 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
the
cncf-cla: yes
|
Hi @itzPranshul. 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 Regular contributors should join the org to skip this step. Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions 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
added
needs-ok-to-test
alvaroaleman
left a comment
alvaroaleman
left a comment
There was a problem hiding this comment.
/ok-to-test
Can you please also add an envtest-based test?
k8s-ci-robot
added
ok-to-test
k8s-ci-robot
added
size/L
k8s-ci-robot
added
the
needs-rebase
k8s-ci-robot
removed
the
needs-rebase
| // This tests that +k8s:opaque suppresses type-level validation from LongerString (MinLength=4). | ||
| // +k8s:opaque | ||
| // +kubebuilder:validation:MaxLength=5 | ||
| OpaqueField LongerString `json:"opaqueField,omitempty"` |
There was a problem hiding this comment.
How about adding a case where the is a direct replacement for a validation on the type? So one with a MinLength as well? Normally this would create an anyOf right?
There was a problem hiding this comment.
Great suggestion, I've added OpaqueMinLengthField test case where a field-level validation completely replaces the type-level validation.
Normally, controller-gen uses allOf (rather than anyOf) to merge validation from a named type + field by adding +k8s:opaque the allOf is suppressed, allowing field level validation to completely replace type-level validation.
k8s-ci-robot
added
the
needs-rebase
k8s-ci-robot
removed
the
needs-rebase
- Suppresses the inheritance of type-level validations from Go named type aliases by bypassing `$ref` generation and inlining the underlying primitive type. - Struct fields can avoid type-level constraints while correctly applying field-level overrides.
|
/cc @lalitc375 |
|
@itzPranshul: GitHub didn't allow me to request PR reviews from the following users: lalitc375. Note that only kubernetes-sigs members and repo collaborators can review this PR, and authors cannot review their own PRs. DetailsIn response to this:
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. |
4 participants
What does this do, and why do we need it?
When a Go type has type-level validation markers, those markers are automatically inherited by all fields that use that type. This PR introduces
+k8s: opaque, a field-level marker that suppresses type-level validation inheritance for a specific field.This marker gives users a way to opt-out of type level validations when reusing a go type in a CRD struct field, so they can define custom field level validations without inheriting any conflicts.
Which issue(s) this PR is related to:
Fixes #1301