refactor: move data conversion code to internal/converters (#473)

This PR is part of a refactoring effort (#106). It moves some helper
code to another internal subpackage.

equinix/data_source_ecx_l2_sellerprofile.go

@@ -6,6 +6,8 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/equinix/terraform-provider-equinix/internal/hashcode"
+
 	"github.com/equinix/terraform-provider-equinix/internal/config"
 
 	"github.com/equinix/ecx-go/v2"
@@ -349,19 +351,19 @@ func ecxL2ServiceProfileSpeedBandHash(v interface{}) int {
 	m := v.(map[string]interface{})
 	buf.WriteString(fmt.Sprintf("%d-", m[ecxL2ServiceProfileSpeedBandSchemaNames["Speed"]].(int)))
 	buf.WriteString(fmt.Sprintf("%s-", m[ecxL2ServiceProfileSpeedBandSchemaNames["SpeedUnit"]].(string)))
-	return hashcodeString(buf.String())
+	return hashcode.String(buf.String())
 }
 
 func ecxL2SellerProfileMetroHash(v interface{}) int {
 	var buf bytes.Buffer
 	m := v.(map[string]interface{})
 	buf.WriteString(fmt.Sprintf("%s-", m[ecxL2SellerProfileMetrosSchemaNames["Code"]].(string)))
-	return hashcodeString(buf.String())
+	return hashcode.String(buf.String())
 }
 
 func ecxL2SellerProfileAdditionalInfoHash(v interface{}) int {
 	var buf bytes.Buffer
 	m := v.(map[string]interface{})
 	buf.WriteString(fmt.Sprintf("%s-", m[ecxL2SellerProfileAdditionalInfosSchemaNames["Name"]].(string)))
-	return hashcodeString(buf.String())
+	return hashcode.String(buf.String())
 }

equinix/data_source_metal_facility.go

@@ -4,6 +4,8 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/equinix/terraform-provider-equinix/internal/converters"
+
 	equinix_schema "github.com/equinix/terraform-provider-equinix/internal/schema"
 
 	"github.com/equinix/terraform-provider-equinix/internal/config"
@@ -118,7 +120,7 @@ func dataSourceMetalFacilityRead(d *schema.ResourceData, meta interface{}) error
 	for _, f := range facilities {
 		if f.Code == code {
 			if dfOk {
-				unsupported := difference(convertStringArr(dfRaw.(*schema.Set).List()), f.Features)
+				unsupported := converters.Difference(converters.IfArrToStringArr(dfRaw.(*schema.Set).List()), f.Features)
 				if len(unsupported) > 0 {
 					return fmt.Errorf("facililty %s doesn't have feature(s) %v", f.Code, unsupported)
 				}

equinix/data_source_metal_ip_block_ranges.go

@@ -3,6 +3,8 @@ package equinix
 import (
 	"fmt"
 
+	"github.com/equinix/terraform-provider-equinix/internal/converters"
+
 	"github.com/equinix/terraform-provider-equinix/internal/config"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -29,7 +31,7 @@ func dataSourceMetalIPBlockRanges() *schema.Resource {
 				Type:        schema.TypeString,
 				Description: "Metro code filtering the IP blocks. Global IPv4 blocks will be listed anyway. If you omit this and facility, all the block from the project will be listed",
 				Optional:    true,
-				StateFunc:   toLower,
+				StateFunc:   converters.ToLowerIf,
 			},
 			"public_ipv4": {
 				Type:        schema.TypeList,

equinix/data_source_metal_plans.go

@@ -3,6 +3,8 @@ package equinix
 import (
 	"fmt"
 
+	"github.com/equinix/terraform-provider-equinix/internal/converters"
+
 	"github.com/equinix/terraform-provider-equinix/internal/config"
 
 	"github.com/equinix/terraform-provider-equinix/internal/datalist"
@@ -108,10 +110,10 @@ func flattenPlan(rawPlan interface{}, meta interface{}, extra map[string]interfa
 		metros = append(metros, m.Code)
 	}
 
-	flattenedFacs := schema.NewSet(schema.HashString, stringArrToIfArr(facs))
-	flattenedMetros := schema.NewSet(schema.HashString, stringArrToIfArr(metros))
+	flattenedFacs := schema.NewSet(schema.HashString, converters.StringArrToIfArr(facs))
+	flattenedMetros := schema.NewSet(schema.HashString, converters.StringArrToIfArr(metros))
 	flattenedDepTypes := schema.NewSet(schema.HashString,
-		stringArrToIfArr(plan.DeploymentTypes))
+		converters.StringArrToIfArr(plan.DeploymentTypes))
 
 	flattenedPlan := map[string]interface{}{
 		"id":                  plan.ID,

equinix/data_source_metal_spot_market_price.go

@@ -3,6 +3,8 @@ package equinix
 import (
 	"fmt"
 
+	"github.com/equinix/terraform-provider-equinix/internal/converters"
+
 	"github.com/equinix/terraform-provider-equinix/internal/config"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -25,7 +27,7 @@ func dataSourceSpotMarketPrice() *schema.Resource {
 				Description:   "Name of the metro",
 				ConflictsWith: []string{"facility"},
 				Optional:      true,
-				StateFunc:     toLower,
+				StateFunc:     converters.ToLowerIf,
 			},
 			"plan": {
 				Type:        schema.TypeString,

equinix/data_source_metal_vlan.go

@@ -3,6 +3,8 @@ package equinix
 import (
 	"fmt"
 
+	"github.com/equinix/terraform-provider-equinix/internal/converters"
+
 	equinix_errors "github.com/equinix/terraform-provider-equinix/internal/errors"
 	equinix_schema "github.com/equinix/terraform-provider-equinix/internal/schema"
 
@@ -47,7 +49,7 @@ func dataSourceMetalVlan() *schema.Resource {
 				Computed:      true,
 				ConflictsWith: []string{"vlan_id", "facility"},
 				Description:   "Metro where the VLAN is deployed",
-				StateFunc:     toLower,
+				StateFunc:     converters.ToLowerIf,
 			},
 			"vlan_id": {
 				Type:          schema.TypeString,

equinix/helpers_device.go

@@ -12,6 +12,8 @@ import (
 	"sync"
 	"time"
 
+	"github.com/equinix/terraform-provider-equinix/internal/converters"
+
 	equinix_errors "github.com/equinix/terraform-provider-equinix/internal/errors"
 
 	metalv1 "github.com/equinix-labs/metal-go/metal/v1"
@@ -49,7 +51,7 @@ func ifToIPCreateRequest(m interface{}) packngo.IPAddressCreateRequest {
 		iacr.Public = true
 	}
 	iacr.CIDR = ia["cidr"].(int)
-	iacr.Reservations = convertStringArr(ia["reservation_ids"].([]interface{}))
+	iacr.Reservations = converters.IfArrToStringArr(ia["reservation_ids"].([]interface{}))
 	return iacr
 }
 
@@ -269,7 +271,7 @@ func getDeviceMap(device metalv1.Device) map[string]interface{} {
 		"ipxe_script_url":     device.GetIpxeScriptUrl(),
 		"always_pxe":          device.GetAlwaysPxe(),
 		"root_password":       device.GetRootPassword(),
-		"tags":                stringArrToIfArr(device.GetTags()),
+		"tags":                converters.StringArrToIfArr(device.GetTags()),
 		"access_public_ipv6":  networkInfo.PublicIPv6,
 		"access_public_ipv4":  networkInfo.PublicIPv4,
 		"access_private_ipv4": networkInfo.PrivateIPv4,

equinix/helpers_device_test.go

@@ -6,6 +6,8 @@ import (
 	"testing"
 	"time"
 
+	"golang.org/x/exp/slices"
+
 	"github.com/packethost/packngo"
 )
 
@@ -79,7 +81,7 @@ func Test_waitUntilReservationProvisionable(t *testing.T) {
 								*invoked++
 
 								var device *packngo.Device
-								if opts != nil && contains(opts.Includes, "device") {
+								if opts != nil && slices.Contains(opts.Includes, "device") {
 									device = &packngo.Device{ID: response.id}
 								}
 								return &packngo.HardwareReservation{
@@ -114,7 +116,7 @@ func Test_waitUntilReservationProvisionable(t *testing.T) {
 								*invoked++
 
 								var device *packngo.Device
-								if opts != nil && contains(opts.Includes, "device") {
+								if opts != nil && slices.Contains(opts.Includes, "device") {
 									device = &packngo.Device{ID: response.id}
 								}
 								return &packngo.HardwareReservation{

equinix/port_helpers.go

@@ -6,6 +6,10 @@ import (
 	"strings"
 	"time"
 
+	"golang.org/x/exp/slices"
+
+	"github.com/equinix/terraform-provider-equinix/internal/converters"
+
 	"github.com/equinix/terraform-provider-equinix/internal/config"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/retry"
@@ -119,12 +123,12 @@ func specifiedVlanIds(d *schema.ResourceData) []string {
 	// either vlan_ids or vxlan_ids should be set, TF should ensure that
 	vlanIdsRaw, vlanIdsOk := d.GetOk("vlan_ids")
 	if vlanIdsOk {
-		return convertStringArr(vlanIdsRaw.(*schema.Set).List())
+		return converters.IfArrToStringArr(vlanIdsRaw.(*schema.Set).List())
 	}
 
 	vxlanIdsRaw, vxlanIdsOk := d.GetOk("vxlan_ids")
 	if vxlanIdsOk {
-		return convertIntArr(vxlanIdsRaw.(*schema.Set).List())
+		return converters.IfArrToIntStringArr(vxlanIdsRaw.(*schema.Set).List())
 	}
 	return []string{}
 }
@@ -133,14 +137,14 @@ func batchVlans(ctx context.Context, start time.Time, removeOnly bool) func(*Cli
 	return func(cpr *ClientPortResource) error {
 		var vlansToAssign []string
 		var currentNative string
-		vlansToRemove := difference(
+		vlansToRemove := converters.Difference(
 			attachedVlanIds(cpr.Port),
 			specifiedVlanIds(cpr.Resource),
 		)
 		if !removeOnly {
 			currentNative = getCurrentNative(cpr.Port)
 
-			vlansToAssign = difference(
+			vlansToAssign = converters.Difference(
 				specifiedVlanIds(cpr.Resource),
 				attachedVlanIds(cpr.Port),
 			)
@@ -271,7 +275,7 @@ func makeDisbond(cpr *ClientPortResource) error {
 
 func convertToL2(cpr *ClientPortResource) error {
 	l2, l2Ok := cpr.Resource.GetOkExists("layer2")
-	isLayer2 := contains(l2Types, cpr.Port.NetworkType)
+	isLayer2 := slices.Contains(l2Types, cpr.Port.NetworkType)
 
 	if l2Ok && l2.(bool) && !isLayer2 {
 		port, _, err := cpr.Client.Ports.ConvertToLayerTwo(cpr.Port.ID)
@@ -285,7 +289,7 @@ func convertToL2(cpr *ClientPortResource) error {
 
 func convertToL3(cpr *ClientPortResource) error {
 	l2, l2Ok := cpr.Resource.GetOkExists("layer2")
-	isLayer2 := contains(l2Types, cpr.Port.NetworkType)
+	isLayer2 := slices.Contains(l2Types, cpr.Port.NetworkType)
 
 	if l2Ok && !l2.(bool) && isLayer2 {
 		ips := []packngo.AddressRequest{
@@ -327,7 +331,7 @@ func portSanityChecks(cpr *ClientPortResource) error {
 	if nativeVlanOk {
 		nativeVlan := nativeVlanRaw.(string)
 		vlans := specifiedVlanIds(cpr.Resource)
-		if !contains(vlans, nativeVlan) {
+		if !slices.Contains(vlans, nativeVlan) {
 			return fmt.Errorf("the native VLAN to be set is not (being) assigned to the port")
 		}
 		if len(vlans) < 2 {

equinix/provider_test.go

@@ -9,6 +9,8 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/equinix/terraform-provider-equinix/internal/hashcode"
+
 	"github.com/equinix/ecx-go/v2"
 	"github.com/equinix/rest-go"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest"
@@ -378,7 +380,7 @@ func TestProvider_schemaSetToMap(t *testing.T) {
 	}
 	setFunc := func(v interface{}) int {
 		i := v.(item)
-		return hashcodeString(i.id)
+		return hashcode.String(i.id)
 	}
 	items := []interface{}{
 		item{"id1", 100, 200},

equinix/resource_metal_connection.go

@@ -7,6 +7,8 @@ import (
 	"strconv"
 	"strings"
 
+	"github.com/equinix/terraform-provider-equinix/internal/converters"
+
 	equinix_errors "github.com/equinix/terraform-provider-equinix/internal/errors"
 	equinix_schema "github.com/equinix/terraform-provider-equinix/internal/schema"
 
@@ -94,7 +96,7 @@ func resourceMetalConnection() *schema.Resource {
 				Description:   "Metro where the connection will be created",
 				ConflictsWith: []string{"facility"},
 				ForceNew:      true,
-				StateFunc:     toLower,
+				StateFunc:     converters.ToLowerIf,
 			},
 			"redundancy": {
 				Type:        schema.TypeString,
@@ -223,7 +225,7 @@ func resourceMetalConnectionCreate(d *schema.ResourceData, meta interface{}) err
 	vlans := []int{}
 	vlansNum := d.Get("vlans.#").(int)
 	if vlansNum > 0 {
-		vlans = convertIntArr2(d.Get("vlans").([]interface{}))
+		vlans = converters.IfArrToIntArr(d.Get("vlans").([]interface{}))
 	}
 	connRedundancy := packngo.ConnectionRedundancy(d.Get("redundancy").(string))
 
@@ -256,7 +258,7 @@ func resourceMetalConnectionCreate(d *schema.ResourceData, meta interface{}) err
 	// this could be generalized, see $ grep "d.Get(\"tags" *
 	tags := d.Get("tags.#").(int)
 	if tags > 0 {
-		connReq.Tags = convertStringArr(d.Get("tags").([]interface{}))
+		connReq.Tags = converters.IfArrToStringArr(d.Get("tags").([]interface{}))
 	}
 
 	if metOk {
@@ -381,8 +383,8 @@ func resourceMetalConnectionUpdate(d *schema.ResourceData, meta interface{}) err
 
 		if connType == packngo.ConnectionShared {
 			old, new := d.GetChange("vlans")
-			oldVlans := convertIntArr2(old.([]interface{}))
-			newVlans := convertIntArr2(new.([]interface{}))
+			oldVlans := converters.IfArrToIntArr(old.([]interface{}))
+			newVlans := converters.IfArrToIntArr(new.([]interface{}))
 			maxVlans := int(math.Max(float64(len(oldVlans)), float64(len(newVlans))))
 
 			ports := d.Get("ports").([]interface{})