Skip to content
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.

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

Deeply copy JSONSchemaProps.XValidations. #107956

Merged
merged 1 commit into from Feb 5, 2022

Conversation

benluddy
Copy link
Contributor

@benluddy benluddy commented Feb 4, 2022

What type of PR is this?

/kind bug

What this PR does / why we need it:

Mutations to XValidations in a deep-copied CRD's schema can alter the original.

Which issue(s) this PR fixes:

Fixes #107954

Does this PR introduce a user-facing change?

CRD deep copies should no longer contain shallow copies of JSONSchemaProps.XValidations.

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/bug Categorizes issue or PR as related to a bug. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Feb 4, 2022
@k8s-ci-robot
Copy link
Contributor

Hi @benluddy. Thanks for your PR.

I'm waiting for a kubernetes 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.

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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Feb 4, 2022
@benluddy
Copy link
Contributor Author

benluddy commented Feb 4, 2022

/assign @jpbetz

@benluddy
Copy link
Contributor Author

benluddy commented Feb 4, 2022

/sig api-machinery

@k8s-ci-robot k8s-ci-robot added sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Feb 4, 2022
@k8s-triage-robot
Copy link

This PR may require API review.

If so, when the changes are ready, complete the pre-review checklist and request an API review.

Status of requested reviews is tracked in the API Review project.

@benluddy
Copy link
Contributor Author

benluddy commented Feb 4, 2022

/cc @sttts

@aojea
Copy link
Member

aojea commented Feb 4, 2022

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 4, 2022
@aojea
Copy link
Member

aojea commented Feb 4, 2022

/assign @liggitt
you are going to like this one

@liggitt
Copy link
Member

liggitt commented Feb 4, 2022

huh... glad to see this fixed... is there a test that should be updated that would have noticed this deterministically in presubmit?

@liggitt
Copy link
Member

liggitt commented Feb 4, 2022

trying to remember why these are hand-written and not generated

@benluddy
Copy link
Contributor Author

benluddy commented Feb 4, 2022

huh... glad to see this fixed... is there a test that should be updated that would have noticed this deterministically in presubmit?

The fuzzer seeds the global math/rand source from itself in https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/apitesting/roundtrip/roundtrip.go#L63, so it probably depends on whatever else is using that source in-process. That should probably be seeded from a better source of randomness (maybe with an env var or flag to override the seed for reproducibility?).

Edit: I'm not aware of a deterministic test, but it seems this would have shown up all the time as a flake if the fuzzer were seeded better. I ran this test with 10000 seeds and it caught the bug around 75% of the time.

@benluddy
Copy link
Contributor Author

benluddy commented Feb 4, 2022

/test pull-kubernetes-node-e2e-containerd

@liggitt
Copy link
Member

liggitt commented Feb 5, 2022

/lgtm
/approve

mind picking to release-1.23 once this merges?

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 5, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: benluddy, liggitt

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 5, 2022
@k8s-ci-robot k8s-ci-robot merged commit 8dee712 into kubernetes:master Feb 5, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.24 milestone Feb 5, 2022
@sttts
Copy link
Contributor

sttts commented Feb 7, 2022

trying to remember why these are hand-written and not generated

Did you remember? Is it because of the JSON types?

k8s-ci-robot added a commit that referenced this pull request Feb 7, 2022
…7956-upstream-release-1.23

Automated cherry pick of #107956: Deeply copy JSONSchemaProps.XValidations.
@liggitt
Copy link
Member

liggitt commented Feb 7, 2022

Did you remember? Is it because of the JSON types?

yeah, attempting to autogenerate:

F0207 11:33:56.866152 66457 deepcopy.go:927] Hit an unsupported type k8s.io/apiextensions-apiserver/pkg/apis/apiextensions.JSON for *k8s.io/apiextensions-apiserver/pkg/apis/apiextensions.JSON

@liggitt
Copy link
Member

liggitt commented Feb 7, 2022

looks like we can narrowly define DeepCopy for JSON and take advantage of generated deep copy code for the rest

@liggitt
Copy link
Member

liggitt commented Feb 7, 2022

looks like we can narrowly define DeepCopy for JSON and take advantage of generated deep copy code for the rest

actually... defining that makes the generated deep copy files/functions look right, but go is unhappy with defining DeepCopy methods on JSON:

vendor/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/deepcopy.go:21:6: invalid receiver type JSON (JSON is an interface type)
vendor/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/zz_generated.deepcopy.go:442:13: (*in).DeepCopy undefined (type *JSON is pointer to interface, not interface)
vendor/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/zz_generated.deepcopy.go:484:12: (*in)[i].DeepCopyInto undefined (type JSON is interface with no methods)
vendor/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/zz_generated.deepcopy.go:578:13: (*in).DeepCopy undefined (type *JSON is pointer to interface, not interface)

@leilajal
Copy link
Contributor

leilajal commented Feb 8, 2022

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Feb 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API kind/bug Categorizes issue or PR as related to a bug. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DeepCopy of JSONSchemaProps doesn't deeply copy XValidations.
8 participants