Support for Default tags

client/configuration.go

@@ -1,94 +1,100 @@
 package client
 
 import (
-	"errors"
-	"fmt"
-	"net/http"
-	"os"
+    "errors"
+    "fmt"
+    "net/http"
+    "os"
 
-	"github.com/infobloxopen/bloxone-go-client/internal"
+    "github.com/infobloxopen/bloxone-go-client/internal"
 )
 
 const (
-	ENVBloxOneCSPURL = "BLOXONE_CSP_URL"
-	ENVBloxOneAPIKey = "BLOXONE_API_KEY"
+    ENVBloxOneCSPURL = "BLOXONE_CSP_URL"
+    ENVBloxOneAPIKey = "BLOXONE_API_KEY"
 )
 
 const (
-	HeaderClient        = "x-infoblox-client"
-	HeaderSDK           = "x-infoblox-sdk"
-	HeaderAuthorization = "Authorization"
+    HeaderClient        = "x-infoblox-client"
+    HeaderSDK           = "x-infoblox-sdk"
+    HeaderAuthorization = "Authorization"
+    version             = "0.1"
+    sdkIdentifier       = "golang-sdk"
 )
 
-const version = "0.1"
-const sdkIdentifier = "golang-sdk"
-
 // Configuration stores the configuration of the API client
 type Configuration struct {
-	// ClientName is the name of the client using the SDK.
-	// Required.
-	ClientName string
-
-	// CSPURL is the URL for BloxOne Cloud Services Portal.
-	// Can also be configured using the `BLOXONE_CSP_URL` environment variable.
-	// Optional. Default is https://csp.infoblox.com
-	CSPURL string
-
-	// APIKey for accessing the BloxOne API.
-	// Can also be configured by using the `BLOXONE_API_KEY` environment variable.
-	// https://docs.infoblox.com/space/BloxOneCloud/35430405/Configuring+User+API+Keys
-	// Required.
-	APIKey string
-
-	// HTTPClient to use for the SDK.
-	// Optional. The default HTTPClient will be used if not provided.
-	HTTPClient *http.Client
+    // ClientName is the name of the client using the SDK.
+    // Required.
+    ClientName string
+
+    // CSPURL is the URL for BloxOne Cloud Services Portal.
+    // Can also be configured using the `BLOXONE_CSP_URL` environment variable.
+    // Optional. Default is https://csp.infoblox.com
+    CSPURL string
+
+    // APIKey for accessing the BloxOne API.
+    // Can also be configured by using the `BLOXONE_API_KEY` environment variable.
+    // https://docs.infoblox.com/space/BloxOneCloud/35430405/Configuring+User+API+Keys
+    // Required.
+    APIKey string
+
+    // HTTPClient to use for the SDK.
+    // Optional. The default HTTPClient will be used if not provided.
+    HTTPClient *http.Client
+
+    // Default tags the client can set for objects that has tags support.
+    // Optional. The default is an empty map.
+    DefaultTags map[string]string
 }
 
 func (c Configuration) internal(basePath string) (*internal.Configuration, error) {
-	cspURL := "https://csp.infoblox.com"
-	if v, ok := os.LookupEnv(ENVBloxOneCSPURL); ok {
-		cspURL = v
-	}
-	if len(c.CSPURL) > 0 {
-		cspURL = c.CSPURL
-	}
-	cspURL = cspURL + basePath
-
-	apiKey := ""
-	if v, ok := os.LookupEnv(ENVBloxOneAPIKey); ok {
-		apiKey = v
-	}
-	if len(c.APIKey) > 0 {
-		apiKey = c.APIKey
-	}
-	if len(apiKey) == 0 {
-		return nil, errors.New("APIKey is required")
-	}
-
-	if len(c.ClientName) == 0 {
-		return nil, errors.New("ClientName is required")
-	}
-
-	httpClient := c.HTTPClient
-	if httpClient == nil {
-		httpClient = http.DefaultClient
-	}
-
-	defaultHeaders := map[string]string{
-		HeaderAuthorization: "Token " + apiKey,
-		HeaderClient:        c.ClientName,
-		HeaderSDK:           sdkIdentifier,
-	}
-
-	userAgent := fmt.Sprintf("bloxone-%s/%s", sdkIdentifier, version)
-
-	return &internal.Configuration{
-		DefaultHeader:    defaultHeaders,
-		UserAgent:        userAgent,
-		Debug:            false,
-		OperationServers: nil,
-		Servers:          []internal.ServerConfiguration{{URL: cspURL}},
-		HTTPClient:       httpClient,
-	}, nil
+    cspURL := "https://csp.infoblox.com"
+    if v, ok := os.LookupEnv(ENVBloxOneCSPURL); ok {
+        cspURL = v
+    }
+    if len(c.CSPURL) > 0 {
+        cspURL = c.CSPURL
+    }
+    cspURL = cspURL + basePath
+
+    apiKey := ""
+    if v, ok := os.LookupEnv(ENVBloxOneAPIKey); ok {
+        apiKey = v
+    }
+    if len(c.APIKey) > 0 {
+        apiKey = c.APIKey
+    }
+    if len(apiKey) == 0 {
+        return nil, errors.New("APIKey is required")
+    }
+
+    if len(c.ClientName) == 0 {
+        return nil, errors.New("ClientName is required")
+    }
+
+    httpClient := c.HTTPClient
+    if httpClient == nil {
+        httpClient = http.DefaultClient
+    }
+
+    defaultHeaders := map[string]string{
+        HeaderAuthorization: "Token " + apiKey,
+        HeaderClient:        c.ClientName,
+        HeaderSDK:           sdkIdentifier,
+    }
+
+    userAgent := fmt.Sprintf("bloxone-%s/%s", sdkIdentifier, version)
+
+    ic := &internal.Configuration{
+        DefaultHeader:    defaultHeaders,
+        UserAgent:        userAgent,
+        Debug:            false,
+        OperationServers: nil,
+        Servers:          []internal.ServerConfiguration{{URL: cspURL}},
+        HTTPClient:       httpClient,
+        DefaultTags:      c.DefaultTags,
+    }
+
+    return ic, nil
 }

