Provider config tests. TDD failing on TestConfigLoadAndValidate before

cherry-picking in #1233
okta · Aug 1, 2022 · add3016 · add3016
1 parent fb7c249
commit add3016
Show file tree

Hide file tree

Showing 2 changed files with 155 additions and 1 deletion.
diff --git a/okta/config_test.go b/okta/config_test.go
@@ -0,0 +1,52 @@
+package okta
+
+import (
+	"context"
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/go-hclog"
+)
+
+func TestConfigLoadAndValidate(t *testing.T) {
+	tests := []struct {
+		name         string
+		accessToken  string
+		apiToken     string
+		clientID     string
+		privateKey   string
+		privateKeyID string
+		scopes       []string
+		expectError  bool
+	}{
+		{"access_token = pass", "accessToken", "", "", "", "", nil, false},
+		// NOTE: don't test apiToken, it causes a hit to the wire with a "GET
+		//       /api/v1/users/me" and the test tokens are scrubbed for this test
+		// {"api_token = pass", "", "apiToken", "", "", "", nil, false},
+		{"client_id, private_key, scopes = pass", "", "", "clientID", "privateKey", "", []string{"scope1", "scope2"}, false},
+		{"client_id, private_key, private_key_id, scopes = pass", "", "", "clientID", "privateKey", "privateKeyID", []string{"scope1", "scope2"}, false},
+	}
+
+	for _, test := range tests {
+		config := Config{
+			orgName:      "test",
+			domain:       "okta.com",
+			accessToken:  test.accessToken,
+			apiToken:     test.apiToken,
+			clientID:     test.clientID,
+			privateKey:   test.privateKey,
+			privateKeyId: test.privateKeyID,
+			scopes:       test.scopes,
+			logLevel:     int(hclog.Warn),
+		}
+		err := config.loadAndValidate(context.TODO())
+
+		if test.expectError && err == nil {
+			t.Errorf("test %q: expected error but received none", test.name)
+		}
+		if !test.expectError && err != nil {
+			t.Errorf("test %q: did not expect error but received error: %+v", test.name, err)
+			fmt.Println()
+		}
+	}
+}
diff --git a/okta/provider_test.go b/okta/provider_test.go
@@ -13,6 +13,7 @@ import (
 	"time"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
 	"github.com/okta/okta-sdk-golang/v2/okta"
 )
 
@@ -47,7 +48,7 @@ func oktaConfig() (*Config, error) {
 		httpProxy:      os.Getenv("OKTA_HTTP_PROXY"),
 		clientID:       os.Getenv("OKTA_API_CLIENT_ID"),
 		privateKey:     os.Getenv("OKTA_API_PRIVATE_KEY"),
-		privateKeyId: 	os.Getenv("OKTA_API_PRIVATE_KEY_ID"),
+		privateKeyId:   os.Getenv("OKTA_API_PRIVATE_KEY_ID"),
 		scopes:         strings.Split(os.Getenv("OKTA_API_SCOPES"), ","),
 		domain:         os.Getenv("OKTA_BASE_URL"),
 		parallelism:    1,
@@ -133,3 +134,104 @@ func TestHTTPProxy(t *testing.T) {
 		t.Fatal("Expected local server to handle user request, but it didn't")
 	}
 }
+
+func TestProviderValidate(t *testing.T) {
+	envKeys := []string{
+		"OKTA_ACCESS_TOKEN",
+		"OKTA_ALLOW_LONG_RUNNING_ACC_TEST",
+		"OKTA_API_CLIENT_ID",
+		"OKTA_API_PRIVATE_KEY",
+		"OKTA_API_PRIVATE_KEY_ID",
+		"OKTA_API_PRIVATE_KEY_IE",
+		"OKTA_API_SCOPES",
+		"OKTA_API_TOKEN",
+		"OKTA_BASE_URL",
+		"OKTA_DEFAULT",
+		"OKTA_GROUP",
+		"OKTA_HTTP_PROXY",
+		"OKTA_ORG_NAME",
+		"OKTA_UPDATE",
+	}
+	envVals := make(map[string]string)
+	// save and clear OKTA env vars so config can be test cleanly
+	for _, key := range envKeys {
+		val := os.Getenv(key)
+		if val == "" {
+			continue
+		}
+		envVals[key] = val
+		os.Unsetenv(key)
+	}
+
+	tests := []struct {
+		name         string
+		accessToken  string
+		apiToken     string
+		clientID     string
+		privateKey   string
+		privateKeyID string
+		scopes       []interface{}
+		expectError  bool
+	}{
+		{"simple pass", "", "", "", "", "", []interface{}{}, false},
+		{"access_token pass", "accessToken", "", "", "", "", []interface{}{}, false},
+		{"access_token fail 1", "accessToken", "apiToken", "", "", "", []interface{}{}, true},
+		{"access_token fail 2", "accessToken", "", "cliendID", "", "", []interface{}{}, true},
+		{"access_token fail 3", "accessToken", "", "", "privateKey", "", []interface{}{}, true},
+		{"access_token fail 4", "accessToken", "", "", "", "", []interface{}{"scope1", "scope2"}, true},
+		{"api_token pass", "", "apiToken", "", "", "", []interface{}{}, false},
+		{"api_token fail 1", "accessToken", "apiToken", "", "", "", []interface{}{}, true},
+		{"api_token fail 2", "", "apiToken", "clientID", "", "", []interface{}{}, true},
+		{"api_token fail 3", "", "apiToken", "", "", "privateKey", []interface{}{}, true},
+		{"api_token fail 4", "", "apiToken", "", "", "", []interface{}{"scope1", "scope2"}, true},
+		{"client_id pass", "", "", "clientID", "", "", []interface{}{}, false},
+		{"client_id fail 1", "accessToken", "", "clientID", "", "", []interface{}{}, true},
+		{"client_id fail 2", "accessToken", "apiToken", "clientID", "", "", []interface{}{}, true},
+		{"private_key pass", "", "", "", "privateKey", "", []interface{}{}, false},
+		{"private_key fail 1", "accessToken", "", "", "privateKey", "", []interface{}{}, true},
+		{"private_key fail 2", "", "apiToken", "", "privateKey", "", []interface{}{}, true},
+		{"private_key_id pass", "", "", "", "", "privateKeyID", []interface{}{}, false},
+		{"private_key_id fail 1", "", "apiToken", "", "", "privateKeyID", []interface{}{}, true},
+		{"scopes pass", "", "", "", "", "", []interface{}{"scope1", "scope2"}, false},
+		{"scopes fail 1", "accessToken", "", "", "", "", []interface{}{"scope1", "scope2"}, true},
+		{"scopes fail 2", "", "apiToken", "", "", "", []interface{}{"scope1", "scope2"}, true},
+	}
+
+	for _, test := range tests {
+		resourceConfig := map[string]interface{}{}
+		if test.accessToken != "" {
+			resourceConfig["access_token"] = test.accessToken
+		}
+		if test.apiToken != "" {
+			resourceConfig["api_token"] = test.apiToken
+		}
+		if test.clientID != "" {
+			resourceConfig["client_id"] = test.clientID
+		}
+		if test.privateKey != "" {
+			resourceConfig["private_key"] = test.privateKey
+		}
+		if test.privateKeyID != "" {
+			resourceConfig["private_key_id"] = test.privateKeyID
+		}
+		if len(test.scopes) > 0 {
+			resourceConfig["scopes"] = test.scopes
+		}
+
+		config := terraform.NewResourceConfigRaw(resourceConfig)
+		provider := Provider()
+		err := provider.Validate(config)
+
+		if test.expectError && err == nil {
+			t.Errorf("test %q: expected error but received none", test.name)
+		}
+		if !test.expectError && err != nil {
+			t.Errorf("test %q: did not expect error but received error: %+v", test.name, err)
+			fmt.Println()
+		}
+	}
+
+	for key, val := range envVals {
+		os.Setenv(key, val)
+	}
+}