Skip to content

🏃 Use whole list matching for known types. #842

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

Merged
merged 1 commit into from
Mar 30, 2020

Conversation

Capstan
Copy link
Contributor

@Capstan Capstan commented Mar 6, 2020

The scheme test knows how many types should be returned, but omitted CreateOptions from being explicitly checked.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 6, 2020
@k8s-ci-robot
Copy link
Contributor

Welcome @Capstan!

It looks like this is your first PR to kubernetes-sigs/controller-runtime 🎉. 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-runtime 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 Mar 6, 2020
@k8s-ci-robot
Copy link
Contributor

Hi @Capstan. 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.

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 the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 6, 2020
@Capstan
Copy link
Contributor Author

Capstan commented Mar 6, 2020

/cc @mengqiy

@k8s-ci-robot k8s-ci-robot requested a review from mengqiy March 6, 2020 12:15
@Capstan
Copy link
Contributor Author

Capstan commented Mar 6, 2020

I think this whole set could be better written using MatchAllKeys, a la

Expect(s.AllKnownTypes()).To(MatchAllKeys(Keys{
    gv.WithKind("Pod"): Equal(reflect.TypeOf(corev1.Pod{})),
    …
    gv.WithKind("CreateOptions"): Ignore(),
    …
}))

The length check would go away, being implicit to the exact match of keys. The values that aren't inspected would be Ignore()d.

If you prefer I do this approach I can either replace this or commit and follow-on.

@mengqiy
Copy link
Member

mengqiy commented Mar 6, 2020

/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 Mar 6, 2020
@mengqiy
Copy link
Member

mengqiy commented Mar 6, 2020

I seems using MatchAllKeys is better. Can you please change it in this PR?
But I feel we still need to keep the length checking, since it can give us signals when upstream introduce more stuffs in the scheme and we can make appropriate changes.
e.g. 71cf6f6#diff-b8b47f9ed3f5e8f94b54d518a7693971

@Capstan Capstan force-pushed the fix/createoptions-test branch from 96f9665 to b4a2bb3 Compare March 18, 2020 06:58
@Capstan
Copy link
Contributor Author

Capstan commented Mar 18, 2020

MatchAllKeys does length checking implicitly, as the set of keys must exactly match that which is provided.

This adds missing tests for
* CreateOptions
* DeploymentList (Deployment was checked twice)

MatchAllKeys will also validate there are no missing or extra keys.
@Capstan Capstan force-pushed the fix/createoptions-test branch from b4a2bb3 to 87e0f8d Compare March 18, 2020 06:59
@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 Mar 18, 2020
@Capstan Capstan changed the title 🏃 Add existence test for CreateOptions on base types. 🏃 Use whole list matching for known types. Mar 18, 2020
@Capstan
Copy link
Contributor Author

Capstan commented Mar 19, 2020

@mengqiy PTAL

@Capstan
Copy link
Contributor Author

Capstan commented Mar 26, 2020

Addresses #835.

Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

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

/approve

@vincepri vincepri added this to the v0.5.x milestone Mar 26, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Capstan, vincepri

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 Mar 26, 2020
@Capstan
Copy link
Contributor Author

Capstan commented Mar 26, 2020

Still need @mengqiy or another reviewer to review and lgtm.

@Capstan
Copy link
Contributor Author

Capstan commented Mar 30, 2020

Is there some other action people are waiting for me to perform?

@vincepri
Copy link
Member

/assign @mengqiy @alvaroaleman

Copy link
Member

@alvaroaleman alvaroaleman left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 30, 2020
@k8s-ci-robot k8s-ci-robot merged commit a11a908 into kubernetes-sigs:master Mar 30, 2020
@mengqiy
Copy link
Member

mengqiy commented Mar 30, 2020

/lgtm

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. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that 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.

5 participants