Skip to content
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.

Sign up for GitHub

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

Jump to bottom

🌱 Add Unit tests for reconcileDelete #11636

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

🌱 Add Unit tests for reconcileDelete #11636

wants to merge 2 commits into from

Conversation

arshadd-b
Copy link

@arshadd-b arshadd-b commented Jan 6, 2025 •
edited
Loading

🌱

What this PR does / why we need it:
ThIs improves test coverage of Machine Controller reconcileDelete

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes # #11626

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 6, 2025
@k8s-ci-robot k8s-ci-robot requested a review from enxebre January 6, 2025 03:39
@k8s-ci-robot k8s-ci-robot added the do-not-merge/needs-area PR is missing an area label label Jan 6, 2025
@k8s-ci-robot
Copy link
Contributor

This PR is currently missing an area label, which is used to identify the modified component when generating release notes.

Area labels can be added by org members by writing /area ${COMPONENT} in a comment

Please see the labels list for possible areas.

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.

@k8s-ci-robot
Copy link
Contributor

Welcome @arshadd-b!

It looks like this is your first PR to kubernetes-sigs/cluster-api 🎉. 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/cluster-api 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 needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jan 6, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @arshadd-b. 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.

@arshadd-b arshadd-b changed the title Add Unit tests for reconcileDelete (:seedling:) Add Unit tests for reconcileDelete Jan 6, 2025
@arshadd-b arshadd-b changed the title (:seedling:) Add Unit tests for reconcileDelete 🌱 Add Unit tests for reconcileDelete Jan 6, 2025
@Karthik-K-N
Copy link
Contributor

/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 Jan 6, 2025
@arshadd-b
Copy link
Author

Hi @sbueringer
I have tried to cover the entire function reconcileDelete
but these are pending blocks and all are negative test cases

could you please guide me how i can cover these cases as well ?
Thanks

@arshadd-b
Copy link
Author

/retest

enxebre
enxebre reviewed Jan 7, 2025
View reviewed changes
internal/controllers/machine/machine_controller_test.go Outdated
reconcileDeleteCache: cache.New[cache.ReconcileEntry](),
}

cluster := testCluster.DeepCopy()
Copy link
Member

Choose a reason for hiding this comment

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

this probably worth a comment on why is needed

Copy link
Author

Choose a reason for hiding this comment

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

Actually it is not needed to make a copy, so removed it

enxebre
enxebre reviewed Jan 7, 2025
View reviewed changes
internal/controllers/machine/machine_controller_test.go Outdated
expectNodeDeletion: false,
expectDeletingReason: clusterv1.MachineDeletingDrainingNodeV1Beta2Reason,
annotations: map[string]string{
"machine.cluster.x-k8s.io": "",
Copy link
Member

Choose a reason for hiding this comment

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

whats the purpose of this annotation?

Copy link
Author

Choose a reason for hiding this comment

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

This is case when we don't want to exclude node draining , we want to check for Node Drain and will return an error

Copy link
Member

Choose a reason for hiding this comment

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

that's regular behaviour right? which effect would have setting an annotation key "machine.cluster.x-k8s.io" within a Machine CR?

Copy link
Author

Choose a reason for hiding this comment

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

yes it is regular behaviour. I had gone through Machine CR . I have changed this to a valid annotaion here
fe1a466#diff-eca451c4058d015075de4b1e9713d6154e1d50f7d4595df4218d87fb0163bc20R3670

enxebre
enxebre reviewed Jan 7, 2025
View reviewed changes
internal/controllers/machine/machine_controller_test.go
}
}

func TestNodeDeletionWithPreDrainHook(t *testing.T) {
Copy link
Member

Choose a reason for hiding this comment

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

why isn't this one a test case of the above?

Copy link
Author

@arshadd-b arshadd-b Jan 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

In this testCase, need some custom object to be passed here in the client
https://github.com/kubernetes-sigs/cluster-api/pull/11636/files#diff-eca451c4058d015075de4b1e9713d6154e1d50f7d4595df4218d87fb0163bc20R3858

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign chrischdi for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

alexander-demicev
alexander-demicev reviewed Jan 9, 2025
View reviewed changes
internal/controllers/machine/machine_controller_test.go
},
}

cpmachine1 := &clusterv1.Machine{
Copy link
Contributor

Choose a reason for hiding this comment

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

I might be missing something, is cpmachine1 used in the test?

Copy link
Author

Choose a reason for hiding this comment

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

yeah, Actually it is used here while creating Fake client
https://github.com/kubernetes-sigs/cluster-api/pull/11636/files#diff-eca451c4058d015075de4b1e9713d6154e1d50f7d4595df4218d87fb0163bc20R3689

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alexander-demicev alexander-demicev alexander-demicev left review comments

@enxebre enxebre enxebre left review comments

@sbueringer sbueringer Awaiting requested review from sbueringer

Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-area PR is missing an area label ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@arshadd-b @k8s-ci-robot @Karthik-K-N @enxebre @alexander-demicev