Split some functions and tests into differnt files (#7684) (#5469)

Signed-off-by: Modular Magician <[email protected]>

Author: modular-magician

.changelog/7684.txt

@@ -0,0 +1,3 @@
+```release-note:none
+
+```

google-beta/bootstrap_iam_test.go renamed to google-beta/bootstrap_iam_test_utils.go

@@ -7,6 +7,7 @@ import (
 	"fmt"
 	"log"
 	"net/http"
+	"os"
 	"regexp"
 	"strconv"
 	"strings"
@@ -2056,3 +2057,31 @@ func ConfigureBasePaths(c *Config) {
 	c.BigtableAdminBasePath = DefaultBasePaths[BigtableAdminBasePathKey]
 	c.TagsLocationBasePath = DefaultBasePaths[TagsLocationBasePathKey]
 }
+
+func GetCurrentUserEmail(config *Config, userAgent string) (string, error) {
+	// When environment variables UserProjectOverride and BillingProject are set for the provider,
+	// the header X-Goog-User-Project is set for the API requests.
+	// But it causes an error when calling GetCurrentUserEmail. Set the project to be "NO_BILLING_PROJECT_OVERRIDE".
+	// And then it triggers the header X-Goog-User-Project to be set to empty string.
+
+	// See https://github.com/golang/oauth2/issues/306 for a recommendation to do this from a Go maintainer
+	// URL retrieved from https://accounts.google.com/.well-known/openid-configuration
+	res, err := SendRequest(config, "GET", "NO_BILLING_PROJECT_OVERRIDE", "https://openidconnect.googleapis.com/v1/userinfo", userAgent, nil)
+
+	if err != nil {
+		return "", fmt.Errorf("error retrieving userinfo for your provider credentials. have you enabled the 'https://www.googleapis.com/auth/userinfo.email' scope? error: %s", err)
+	}
+	if res["email"] == nil {
+		return "", fmt.Errorf("error retrieving email from userinfo. email was nil in the response.")
+	}
+	return res["email"].(string), nil
+}
+
+func MultiEnvSearch(ks []string) string {
+	for _, k := range ks {
+		if v := os.Getenv(k); v != "" {
+			return v
+		}
+	}
+	return ""
+}

google-beta/bootstrap_utils_test.go renamed to google-beta/bootstrap_test_utils.go

@@ -11,9 +11,6 @@ import (
 	"golang.org/x/oauth2/google"
 )
 
-const testFakeCredentialsPath = "./test-fixtures/fake_account.json"
-const testOauthScope = "https://www.googleapis.com/auth/compute"
-
 func TestHandleSDKDefaults_ImpersonateServiceAccount(t *testing.T) {
 	cases := map[string]struct {
 		ConfigValue      string

google-beta/config.go

@@ -5,6 +5,9 @@ import (
 	"strings"
 )
 
+const testFakeCredentialsPath = "./test-fixtures/fake_account.json"
+const testOauthScope = "https://www.googleapis.com/auth/compute"
+
 // NewTestConfig create a config using the http test server.
 func NewTestConfig(server *httptest.Server) *Config {
 	cfg := &Config{}

google-beta/config_test.go

@@ -0,0 +1,53 @@
+package google
+
+import (
+	"fmt"
+	"strings"
+)
+
+// List of prefixes used for test resource names
+var testResourcePrefixes = []string{
+	// tf-test and tf_test are automatically prepended to resource ids in examples that
+	// include a "-" or "_" respectively, and they are the preferred prefix for our test resources to use
+	"tf-test",
+	"tf_test",
+	"tfgen",
+	"gke-us-central1-tf",  // composer-created disks which are abandoned by design (https://cloud.google.com/composer/pricing)
+	"gcs-bucket-tf-test-", // https://github.com/hashicorp/terraform-provider-google/issues/8909
+	"df-",                 // https://github.com/hashicorp/terraform-provider-google/issues/8909
+	"resourcegroup-",      // https://github.com/hashicorp/terraform-provider-google/issues/8924
+	"cluster-",            // https://github.com/hashicorp/terraform-provider-google/issues/8924
+	"k8s-fw-",             // firewall rules are getting created and not cleaned up by k8 resources using this prefix
+}
+
+// SharedConfigForRegion returns a common config setup needed for the sweeper
+// functions for a given region
+func SharedConfigForRegion(region string) (*Config, error) {
+	project := GetTestProjectFromEnv()
+	if project == "" {
+		return nil, fmt.Errorf("set project using any of these env variables %v", ProjectEnvVars)
+	}
+
+	if v := MultiEnvSearch(CredsEnvVars); v == "" {
+		return nil, fmt.Errorf("set credentials using any of these env variables %v", CredsEnvVars)
+	}
+
+	conf := &Config{
+		Credentials: GetTestCredsFromEnv(),
+		Region:      region,
+		Project:     project,
+	}
+
+	ConfigureBasePaths(conf)
+
+	return conf, nil
+}
+
+func IsSweepableTestResource(resourceName string) bool {
+	for _, p := range testResourcePrefixes {
+		if strings.HasPrefix(resourceName, p) {
+			return true
+		}
+	}
+	return false
+}

google-beta/config_test_utils.go

@@ -1,60 +1,11 @@
 package google
 
 import (
-	"fmt"
-	"strings"
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
 )
 
-// List of prefixes used for test resource names
-var testResourcePrefixes = []string{
-	// tf-test and tf_test are automatically prepended to resource ids in examples that
-	// include a "-" or "_" respectively, and they are the preferred prefix for our test resources to use
-	"tf-test",
-	"tf_test",
-	"tfgen",
-	"gke-us-central1-tf",  // composer-created disks which are abandoned by design (https://cloud.google.com/composer/pricing)
-	"gcs-bucket-tf-test-", // https://github.com/hashicorp/terraform-provider-google/issues/8909
-	"df-",                 // https://github.com/hashicorp/terraform-provider-google/issues/8909
-	"resourcegroup-",      // https://github.com/hashicorp/terraform-provider-google/issues/8924
-	"cluster-",            // https://github.com/hashicorp/terraform-provider-google/issues/8924
-	"k8s-fw-",             // firewall rules are getting created and not cleaned up by k8 resources using this prefix
-}
-
 func TestMain(m *testing.M) {
 	resource.TestMain(m)
 }
-
-// SharedConfigForRegion returns a common config setup needed for the sweeper
-// functions for a given region
-func SharedConfigForRegion(region string) (*Config, error) {
-	project := GetTestProjectFromEnv()
-	if project == "" {
-		return nil, fmt.Errorf("set project using any of these env variables %v", ProjectEnvVars)
-	}
-
-	if v := MultiEnvSearch(CredsEnvVars); v == "" {
-		return nil, fmt.Errorf("set credentials using any of these env variables %v", CredsEnvVars)
-	}
-
-	conf := &Config{
-		Credentials: GetTestCredsFromEnv(),
-		Region:      region,
-		Project:     project,
-	}
-
-	ConfigureBasePaths(conf)
-
-	return conf, nil
-}
-
-func IsSweepableTestResource(resourceName string) bool {
-	for _, p := range testResourcePrefixes {
-		if strings.HasPrefix(resourceName, p) {
-			return true
-		}
-	}
-	return false
-}

google-beta/gcp_sweeper.go

@@ -466,3 +466,15 @@ func IamWithDeprecationMessage(message string) func(s *IamSettings) {
 func IamWithGAResourceDeprecation() func(s *IamSettings) {
 	return IamWithDeprecationMessage("")
 }
+
+// Util to deref and print auditConfigs
+func debugPrintAuditConfigs(bs []*cloudresourcemanager.AuditConfig) string {
+	v, _ := json.MarshalIndent(bs, "", "\t")
+	return string(v)
+}
+
+// Util to deref and print bindings
+func debugPrintBindings(bs []*cloudresourcemanager.Binding) string {
+	v, _ := json.MarshalIndent(bs, "", "\t")
+	return string(v)
+}

google-beta/gcp_sweeper_test.go

@@ -1,7 +1,6 @@
 package google
 
 import (
-	"encoding/json"
 	"reflect"
 	"testing"
 
@@ -1324,15 +1323,3 @@ func TestIamListFromIamAuditConfigsMap(t *testing.T) {
 		}
 	}
 }
-
-// Util to deref and print auditConfigs
-func debugPrintAuditConfigs(bs []*cloudresourcemanager.AuditConfig) string {
-	v, _ := json.MarshalIndent(bs, "", "\t")
-	return string(v)
-}
-
-// Util to deref and print bindings
-func debugPrintBindings(bs []*cloudresourcemanager.Binding) string {
-	v, _ := json.MarshalIndent(bs, "", "\t")
-	return string(v)
-}