Failing closed after maximum retry is achieved to avoid inf recursion #336

knabben · 2024-04-16T22:04:27Z

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
/kind bug

What this PR does / why we need it:
Adding a maximum retry for the CSI to find the volume target from a mountpath.

Which issue(s) this PR fixes:

Fixes #193

Special notes for your reviewer:
Tracking the recursion call trace here:
#193 (comment)

Does this PR introduce a user-facing change?:

Maximum retry (3) when for the getTarget method iterate and find the correct volume of the mount path.

…sion

k8s-ci-robot · 2024-04-16T22:04:34Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: knabben
Once this PR has been reviewed and has the lgtm label, please assign msau42 for approval. For more information see the Kubernetes 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:

OWNERS

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 · 2024-04-16T22:04:37Z

Hi @knabben. 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.

knabben · 2024-04-16T22:04:50Z

/assign @mauriciopoppe

knabben · 2024-04-17T04:30:43Z

pkg/os/volume/api_test.go

+	"testing"
+)
+
+func TestGetTarget(t *testing.T) {


This (and other calls) needs a real coverage

Agreed, it'd be hard to setup a scenario with symlinks so that (Get-Item -Path $Env:mountpath).Target works though.

jsturtevant · 2024-04-17T18:04:32Z

/ok-to-test

k8s-ci-robot · 2024-04-17T18:04:46Z

@jsturtevant: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/ok-to-test

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.

mauriciopoppe · 2024-04-25T23:51:49Z

/ok-to-test

mauriciopoppe · 2024-04-25T23:53:52Z

pkg/os/volume/api.go

@@ -268,7 +271,8 @@ func (VolumeAPI) GetDiskNumberFromVolumeID(volumeID string) (uint32, error) {

 // GetVolumeIDFromTargetPath - gets the volume ID given a mount point, the function is recursive until it find a volume or errors out
 func (VolumeAPI) GetVolumeIDFromTargetPath(mount string) (string, error) {
-	volumeString, err := getTarget(mount)
+	var initialRetry = 1


Nit: it could be just 0

mauriciopoppe · 2024-04-25T23:56:44Z

pkg/os/volume/api.go

@@ -54,6 +54,9 @@ var (
 	// PS C:\disks> (Get-Disk -Number 1 | Get-Partition | Get-Volume).UniqueId
 	// \\?\Volume{452e318a-5cde-421e-9831-b9853c521012}\
 	VolumeRegexp = regexp.MustCompile(`Volume\{[\w-]*\}`)
+
+	// MaxGetTargetRetry defines the number of retries trying to get the correct volume target
+	MaxGetTargetRetry = 3


I think 3 is a very low number, in previous symlink dereferencing code I think we used 256 or maybe I read that in https://github.com/cyphar/filepath-securejoin/blob/main/join.go#L57

What about inlining the value where it's used?

mauriciopoppe · 2024-04-25T23:58:02Z

pkg/os/volume/api.go

 	cmd := `(Get-Item -Path $Env:mountpath).Target`
 	cmdEnv := fmt.Sprintf("mountpath=%s", mount)
 	out, err := utils.RunPowershellCmd(cmd, cmdEnv)
-	if err != nil || len(out) == 0 {
-		return "", fmt.Errorf("error getting volume from mount. cmd: %s, output: %s, error: %v", cmd, string(out), err)
+	if err != nil || len(out) == 0 || retry >= MaxGetTargetRetry {


As an alternative we can hardcode it to retry == 256

mauriciopoppe · 2024-04-25T23:58:52Z

pkg/os/volume/api.go

 	}

 	return ensureVolumePrefix(volumeString), nil
 }

-// GetVolumeIDFromTargetPath returns the volume id of a given target path.
+// GetClosestVolumeIDFromTargetPath returns the volume id of a given target path.


Thanks for fixing this!

mauriciopoppe · 2024-04-26T00:00:17Z

pkg/os/volume/api.go

 	cmd := `(Get-Item -Path $Env:mountpath).Target`
 	cmdEnv := fmt.Sprintf("mountpath=%s", mount)
 	out, err := utils.RunPowershellCmd(cmd, cmdEnv)
-	if err != nil || len(out) == 0 {
-		return "", fmt.Errorf("error getting volume from mount. cmd: %s, output: %s, error: %v", cmd, string(out), err)
+	if err != nil || len(out) == 0 || retry >= MaxGetTargetRetry {


We can have many ifs, that way we know which was the actual reason e.g.

if err != nil { // error message } if len(out) == 0 { // no length error message } if retry == 256 { // max recursion reached error message }

mauriciopoppe · 2024-04-26T00:00:53Z

pkg/os/volume/api_test.go

+	"testing"
+)
+
+func TestGetTarget(t *testing.T) {


Agreed, it'd be hard to setup a scenario with symlinks so that (Get-Item -Path $Env:mountpath).Target works though.

mauriciopoppe · 2024-04-26T00:05:57Z

pkg/os/volume/api.go

}
+

For debugging purposes of #193 (comment) maybe you could add

klog.V(8).Infof("retry: %d, volumeString: %s", retry, volumeString)

And start the server with very high verbosity

k8s-ci-robot · 2024-04-26T00:47:26Z

@knabben: The following test 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-csi-csi-proxy-integration	`9740ee2`	link	true	`/test pull-kubernetes-csi-csi-proxy-integration`

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

Failing closed after maximum retry is achieved to avoid inifite recur…

9740ee2

…sion

k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/bug Categorizes issue or PR as related to a bug. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Apr 16, 2024

k8s-ci-robot requested review from gnufied and pohly April 16, 2024 22:04

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

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Apr 16, 2024

k8s-ci-robot assigned mauriciopoppe Apr 16, 2024

knabben commented Apr 17, 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 Apr 25, 2024

mauriciopoppe reviewed Apr 26, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Failing closed after maximum retry is achieved to avoid inf recursion #336

Failing closed after maximum retry is achieved to avoid inf recursion #336

knabben commented Apr 16, 2024

k8s-ci-robot commented Apr 16, 2024

k8s-ci-robot commented Apr 16, 2024

knabben commented Apr 16, 2024

knabben Apr 17, 2024

mauriciopoppe Apr 26, 2024

jsturtevant commented Apr 17, 2024

k8s-ci-robot commented Apr 17, 2024

mauriciopoppe commented Apr 25, 2024

mauriciopoppe Apr 25, 2024

mauriciopoppe Apr 25, 2024

mauriciopoppe Apr 25, 2024

mauriciopoppe Apr 25, 2024

mauriciopoppe Apr 26, 2024

mauriciopoppe Apr 26, 2024

mauriciopoppe Apr 26, 2024

k8s-ci-robot commented Apr 26, 2024

Failing closed after maximum retry is achieved to avoid inf recursion #336

Are you sure you want to change the base?

Failing closed after maximum retry is achieved to avoid inf recursion #336

Conversation

knabben commented Apr 16, 2024

k8s-ci-robot commented Apr 16, 2024

k8s-ci-robot commented Apr 16, 2024

knabben commented Apr 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jsturtevant commented Apr 17, 2024

k8s-ci-robot commented Apr 17, 2024

mauriciopoppe commented Apr 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8s-ci-robot commented Apr 26, 2024