client/configuration_test.go

@@ -0,0 +1,130 @@
+package client
+
+import (
+	"fmt"
+	"net/http"
+	"os"
+	"reflect"
+	"testing"
+
+	"github.com/infobloxopen/bloxone-go-client/internal"
+)
+
+func TestConfiguration_internal(t *testing.T) {
+	type fields struct {
+		ClientName  string
+		CSPURL      string
+		APIKey      string
+		HTTPClient  *http.Client
+		DefaultTags map[string]string
+	}
+	type args struct {
+		basePath string
+	}
+	tests := []struct {
+		name    string
+		fields  fields
+		args    args
+		want    *internal.Configuration
+		wantErr bool
+	}{
+		{
+			"empty API key",
+			fields{
+				APIKey: "",
+			},
+			args{basePath: ""},
+			nil,
+			true,
+		},
+		{"empty clientName",
+			fields{
+				ClientName: "",
+			},
+			args{basePath: ""},
+			nil,
+			true,
+		},
+		{
+			"empty DefaultTags",
+			fields{
+				ClientName: "terraform/v1.1#yug278872h",
+				APIKey:     "12323455",
+			},
+			args{basePath: ""},
+			&internal.Configuration{
+				DefaultHeader: map[string]string{
+					HeaderAuthorization: "Token 12323455",
+					HeaderClient:        "terraform/v1.1#yug278872h",
+					HeaderSDK:           sdkIdentifier,
+				},
+				Debug:       false,
+				UserAgent:   fmt.Sprintf("bloxone-%s/%s", sdkIdentifier, version),
+				Servers:     []internal.ServerConfiguration{{URL: "https://csp.infoblox.com"}},
+				HTTPClient:  http.DefaultClient,
+				DefaultTags: nil,
+			},
+			false,
+		},
+		{
+			"DefaultTags provided",
+			fields{
+				CSPURL:     "https://stage.csp.infoblox.com",
+				ClientName: "terraformv1.1#yug278872h",
+				APIKey:     "12323455",
+				DefaultTags: map[string]string{
+					"site": "A",
+					"env":  "test",
+				},
+			},
+			args{basePath: ""},
+			&internal.Configuration{
+				DefaultHeader: map[string]string{
+					HeaderAuthorization: "Token 12323455",
+					HeaderClient:        "terraformv1.1#yug278872h",
+					HeaderSDK:           sdkIdentifier,
+				},
+				Debug:      false,
+				UserAgent:  fmt.Sprintf("bloxone-%s/%s", sdkIdentifier, version),
+				Servers:    []internal.ServerConfiguration{{URL: "https://stage.csp.infoblox.com"}},
+				HTTPClient: http.DefaultClient,
+				DefaultTags: map[string]string{
+					"site": "A",
+					"env":  "test",
+				},
+			},
+			false,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			var curEnvVal string
+			c := Configuration{
+				ClientName:  tt.fields.ClientName,
+				CSPURL:      tt.fields.CSPURL,
+				APIKey:      tt.fields.APIKey,
+				HTTPClient:  tt.fields.HTTPClient,
+				DefaultTags: tt.fields.DefaultTags,
+			}
+			if c.CSPURL != "" {
+				curEnvVal = os.Getenv(ENVBloxOneCSPURL)
+				t.Setenv(ENVBloxOneCSPURL, c.CSPURL)
+			}
+
+			got, err := c.internal(tt.args.basePath)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("internal() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			if !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("internal() got = %v, want %v", got, tt.want)
+			}
+			t.Cleanup(func() {
+				// Set it to the value prior to executing the test
+				if c.CSPURL != "" {
+					t.Setenv(ENVBloxOneCSPURL, curEnvVal)
+				}
+			})
+		})
+	}
+}