search

kubernetes-csi / csi-test

CSI test frameworks
Apache License 2.0
151 stars 147 forks source link

replace offset args with new GinkgoHelper #523

Closed huww98 closed 3 months ago

huww98 commented 3 months ago

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 commented 3 months ago

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](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
huww98 commented 3 months ago

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 commented 3 months ago

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.

huww98 commented 3 months ago

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

pohly commented 3 months ago

/ok-to-test

pohly commented 3 months ago

/lgtm /approve

k8s-ci-robot commented 3 months ago

[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: - ~~[OWNERS](https://github.com/kubernetes-csi/csi-test/blob/master/OWNERS)~~ [pohly] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment