Move helper functions to common package (#806)

Follow-up to #805

These are all helpers that may be used by any "section" of the provider and only depends on external packages

Author: julienduchesne

provider/adapters.go

@@ -0,0 +1,69 @@
+package common
+
+import (
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+)
+
+func ListToStringSlice(src []interface{}) []string {
+	dst := make([]string, 0, len(src))
+	for _, s := range src {
+		val, ok := s.(string)
+		if !ok {
+			val = ""
+		}
+		dst = append(dst, val)
+	}
+	return dst
+}
+
+func SetToStringSlice(src *schema.Set) []string {
+	return ListToStringSlice(src.List())
+}
+
+func ListToIntSlice(src []interface{}) []int {
+	dst := make([]int, 0, len(src))
+	for _, s := range src {
+		val, ok := s.(int)
+		if !ok {
+			val = 0
+		}
+		dst = append(dst, val)
+	}
+	return dst
+}
+
+func SetToIntSlice(src *schema.Set) []int {
+	return ListToIntSlice(src.List())
+}
+
+func StringSliceToList(list []string) []interface{} {
+	vs := make([]interface{}, 0, len(list))
+	for _, v := range list {
+		vs = append(vs, v)
+	}
+	return vs
+}
+
+func StringSliceToSet(src []string) *schema.Set {
+	return schema.NewSet(schema.HashString, StringSliceToList(src))
+}
+
+func Int32SliceToIntList(list []int32) []interface{} {
+	vs := make([]interface{}, 0, len(list))
+	for _, v := range list {
+		vs = append(vs, int(v))
+	}
+	return vs
+}
+
+func Int32SliceToSet(src []int32) *schema.Set {
+	return schema.NewSet(schema.HashInt, Int32SliceToIntList(src))
+}
+
+func ListOfSetsToStringSlice(listSet []interface{}) [][]string {
+	ret := make([][]string, 0, len(listSet))
+	for _, set := range listSet {
+		ret = append(ret, SetToStringSlice(set.(*schema.Set)))
+	}
+	return ret
+}

provider/common/adapters.go

@@ -1,4 +1,4 @@
-package provider
+package common
 
 import (
 	"bytes"

provider/json.go provider/common/json.goprovider/json.go renamed to provider/common/json.go

@@ -1,4 +1,4 @@
-package provider
+package common
 
 import (
 	"fmt"
@@ -8,21 +8,21 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-// schemaDiffFloat32 is a SchemaDiffSuppressFunc for diffing float32 values.
+// SchemaDiffFloat32 is a SchemaDiffSuppressFunc for diffing float32 values.
 // schema.TypeFloat uses float64, which is a problem for API types that use
 // float32. Terraform automatically converts float32 to float64 which changes
 // the precision and causes incorrect diffs.
 //
 // For example, synthetic_monitoring.Probe.Latitude is float32. Attempting to
 // set grafanacloud_synthetic_monitoring_probe.latitude to 27.98606 results in
 // 27.986059188842773. The solution is to diff old and new values as float32.
-func schemaDiffFloat32(k, old string, nw string, d *schema.ResourceData) bool {
+func SchemaDiffFloat32(k, old string, nw string, d *schema.ResourceData) bool {
 	old32, _ := strconv.ParseFloat(old, 32)
 	nw32, _ := strconv.ParseFloat(nw, 32)
 	return old32 == nw32
 }
 
-func cloneResourceSchemaForDatasource(r *schema.Resource, updates map[string]*schema.Schema) map[string]*schema.Schema {
+func CloneResourceSchemaForDatasource(r *schema.Resource, updates map[string]*schema.Schema) map[string]*schema.Schema {
 	resourceSchema := r.Schema
 	clone := make(map[string]*schema.Schema)
 	for k, v := range resourceSchema {
@@ -47,6 +47,6 @@ func cloneResourceSchemaForDatasource(r *schema.Resource, updates map[string]*sc
 	return clone
 }
 
-func allowedValuesDescription(description string, allowedValues []string) string {
+func AllowedValuesDescription(description string, allowedValues []string) string {
 	return fmt.Sprintf("%s. Allowed values: `%s`.", description, strings.Join(allowedValues, "`, `"))
 }

provider/schema.go provider/common/schema.goprovider/schema.go renamed to provider/common/schema.go

@@ -12,7 +12,7 @@ func DatasourceCloudStack() *schema.Resource {
 	return &schema.Resource{
 		Description: "Data source for Grafana Stack",
 		ReadContext: datasourceCloudStackRead,
-		Schema: cloneResourceSchemaForDatasource(ResourceCloudStack(), map[string]*schema.Schema{
+		Schema: common.CloneResourceSchemaForDatasource(ResourceCloudStack(), map[string]*schema.Schema{
 			"slug": {
 				Type:     schema.TypeString,
 				Required: true,

provider/data_source_cloud_stack.go

@@ -14,7 +14,7 @@ func DatasourceDatasource() *schema.Resource {
 	return &schema.Resource{
 		Description: "Get details about a Grafana Datasource querying by either name, uid or ID",
 		ReadContext: datasourceDatasourceRead,
-		Schema: cloneResourceSchemaForDatasource(ResourceDataSource(), map[string]*schema.Schema{
+		Schema: common.CloneResourceSchemaForDatasource(ResourceDataSource(), map[string]*schema.Schema{
 			"id": {
 				Type:         schema.TypeString,
 				Optional:     true,

provider/data_source_data_source.go

@@ -12,7 +12,7 @@ func DatasourceLibraryPanel() *schema.Resource {
 	return &schema.Resource{
 		Description: "Data source for retrieving a single library panel by name or uid.",
 		ReadContext: dataSourceLibraryPanelRead,
-		Schema: cloneResourceSchemaForDatasource(ResourceLibraryPanel(), map[string]*schema.Schema{
+		Schema: common.CloneResourceSchemaForDatasource(ResourceLibraryPanel(), map[string]*schema.Schema{
 			"name": {
 				Type:        schema.TypeString,
 				Optional:    true,

provider/data_source_library_panel.go

@@ -15,7 +15,7 @@ func DatasourceOrganizationPreferences() *schema.Resource {
 * [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/preferences/#get-current-org-prefs)
 `,
 		ReadContext: dataSourceOrganizationPreferencesRead,
-		Schema:      cloneResourceSchemaForDatasource(ResourceOrganizationPreferences(), map[string]*schema.Schema{}),
+		Schema:      common.CloneResourceSchemaForDatasource(ResourceOrganizationPreferences(), map[string]*schema.Schema{}),
 	}
 }
 

provider/data_source_organization_preferences.go

@@ -15,7 +15,7 @@ func DatasourceSyntheticMonitoringProbe() *schema.Resource {
 	return &schema.Resource{
 		Description: "Data source for retrieving a single probe by name.",
 		ReadContext: dataSourceSyntheticMonitoringProbeRead,
-		Schema: cloneResourceSchemaForDatasource(ResourceSyntheticMonitoringProbe(), map[string]*schema.Schema{
+		Schema: common.CloneResourceSchemaForDatasource(ResourceSyntheticMonitoringProbe(), map[string]*schema.Schema{
 			"name": {
 				Description: "Name of the probe.",
 				Type:        schema.TypeString,

provider/data_source_synthetic_monitoring_probe.go

@@ -6,6 +6,7 @@ import (
 	"strings"
 
 	gapi "github.com/grafana/grafana-api-golang-client"
+	"github.com/grafana/terraform-provider-grafana/provider/common"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 )
@@ -338,7 +339,7 @@ func packAddrs(addrs string) []string {
 }
 
 func unpackAddrs(addrs []interface{}) string {
-	strs := listToStringSlice(addrs)
+	strs := common.ListToStringSlice(addrs)
 	return strings.Join(strs, addrSeparator)
 }