Merge pull request #54 from MbolotSuse/test-ids-2.7

Adding a dev mode

Author: MbolotSuse

charts/rancher-csp-adapter/templates/deployment.yaml

@@ -16,6 +16,8 @@ spec:
       - env:
         - name: CATTLE_DEBUG
           value: {{ .Values.debug | quote }}
+        - name: CATTLE_DEV_MODE
+          value: {{ .Values.devMode | quote }}
         - name: K8S_OUTPUT_CONFIGMAP
           value: '{{ template "csp-adapter.outputConfigMap"  }}'
         - name: K8S_OUTPUT_NOTIFICATION

charts/rancher-csp-adapter/values.yaml

@@ -1,4 +1,6 @@
 debug: false
+# used for development only - not supported in production
+devMode: false
 
 image:
   repository: rancher/rancher-csp-adapter

main.go

@@ -28,8 +28,9 @@ func main() {
 }
 
 const (
-	debugEnv = "CATTLE_DEBUG"
-	awsCSP   = "aws"
+	debugEnv   = "CATTLE_DEBUG"
+	devModeEnv = "CATTLE_DEV_MODE"
+	awsCSP     = "aws"
 )
 
 func run() error {
@@ -55,7 +56,9 @@ func run() error {
 		return err
 	}
 
-	awsClient, err := aws.NewClient(ctx)
+	devMode := os.Getenv(devModeEnv) == "true"
+
+	awsClient, err := aws.NewClient(ctx, devMode)
 	if err != nil {
 		registerErr := registerStartupError(k8sClients, createCSPInfo(awsCSP, "unknown"), err)
 		if registerErr != nil {

pkg/clients/aws/client.go

@@ -42,12 +42,13 @@ type stsClient interface {
 }
 
 type client struct {
-	acctNum string
-	sts     stsClient
-	lm      licenseManagerClient
+	acctNum         string
+	sts             stsClient
+	lm              licenseManagerClient
+	useTestProducts bool
 }
 
-func NewClient(ctx context.Context) (Client, error) {
+func NewClient(ctx context.Context, useTestProducts bool) (Client, error) {
 	cfg, err := config.LoadDefaultConfig(ctx)
 	if err != nil {
 		return nil, err
@@ -66,6 +67,7 @@ func NewClient(ctx context.Context) (Client, error) {
 	}
 
 	c.acctNum = acctNum
+	c.useTestProducts = useTestProducts
 
 	logrus.Debugf("account number: %s", acctNum)
 
@@ -92,23 +94,39 @@ func (c *client) getAccountNumber(ctx context.Context) (string, error) {
 }
 
 var (
-	productSKUField                = "ProductSKU"
-	rancherProductSKUNonEmea       = "0b87d4fa-d1fe-41d8-830b-67d4ec381549"
-	rancherProductSKUEmea          = "a303097d-1dc2-4548-8ea6-f46bb9842e21"
-	maxResults               int32 = 1
+	productSKUField          = "ProductSKU"
+	rancherProductSKUNonEmea = "0b87d4fa-d1fe-41d8-830b-67d4ec381549"
+	rancherProductSKUEmea    = "a303097d-1dc2-4548-8ea6-f46bb9842e21"
+	// test skus - should not be enabled at the same time as prod skus
+	rancherProductTestSKUNonEmea       = "83929a73-7c49-4511-aa45-8854a4f001d4"
+	rancherProductTestSKUEmea          = "e001cf36-9e45-496e-be2c-b48749bf7dd2"
+	maxResults                   int32 = 1
 )
 
 func (c *client) GetRancherLicense(ctx context.Context) (*types.GrantedLicense, error) {
-	license, err := c.getLicenseForProductID(ctx, rancherProductSKUNonEmea)
-	if err != nil {
-		// if we could not get the original license, attempt to retrieve the license for Emea countries
-		license, newErr := c.getLicenseForProductID(ctx, rancherProductSKUEmea)
-		if newErr != nil {
-			return nil, fmt.Errorf("unable to get license for non-emea: %s, unable to get license for emea: %s", err.Error(), newErr.Error())
+	// only attempt to retrieve the Emea licenses if we can't get the standard license
+	productSKUs := []string{rancherProductSKUNonEmea, rancherProductSKUEmea}
+	// test product IDs should only be used specifically when requested
+	if c.useTestProducts {
+		productSKUs = []string{rancherProductTestSKUNonEmea, rancherProductTestSKUEmea}
+	}
+	var errors []error
+	for _, productSKU := range productSKUs {
+		license, err := c.getLicenseForProductID(ctx, productSKU)
+		if err != nil {
+			errors = append(errors, fmt.Errorf("unable to get license for sku %s: %w", productSKU, err))
+			continue
 		}
+		// if we found a valid license, return the first one that we find
 		return license, nil
 	}
-	return license, nil
+	// if we got to this point, then we never found a valid license
+	err := fmt.Errorf("unable to get a valid rancher license")
+	// aggregate all individual errors into one message so we can see each error for each product sku
+	for _, productError := range errors {
+		err = fmt.Errorf("%s, %s", err.Error(), productError.Error())
+	}
+	return nil, err
 }
 
 func (c *client) getLicenseForProductID(ctx context.Context, productID string) (*types.GrantedLicense, error) {

pkg/clients/aws/client_test.go

@@ -11,12 +11,15 @@ const fakeAccountNum = "123456789101"
 
 func TestGetRancherLicense(t *testing.T) {
 	tests := []struct {
-		name              string // name of the test, to be displayed on failure
-		hasNonEmeaLicense bool   // if the account has a license for the non-EMEA product sku
-		hasEmeaLicense    bool   // if the account has a licensed for the EMEA product sku
-		includeProductSku bool   // if the return from aws should include or exclude a product sku
-		desiredLicense    string // which license our client should pick - emea, non-emea, or nothing
-		errDesired        bool   // if we wanted an error for this test case
+		name                  string // name of the test, to be displayed on failure
+		hasNonEmeaLicense     bool   // if the account has a license for the non-EMEA product sku
+		hasEmeaLicense        bool   // if the account has a licensed for the EMEA product sku
+		hasTestNonEmeaLicense bool   // if the account has a license for the test non-EMEA product sku
+		hasTestEmeaLicense    bool   // if the account has a license for the test EMEA product sku
+		usesTestIds           bool   // if the account is using a test product id
+		includeProductSku     bool   // if the return from aws should include or exclude a product sku
+		desiredLicense        string // which license our client should pick - emea, non-emea, or nothing
+		errDesired            bool   // if we wanted an error for this test case
 	}{
 		{
 			name:              "test non-emea license",
@@ -66,22 +69,67 @@ func TestGetRancherLicense(t *testing.T) {
 			desiredLicense:    rancherProductSKUEmea,
 			errDesired:        false,
 		},
+		{
+			name:                  "test non-emea test license",
+			hasTestNonEmeaLicense: true,
+			usesTestIds:           true,
+			includeProductSku:     true,
+			desiredLicense:        rancherProductTestSKUNonEmea,
+		},
+		{
+			name:               "test emea test license",
+			hasTestEmeaLicense: true,
+			usesTestIds:        true,
+			includeProductSku:  true,
+			desiredLicense:     rancherProductTestSKUEmea,
+		},
+		{
+			name:                  "test non-emea + emea test license",
+			hasTestNonEmeaLicense: true,
+			hasTestEmeaLicense:    true,
+			usesTestIds:           true,
+			includeProductSku:     true,
+			desiredLicense:        rancherProductTestSKUNonEmea,
+		},
+		{
+			name:                  "test non-emea test + prod skus, test requested, test used",
+			hasNonEmeaLicense:     true,
+			hasTestNonEmeaLicense: true,
+			usesTestIds:           true,
+			includeProductSku:     true,
+			desiredLicense:        rancherProductTestSKUNonEmea,
+		},
+		{
+			name:                  "test non-emea test + prod skus, prod requested, prod used",
+			hasNonEmeaLicense:     true,
+			hasTestNonEmeaLicense: true,
+			usesTestIds:           false,
+			includeProductSku:     true,
+			desiredLicense:        rancherProductSKUNonEmea,
+		},
 	}
 	for _, test := range tests {
 		test := test
 		t.Run(test.name, func(t *testing.T) {
 			mockLMClient := mockLicenseManagerClient{}
 			client := &client{
-				acctNum: fakeAccountNum,
-				lm:      &mockLMClient,
-				sts:     &mockSTSClient{accountNumber: fakeAccountNum},
+				acctNum:         fakeAccountNum,
+				lm:              &mockLMClient,
+				sts:             &mockSTSClient{accountNumber: fakeAccountNum},
+				useTestProducts: test.usesTestIds,
 			}
 			if test.hasNonEmeaLicense {
 				mockLMClient.AddLicenseForSku(rancherProductSKUNonEmea, fakeAccountNum, test.includeProductSku)
 			}
+			if test.hasTestNonEmeaLicense {
+				mockLMClient.AddLicenseForSku(rancherProductTestSKUNonEmea, fakeAccountNum, test.includeProductSku)
+			}
 			if test.hasEmeaLicense {
 				mockLMClient.AddLicenseForSku(rancherProductSKUEmea, fakeAccountNum, test.includeProductSku)
 			}
+			if test.hasTestEmeaLicense {
+				mockLMClient.AddLicenseForSku(rancherProductTestSKUEmea, fakeAccountNum, test.includeProductSku)
+			}
 
 			license, err := client.GetRancherLicense(context.Background())
 			if test.errDesired {