cost-model/pkg/cloud/azure/storageconfiguration_test.go

package azure

import (
	"fmt"
	"testing"

	"github.com/opencost/opencost/core/pkg/log"
	"github.com/opencost/opencost/core/pkg/storage"
	"github.com/opencost/opencost/core/pkg/util/json"
	"github.com/opencost/opencost/pkg/cloud"
)

func TestStorageConfiguration_Validate(t *testing.T) {
	testCases := map[string]struct {
		config   StorageConfiguration
		expected error
	}{
		"valid config Azure SharedKeyCredential": {
			config: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			expected: nil,
		},
		"access key invalid": {
			config: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					Account: "account",
				},
			},
			expected: fmt.Errorf("SharedKeyCredential: missing access key"),
		},
		"missing authorizer": {
			config: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer:     nil,
			},
			expected: fmt.Errorf("StorageConfiguration: missing authorizer"),
		},
		"missing subscriptionID": {
			config: StorageConfiguration{
				SubscriptionID: "",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			expected: fmt.Errorf("StorageConfiguration: missing Subcription ID"),
		},
		"missing account": {
			config: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			expected: fmt.Errorf("StorageConfiguration: missing Account"),
		},
		"missing container": {
			config: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			expected: fmt.Errorf("StorageConfiguration: missing Container"),
		},
		"missing path": {
			config: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			expected: nil,
		},
		"missing cloud": {
			config: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			expected: nil,
		},
		"valid config StorageConnectionStringCredential": {
			config: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &StorageConnectionStringCredential{
					StorageConnectionString: "storageConnectionString",
				},
			},
			expected: nil,
		},
		"missing storage connection string": {
			config: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer:     &StorageConnectionStringCredential{},
			},
			expected: fmt.Errorf("StorageConnectionStringCredential: missing storage connection string"),
		},
	}

	for name, testCase := range testCases {
		t.Run(name, func(t *testing.T) {
			actual := testCase.config.Validate()
			actualString := "nil"
			if actual != nil {
				actualString = actual.Error()
			}
			expectedString := "nil"
			if testCase.expected != nil {
				expectedString = testCase.expected.Error()
			}
			if actualString != expectedString {
				t.Errorf("errors do not match: Actual: '%s', Expected: '%s", actualString, expectedString)
			}
		})
	}
}

func TestStorageConfiguration_Equals(t *testing.T) {
	testCases := map[string]struct {
		left     StorageConfiguration
		right    cloud.Config
		expected bool
	}{
		"matching config": {
			left: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			right: &StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			expected: true,
		},
		"matching config AuthorizerHolder": {
			left: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &AuthorizerHolder{
					Authorizer: &DefaultAzureCredentialHolder{},
				},
			},
			right: &StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &AuthorizerHolder{
					Authorizer: &DefaultAzureCredentialHolder{},
				},
			},
			expected: true,
		},
		"missing both authorizer": {
			left: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer:     nil,
			},
			right: &StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer:     nil,
			},
			expected: true,
		},
		"missing left authorizer": {
			left: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer:     nil,
			},
			right: &StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			expected: false,
		},
		"missing right authorizer": {
			left: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			right: &StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer:     nil,
			},
			expected: false,
		},
		"differing storage authorizer": {
			left: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			right: &StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &AuthorizerHolder{
					Authorizer: &DefaultAzureCredentialHolder{},
				},
			},
			expected: false,
		},
		"different subscriptionID": {
			left: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			right: &StorageConfiguration{
				SubscriptionID: "subscriptionID2",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			expected: false,
		},
		"different account": {
			left: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			right: &StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account2",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			expected: false,
		},
		"different container": {
			left: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			right: &StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container2",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			expected: false,
		},
		"different path": {
			left: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			right: &StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path2",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			expected: false,
		},
		"different cloud": {
			left: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			right: &StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud2",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			expected: false,
		},
		"different config": {
			left: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			right: &SharedKeyCredential{
				AccessKey: "accessKey",
				Account:   "account",
			},
			expected: false,
		},
		"matching config StorageConnectionStringCredential": {
			left: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &StorageConnectionStringCredential{
					StorageConnectionString: "storageConnectionString",
				},
			},
			right: &StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &StorageConnectionStringCredential{
					StorageConnectionString: "storageConnectionString",
				},
			},
			expected: true,
		},
		"different StorageConnectionString in StorageConnectionStringCredential": {
			left: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &StorageConnectionStringCredential{
					StorageConnectionString: "storageConnectionString1",
				},
			},
			right: &StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &StorageConnectionStringCredential{
					StorageConnectionString: "storageConnectionString2",
				},
			},
			expected: false,
		},
		"different HTTPConfig in StorageConnectionStringCredential": {
			left: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &StorageConnectionStringCredential{
					StorageConnectionString: "storageConnectionString",
					HTTPConfig:              defaultHTTPConfig,
				},
			},
			right: &StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &StorageConnectionStringCredential{
					StorageConnectionString: "storageConnectionString",
					HTTPConfig: storage.HTTPConfig{
						InsecureSkipVerify: true,
					},
				},
			},
			expected: false,
		},
	}

	for name, testCase := range testCases {
		t.Run(name, func(t *testing.T) {
			actual := testCase.left.Equals(testCase.right)
			if actual != testCase.expected {
				t.Errorf("incorrect result: Actual: '%t', Expected: '%t", actual, testCase.expected)
			}
		})
	}
}

