Added csp client timeout to be configurable (#149)

* Added csp client timeout to be configurable

Signed-off-by: Sneha Rai <[email protected]>

* Updated as per review and added UT

Signed-off-by: Sneha Rai <[email protected]>

* Updated as per review

Signed-off-by: Sneha Rai <[email protected]>

* Updated UT

Signed-off-by: Sneha Rai <[email protected]>

* Updated UT

Signed-off-by: Sneha Rai <[email protected]>

Co-authored-by: Sneha Rai <[email protected]>

Author: sneharai4

storageprovider/csp/container_storage_provider.go

@@ -936,12 +936,15 @@ func getCspClient(credentials *storageprovider.Credentials) (*connectivity.Clien
 	// Off-Array CSP
 	cspURI := fmt.Sprintf("http://%s:%d", credentials.ServiceName, credentials.ServicePort)
 
-	log.Tracef(">>>>> getCspClient (service) using URI %s and username %s", cspURI, credentials.Username)
+	if credentials.CspClientTimeout == 0 {
+		 credentials.CspClientTimeout = storageprovider.DefaultCSPClientTimeout
+	}
+	log.Tracef(">>>>> getCspClient (service) using URI %s and username %s with timeout set to %d seconds", cspURI, credentials.Username, credentials.CspClientTimeout)
 	defer log.Trace("<<<<< getCspClient")
 
+	cspHTTPClientTimeout := time.Duration(credentials.CspClientTimeout)*time.Second
 	// Setup HTTP client to the CSP service
-	cspClient := connectivity.NewHTTPClient(cspURI)
-
+	cspClient := connectivity.NewHTTPClientWithTimeout(cspURI, cspHTTPClientTimeout)
 	return cspClient, nil
 }
 

storageprovider/storage_provider.go

@@ -4,10 +4,9 @@ package storageprovider
 
 import (
 	"fmt"
-	"strconv"
-
 	log "github.com/hpe-storage/common-host-libs/logger"
 	"github.com/hpe-storage/common-host-libs/model"
+	"strconv"
 )
 
 const (
@@ -21,6 +20,8 @@ const (
 	DefaultContextPath = "/csp"
 	// DefaultServicePort if not set for on-array csp
 	DefaultServicePort = 443
+	// DefaultCSPClientTimeout if not set for off-array csp
+	DefaultCSPClientTimeout = 60
 )
 
 // StorageProvider defines the interface to any storage related operations required by CSI and hopefully docker
@@ -50,12 +51,13 @@ type StorageProvider interface {
 
 // Credentials defines how a StorageProvider is accessed
 type Credentials struct {
-	Username    string
-	Password    string
-	Backend     string
-	ServicePort int
-	ContextPath string
-	ServiceName string
+	Username         string
+	Password         string
+	Backend          string
+	ServicePort      int
+	ContextPath      string
+	ServiceName      string
+	CspClientTimeout int64
 }
 
 // CreateCredentials creates the credentail object from the given secrets
@@ -65,7 +67,7 @@ func CreateCredentials(secrets map[string]string) (*Credentials, error) {
 
 	// When secrets specified
 	if secrets == nil || len(secrets) == 0 {
-		return nil, fmt.Errorf("No secrets have been provided")
+		return nil, fmt.Errorf("no secrets have been provided")
 	}
 
 	credentials := &Credentials{}
@@ -116,5 +118,9 @@ func CreateCredentials(secrets map[string]string) (*Credentials, error) {
 		return nil, fmt.Errorf("Missing port in the secrets")
 	}
 
+	if credentials.ServiceName != "" && credentials.CspClientTimeout == 0 {
+		credentials.CspClientTimeout = 60
+	}
+
 	return credentials, nil
 }

storageprovider/storage_provider_test.go

@@ -27,6 +27,7 @@ func TestCreateCredentials(t *testing.T) {
 		Backend:     "1.1.1.1",
 		ServiceName: "csp-service",
 		ServicePort: 8080,
+		CspClientTimeout: DefaultCSPClientTimeout,
 	}
 
 	// Valid On-Array params
@@ -81,19 +82,38 @@ func TestCreateCredentials(t *testing.T) {
 	// Empty params map
 	map7 := map[string]string{}
 
+	// Valid Off-Array params with csp client timeout
+	map8 := map[string]string{
+		usernameKey:    "admin",
+		passwordKey:    "admin",
+		backendKey:     "1.1.1.1",
+		serviceNameKey: "csp-service",
+		servicePortKey: "8080",
+	}
+	// Valid Off-Array credential with csp client timeout
+	cred8 := &Credentials{
+		Username:    "admin",
+		Password:    "admin",
+		Backend:     "1.1.1.1",
+		ServiceName: "csp-service",
+		ServicePort: 8080,
+		CspClientTimeout: DefaultCSPClientTimeout,
+	}
+
 	tests := []struct {
 		name    string
 		args    args
 		want    *Credentials
 		wantErr bool
 	}{
-		{"Test valid on-array args", args{map1}, cred1, false},
-		{"Test valid off-array args", args{map2}, cred2, false},
+		{"Test valid off-array args", args{map1}, cred1, false},
+		{"Test valid on-array args", args{map2}, cred2, false},
 		{"Test missing/invalid port", args{map3}, nil, true},
 		{"Test missing backend", args{map4}, nil, true},
 		{"Test missing username", args{map5}, nil, true},
 		{"Test missing password", args{map6}, nil, true},
 		{"Test empty credentials", args{map7}, nil, true},
+		{"Test valid off-array credentials with csp client timeout", args{map8}, cred8, false},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {