Fix object path trimming in Bucket Object Path mount support (#288)

* Fix object path trimming for Bucket Object Path mount support

* Fix object path trimming for Bucket Object Path mount support

* minor canges

* deleted:    tests/e2e/test_results.txt

* minor canges

* minor canges

* minor canges

* Remove logging of objectPath in parseCustomSecret

Removed logging of the found objectPath for custom secret parsing.

* minor canges

* minor canges

* minor canges

* minor canges

* minor canges

* minor canges

* minor canges

* minor canges

* minor canges

* minor canges

---------

Co-authored-by: Prachi Shivanand Anure <[email protected]>

Author: Prachi030510

go.mod

@@ -27,6 +27,7 @@ require (
 	k8s.io/client-go v0.33.4
 	k8s.io/klog/v2 v2.130.1
 	k8s.io/kubernetes v1.33.4
+	k8s.io/mount-utils v0.33.4
 	k8s.io/pod-security-admission v0.33.4
 )
 
@@ -173,7 +174,6 @@ require (
 	k8s.io/kube-scheduler v0.33.4 // indirect
 	k8s.io/kubectl v0.33.4 // indirect
 	k8s.io/kubelet v0.33.4 // indirect
-	k8s.io/mount-utils v0.33.4 // indirect
 	k8s.io/utils v0.0.0-20241104100929-3ea5e8cea738 // indirect
 	sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.31.2 // indirect
 	sigs.k8s.io/json v0.0.0-20241010143419-9aa6b5e7a4b3 // indirect

pkg/driver/controllerserver.go

@@ -132,6 +132,13 @@ func (cs *controllerServer) CreateVolume(_ context.Context, req *csi.CreateVolum
 		secretMapCustom := parseCustomSecret(secret)
 		klog.Info("custom secret parameters parsed successfully, length of custom secret: ", len(secretMapCustom))
 
+		if objectPath, exists := secretMapCustom["objectPath"]; exists {
+			klog.Infof("volume_id:%q objectPath found in secret: %q", volumeID, objectPath)
+			params["objectPath"] = objectPath
+		} else {
+			klog.Infof("volume_id:%q no objectPath in secret (mounting bucket root)", volumeID)
+		}
+
 		secretMap = secretMapCustom
 	}
 
@@ -497,6 +504,7 @@ func parseCustomSecret(secret *v1.Secret) map[string]string {
 		cosEndpoint        string
 		locationConstraint string
 		bucketVersioning   string
+		objectPath         string
 	)
 
 	if bytesVal, ok := secret.Data["accessKey"]; ok {
@@ -539,6 +547,10 @@ func parseCustomSecret(secret *v1.Secret) map[string]string {
 		bucketVersioning = string(bytesVal)
 	}
 
+	if bytesVal, ok := secret.Data["objectPath"]; ok {
+		objectPath = string(bytesVal)
+	}
+
 	secretMapCustom["accessKey"] = accessKey
 	secretMapCustom["secretKey"] = secretKey
 	secretMapCustom["apiKey"] = apiKey
@@ -549,6 +561,7 @@ func parseCustomSecret(secret *v1.Secret) map[string]string {
 	secretMapCustom["cosEndpoint"] = cosEndpoint
 	secretMapCustom["locationConstraint"] = locationConstraint
 	secretMapCustom[constants.BucketVersioning] = bucketVersioning
+	secretMapCustom["objectPath"] = objectPath
 
 	return secretMapCustom
 }

pkg/driver/controllerserver_test.go

@@ -62,6 +62,7 @@ var (
 		"cosEndpoint":        "test-endpoint",
 		"iamEndpoint":        "testIamEndpoint",
 		"bucketName":         bucketName,
+		"objectPath":         "test/object/path",
 	}
 
 	testEndpoint = flag.String("endpoint", "unix:/tmp/testcsi.sock", "Test CSI endpoint")
@@ -192,6 +193,7 @@ func TestCreateVolume(t *testing.T) {
 						constants.BucketVersioning: "true",
 						"locationConstraint":       "test-region",
 						"cosEndpoint":              "test-endpoint",
+						"objectPath":               "test/object/path",
 					},
 				},
 			},

pkg/mounter/fake_mounter-rclone.go

@@ -4,7 +4,7 @@ import "errors"
 
 type fakercloneMounter struct {
 	bucketName    string
-	objPath       string
+	objectPath    string
 	endPoint      string
 	locConstraint string
 	authType      string
@@ -20,7 +20,7 @@ type fakercloneMounter struct {
 func fakenewRcloneMounter(isFailedMount, isFailedUnmount bool) Mounter {
 	return &fakercloneMounter{
 		bucketName:      bucketName,
-		objPath:         objPath,
+		objectPath:      objectPath,
 		endPoint:        endPoint,
 		locConstraint:   region,
 		accessKeys:      keys,

pkg/mounter/fake_mounter-s3fs.go

@@ -4,7 +4,7 @@ import "errors"
 
 type fakes3fsMounter struct {
 	bucketName    string
-	objPath       string
+	objectPath    string
 	endPoint      string
 	locConstraint string
 	authType      string
@@ -18,7 +18,7 @@ type fakes3fsMounter struct {
 func fakenewS3fsMounter(isFailedMount, isFailedUnmount bool) Mounter {
 	return &fakes3fsMounter{
 		bucketName:      bucketName,
-		objPath:         objPath,
+		objectPath:      objectPath,
 		endPoint:        endPoint,
 		locConstraint:   region,
 		accessKeys:      keys,

pkg/mounter/fake_mounter.go

@@ -4,7 +4,7 @@ import "github.com/IBM/ibm-object-csi-driver/pkg/constants"
 
 const (
 	bucketName = "fakeBucketName"
-	objPath    = "fakePath"
+	objectPath = "fakePath"
 	endPoint   = "fakeEndPoint"
 	region     = "fakeRegion"
 	keys       = "fakeKeys"

pkg/mounter/mounter-rclone.go

@@ -30,7 +30,7 @@ import (
 // rcloneMounter Implements Mounter
 type RcloneMounter struct {
 	BucketName    string //From Secret in SC
-	ObjPath       string //From Secret in SC
+	ObjectPath    string //From Secret in SC
 	EndPoint      string //From Secret in SC
 	LocConstraint string //From Secret in SC
 	AuthType      string
@@ -78,8 +78,8 @@ func NewRcloneMounter(secretMap map[string]string, mountOptions []string, mounte
 	if val, check = secretMap["bucketName"]; check {
 		mounter.BucketName = val
 	}
-	if val, check = secretMap["objPath"]; check {
-		mounter.ObjPath = val
+	if val, check = secretMap["objectPath"]; check {
+		mounter.ObjectPath = val
 	}
 	if val, check = secretMap["accessKey"]; check {
 		accessKey = val
@@ -115,8 +115,8 @@ func NewRcloneMounter(secretMap map[string]string, mountOptions []string, mounte
 		mounter.UID = secretMap["uid"]
 	}
 
-	klog.Infof("newRcloneMounter args:\n\tbucketName: [%s]\n\tobjPath: [%s]\n\tendPoint: [%s]\n\tlocationConstraint: [%s]\n\tauthType: [%s]",
-		mounter.BucketName, mounter.ObjPath, mounter.EndPoint, mounter.LocConstraint, mounter.AuthType)
+	klog.Infof("newRcloneMounter args:\n\tbucketName: [%s]\n\tobjectPath: [%s]\n\tendPoint: [%s]\n\tlocationConstraint: [%s]\n\tauthType: [%s]",
+		mounter.BucketName, mounter.ObjectPath, mounter.EndPoint, mounter.LocConstraint, mounter.AuthType)
 
 	updatedOptions := updateMountOptions(mountOptions, secretMap)
 	mounter.MountOptions = updatedOptions
@@ -191,8 +191,9 @@ func (rclone *RcloneMounter) Mount(source string, target string) error {
 		return err
 	}
 
-	if rclone.ObjPath != "" {
-		bucketName = fmt.Sprintf("%s:%s/%s", remote, rclone.BucketName, rclone.ObjPath)
+	if rclone.ObjectPath != "" {
+		trimmedPath := strings.TrimPrefix(rclone.ObjectPath, "/")
+		bucketName = fmt.Sprintf("%s:%s/%s", remote, rclone.BucketName, trimmedPath)
 	} else {
 		bucketName = fmt.Sprintf("%s:%s", remote, rclone.BucketName)
 	}

pkg/mounter/mounter-rclone_test.go

@@ -14,7 +14,7 @@ var (
 		"cosEndpoint":        "test-endpoint",
 		"locationConstraint": "test-loc-constraint",
 		"bucketName":         "test-bucket-name",
-		"objPath":            "test-obj-path",
+		"objectPath":         "test-obj-path",
 		"accessKey":          "test-access-key",
 		"secretKey":          "test-secret-key",
 		"apiKey":             "test-api-key",
@@ -35,7 +35,7 @@ func TestNewRcloneMounter_Success(t *testing.T) {
 	assert.True(t, ok)
 
 	assert.Equal(t, rCloneMounter.BucketName, secretMapRClone["bucketName"])
-	assert.Equal(t, rCloneMounter.ObjPath, secretMapRClone["objPath"])
+	assert.Equal(t, rCloneMounter.ObjectPath, secretMapRClone["objectPath"])
 	assert.Equal(t, rCloneMounter.EndPoint, secretMapRClone["cosEndpoint"])
 	assert.Equal(t, rCloneMounter.LocConstraint, secretMapRClone["locationConstraint"])
 	assert.Equal(t, rCloneMounter.UID, secretMapRClone["uid"])
@@ -47,7 +47,7 @@ func TestNewRcloneMounter_Only_GID(t *testing.T) {
 		"cosEndpoint":        "test-endpoint",
 		"locationConstraint": "test-loc-constraint",
 		"bucketName":         "test-bucket-name",
-		"objPath":            "test-obj-path",
+		"objectPath":         "test-obj-path",
 		"accessKey":          "test-access-key",
 		"secretKey":          "test-secret-key",
 		"apiKey":             "test-api-key",
@@ -60,7 +60,7 @@ func TestNewRcloneMounter_Only_GID(t *testing.T) {
 	assert.True(t, ok)
 
 	assert.Equal(t, rCloneMounter.BucketName, secretMap["bucketName"])
-	assert.Equal(t, rCloneMounter.ObjPath, secretMap["objPath"])
+	assert.Equal(t, rCloneMounter.ObjectPath, secretMap["objectPath"])
 	assert.Equal(t, rCloneMounter.EndPoint, secretMap["cosEndpoint"])
 	assert.Equal(t, rCloneMounter.LocConstraint, secretMap["locationConstraint"])
 	assert.Equal(t, rCloneMounter.GID, secretMap["gid"])
@@ -71,7 +71,7 @@ func TestNewRcloneMounter_MountOptsInSecret(t *testing.T) {
 		"cosEndpoint":        "test-endpoint",
 		"locationConstraint": "test-loc-constraint",
 		"bucketName":         "test-bucket-name",
-		"objPath":            "test-obj-path",
+		"objectPath":         "test-obj-path",
 		"accessKey":          "test-access-key",
 		"secretKey":          "test-secret-key",
 		"apiKey":             "test-api-key",
@@ -86,7 +86,7 @@ func TestNewRcloneMounter_MountOptsInSecret(t *testing.T) {
 	assert.True(t, ok)
 
 	assert.Equal(t, rCloneMounter.BucketName, secretMap["bucketName"])
-	assert.Equal(t, rCloneMounter.ObjPath, secretMap["objPath"])
+	assert.Equal(t, rCloneMounter.ObjectPath, secretMap["objectPath"])
 	assert.Equal(t, rCloneMounter.EndPoint, secretMap["cosEndpoint"])
 	assert.Equal(t, rCloneMounter.LocConstraint, secretMap["locationConstraint"])
 	assert.Equal(t, rCloneMounter.UID, secretMap["uid"])
@@ -138,7 +138,7 @@ func TestRcloneMount_WorkerNode_Positive(t *testing.T) {
 		EndPoint:   "testEndpoint",
 		GID:        "testGID",
 		UID:        "testUID",
-		ObjPath:    "testObjPath",
+		ObjectPath: "testObjectPath",
 		MounterUtils: mounterUtils.NewFakeMounterUtilsImpl(mounterUtils.FakeMounterUtilsFuncStruct{
 			FuseMountFn: func(path, comm string, args []string) error {
 				return nil
@@ -166,7 +166,7 @@ func TestRcloneMount_WorkerNode_Negative(t *testing.T) {
 		EndPoint:   "testEndpoint",
 		GID:        "testGID",
 		UID:        "testUID",
-		ObjPath:    "testObjPath",
+		ObjectPath: "testObjectPath",
 		MounterUtils: mounterUtils.NewFakeMounterUtilsImpl(mounterUtils.FakeMounterUtilsFuncStruct{
 			FuseMountFn: func(path, comm string, args []string) error {
 				return nil

pkg/mounter/mounter-s3fs.go

@@ -29,7 +29,7 @@ import (
 // s3fsMounter Implements Mounter
 type S3fsMounter struct {
 	BucketName    string //From Secret in SC
-	ObjPath       string //From Secret in SC
+	ObjectPath    string //From Secret in SC
 	EndPoint      string //From Secret in SC
 	LocConstraint string //From Secret in SC
 	AuthType      string
@@ -73,8 +73,8 @@ func NewS3fsMounter(secretMap map[string]string, mountOptions []string, mounterU
 	if val, check = secretMap["bucketName"]; check {
 		mounter.BucketName = val
 	}
-	if val, check = secretMap["objPath"]; check {
-		mounter.ObjPath = val
+	if val, check = secretMap["objectPath"]; check {
+		mounter.ObjectPath = val
 	}
 	if val, check = secretMap["accessKey"]; check {
 		accessKey = val
@@ -100,8 +100,8 @@ func NewS3fsMounter(secretMap map[string]string, mountOptions []string, mounterU
 		mounter.AuthType = "hmac"
 	}
 
-	klog.Infof("newS3fsMounter args:\n\tbucketName: [%s]\n\tobjPath: [%s]\n\tendPoint: [%s]\n\tlocationConstraint: [%s]\n\tauthType: [%s]\n\tkpRootKeyCrn: [%s]",
-		mounter.BucketName, mounter.ObjPath, mounter.EndPoint, mounter.LocConstraint, mounter.AuthType, mounter.KpRootKeyCrn)
+	klog.Infof("newS3fsMounter args:\n\tbucketName: [%s]\n\tobjectPath: [%s]\n\tendPoint: [%s]\n\tlocationConstraint: [%s]\n\tauthType: [%s]\n\tkpRootKeyCrn: [%s]",
+		mounter.BucketName, mounter.ObjectPath, mounter.EndPoint, mounter.LocConstraint, mounter.AuthType, mounter.KpRootKeyCrn)
 
 	updatedOptions := updateS3FSMountOptions(mountOptions, secretMap, defaultParams)
 	mounter.MountOptions = updatedOptions
@@ -147,8 +147,12 @@ func (s3fs *S3fsMounter) Mount(source string, target string) error {
 		return fmt.Errorf("S3FSMounter Mount: Cannot create file %s: %v", passwdFile, err)
 	}
 
-	if s3fs.ObjPath != "" {
-		bucketName = fmt.Sprintf("%s:/%s", s3fs.BucketName, s3fs.ObjPath)
+	if s3fs.ObjectPath != "" {
+		if strings.HasPrefix(s3fs.ObjectPath, "/") {
+			bucketName = fmt.Sprintf("%s:%s", s3fs.BucketName, s3fs.ObjectPath)
+		} else {
+			bucketName = fmt.Sprintf("%s:/%s", s3fs.BucketName, s3fs.ObjectPath)
+		}
 	} else {
 		bucketName = s3fs.BucketName
 	}

pkg/mounter/mounter-s3fs_test.go

@@ -15,7 +15,7 @@ var (
 		"cosEndpoint":        "test-endpoint",
 		"locationConstraint": "test-loc-constraint",
 		"bucketName":         "test-bucket-name",
-		"objPath":            "test-obj-path",
+		"objectPath":         "test-obj-path",
 		"accessKey":          "test-access-key",
 		"secretKey":          "test-secret-key",
 		"apiKey":             "test-api-key",
@@ -33,7 +33,7 @@ func TestNewS3fsMounter_Success(t *testing.T) {
 	assert.True(t, ok)
 
 	assert.Equal(t, s3fsMounter.BucketName, secretMap["bucketName"])
-	assert.Equal(t, s3fsMounter.ObjPath, secretMap["objPath"])
+	assert.Equal(t, s3fsMounter.ObjectPath, secretMap["objectPath"])
 	assert.Equal(t, s3fsMounter.EndPoint, secretMap["cosEndpoint"])
 	assert.Equal(t, s3fsMounter.LocConstraint, secretMap["locationConstraint"])
 }
@@ -43,7 +43,7 @@ func TestNewS3fsMounter_Success_Hmac(t *testing.T) {
 		"cosEndpoint":        "test-endpoint",
 		"locationConstraint": "test-loc-constraint",
 		"bucketName":         "test-bucket-name",
-		"objPath":            "test-obj-path",
+		"objectPath":         "test-obj-path",
 		"accessKey":          "test-access-key",
 		"secretKey":          "test-secret-key",
 		"kpRootKeyCRN":       "test-kp-root-key-crn",
@@ -62,7 +62,7 @@ func TestNewS3fsMounter_Success_Hmac(t *testing.T) {
 	assert.True(t, ok)
 
 	assert.Equal(t, s3fsMounter.BucketName, secretMap["bucketName"])
-	assert.Equal(t, s3fsMounter.ObjPath, secretMap["objPath"])
+	assert.Equal(t, s3fsMounter.ObjectPath, secretMap["objectPath"])
 	assert.Equal(t, s3fsMounter.EndPoint, secretMap["cosEndpoint"])
 	assert.Equal(t, s3fsMounter.LocConstraint, secretMap["locationConstraint"])
 }
@@ -85,7 +85,7 @@ func TestS3FSMount_NodeServer_Positive(t *testing.T) {
 		}),
 		LocConstraint: "test-location",
 		MountOptions:  mountOptions,
-		ObjPath:       "test-objPath",
+		ObjectPath:    "test-objectPath",
 	}
 
 	err := s3fs.Mount(source, target)