Move files to the tpgresource package (#7891) (#5612)

* Move TerraformResourceData and field_helpers.go to the tpgresource package

* Move regional_utils.go to the tpgresource package

* Replace functions

* Move ResourceDataMock, ResourceDiffMock and ReplaceVarsForTest to the tpgresource package

* Fix DCL imports

* Fix imports format

* Move utils_test.go back to the google package

* Fix comments

* Fix the function name ReplaceVars

* Rebase the main branch

* Fix import path

* Move   TimoutError to the transport package

* Fix comments

* Add field_helper.go and regional_utils.go in the tpgresource package to the convertion list

* Import tpgresource package for validator files

* Rebase main branch

* Fix rebasing error

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

Author: modular-magician

.changelog/7891.txt

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

google-beta/acctest/provider_test_utils.go

@@ -150,7 +150,7 @@ func AccTestPreCheck(t *testing.T) {
 	}
 }
 
-// GetTestRegion has the same logic as the provider's getRegion, to be used in tests.
+// GetTestRegion has the same logic as the provider's GetRegion, to be used in tests.
 func GetTestRegion(is *terraform.InstanceState, config *transport_tpg.Config) (string, error) {
 	if res, ok := is.Attributes["region"]; ok {
 		return res, nil
@@ -161,7 +161,7 @@ func GetTestRegion(is *terraform.InstanceState, config *transport_tpg.Config) (s
 	return "", fmt.Errorf("%q: required field is not set", "region")
 }
 
-// GetTestProject has the same logic as the provider's getProject, to be used in tests.
+// GetTestProject has the same logic as the provider's GetProject, to be used in tests.
 func GetTestProject(is *terraform.InstanceState, config *transport_tpg.Config) (string, error) {
 	if res, ok := is.Attributes["project"]; ok {
 		return res, nil

google-beta/acctest/test_utils.go

@@ -3,113 +3,10 @@ package acctest
 import (
 	"errors"
 	"fmt"
-	"reflect"
-	"time"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
-	"github.com/hashicorp/terraform-provider-google-beta/google-beta/tpgresource"
 )
 
-type ResourceDataMock struct {
-	FieldsInSchema      map[string]interface{}
-	FieldsWithHasChange []string
-	id                  string
-}
-
-func (d *ResourceDataMock) HasChange(key string) bool {
-	exists := false
-	for _, val := range d.FieldsWithHasChange {
-		if key == val {
-			exists = true
-		}
-	}
-
-	return exists
-}
-
-func (d *ResourceDataMock) Get(key string) interface{} {
-	v, _ := d.GetOk(key)
-	return v
-}
-
-func (d *ResourceDataMock) GetOk(key string) (interface{}, bool) {
-	v, ok := d.GetOkExists(key)
-	if ok && !tpgresource.IsEmptyValue(reflect.ValueOf(v)) {
-		return v, true
-	} else {
-		return v, false
-	}
-}
-
-func (d *ResourceDataMock) GetOkExists(key string) (interface{}, bool) {
-	for k, v := range d.FieldsInSchema {
-		if key == k {
-			return v, true
-		}
-	}
-
-	return nil, false
-}
-
-func (d *ResourceDataMock) Set(key string, value interface{}) error {
-	d.FieldsInSchema[key] = value
-	return nil
-}
-
-func (d *ResourceDataMock) SetId(v string) {
-	d.id = v
-}
-
-func (d *ResourceDataMock) Id() string {
-	return d.id
-}
-
-func (d *ResourceDataMock) GetProviderMeta(dst interface{}) error {
-	return nil
-}
-
-func (d *ResourceDataMock) Timeout(key string) time.Duration {
-	return time.Duration(1)
-}
-
-type ResourceDiffMock struct {
-	Before     map[string]interface{}
-	After      map[string]interface{}
-	Cleared    map[string]interface{}
-	IsForceNew bool
-}
-
-func (d *ResourceDiffMock) GetChange(key string) (interface{}, interface{}) {
-	return d.Before[key], d.After[key]
-}
-
-func (d *ResourceDiffMock) HasChange(key string) bool {
-	old, new := d.GetChange(key)
-	return old != new
-}
-
-func (d *ResourceDiffMock) Get(key string) interface{} {
-	return d.After[key]
-}
-
-func (d *ResourceDiffMock) GetOk(key string) (interface{}, bool) {
-	v, ok := d.After[key]
-	return v, ok
-}
-
-func (d *ResourceDiffMock) Clear(key string) error {
-	if d.Cleared == nil {
-		d.Cleared = map[string]interface{}{}
-	}
-	d.Cleared[key] = true
-	return nil
-}
-
-func (d *ResourceDiffMock) ForceNew(key string) error {
-	d.IsForceNew = true
-	return nil
-}
-
 func CheckDataSourceStateMatchesResourceState(dataSourceName, resourceName string) func(*terraform.State) error {
 	return CheckDataSourceStateMatchesResourceStateWithIgnores(dataSourceName, resourceName, map[string]struct{}{})
 }
@@ -157,17 +54,3 @@ func CheckDataSourceStateMatchesResourceStateWithIgnores(dataSourceName, resourc
 		return nil
 	}
 }
-
-type TimeoutError struct {
-	timeout bool
-}
-
-func (e *TimeoutError) Timeout() bool {
-	return e.timeout
-}
-
-func (e *TimeoutError) Error() string {
-	return "timeout error"
-}
-
-var TimeoutErr = &TimeoutError{timeout: true}

google-beta/acctest/transport_test_utils.go

@@ -5,7 +5,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/hashicorp/terraform-provider-google-beta/google-beta/acctest"
+	transport_tpg "github.com/hashicorp/terraform-provider-google-beta/google-beta/transport"
 )
 
 type TestWaiter struct {
@@ -35,7 +35,7 @@ func (w *TestWaiter) QueryOp() (interface{}, error) {
 	w.runCount++
 	if w.runCount == 1 {
 		return nil, &url.Error{
-			Err: acctest.TimeoutErr,
+			Err: transport_tpg.TimeoutErr,
 		}
 	}
 	return "my return value", nil

google-beta/common_operation_test.go

@@ -260,7 +260,7 @@ func flattenNetworkInterfaces(d *schema.ResourceData, config *transport_tpg.Conf
 		var ac []map[string]interface{}
 		ac, externalIP = flattenAccessConfigs(iface.AccessConfigs)
 
-		subnet, err := ParseSubnetworkFieldValue(iface.Subnetwork, d, config)
+		subnet, err := tpgresource.ParseSubnetworkFieldValue(iface.Subnetwork, d, config)
 		if err != nil {
 			return nil, "", "", "", err
 		}
@@ -326,7 +326,7 @@ func expandIpv6AccessConfigs(configs []interface{}) []*compute.AccessConfig {
 	return iacs
 }
 
-func expandNetworkInterfaces(d TerraformResourceData, config *transport_tpg.Config) ([]*compute.NetworkInterface, error) {
+func expandNetworkInterfaces(d tpgresource.TerraformResourceData, config *transport_tpg.Config) ([]*compute.NetworkInterface, error) {
 	configs := d.Get("network_interface").([]interface{})
 	ifaces := make([]*compute.NetworkInterface, len(configs))
 	for i, raw := range configs {
@@ -338,13 +338,13 @@ func expandNetworkInterfaces(d TerraformResourceData, config *transport_tpg.Conf
 			return nil, fmt.Errorf("exactly one of network or subnetwork must be provided")
 		}
 
-		nf, err := ParseNetworkFieldValue(network, d, config)
+		nf, err := tpgresource.ParseNetworkFieldValue(network, d, config)
 		if err != nil {
 			return nil, fmt.Errorf("cannot determine self_link for network %q: %s", network, err)
 		}
 
 		subnetProjectField := fmt.Sprintf("network_interface.%d.subnetwork_project", i)
-		sf, err := ParseSubnetworkFieldValueWithProjectField(subnetwork, subnetProjectField, d, config)
+		sf, err := tpgresource.ParseSubnetworkFieldValueWithProjectField(subnetwork, subnetProjectField, d, config)
 		if err != nil {
 			return nil, fmt.Errorf("cannot determine self_link for subnetwork %q: %s", subnetwork, err)
 		}
@@ -403,7 +403,7 @@ func flattenGuestAccelerators(accelerators []*compute.AcceleratorConfig) []map[s
 	return acceleratorsSchema
 }
 
-func resourceInstanceTags(d TerraformResourceData) *compute.Tags {
+func resourceInstanceTags(d tpgresource.TerraformResourceData) *compute.Tags {
 	// Calculate the tags
 	var tags *compute.Tags
 	if v := d.Get("tags"); v != nil {
@@ -420,7 +420,7 @@ func resourceInstanceTags(d TerraformResourceData) *compute.Tags {
 	return tags
 }
 
-func expandShieldedVmConfigs(d TerraformResourceData) *compute.ShieldedInstanceConfig {
+func expandShieldedVmConfigs(d tpgresource.TerraformResourceData) *compute.ShieldedInstanceConfig {
 	if _, ok := d.GetOk("shielded_instance_config"); !ok {
 		return nil
 	}
@@ -434,7 +434,7 @@ func expandShieldedVmConfigs(d TerraformResourceData) *compute.ShieldedInstanceC
 	}
 }
 
-func expandConfidentialInstanceConfig(d TerraformResourceData) *compute.ConfidentialInstanceConfig {
+func expandConfidentialInstanceConfig(d tpgresource.TerraformResourceData) *compute.ConfidentialInstanceConfig {
 	if _, ok := d.GetOk("confidential_instance_config"); !ok {
 		return nil
 	}
@@ -455,7 +455,7 @@ func flattenConfidentialInstanceConfig(ConfidentialInstanceConfig *compute.Confi
 	}}
 }
 
-func expandAdvancedMachineFeatures(d TerraformResourceData) *compute.AdvancedMachineFeatures {
+func expandAdvancedMachineFeatures(d tpgresource.TerraformResourceData) *compute.AdvancedMachineFeatures {
 	if _, ok := d.GetOk("advanced_machine_features"); !ok {
 		return nil
 	}
@@ -491,7 +491,7 @@ func flattenShieldedVmConfig(shieldedVmConfig *compute.ShieldedInstanceConfig) [
 	}}
 }
 
-func expandDisplayDevice(d TerraformResourceData) *compute.DisplayDevice {
+func expandDisplayDevice(d tpgresource.TerraformResourceData) *compute.DisplayDevice {
 	if _, ok := d.GetOk("enable_display"); !ok {
 		return nil
 	}
@@ -637,7 +637,7 @@ func flattenReservationAffinity(affinity *compute.ReservationAffinity) []map[str
 	return []map[string]interface{}{flattened}
 }
 
-func expandNetworkPerformanceConfig(d TerraformResourceData, config *transport_tpg.Config) (*compute.NetworkPerformanceConfig, error) {
+func expandNetworkPerformanceConfig(d tpgresource.TerraformResourceData, config *transport_tpg.Config) (*compute.NetworkPerformanceConfig, error) {
 	configs, ok := d.GetOk("network_performance_config")
 	if !ok {
 		return nil, nil

google-beta/compute_instance_helpers.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/hashicorp/terraform-provider-google-beta/google-beta/tpgresource"
 	transport_tpg "github.com/hashicorp/terraform-provider-google-beta/google-beta/transport"
 )
 
@@ -30,20 +31,20 @@ func DataSourceAccessApprovalFolderServiceAccount() *schema.Resource {
 
 func dataSourceAccessApprovalFolderServiceAccountRead(d *schema.ResourceData, meta interface{}) error {
 	config := meta.(*transport_tpg.Config)
-	userAgent, err := generateUserAgentString(d, config.UserAgent)
+	userAgent, err := tpgresource.GenerateUserAgentString(d, config.UserAgent)
 	if err != nil {
 		return err
 	}
 
-	url, err := ReplaceVars(d, config, "{{AccessApprovalBasePath}}folders/{{folder_id}}/serviceAccount")
+	url, err := tpgresource.ReplaceVars(d, config, "{{AccessApprovalBasePath}}folders/{{folder_id}}/serviceAccount")
 	if err != nil {
 		return err
 	}
 
 	billingProject := ""
 
 	// err == nil indicates that the billing_project value was found
-	if bp, err := getBillingProject(d, config); err == nil {
+	if bp, err := tpgresource.GetBillingProject(d, config); err == nil {
 		billingProject = bp
 	}
 

google-beta/data_source_access_approval_folder_service_account.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/hashicorp/terraform-provider-google-beta/google-beta/tpgresource"
 	transport_tpg "github.com/hashicorp/terraform-provider-google-beta/google-beta/transport"
 )
 
@@ -30,20 +31,20 @@ func DataSourceAccessApprovalOrganizationServiceAccount() *schema.Resource {
 
 func dataSourceAccessApprovalOrganizationServiceAccountRead(d *schema.ResourceData, meta interface{}) error {
 	config := meta.(*transport_tpg.Config)
-	userAgent, err := generateUserAgentString(d, config.UserAgent)
+	userAgent, err := tpgresource.GenerateUserAgentString(d, config.UserAgent)
 	if err != nil {
 		return err
 	}
 
-	url, err := ReplaceVars(d, config, "{{AccessApprovalBasePath}}organizations/{{organization_id}}/serviceAccount")
+	url, err := tpgresource.ReplaceVars(d, config, "{{AccessApprovalBasePath}}organizations/{{organization_id}}/serviceAccount")
 	if err != nil {
 		return err
 	}
 
 	billingProject := ""
 
 	// err == nil indicates that the billing_project value was found
-	if bp, err := getBillingProject(d, config); err == nil {
+	if bp, err := tpgresource.GetBillingProject(d, config); err == nil {
 		billingProject = bp
 	}