Merge pull request #476 from andyzhangx/driver-options

chore: refine driver parameter setting

Author: andyzhangx

pkg/blob/blob.go

@@ -101,6 +101,16 @@ var (
 	retriableErrors       = []string{accountNotProvisioned, tooManyRequests, shareNotFound, shareBeingDeleted, clientThrottled}
 )
 
+// DriverOptions defines driver parameters specified in driver deployment
+type DriverOptions struct {
+	NodeID                  string
+	DriverName              string
+	BlobfuseProxyEndpoint   string
+	EnableBlobfuseProxy     bool
+	BlobfuseProxyConnTimout int
+	EnableBlobMockMount     bool
+}
+
 // Driver implements all interfaces of CSI drivers
 type Driver struct {
 	csicommon.CSIDriver
@@ -121,19 +131,20 @@ type Driver struct {
 
 // NewDriver Creates a NewCSIDriver object. Assumes vendor version is equal to driver version &
 // does not support optional driver plugin info manifest field. Refer to CSI spec for more details.
-func NewDriver(nodeID, driverName, blobfuseProxyEndpoint string, enableBlobfuseProxy bool, blobfuseProxyConnTimout int, enableBlobMockMount bool) *Driver {
-	driver := Driver{}
-	driver.Name = driverName
-	driver.Version = driverVersion
-	driver.NodeID = nodeID
-	driver.volLockMap = util.NewLockMap()
-	driver.subnetLockMap = util.NewLockMap()
-	driver.volumeLocks = newVolumeLocks()
-	driver.blobfuseProxyEndpoint = blobfuseProxyEndpoint
-	driver.enableBlobfuseProxy = enableBlobfuseProxy
-	driver.blobfuseProxyConnTimout = blobfuseProxyConnTimout
-	driver.enableBlobMockMount = enableBlobMockMount
-	return &driver
+func NewDriver(options *DriverOptions) *Driver {
+	d := Driver{
+		volLockMap:              util.NewLockMap(),
+		subnetLockMap:           util.NewLockMap(),
+		volumeLocks:             newVolumeLocks(),
+		blobfuseProxyEndpoint:   options.BlobfuseProxyEndpoint,
+		enableBlobfuseProxy:     options.EnableBlobfuseProxy,
+		blobfuseProxyConnTimout: options.BlobfuseProxyConnTimout,
+		enableBlobMockMount:     options.EnableBlobMockMount,
+	}
+	d.Name = options.DriverName
+	d.Version = driverVersion
+	d.NodeID = options.NodeID
+	return &d
 }
 
 // Run driver initialization

pkg/blob/blob_test.go

@@ -45,20 +45,44 @@ const (
 )
 
 func NewFakeDriver() *Driver {
-	driver := NewDriver(fakeNodeID, DefaultDriverName, "", false, 5, false)
+	driverOptions := DriverOptions{
+		NodeID:                  fakeNodeID,
+		DriverName:              DefaultDriverName,
+		BlobfuseProxyEndpoint:   "",
+		EnableBlobfuseProxy:     false,
+		BlobfuseProxyConnTimout: 5,
+		EnableBlobMockMount:     false,
+	}
+	driver := NewDriver(&driverOptions)
 	driver.Name = fakeDriverName
 	driver.Version = vendorVersion
 	driver.subnetLockMap = util.NewLockMap()
 	return driver
 }
 
 func TestNewFakeDriver(t *testing.T) {
-	d := NewDriver(fakeNodeID, DefaultDriverName, "", false, 5, false)
+	driverOptions := DriverOptions{
+		NodeID:                  fakeNodeID,
+		DriverName:              DefaultDriverName,
+		BlobfuseProxyEndpoint:   "",
+		EnableBlobfuseProxy:     false,
+		BlobfuseProxyConnTimout: 5,
+		EnableBlobMockMount:     false,
+	}
+	d := NewDriver(&driverOptions)
 	assert.NotNil(t, d)
 }
 
 func TestNewDriver(t *testing.T) {
-	driver := NewDriver(fakeNodeID, DefaultDriverName, "", false, 5, false)
+	driverOptions := DriverOptions{
+		NodeID:                  fakeNodeID,
+		DriverName:              DefaultDriverName,
+		BlobfuseProxyEndpoint:   "",
+		EnableBlobfuseProxy:     false,
+		BlobfuseProxyConnTimout: 5,
+		EnableBlobMockMount:     false,
+	}
+	driver := NewDriver(&driverOptions)
 	fakedriver := NewFakeDriver()
 	fakedriver.Name = DefaultDriverName
 	fakedriver.Version = driverVersion

pkg/blobplugin/main.go

@@ -66,7 +66,15 @@ func main() {
 }
 
 func handle() {
-	driver := blob.NewDriver(*nodeID, *driverName, *blobfuseProxyEndpoint, *enableBlobfuseProxy, *blobfuseProxyConnTimout, *enableBlobMockMount)
+	driverOptions := blob.DriverOptions{
+		NodeID:                  *nodeID,
+		DriverName:              *driverName,
+		BlobfuseProxyEndpoint:   *blobfuseProxyEndpoint,
+		EnableBlobfuseProxy:     *enableBlobfuseProxy,
+		BlobfuseProxyConnTimout: *blobfuseProxyConnTimout,
+		EnableBlobMockMount:     *enableBlobMockMount,
+	}
+	driver := blob.NewDriver(&driverOptions)
 	if driver == nil {
 		klog.Fatalln("Failed to initialize Azure Blob Storage CSI driver")
 	}

test/e2e/suite_test.go

@@ -107,10 +107,17 @@ var _ = ginkgo.BeforeSuite(func() {
 	}
 	execTestCmd([]testCmd{e2eBootstrap, createMetricsSVC})
 
-	nodeid := os.Getenv("nodeid")
 	kubeconfig := os.Getenv(kubeconfigEnvVar)
 	_, useBlobfuseProxy := os.LookupEnv("ENABLE_BLOBFUSE_PROXY")
-	blobDriver = blob.NewDriver(nodeid, blob.DefaultDriverName, "", useBlobfuseProxy, 5, false)
+	driverOptions := blob.DriverOptions{
+		NodeID:                  os.Getenv("nodeid"),
+		DriverName:              blob.DefaultDriverName,
+		BlobfuseProxyEndpoint:   "",
+		EnableBlobfuseProxy:     useBlobfuseProxy,
+		BlobfuseProxyConnTimout: 5,
+		EnableBlobMockMount:     false,
+	}
+	blobDriver = blob.NewDriver(&driverOptions)
 	go func() {
 		os.Setenv("AZURE_CREDENTIAL_FILE", credentials.TempAzureCredentialFilePath)
 		blobDriver.Run(fmt.Sprintf("unix:///tmp/csi-%s.sock", uuid.NewUUID().String()), kubeconfig, false)