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.

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

replace offset args with new GinkgoHelper #523

Merged
merged 1 commit into from
Apr 17, 2024

Conversation

huww98
Copy link
Contributor

@huww98 huww98 commented Apr 2, 2024

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespaces from that line:

/kind api-change
/kind bug

/kind cleanup

/kind design
/kind documentation
/kind failing-test
/kind feature
/kind flake

What this PR does / why we need it:

it is simpler, and easier to maintain

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. 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. labels Apr 2, 2024
@k8s-ci-robot 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 Apr 2, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @huww98. Thanks for your PR.

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

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Apr 2, 2024
Copy link
Contributor

@pohly pohly left a comment

Choose a reason for hiding this comment

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

ginkgo.GinkgoHelper didn't exist when this code was written. Using it indeed is simpler.

We want to treat all methods as helpers, right? Then some ginkgo.GinkgoHelper calls are missing.

pkg/sanity/resources.go Show resolved Hide resolved
pkg/sanity/resources.go Show resolved Hide resolved
pkg/sanity/resources.go Show resolved Hide resolved
@huww98
Copy link
Contributor Author

huww98 commented Apr 16, 2024

We want to treat all methods as helpers, right?

Yes, but so long as one of the callers has GinkgoHelper(), it should be fine. And I think registerXxx() is not intended to be called outside of resources.go. e.g. registerVolume is called from CreateVolume, which has GinkgoHelper

@pohly
Copy link
Contributor

pohly commented Apr 16, 2024

Yes, but so long as one of the callers has GinkgoHelper(), it should be fine.

That's not my understanding of how that function works. GinkgoHelper marks "the function it's called in as a test helper" (emphasis mine). It does not mark the function and all functions called by it as helper.

it is simpler, and easier to maintain
@huww98
Copy link
Contributor Author

huww98 commented Apr 16, 2024

Yes, you are correct. I just experimented and confirmed that every function in the stack should have GinkgoHelper(). Thank you.

@huww98 huww98 requested a review from pohly April 16, 2024 15:16
@pohly
Copy link
Contributor

pohly commented Apr 17, 2024

/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 Apr 17, 2024
@pohly
Copy link
Contributor

pohly commented Apr 17, 2024

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 17, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: huww98, pohly

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:

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 k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 17, 2024
@k8s-ci-robot k8s-ci-robot merged commit dae19b9 into kubernetes-csi:master Apr 17, 2024
3 checks passed
@huww98 huww98 deleted the ginkgo-helper branch April 19, 2024 08:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. 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. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. 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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants