Move files to tpgiamresource package (#7984) (#5672)

* Move files to tpgiamresource package

* Add docs

* Use type alias

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

Author: modular-magician

.changelog/7984.txt

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

google-beta/bootstrap_iam_test_utils.go

@@ -6,6 +6,7 @@ import (
 	"testing"
 
 	"github.com/hashicorp/terraform-provider-google-beta/google-beta/acctest"
+	"github.com/hashicorp/terraform-provider-google-beta/google-beta/tpgiamresource"
 	cloudresourcemanager "google.golang.org/api/cloudresourcemanager/v1"
 )
 
@@ -49,10 +50,10 @@ func BootstrapAllPSARoles(t *testing.T, prefix string, agentNames, roles []strin
 		})
 	}
 
-	mergedBindings := MergeBindings(append(policy.Bindings, newBindings...))
+	mergedBindings := tpgiamresource.MergeBindings(append(policy.Bindings, newBindings...))
 
-	if !compareBindings(policy.Bindings, mergedBindings) {
-		addedBindings := missingBindings(policy.Bindings, mergedBindings)
+	if !tpgiamresource.CompareBindings(policy.Bindings, mergedBindings) {
+		addedBindings := tpgiamresource.MissingBindings(policy.Bindings, mergedBindings)
 		for _, missingBinding := range addedBindings {
 			log.Printf("[DEBUG] Adding binding: %+v", missingBinding)
 		}
@@ -92,61 +93,10 @@ func BootstrapPSARole(t *testing.T, prefix, agentName, role string) bool {
 	return BootstrapPSARoles(t, prefix, agentName, []string{role})
 }
 
-// Returns a map representing iam bindings that are in the first map but not the second.
-func missingBindingsMap(aMap, bMap map[iamBindingKey]map[string]struct{}) map[iamBindingKey]map[string]struct{} {
-	results := make(map[iamBindingKey]map[string]struct{})
-	for key, aMembers := range aMap {
-		if bMembers, ok := bMap[key]; ok {
-			// The key is in both maps.
-			resultMembers := make(map[string]struct{})
-
-			for aMember := range aMembers {
-				if _, ok := bMembers[aMember]; !ok {
-					// The member is in a but not in b.
-					resultMembers[aMember] = struct{}{}
-				}
-			}
-			for bMember := range bMembers {
-				if _, ok := aMembers[bMember]; !ok {
-					// The member is in b but not in a.
-					resultMembers[bMember] = struct{}{}
-				}
-			}
-
-			if len(resultMembers) > 0 {
-				results[key] = resultMembers
-			}
-		} else {
-			// The key is in map a but not map b.
-			results[key] = aMembers
-		}
-	}
-
-	for key, bMembers := range bMap {
-		if _, ok := aMap[key]; !ok {
-			// The key is in map b but not map a.
-			results[key] = bMembers
-		}
-	}
-
-	return results
-}
-
 // Returns the bindings that are in the first set of bindings but not the second.
+//
+// Deprecated: For backward compatibility missingBindings is still working,
+// but all new code should use MissingBindings in the tpgiamresource package instead.
 func missingBindings(a, b []*cloudresourcemanager.Binding) []*cloudresourcemanager.Binding {
-	aMap := createIamBindingsMap(a)
-	bMap := createIamBindingsMap(b)
-
-	var results []*cloudresourcemanager.Binding
-	for key, membersSet := range missingBindingsMap(aMap, bMap) {
-		members := make([]string, 0, len(membersSet))
-		for member := range membersSet {
-			members = append(members, member)
-		}
-		results = append(results, &cloudresourcemanager.Binding{
-			Role:    key.Role,
-			Members: members,
-		})
-	}
-	return results
+	return tpgiamresource.MissingBindings(a, b)
 }

google-beta/bootstrap_test_utils.go

@@ -10,6 +10,7 @@ import (
 	"time"
 
 	"github.com/hashicorp/terraform-provider-google-beta/google-beta/acctest"
+	"github.com/hashicorp/terraform-provider-google-beta/google-beta/tpgiamresource"
 	"github.com/hashicorp/terraform-provider-google-beta/google-beta/tpgresource"
 	transport_tpg "github.com/hashicorp/terraform-provider-google-beta/google-beta/transport"
 
@@ -841,19 +842,19 @@ func setupProjectsAndGetAccessToken(org, billing, pid, service string, config *t
 		Role:    "roles/iam.serviceAccountCreator",
 	}
 
-	bindings := MergeBindings([]*cloudresourcemanager.Binding{proj1SATokenCreator, proj1SACreator})
+	bindings := tpgiamresource.MergeBindings([]*cloudresourcemanager.Binding{proj1SATokenCreator, proj1SACreator})
 
 	p, err := rmService.Projects.GetIamPolicy(pid,
 		&cloudresourcemanager.GetIamPolicyRequest{
 			Options: &cloudresourcemanager.GetPolicyOptions{
-				RequestedPolicyVersion: IamPolicyVersion,
+				RequestedPolicyVersion: tpgiamresource.IamPolicyVersion,
 			},
 		}).Do()
 	if err != nil {
 		return "", err
 	}
 
-	p.Bindings = MergeBindings(append(p.Bindings, bindings...))
+	p.Bindings = tpgiamresource.MergeBindings(append(p.Bindings, bindings...))
 	_, err = config.NewResourceManagerClient(config.UserAgent).Projects.SetIamPolicy(pid,
 		&cloudresourcemanager.SetIamPolicyRequest{
 			Policy:     p,
@@ -883,7 +884,7 @@ func setupProjectsAndGetAccessToken(org, billing, pid, service string, config *t
 		Role:    fmt.Sprintf("roles/%s.admin", service),
 	}
 
-	bindings = MergeBindings([]*cloudresourcemanager.Binding{proj2ServiceUsageBinding, proj2ServiceAdminBinding})
+	bindings = tpgiamresource.MergeBindings([]*cloudresourcemanager.Binding{proj2ServiceUsageBinding, proj2ServiceAdminBinding})
 
 	// For KMS test only
 	if service == "cloudkms" {
@@ -892,20 +893,20 @@ func setupProjectsAndGetAccessToken(org, billing, pid, service string, config *t
 			Role:    "roles/cloudkms.cryptoKeyEncrypter",
 		}
 
-		bindings = MergeBindings(append(bindings, proj2CryptoKeyBinding))
+		bindings = tpgiamresource.MergeBindings(append(bindings, proj2CryptoKeyBinding))
 	}
 
 	p, err = rmService.Projects.GetIamPolicy(p2,
 		&cloudresourcemanager.GetIamPolicyRequest{
 			Options: &cloudresourcemanager.GetPolicyOptions{
-				RequestedPolicyVersion: IamPolicyVersion,
+				RequestedPolicyVersion: tpgiamresource.IamPolicyVersion,
 			},
 		}).Do()
 	if err != nil {
 		return "", err
 	}
 
-	p.Bindings = MergeBindings(append(p.Bindings, bindings...))
+	p.Bindings = tpgiamresource.MergeBindings(append(p.Bindings, bindings...))
 	_, err = config.NewResourceManagerClient(config.UserAgent).Projects.SetIamPolicy(p2,
 		&cloudresourcemanager.SetIamPolicyRequest{
 			Policy:     p,

google-beta/compute_instance_helpers.go

@@ -111,7 +111,7 @@ func expandScheduling(v interface{}) (*compute.Scheduling, error) {
 			transformed := &compute.SchedulingNodeAffinity{
 				Key:      nodeAff["key"].(string),
 				Operator: nodeAff["operator"].(string),
-				Values:   convertStringArr(nodeAff["values"].(*schema.Set).List()),
+				Values:   tpgresource.ConvertStringArr(nodeAff["values"].(*schema.Set).List()),
 			}
 			scheduling.NodeAffinities = append(scheduling.NodeAffinities, transformed)
 		}
@@ -204,7 +204,7 @@ func flattenScheduling(resp *compute.Scheduling) []map[string]interface{} {
 		nodeAffinities.Add(map[string]interface{}{
 			"key":      na.Key,
 			"operator": na.Operator,
-			"values":   schema.NewSet(schema.HashString, convertStringArrToInterface(na.Values)),
+			"values":   schema.NewSet(schema.HashString, tpgresource.ConvertStringArrToInterface(na.Values)),
 		})
 	}
 	schedulingMap["node_affinities"] = nodeAffinities
@@ -369,7 +369,7 @@ func flattenServiceAccounts(serviceAccounts []*compute.ServiceAccount) []map[str
 	for i, serviceAccount := range serviceAccounts {
 		result[i] = map[string]interface{}{
 			"email":  serviceAccount.Email,
-			"scopes": schema.NewSet(tpgresource.StringScopeHashcode, convertStringArrToInterface(serviceAccount.Scopes)),
+			"scopes": schema.NewSet(tpgresource.StringScopeHashcode, tpgresource.ConvertStringArrToInterface(serviceAccount.Scopes)),
 		}
 	}
 	return result

google-beta/data_source_google_compute_instance.go

@@ -86,7 +86,7 @@ func dataSourceGoogleComputeInstanceRead(d *schema.ResourceData, meta interface{
 		if err := d.Set("tags_fingerprint", instance.Tags.Fingerprint); err != nil {
 			return fmt.Errorf("Error setting tags_fingerprint: %s", err)
 		}
-		if err := d.Set("tags", convertStringArrToInterface(instance.Tags.Items)); err != nil {
+		if err := d.Set("tags", tpgresource.ConvertStringArrToInterface(instance.Tags.Items)); err != nil {
 			return fmt.Errorf("Error setting tags: %s", err)
 		}
 	}

google-beta/data_source_google_iam_policy.go

@@ -198,7 +198,7 @@ func expandAuditConfig(set *schema.Set) []*cloudresourcemanager.AuditConfig {
 			logConfig := y.(map[string]interface{})
 			auditLogConfigs = append(auditLogConfigs, &cloudresourcemanager.AuditLogConfig{
 				LogType:         logConfig["log_type"].(string),
-				ExemptedMembers: convertStringArr(logConfig["exempted_members"].(*schema.Set).List()),
+				ExemptedMembers: tpgresource.ConvertStringArr(logConfig["exempted_members"].(*schema.Set).List()),
 			})
 		}
 		auditConfigs = append(auditConfigs, &cloudresourcemanager.AuditConfig{

google-beta/data_source_monitoring_service.go

@@ -25,7 +25,7 @@ func dataSourceMonitoringServiceType(
 	tpgresource.AddOptionalFieldsToSchema(dsSchema, "project")
 
 	// Add schema specific to the service type
-	dsSchema = mergeSchemas(typeSchema, dsSchema)
+	dsSchema = tpgresource.MergeSchemas(typeSchema, dsSchema)
 
 	return &schema.Resource{
 		Read:   dataSourceMonitoringServiceTypeReadFromList(listFilter, typeStateSetter),

google-beta/datasource_iam_policy.go

@@ -2,61 +2,11 @@ package google
 
 import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
-
-	"fmt"
-
-	transport_tpg "github.com/hashicorp/terraform-provider-google-beta/google-beta/transport"
+	"github.com/hashicorp/terraform-provider-google-beta/google-beta/tpgiamresource"
 )
 
-var IamPolicyBaseDataSourceSchema = map[string]*schema.Schema{
-	"policy_data": {
-		Type:     schema.TypeString,
-		Computed: true,
-	},
-	"etag": {
-		Type:     schema.TypeString,
-		Computed: true,
-	},
-}
-
-func DataSourceIamPolicy(parentSpecificSchema map[string]*schema.Schema, newUpdaterFunc newResourceIamUpdaterFunc, options ...func(*IamSettings)) *schema.Resource {
-	settings := &IamSettings{}
-	for _, o := range options {
-		o(settings)
-	}
-
-	return &schema.Resource{
-		Read: DatasourceIamPolicyRead(newUpdaterFunc),
-		// if non-empty, this will be used to send a deprecation message when the
-		// datasource is used.
-		DeprecationMessage: settings.DeprecationMessage,
-		Schema:             mergeSchemas(IamPolicyBaseDataSourceSchema, parentSpecificSchema),
-		UseJSONNumber:      true,
-	}
-}
-
-func DatasourceIamPolicyRead(newUpdaterFunc newResourceIamUpdaterFunc) schema.ReadFunc {
-	return func(d *schema.ResourceData, meta interface{}) error {
-		config := meta.(*transport_tpg.Config)
-
-		updater, err := newUpdaterFunc(d, config)
-		if err != nil {
-			return err
-		}
-
-		policy, err := iamPolicyReadWithRetry(updater)
-		if err != nil {
-			return transport_tpg.HandleNotFoundError(err, d, fmt.Sprintf("Resource %q with IAM Policy", updater.DescribeResource()))
-		}
-
-		if err := d.Set("etag", policy.Etag); err != nil {
-			return fmt.Errorf("Error setting etag: %s", err)
-		}
-		if err := d.Set("policy_data", marshalIamPolicy(policy)); err != nil {
-			return fmt.Errorf("Error setting policy_data: %s", err)
-		}
-		d.SetId(updater.GetResourceId())
-
-		return nil
-	}
+// Deprecated: For backward compatibility DataSourceIamPolicy is still working,
+// but all new code should use DataSourceIamPolicy in the tpgiamresource package instead.
+func DataSourceIamPolicy(parentSpecificSchema map[string]*schema.Schema, newUpdaterFunc tpgiamresource.NewResourceIamUpdaterFunc, options ...func(*tpgiamresource.IamSettings)) *schema.Resource {
+	return tpgiamresource.DataSourceIamPolicy(parentSpecificSchema, newUpdaterFunc, options...)
 }