feat: configfile support for v2 (#37)

* feat: add option to config data from file (#27)

* fix: create client in config along with transport (#30)

* feat: add more useful util funcs

* test: add tests and debug prints, discard override if unexpected location

---------

Co-authored-by: cguran-ionos <cristian-mihai.guran@ionos.com>

Author: avirtopeanu-ionos

shared/configuration.go

@@ -6,7 +6,10 @@ package shared
 
 import (
 	"context"
+	"crypto/tls"
+	"crypto/x509"
 	"fmt"
+	"net"
 	"net/http"
 	"net/url"
 	"os"
@@ -17,13 +20,15 @@ import (
 var DefaultIonosBasePath = ""
 
 const (
-	IonosUsernameEnvVar   = "IONOS_USERNAME"
-	IonosPasswordEnvVar   = "IONOS_PASSWORD"
-	IonosTokenEnvVar      = "IONOS_TOKEN"
-	IonosApiUrlEnvVar     = "IONOS_API_URL"
-	IonosPinnedCertEnvVar = "IONOS_PINNED_CERT"
-	IonosLogLevelEnvVar   = "IONOS_LOG_LEVEL"
-	DefaultIonosServerUrl = "https://api.ionos.com/"
+	IonosUsernameEnvVar       = "IONOS_USERNAME"
+	IonosPasswordEnvVar       = "IONOS_PASSWORD"
+	IonosTokenEnvVar          = "IONOS_TOKEN"
+	IonosApiUrlEnvVar         = "IONOS_API_URL"
+	IonosPinnedCertEnvVar     = "IONOS_PINNED_CERT"
+	IonosLogLevelEnvVar       = "IONOS_LOG_LEVEL"
+	IonosFilePathEnvVar       = "IONOS_CONFIG_FILE"
+	IonosCurrentProfileEnvVar = "IONOS_CURRENT_PROFILE"
+	DefaultIonosServerUrl     = "https://api.ionos.com/"
 
 	defaultMaxRetries   = 3
 	defaultWaitTime     = time.Duration(100) * time.Millisecond
@@ -99,7 +104,7 @@ type ServerConfiguration struct {
 // ServerConfigurations stores multiple ServerConfiguration items
 type ServerConfigurations []ServerConfiguration
 
-// shared.Configuration stores the configuration of the API client
+// Configuration stores the configuration of the API client
 type Configuration struct {
 	Host               string            `json:"host,omitempty"`
 	Scheme             string            `json:"scheme,omitempty"`
@@ -145,6 +150,75 @@ func NewConfiguration(username, password, token, hostUrl string) *Configuration
 	return cfg
 }
 
+// ClientOptions is a struct that represents the client options
+type ClientOptions struct {
+	// Endpoint is the endpoint that will be overridden
+	Endpoint string
+	// SkipTLSVerify skips tls verification. Not recommended for production!
+	SkipTLSVerify bool
+	// Certificate is the certificate that will be used for tls verification
+	Certificate string
+	// Credentials are the credentials that will be used for authentication
+	Credentials Credentials
+}
+
+// Credentials are the credentials that will be used for authentication
+type Credentials struct {
+	Username string `yaml:"username"`
+	Password string `yaml:"password"`
+	Token    string `yaml:"token"`
+}
+
+// NewConfigurationFromOptions returns a new shared.Configuration object created from the client options
+func NewConfigurationFromOptions(clientOptions ClientOptions) *Configuration {
+	cfg := &Configuration{
+		DefaultHeader:      make(map[string]string),
+		DefaultQueryParams: url.Values{},
+		UserAgent:          "shared-sdk-go",
+		Username:           clientOptions.Credentials.Username,
+		Password:           clientOptions.Credentials.Password,
+		Token:              clientOptions.Credentials.Token,
+		MaxRetries:         defaultMaxRetries,
+		MaxWaitTime:        defaultMaxWaitTime,
+		WaitTime:           defaultWaitTime,
+		Servers:            ServerConfigurations{},
+		OperationServers:   map[string]ServerConfigurations{},
+		HTTPClient:         http.DefaultClient,
+	}
+	if clientOptions.Endpoint != "" {
+		cfg.Servers = ServerConfigurations{
+			{
+				URL:         getServerUrl(clientOptions.Endpoint),
+				Description: "Production",
+			},
+		}
+	}
+	cfg.HTTPClient.Transport = CreateTransport(clientOptions.SkipTLSVerify, clientOptions.Certificate)
+	return cfg
+}
+
+func CreateTransport(insecure bool, certificate string) *http.Transport {
+	dialer := &net.Dialer{
+		Timeout:   30 * time.Second,
+		KeepAlive: 30 * time.Second,
+	}
+	transport := &http.Transport{
+		Proxy:                 http.ProxyFromEnvironment,
+		DialContext:           dialer.DialContext,
+		DisableKeepAlives:     true,
+		IdleConnTimeout:       30 * time.Second,
+		TLSHandshakeTimeout:   15 * time.Second,
+		ExpectContinueTimeout: 1 * time.Second,
+		MaxIdleConnsPerHost:   3,
+		MaxConnsPerHost:       3,
+	}
+	transport.TLSClientConfig = &tls.Config{InsecureSkipVerify: insecure}
+	if certificate != "" {
+		transport.TLSClientConfig.RootCAs = AddCertsToClient(certificate)
+	}
+	return transport
+}
+
 func NewConfigurationFromEnv() *Configuration {
 	return NewConfiguration(os.Getenv(IonosUsernameEnvVar), os.Getenv(IonosPasswordEnvVar), os.Getenv(IonosTokenEnvVar), os.Getenv(IonosApiUrlEnvVar))
 }
@@ -161,7 +235,7 @@ func (c *Configuration) AddDefaultQueryParam(key string, value string) {
 // URL formats template on a index using given variables
 func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error) {
 	if index < 0 || len(sc) <= index {
-		return "", fmt.Errorf("Index %v out of range %v", index, len(sc)-1)
+		return "", fmt.Errorf("index %v out of range %v", index, len(sc)-1)
 	}
 	server := sc[index]
 	url := server.URL
@@ -182,7 +256,7 @@ func (sc ServerConfigurations) URL(index int, variables map[string]string) (stri
 				}
 			}
 			if !found {
-				return "", fmt.Errorf("The variable %s in the server URL has invalid value %v. Must be %v", name, value, variable.EnumValues)
+				return "", fmt.Errorf("the variable %s in the server URL has invalid value %v. Must be %v", name, value, variable.EnumValues)
 			}
 			url = strings.Replace(url, "{"+name+"}", value, -1)
 		} else {
@@ -203,7 +277,7 @@ func getServerIndex(ctx context.Context) (int, error) {
 		if index, ok := si.(int); ok {
 			return index, nil
 		}
-		return 0, reportError("Invalid type %T should be int", si)
+		return 0, reportError("invalid type %T should be int", si)
 	}
 	return 0, nil
 }
@@ -291,3 +365,66 @@ func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint strin
 
 	return sc.URL(index, variables)
 }
+
+// ConfigProvider is an interface that allows to get the configuration of shared clients
+type ConfigProvider interface {
+	GetConfig() *Configuration
+}
+
+// EndpointOverridden is a constant that is used to mark the endpoint as overridden and can be used to search for the location
+// in the server configuration.
+const EndpointOverridden = "endpoint from config file"
+
+// OverrideLocationFor aims to override the server URL for a given client configuration, based on location and endpoint inputs.
+// Mutates the client configuration. It searches for the location in the server configuration and overrides the endpoint.
+// If the endpoint is empty, it early exits without making changes.
+func OverrideLocationFor(configProvider ConfigProvider, location, endpoint string, replaceServers bool) {
+	if endpoint == "" {
+		return
+	}
+	// If the replaceServers flag is set, we replace the servers with the new endpoint
+	if replaceServers {
+		SdkLogger.Printf("[DEBUG] Replacing all server configurations for location %s", location)
+		configProvider.GetConfig().Servers = []ServerConfiguration{
+			{
+				URL:         endpoint,
+				Description: EndpointOverridden + location,
+			},
+		}
+		return
+	}
+	location = strings.TrimSpace(location)
+	endpoint = strings.TrimSpace(endpoint)
+	servers := configProvider.GetConfig().Servers
+	for idx := range servers {
+		if strings.Contains(servers[idx].URL, location) {
+			SdkLogger.Printf("[DEBUG] Overriding server configuration for location %s", location)
+			servers[idx].URL = endpoint
+			servers[idx].Description = EndpointOverridden + location
+			return
+		}
+	}
+	SdkLogger.Printf("[DEBUG] Adding new server configuration for location %s", location)
+	configProvider.GetConfig().Servers = append(configProvider.GetConfig().Servers, ServerConfiguration{
+		URL:         endpoint,
+		Description: EndpointOverridden + location,
+	})
+}
+
+func SetSkipTLSVerify(configProvider ConfigProvider, skipTLSVerify bool) {
+	configProvider.GetConfig().HTTPClient.Transport = &http.Transport{
+		TLSClientConfig: &tls.Config{InsecureSkipVerify: skipTLSVerify},
+	}
+}
+
+// AddCertsToClient adds certificates to the http client
+func AddCertsToClient(authorityData string) *x509.CertPool {
+	rootCAs, _ := x509.SystemCertPool()
+	if rootCAs == nil {
+		rootCAs = x509.NewCertPool()
+	}
+	if ok := rootCAs.AppendCertsFromPEM([]byte(authorityData)); !ok && SdkLogLevel.Satisfies(Debug) {
+		SdkLogger.Printf("No certs appended, using system certs only")
+	}
+	return rootCAs
+}

shared/configuration_test.go

@@ -0,0 +1,141 @@
+package shared
+
+import (
+	"crypto/tls"
+	"github.com/stretchr/testify/assert"
+	"net/http"
+	"testing"
+)
+
+const testEndpoint = "https://test.endpoint"
+
+func TestNewConfigurationFromOptions(t *testing.T) {
+	tests := []struct {
+		name           string
+		clientOptions  ClientOptions
+		expectedConfig *Configuration
+	}{
+		{
+			name: "ValidOptions",
+			clientOptions: ClientOptions{
+				Endpoint:      testEndpoint,
+				SkipTLSVerify: true,
+				Certificate:   "",
+				Credentials: Credentials{
+					Username: "testUser",
+					Password: "testPass",
+					Token:    "testToken",
+				},
+			},
+			expectedConfig: &Configuration{
+				Username: "testUser",
+				Password: "testPass",
+				Token:    "testToken",
+				Servers: ServerConfigurations{
+					{
+						URL:         testEndpoint,
+						Description: "Production",
+					},
+				},
+				HTTPClient: &http.Client{
+					Transport: &http.Transport{
+						TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
+					},
+				},
+			},
+		},
+		{
+			name: "EmptyEndpoint",
+			clientOptions: ClientOptions{
+				SkipTLSVerify: true,
+				Certificate:   "",
+				Credentials: Credentials{
+					Username: "testUser",
+					Password: "testPass",
+					Token:    "testToken",
+				},
+			},
+			expectedConfig: &Configuration{
+				Username: "testUser",
+				Password: "testPass",
+				Token:    "testToken",
+				Servers:  ServerConfigurations{},
+				HTTPClient: &http.Client{
+					Transport: &http.Transport{
+						TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
+					},
+				},
+			},
+		},
+		{
+			name: "NoCredentials",
+			clientOptions: ClientOptions{
+				Endpoint:      testEndpoint,
+				SkipTLSVerify: true,
+				Certificate:   "",
+			},
+			expectedConfig: &Configuration{
+				Username: "",
+				Password: "",
+				Token:    "",
+				Servers: ServerConfigurations{
+					{
+						URL:         testEndpoint,
+						Description: "Production",
+					},
+				},
+				HTTPClient: &http.Client{
+					Transport: &http.Transport{
+						TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
+					},
+				},
+			},
+		},
+		{
+			name: "AddCertificate",
+			clientOptions: ClientOptions{
+				Endpoint:      testEndpoint,
+				SkipTLSVerify: true,
+				Certificate:   "testCertData",
+				Credentials: Credentials{
+					Username: "testUser",
+					Password: "testPass",
+					Token:    "testToken",
+				},
+			},
+			expectedConfig: &Configuration{
+				Username: "testUser",
+				Password: "testPass",
+				Token:    "testToken",
+				Servers: ServerConfigurations{
+					{
+						URL:         testEndpoint,
+						Description: "Production",
+					},
+				},
+				HTTPClient: &http.Client{
+					Transport: &http.Transport{
+						TLSClientConfig: &tls.Config{
+							InsecureSkipVerify: true,
+							RootCAs:            AddCertsToClient("testCertData"),
+						},
+					},
+				},
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			config := NewConfigurationFromOptions(tt.clientOptions)
+			assert.Equal(t, tt.expectedConfig.Username, config.Username)
+			assert.Equal(t, tt.expectedConfig.Password, config.Password)
+			assert.Equal(t, tt.expectedConfig.Token, config.Token)
+			assert.Equal(t, tt.expectedConfig.Servers, config.Servers)
+			assert.NotNil(t, config.HTTPClient)
+			assert.Equal(t, tt.expectedConfig.HTTPClient.Transport.(*http.Transport).TLSClientConfig.InsecureSkipVerify,
+				config.HTTPClient.Transport.(*http.Transport).TLSClientConfig.InsecureSkipVerify)
+			assert.True(t, config.HTTPClient.Transport.(*http.Transport).TLSClientConfig.RootCAs.Equal(tt.expectedConfig.HTTPClient.Transport.(*http.Transport).TLSClientConfig.RootCAs))
+		})
+	}
+}