Skip to content

Address refactoring TODOs in the test/utils module #133236

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

bxrne
Copy link

@bxrne bxrne commented Jul 26, 2025

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

I grepped for TODOs and chose to address three in ./test/utils.

create_resources.go

  • Encapsulated the per object behaviour into the createWithRetries using a generic type to reduce the amount of code

delete_resources.go

  • Refactored common parts for generic object kinds by adding an interface ResourceDeleter to allow deleter to be common

update_resources.go

  • Moved retry/wait to exponential backoff as per TODO for scale.Scale()

Which issue(s) this PR is related to:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:


@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 26, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @bxrne. Thanks for your PR.

I'm waiting for a kubernetes 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.

@k8s-ci-robot k8s-ci-robot added needs-priority Indicates a PR lacks a `priority/foo` label and requires one. area/test sig/testing Categorizes an issue or PR as relevant to SIG Testing. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Jul 26, 2025
@k8s-ci-robot k8s-ci-robot requested review from aojea and wojtek-t July 26, 2025 15:01
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: bxrne
Once this PR has been reviewed and has the lgtm label, please assign smarterclayton 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

@ylink-lfs
Copy link
Contributor

ylink-lfs commented Jul 26, 2025

/priority backlog
/sig apps

@k8s-ci-robot k8s-ci-robot added the priority/backlog Higher priority than priority/awaiting-more-evidence. label Jul 26, 2025
@k8s-ci-robot
Copy link
Contributor

@ylink-lfs: The label(s) sig/app cannot be applied, because the repository doesn't have them.

In response to this:

/priority backlog
/sig app

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 k8s-ci-robot added sig/apps Categorizes an issue or PR as relevant to SIG Apps. and removed needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Jul 26, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in SIG Apps Jul 26, 2025
updateRetryInterval = 5 * time.Second
updateRetryTimeout = 1 * time.Minute
Copy link
Contributor

Choose a reason for hiding this comment

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

I suggest adding a method doing exponential backoff retry and keeping the original updateRetryTimeout and corresponding method untouched. Also, define these factors related to exponential backoff implementation inside the newly added utility func like ScaleResourceWithExponentialRetries.

Copy link
Author

Choose a reason for hiding this comment

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

Ok i tried adding a opt-in way of doing it.

func DeleteResource(c clientset.Interface, kind schema.GroupKind, namespace, name string, options metav1.DeleteOptions) error {
ctx := context.TODO()
Copy link
Contributor

Choose a reason for hiding this comment

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

We should pass down the ctx from top to bottom (in this case, the caller testutils.DeleteResource(c, kind, ns, name, metav1.DeleteOptions{PropagationPolicy: &background}). Change the function signature of caller to allow it passing down). Your initialization break the context chain.

Copy link
Author

Choose a reason for hiding this comment

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

understood 🫡
have adjusted and fixed references


func CreatePodWithRetries(c clientset.Interface, ns string, pod *v1.Pod) error {
return createWithRetries(func() (*v1.Pod, error) {
return c.CoreV1().Pods(ns).Create(context.TODO(), pod, metav1.CreateOptions{})
Copy link
Contributor

Choose a reason for hiding this comment

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

The same context chain break issue as I pointed out in delete_resources.go

@github-project-automation github-project-automation bot moved this from Needs Triage to In Progress in SIG Apps Jul 29, 2025
@ylink-lfs
Copy link
Contributor

/triage accepted
/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. triage/accepted Indicates an issue or PR is ready to be actively worked on. labels Jul 29, 2025
@k8s-ci-robot k8s-ci-robot removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jul 29, 2025
@k8s-ci-robot k8s-ci-robot added area/e2e-test-framework Issues or PRs related to refactoring the kubernetes e2e test framework sig/network Categorizes an issue or PR as relevant to SIG Network. labels Jul 29, 2025
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Jul 29, 2025

@bxrne: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-kubernetes-e2e-kind-nftables 0d906e9 link false /test pull-kubernetes-e2e-kind-nftables
pull-kubernetes-linter-hints 0d906e9 link false /test pull-kubernetes-linter-hints

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/e2e-test-framework Issues or PRs related to refactoring the kubernetes e2e test framework area/test cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. priority/backlog Higher priority than priority/awaiting-more-evidence. release-note-none Denotes a PR that doesn't merit a release note. sig/apps Categorizes an issue or PR as relevant to SIG Apps. sig/network Categorizes an issue or PR as relevant to SIG Network. sig/testing Categorizes an issue or PR as relevant to SIG Testing. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

3 participants