func TestStorageConfiguration_JSON(t *testing.T) {
	testCases := map[string]struct {
		input          map[string]interface{}
		afterUnmarshal StorageConfiguration
	}{
		"Nil Authorizer": {
			input: map[string]interface{}{
				"subscriptionID": "subscriptionID",
				"account":        "account",
				"container":      "container",
				"path":           "path",
				"cloud":          "cloud",
				"authorizer":     nil,
			},
			afterUnmarshal: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer:     nil,
			},
		},
		"SharedKeyCredential Authorizer": {
			input: map[string]interface{}{
				"subscriptionID": "subscriptionID",
				"account":        "account",
				"container":      "container",
				"path":           "path",
				"cloud":          "cloud",
				"authorizer": map[string]interface{}{
					"authorizerType": "AzureAccessKey",
					"accessKey":      "accessKey",
					"account":        "account",
				},
			},
			afterUnmarshal: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
		},
		"Default AuthorizerHolder Authorizer": {
			input: map[string]interface{}{
				"subscriptionID": "subscriptionID",
				"account":        "account",
				"container":      "container",
				"path":           "path",
				"cloud":          "cloud",
				"authorizer": map[string]interface{}{
					"authorizerType": "AzureDefaultCredential",
				},
			},
			afterUnmarshal: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &AuthorizerHolder{
					Authorizer: &DefaultAzureCredentialHolder{},
				},
			},
		},
		"ClientSecretCredential Authorizer": {
			input: map[string]interface{}{
				"subscriptionID": "subscriptionID",
				"account":        "account",
				"container":      "container",
				"path":           "path",
				"cloud":          "cloud",
				"authorizer": map[string]interface{}{
					"authorizerType": "AzureClientSecretCredential",
					"tenantID":       "tenantID",
					"clientID":       "clientID",
					"clientSecret":   "clientSecret",
				},
			},
			afterUnmarshal: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &AuthorizerHolder{
					Authorizer: &ClientSecretCredential{
						TenantID:     "tenantID",
						ClientID:     "clientID",
						ClientSecret: "clientSecret",
					},
				},
			},
		},
		"StorageConnectionStringCredential Authorizer": {
			input: map[string]interface{}{
				"subscriptionID": "subscriptionID",
				"account":        "account",
				"container":      "container",
				"path":           "path",
				"cloud":          "cloud",
				"authorizer": map[string]interface{}{
					"authorizerType":          "AzureStorageConnectionString",
					"storageConnectionString": "storageConnectionString",
					"httpConfig": map[string]interface{}{
						"insecureSkipVerify": true,
					},
				},
			},
			afterUnmarshal: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &StorageConnectionStringCredential{
					StorageConnectionString: "storageConnectionString",
					HTTPConfig: func() storage.HTTPConfig {
						cfg := defaultHTTPConfig
						cfg.InsecureSkipVerify = true
						return cfg
					}(),
				},
			},
		},
	}

	for name, testCase := range testCases {
		t.Run(name, func(t *testing.T) {
			// test JSON Marshalling
			configJSON, err := json.Marshal(testCase.input)
			if err != nil {
				t.Errorf("failed to marshal configuration: %s", err.Error())
			}
			log.Info(string(configJSON))
			unmarshalledConfig := &StorageConfiguration{}
			err = json.Unmarshal(configJSON, unmarshalledConfig)
			if err != nil {
				t.Errorf("failed to unmarshal configuration: %s", err.Error())
			}

			if !testCase.afterUnmarshal.Equals(unmarshalledConfig) {
				t.Error("config does not equal unmarshalled config")
			}
		})
	}
}

func TestStorageConfiguration_Sanitize(t *testing.T) {
	testCases := map[string]struct {
		config   StorageConfiguration
		expected StorageConfiguration
	}{
		"Sanitize StorageConnectionStringCredential": {
			config: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &StorageConnectionStringCredential{
					StorageConnectionString: "storageConnectionString",
					HTTPConfig:              defaultHTTPConfig,
				},
			},
			expected: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &StorageConnectionStringCredential{
					StorageConnectionString: cloud.Redacted,
					HTTPConfig:              defaultHTTPConfig,
				},
			},
		},
		"Sanitize SharedKeyCredential": {
			config: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: "accessKey",
					Account:   "account",
				},
			},
			expected: StorageConfiguration{
				SubscriptionID: "subscriptionID",
				Account:        "account",
				Container:      "container",
				Path:           "path",
				Cloud:          "cloud",
				Authorizer: &SharedKeyCredential{
					AccessKey: cloud.Redacted,
					Account:   "account",
				},
			},
		},
	}

	for name, testCase := range testCases {
		t.Run(name, func(t *testing.T) {
			actual := testCase.config.Sanitize()

			if !testCase.expected.Equals(actual) {
				t.Errorf("incorrect result: got %#v, want %#v", actual, testCase.expected)
			}
		})
	}
}