Cherry-pick envtest example

[gabbifish]

This PR cherry-picks the new envtest documentation for the cronjob example.

[k8s-ci-robot]

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]

@camilamacedo86 would love your review on this! :)

[gabbifish]

/retest

[k8s-ci-robot]

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

In response to this:

/retest

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.

[camilamacedo86]

hi @gabbifish,

It is not passing in the tests. See that it is failing the test to check if the testdata was generated. The testdata is updated with the command make generate. More info: CONTRIBUTING.md

However, I do not think that is required to do the cherry-pick the docs will be updated in the next release. But if you wish to check it in the book now then, to make the cherry-pick is required to do the fixes to allow it pass. E.g https://github.com/kubernetes-sigs/kubebuilder/pull/1554/files

[gabbifish]

@camilamacedo86 Hey there! Yeah, I'm trying to figure out the tricky sigs.k8s.io/kubebuilder-declarative-pattern dependency issue right now. Seems to be a common problem whenever one cherry-picks main branch into book-v2. :( I'll try to fix it. I'm just excited to see my docs live on the kubebuilder book! :)

[gabbifish]

@camilamacedo86 The tests are passing--I think this should be ready for review/merge! :)

[camilamacedo86]

Hi @gabbifish,

See that your change broke the docs. We need to fix it in the master as soon as possible. Could you please check that?
To verify the docs we use the preview. You can see more info in the CONTRIBUTION.md doc as well.

See that in the master we have: https://book.kubebuilder.io/reference/writing-tests.html
And then, after your changes the page is blank: https://deploy-preview-1579--kubebuilder.netlify.app/reference/writing-tests.html

[camilamacedo86]

A bug was introduced in the master regards these changes made in the docs. It needs to be fixed to be cherry-picked here as well.

/hold

[camilamacedo86]

/hold

[camilamacedo86]

Hi @gabbifish,

Could you check my above comment? Wdyt about addressing the fix for the docs in master first? Are you able to help with? Do you think that we need to track an issue to fix the docs?

[gabbifish]

Hi @camilamacedo86! I went back to try and find the docs rendering errors I might have introduced, but it looks like https://deploy-preview-1579--kubebuilder.netlify.app/cronjob-tutorial/writing-tests.html looks correct now--did the fix from master get cherry-picked into this branch already?

Please let me know if there are still issues!

[camilamacedo86]

Hi @gabbifish,

I think that I found the root cause. See:

• https://deploy-preview-1579--kubebuilder.netlify.app/cronjob-tutorial/writing-tests.html
• https://deploy-preview-1579--kubebuilder.netlify.app/reference/writing-tests.html

In the PR shows that a new sub-menu was created when I understand that we should use the pre-existence one : See:

It should be in the references (writing controller test):

When it is in the tutorial (writing tests):

I think the fix that needs to be done in the master and then cherrry-picked to here 👍

[gabbifish]

Cherry-picked the fix from master to this branch! Let me know how things look--I checked that the links to https://deploy-preview-1579--kubebuilder.netlify.app/reference/envtest.html worked from both the sidebar (4.8, Configuring EnvTest) and the link at the top of https://deploy-preview-1579--kubebuilder.netlify.app/cronjob-tutorial/writing-tests.html :D

[estroz]

/retest

[gabbifish]

Oop, looks like i need to rebase on this branch again to fix travis CI (I see some dependency issues)

[gabbifish]

cc @camilamacedo86 this should pass Travis CI now, but I ran into some weird dependency problems along the way. Even though this PR does nothing to change the dependencies in the root testdata/ directory, running make check-testdata still required me to apply and add changes to testdata/project-v2-addon/go.mod? Perhaps we shouldn't even be running make check-testdata on the book-v2 branch because the source of truth for testdata/ is whatever is in the master branch...

[camilamacedo86]

HI @gabbifish,

Note that the common process is just performed merges here when we do the release and all from the master will be added. However, we also can cherry-pick something from the master but in some scenarios, it might need some adjustments as you did. It is ok for now.

However, I am quite sure that we would be able to improve the process and perform changes. I think ideally we need to raise our suggestions and make a proposal. Maybe this kind of discussion can be started in an issue. WDYT?

[camilamacedo86]

/ok-to-test

[camilamacedo86]

/hold cancel

[camilamacedo86]

It is just a cherry-picks for docs.
PR #1521 which adds the example was checked for my contributors and maintainers.
The second pr #1521 was just to fix the layout of the doc and was checked by me and @pwittrock.

So, it shows fine and required to go alive since many users have been asking for further info over how to test their controllers.
Great contribution @gabbifish 🥇

/lgtm
/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

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

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 [camilamacedo86]

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