📖 Update test examples not to set Status on create #4016

hsadoyan · 2024-07-13T19:58:58Z

Change the example tests not to attempt to set Status on Create. The kubernetes api will ignore the status field on creation, leaving it blank. A new user trying to follow the book might be surprised to find their tests failing because of an empty status.

Instead the example will update the Status immediately after creation.

Per conversation in the slack

Related to #1778. Updates the book documentation to match the issue resolution.

k8s-ci-robot · 2024-07-13T19:59:06Z

Welcome @hsadoyan!

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 · 2024-07-13T19:59:07Z

Hi @hsadoyan. 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-sigs/prow repository.

camilamacedo86 · 2024-07-17T05:48:43Z

hack/docs/internal/cronjob-tutorial/writing_tests_controller.go

@@ -194,6 +191,9 @@ var _ = Describe("CronJob controller", func() {
 			controllerRef := metav1.NewControllerRef(createdCronjob, gvk)
 			testJob.SetOwnerReferences([]metav1.OwnerReference{*controllerRef})
 			Expect(k8sClient.Create(ctx, testJob)).Should(Succeed())
+			// Note that you can't set the status while creating the resource. It needs to be updated after


Do we need the comment?
I think we can leave it without the comment right

IHMO just remove the comment and then we can get this one merged

I wouldn't have this comment in production code, but figured it might be worth it for a tutorial example. I can remove it though. Will submit PR update in a bit

I think if we add a comment we need to refine that with something like

// Note that you should not manage the status values while creating the resource. // The status field is managed separately to reflect the current state of the resource. // Therefore, it should be updated using a PATCH or PUT operation after the resource has been created. // Additionally, it is recommended to use StatusConditions to manage the status. For further information see: // https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Pushed the new comment!

camilamacedo86 · 2024-07-17T06:01:50Z

hack/docs/internal/cronjob-tutorial/writing_tests_controller.go

@@ -194,6 +191,9 @@ var _ = Describe("CronJob controller", func() {
 			controllerRef := metav1.NewControllerRef(createdCronjob, gvk)
 			testJob.SetOwnerReferences([]metav1.OwnerReference{*controllerRef})
 			Expect(k8sClient.Create(ctx, testJob)).Should(Succeed())
+			// Note that you can't set the status while creating the resource. It needs to be updated after
+			testJob.Status.Active = 2


Also. we can do that in a follow up. It does not need to be in the PR we need to change this example in order to promote the good practices. Following the k8s API convention we should use status conditions, see: #4019

Just for you know :-)

Good point. That should probably be a followup though since it'll require a bigger refactor

camilamacedo86

/lgtm
/ok-to-test

camilamacedo86 · 2024-07-18T17:54:18Z

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

-    . "github.com/onsi/ginkgo/v2"
-    . "github.com/onsi/gomega"
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"


hi @hsadoyan

See: https://github.com/kubernetes-sigs/kubebuilder/actions/runs/9996175604/job/27630173536?pr=4016
It is failing in the testdata
So, you need to:

rebase your branch with master

then, run make generate locally. This target will update all places and docs with the changes.

camilamacedo86

Require changes ( rebase and run make generate )

hsadoyan · 2024-07-21T00:19:16Z

Require changes ( rebase and run make generate )

Done. Should be ready to merge now

camilamacedo86

/lgtm

k8s-ci-robot · 2024-07-21T10:02:41Z

[APPROVALNOTIFIER] This PR is APPROVED

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

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

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 13, 2024

k8s-ci-robot requested review from Kavinjsir and varshaprasad96 July 13, 2024 19:59

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 13, 2024

camilamacedo86 reviewed Jul 17, 2024

View reviewed changes

hsadoyan force-pushed the fix-test-status-examples branch from cc5145f to aff89b0 Compare July 18, 2024 17:41

camilamacedo86 approved these changes Jul 18, 2024

View reviewed changes

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 18, 2024

k8s-ci-robot assigned camilamacedo86 Jul 18, 2024

k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jul 18, 2024

camilamacedo86 reviewed Jul 18, 2024

View reviewed changes

camilamacedo86 reviewed Jul 19, 2024

View reviewed changes

Update test examples not to set Status on create

90ce1b6

hsadoyan force-pushed the fix-test-status-examples branch from aff89b0 to 90ce1b6 Compare July 19, 2024 23:01

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 19, 2024

camilamacedo86 approved these changes Jul 21, 2024

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 21, 2024

camilamacedo86 merged commit 66d6b4f into kubernetes-sigs:master Jul 21, 2024
15 of 17 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

📖 Update test examples not to set Status on create #4016

📖 Update test examples not to set Status on create #4016

hsadoyan commented Jul 13, 2024

k8s-ci-robot commented Jul 13, 2024

k8s-ci-robot commented Jul 13, 2024

camilamacedo86 Jul 17, 2024

camilamacedo86 Jul 17, 2024

hsadoyan Jul 17, 2024 •

edited

Loading

camilamacedo86 Jul 17, 2024

hsadoyan Jul 18, 2024

camilamacedo86 Jul 17, 2024 •

edited

Loading

camilamacedo86 Jul 17, 2024

hsadoyan Jul 17, 2024

camilamacedo86 left a comment

camilamacedo86 Jul 18, 2024

camilamacedo86 left a comment

hsadoyan commented Jul 21, 2024

camilamacedo86 left a comment

k8s-ci-robot commented Jul 21, 2024

📖 Update test examples not to set Status on create #4016

📖 Update test examples not to set Status on create #4016

Conversation

hsadoyan commented Jul 13, 2024

k8s-ci-robot commented Jul 13, 2024

k8s-ci-robot commented Jul 13, 2024

camilamacedo86 Jul 17, 2024

Choose a reason for hiding this comment

camilamacedo86 Jul 17, 2024

Choose a reason for hiding this comment

hsadoyan Jul 17, 2024 • edited Loading

Choose a reason for hiding this comment

camilamacedo86 Jul 17, 2024

Choose a reason for hiding this comment

hsadoyan Jul 18, 2024

Choose a reason for hiding this comment

camilamacedo86 Jul 17, 2024 • edited Loading

Choose a reason for hiding this comment

camilamacedo86 Jul 17, 2024

Choose a reason for hiding this comment

hsadoyan Jul 17, 2024

Choose a reason for hiding this comment

camilamacedo86 left a comment

Choose a reason for hiding this comment

camilamacedo86 Jul 18, 2024

Choose a reason for hiding this comment

camilamacedo86 left a comment

Choose a reason for hiding this comment

hsadoyan commented Jul 21, 2024

camilamacedo86 left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jul 21, 2024

hsadoyan Jul 17, 2024 •

edited

Loading

camilamacedo86 Jul 17, 2024 •

edited

Loading