Skip to content

add a known limitations section to fake Client #1031

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

Conversation

jpatel-pivotal
Copy link

@jpatel-pivotal jpatel-pivotal commented Jul 6, 2020

This PR adds more information to let users know of the currently known limitations as they exist in fake.Client.

We need this to:

  • share this list with potential users of the fake client to help with expectations around TDD
  • also will help with discussion around which item on the list may be fixed via its own issue.

This PR also removes the deprecation warning as per issue #768 and is the first step to see if we can improve TDD experience for unit testing by using the fake Client in various testing use cases and scenarios.

@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.


  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
  • If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
  • Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: [email protected]

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. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 6, 2020
@k8s-ci-robot
Copy link
Contributor

Hi @jpatel-pivotal. 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
Copy link
Contributor

Welcome @jpatel-pivotal!

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 size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 6, 2020
@jpatel-pivotal jpatel-pivotal changed the title (:book:, docs)(:sparkles, minor) add a known limitations section to fake.Client (:sparkles) add a known limitations section to fake.Client Jul 6, 2020
@jpatel-pivotal jpatel-pivotal changed the title (:sparkles) add a known limitations section to fake.Client add a known limitations section to fake.Client Jul 6, 2020
@jpatel-pivotal jpatel-pivotal changed the title add a known limitations section to fake.Client 📖 add a known limitations section to fake.Client Jul 6, 2020
@jpatel-pivotal jpatel-pivotal changed the title 📖 add a known limitations section to fake.Client :book add a known limitations section to fake.Client Jul 6, 2020
@jpatel-pivotal jpatel-pivotal changed the title :book add a known limitations section to fake.Client <!-- (:book:, :sparkles:) -->add a known limitations section to fake.Client Jul 6, 2020
@jpatel-pivotal jpatel-pivotal changed the title <!-- (:book:, :sparkles:) -->add a known limitations section to fake.Client add a known limitations section to fake Client Jul 6, 2020
@jpatel-pivotal
Copy link
Author

/ok-to-test

@k8s-ci-robot
Copy link
Contributor

@jpatel-pivotal: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/ok-to-test

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.

@jpatel-pivotal
Copy link
Author

I have signed the cla /check-cla

- remove the deprecation warning as per issue kubernetes-sigs#768
- minor typo fixes
@jpatel-pivotal jpatel-pivotal force-pushed the jpatel-pivotal/fakeClientDocDetails branch from 82ab59f to 8cdf1c2 Compare July 7, 2020 23:28
@jpatel-pivotal
Copy link
Author

/check-cla

@jpatel-pivotal
Copy link
Author

/assign @vincepri

@jpatel-pivotal
Copy link
Author

I signed it

@jpatel-pivotal
Copy link
Author

/check cla

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jul 9, 2020
@jpatel-pivotal jpatel-pivotal requested a review from vincepri July 9, 2020 01:50
@vincepri
Copy link
Member

/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 Jul 10, 2020
@jpatel-pivotal
Copy link
Author

/retest

@vincepri
Copy link
Member

vincepri commented Aug 3, 2020

@jpatel-pivotal A few other suggestions, otherwise the change should be good to go, @alvaroaleman wdyt?

jemishp and others added 2 commits August 13, 2020 15:44
Co-authored-by: Vince Prignano <[email protected]>
Co-authored-by: Vince Prignano <[email protected]>
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
/assign @alvaroaleman

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jpatel-pivotal, 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 Aug 18, 2020
@vincepri vincepri added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Aug 18, 2020
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 Aug 18, 2020
@vincepri
Copy link
Member

/test pull-controller-runtime-test-master

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/S Denotes a PR that changes 10-29 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants