Add envtest testing docs to extend cronjob example #1521

gabbifish · 2020-05-18T16:27:45Z

This PR adds testing docs to extend the CronJob example and teach people general patterns for writing tests with envtest. It addresses #1518.

k8s-ci-robot · 2020-05-18T16:27:47Z

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 · 2020-05-18T16:27:52Z

Welcome @gabbifish!

It looks like this is your first PR to kubernetes-sigs/kubebuilder 🎉. 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/kubebuilder 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 · 2020-05-18T16:27:53Z

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

gabbifish · 2020-05-18T16:44:42Z

I'm trying to sign the CLA but when I link my github account to my LF account, I keep seeing There was an error processing your request. :( I'm going to email the LF helpdesk to see what they can do.

camilamacedo86 · 2020-05-18T17:57:59Z

/ok-to-test

@gabbifish really thank you for your great contribution. Please, see that you need to assign the CLA as well for this contribution be able to be accepted.

gabbifish · 2020-05-18T22:32:01Z

All right! My CLA should be signed now.

docs/book/src/cronjob-tutorial/testdata/project/controllers/cronjob_controller_test.go

docs/book/src/cronjob-tutorial/testdata/project/controllers/suite_test.go

docs/book/src/reference/writing-tests.md

hasbro17 · 2020-05-21T17:35:16Z

Still going through the example itself but this is pretty good and a lot more comprehensive than what I originally had in mind.

docs/book/src/reference/writing-tests.md

docs/book/src/cronjob-tutorial/testdata/project/controllers/suite_test.go

docs/book/src/cronjob-tutorial/testdata/project/controllers/cronjob_controller_test.go

docs/book/src/cronjob-tutorial/testdata/project/controllers/suite_test.go

gabbifish · 2020-05-26T04:43:40Z

Thank you for the great feedback, @camilamacedo86 and @hasbro17! I've incorporated most of it, and left a question above I would love some more clarification on. :) Unclear why continuous-integration is failing, given that I rebased my changes on master just now to include the testdata changes @camilamacedo86 recently pushed

pwittrock · 2020-06-16T17:59:11Z

/lgtm

pwittrock · 2020-06-16T17:59:19Z

/hold cancel

DirectXMan12

Comments inline about tests. Just some details about a couple of points in the tests, overall structure looks fine. We should put this in the cronjob tutorial though -- it's not really reference.

Also: please stick the boilerplate sections (e.g. imports) in collapsible sections like we do in the other book pages.

docs/book/src/cronjob-tutorial/testdata/project/controllers/cronjob_controller_test.go

docs/book/src/reference/writing-tests.md

DirectXMan12 · 2020-06-16T22:08:09Z

docs/book/src/cronjob-tutorial/testdata/project/controllers/cronjob_controller_test.go

+				}
+				return true
+			}, timeout, interval).Should(BeTrue())
+			Expect(createdCronjob.Spec.Schedule).Should(Equal("1 * * * *"))


can you add a comment here or something explaining this? I'm assuming it's a sanity test for when you have pruning turned on on the API server (CRD v1 or CRD v1beta1 w/ conversion), but it's worth pointing out.

This isn't as much a sanity test for pruning as it is a check to ensure that our CronJob spec Schedule field matches the parameters we passed in. (I don't think Schedule is supposed to ever get pruned?) Please let me know if I misunderstood something!

I think i'm just not understanding the failure condition you're testing for. The two failure modes I can imaging are conversion screwing up something during round-tripping (which I forgot about when leaving the comment here) or pruning removing the field. Otherwise, "field passed in" == "field read" should be ensured by the apiserver. If not, somethings terribly wrong with the apiserver (hence referring to it above as a "sanity test").

This failure condition was originally created to check for "field passed in" == "field read" (which is ensured by the APIserver). Pruning shouldn't happen here, given that Schedule is a required CronJob Spec field. The idea for adding this came from some conversations @camilamacedo86 and I had earlier (see #1521 (comment)). The conversion point you bring up is still valid and potentially worth leaving the test for, though.

Given that the consistency of a created object and its input spec is ensured by/tested in the apiserver, I think it could make sense to just delete this check or add a comment mentioning testing schedule string conversion behavior--what do you think?

I went with the second option (add extra comment to clarify that this tests the conversion of the Schedule string). I think this should be ready for final review? :)

docs/book/src/cronjob-tutorial/testdata/project/controllers/cronjob_controller_test.go

k8s-ci-robot · 2020-06-21T08:49:30Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: gabbifish, pwittrock

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:

~~OWNERS~~ [pwittrock]

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

gabbifish · 2020-06-21T08:51:17Z

Thank you for the helpful feedback, @DirectXMan12! In my first follow-up commit, I incorporated all of it (except for one follow-up question I asked above). In the second follow-up commit, I put the Writing Tests page under the CronJob tutorial and hoisted the envtest docs up to section 4.9 in the Reference section. Let me know what you think :)

camilamacedo86 · 2020-06-21T10:33:41Z

PS.: For we are able to merge the commits need to be squashed

gabbifish · 2020-06-21T16:19:41Z

/retest

gabbifish · 2020-06-21T16:42:27Z

rebased! now playing a game of whack-a-mole with the e2e tests 😂 (I think they are acting flaky at the moment).

pwittrock · 2020-06-25T23:12:01Z

/retest

pwittrock · 2020-06-29T21:02:32Z

/lgtm

…sting-docs Add envtest testing docs to extend cronjob example

camilamacedo86 · 2020-07-30T19:48:55Z

@pwittrock we need fix this one. See that it is not showing the in the book and then the previous info also shows no longer appears.

…sting-docs Add envtest testing docs to extend cronjob example

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label May 18, 2020

k8s-ci-robot requested review from Adirio and DirectXMan12 May 18, 2020 16:27

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 May 18, 2020

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 18, 2020

gabbifish force-pushed the add-envtest-testing-docs branch from 5ad2ca6 to 8a9198d Compare May 18, 2020 16:31

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 May 18, 2020

gabbifish force-pushed the add-envtest-testing-docs branch from a225c42 to 24965e1 Compare May 19, 2020 00:18

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 May 19, 2020

hasbro17 reviewed May 21, 2020

View reviewed changes

docs/book/src/cronjob-tutorial/testdata/project/controllers/cronjob_controller_test.go Outdated Show resolved Hide resolved

hasbro17 reviewed May 21, 2020

View reviewed changes

docs/book/src/cronjob-tutorial/testdata/project/controllers/suite_test.go Outdated Show resolved Hide resolved

hasbro17 reviewed May 21, 2020

View reviewed changes

docs/book/src/cronjob-tutorial/testdata/project/controllers/suite_test.go Outdated Show resolved Hide resolved

hasbro17 reviewed May 21, 2020

View reviewed changes

docs/book/src/reference/writing-tests.md Outdated Show resolved Hide resolved

hasbro17 reviewed May 21, 2020

View reviewed changes

docs/book/src/reference/writing-tests.md Outdated Show resolved Hide resolved

camilamacedo86 reviewed May 24, 2020

View reviewed changes

docs/book/src/cronjob-tutorial/testdata/project/controllers/suite_test.go Show resolved Hide resolved

camilamacedo86 reviewed May 24, 2020

View reviewed changes

docs/book/src/cronjob-tutorial/testdata/project/controllers/suite_test.go Show resolved Hide resolved

camilamacedo86 reviewed May 24, 2020

View reviewed changes

docs/book/src/cronjob-tutorial/testdata/project/controllers/cronjob_controller_test.go Show resolved Hide resolved

camilamacedo86 reviewed May 24, 2020

View reviewed changes

docs/book/src/cronjob-tutorial/testdata/project/controllers/cronjob_controller_test.go Outdated Show resolved Hide resolved

camilamacedo86 reviewed May 24, 2020

View reviewed changes

docs/book/src/cronjob-tutorial/testdata/project/controllers/suite_test.go Show resolved Hide resolved

gabbifish force-pushed the add-envtest-testing-docs branch from 6f5d143 to db469c6 Compare May 26, 2020 04:56

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 16, 2020

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 16, 2020

DirectXMan12 requested changes Jun 16, 2020

View reviewed changes

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 21, 2020

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 21, 2020

gabbifish force-pushed the add-envtest-testing-docs branch from aa3e6d0 to e5fda8f Compare June 21, 2020 16:14

gabbifish requested a review from DirectXMan12 June 21, 2020 16:19

Add envtest testing docs to extend cronjob example

2080f31

gabbifish force-pushed the add-envtest-testing-docs branch from e5fda8f to 2080f31 Compare June 28, 2020 18:24

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 29, 2020

k8s-ci-robot merged commit 42ae4b8 into kubernetes-sigs:master Jun 29, 2020

gabbifish deleted the add-envtest-testing-docs branch June 29, 2020 22:37

gabbifish pushed a commit to gabbifish/kubebuilder that referenced this pull request Jun 29, 2020

Merge pull request kubernetes-sigs#1521 from gabbifish/add-envtest-te…

62d738f

…sting-docs Add envtest testing docs to extend cronjob example

gabbifish pushed a commit to gabbifish/kubebuilder that referenced this pull request Jul 2, 2020

Merge pull request kubernetes-sigs#1521 from gabbifish/add-envtest-te…

b3d11d9

…sting-docs Add envtest testing docs to extend cronjob example

gabbifish pushed a commit to gabbifish/kubebuilder that referenced this pull request Jul 3, 2020

Merge pull request kubernetes-sigs#1521 from gabbifish/add-envtest-te…

34defe5

…sting-docs Add envtest testing docs to extend cronjob example

camilamacedo86 mentioned this pull request Jul 30, 2020

docs: Controller-test doc page is render blank #1621

Closed

gabbifish mentioned this pull request Aug 28, 2020

REQUEST: New membership for gabbifish kubernetes/org#2149

Closed

6 tasks

gabbifish pushed a commit to gabbifish/kubebuilder that referenced this pull request Aug 31, 2020

Merge pull request kubernetes-sigs#1521 from gabbifish/add-envtest-te…

f79f3d4

…sting-docs Add envtest testing docs to extend cronjob example

camilamacedo86 mentioned this pull request Sep 8, 2020

Cherry-pick envtest example #1579

Merged

camilamacedo86 mentioned this pull request Feb 18, 2021

New Release - proposing 3.0.0 stable #2029

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add envtest testing docs to extend cronjob example #1521

Add envtest testing docs to extend cronjob example #1521

gabbifish commented May 18, 2020

k8s-ci-robot commented May 18, 2020

k8s-ci-robot commented May 18, 2020

k8s-ci-robot commented May 18, 2020

gabbifish commented May 18, 2020

camilamacedo86 commented May 18, 2020

gabbifish commented May 18, 2020 •

edited

Loading

hasbro17 commented May 21, 2020

gabbifish commented May 26, 2020 •

edited

Loading

pwittrock commented Jun 16, 2020

pwittrock commented Jun 16, 2020

DirectXMan12 left a comment

DirectXMan12 Jun 16, 2020

gabbifish Jun 21, 2020

DirectXMan12 Jun 22, 2020 •

edited

Loading

gabbifish Jun 25, 2020 •

edited

Loading

gabbifish Jun 28, 2020 •

edited

Loading

k8s-ci-robot commented Jun 21, 2020

gabbifish commented Jun 21, 2020 •

edited

Loading

camilamacedo86 commented Jun 21, 2020

gabbifish commented Jun 21, 2020

gabbifish commented Jun 21, 2020 •

edited

Loading

pwittrock commented Jun 25, 2020

pwittrock commented Jun 29, 2020

camilamacedo86 commented Jul 30, 2020

Add envtest testing docs to extend cronjob example #1521

Add envtest testing docs to extend cronjob example #1521

Conversation

gabbifish commented May 18, 2020

k8s-ci-robot commented May 18, 2020

k8s-ci-robot commented May 18, 2020

k8s-ci-robot commented May 18, 2020

gabbifish commented May 18, 2020

camilamacedo86 commented May 18, 2020

gabbifish commented May 18, 2020 • edited Loading

hasbro17 commented May 21, 2020

gabbifish commented May 26, 2020 • edited Loading

pwittrock commented Jun 16, 2020

pwittrock commented Jun 16, 2020

DirectXMan12 left a comment

Choose a reason for hiding this comment

DirectXMan12 Jun 16, 2020

Choose a reason for hiding this comment

gabbifish Jun 21, 2020

Choose a reason for hiding this comment

DirectXMan12 Jun 22, 2020 • edited Loading

Choose a reason for hiding this comment

gabbifish Jun 25, 2020 • edited Loading

Choose a reason for hiding this comment

gabbifish Jun 28, 2020 • edited Loading

Choose a reason for hiding this comment

k8s-ci-robot commented Jun 21, 2020

gabbifish commented Jun 21, 2020 • edited Loading

camilamacedo86 commented Jun 21, 2020

gabbifish commented Jun 21, 2020

gabbifish commented Jun 21, 2020 • edited Loading

pwittrock commented Jun 25, 2020

pwittrock commented Jun 29, 2020

camilamacedo86 commented Jul 30, 2020

gabbifish commented May 18, 2020 •

edited

Loading

gabbifish commented May 26, 2020 •

edited

Loading

DirectXMan12 Jun 22, 2020 •

edited

Loading

gabbifish Jun 25, 2020 •

edited

Loading

gabbifish Jun 28, 2020 •

edited

Loading

gabbifish commented Jun 21, 2020 •

edited

Loading

gabbifish commented Jun 21, 2020 •

edited

Loading