add diff suppress for big query table schema (#3751) (#6803)

* add diff suppress for big query table schema * update comments Signed-off-by: Modular Magician <[email protected]>
hashicorp · Jul 16, 2020 · ef4bb49 · ef4bb49
1 parent e09554d
commit ef4bb49
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 1 deletion.
diff --git a/.changelog/3751.txt b/.changelog/3751.txt
@@ -0,0 +1,3 @@
+```release-note:bug
+bigquery: fixed bug where a permadiff would show up when adding a column to the middle of a `bigquery_table.schema`
+```
diff --git a/google/resource_bigquery_table.go b/google/resource_bigquery_table.go
@@ -5,13 +5,49 @@ import (
 	"errors"
 	"fmt"
 	"log"
+	"reflect"
+	"sort"
 
 	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/helper/structure"
 	"github.com/hashicorp/terraform-plugin-sdk/helper/validation"
 	"google.golang.org/api/bigquery/v2"
 )
 
+// JSONBytesEqual compares the JSON in two byte slices.
+// Reference: https://stackoverflow.com/questions/32408890/how-to-compare-two-json-requests
+func JSONBytesEqual(a, b []byte) (bool, error) {
+	var j, j2 interface{}
+	if err := json.Unmarshal(a, &j); err != nil {
+		return false, err
+	}
+	jList := j.([]interface{})
+	sort.Slice(jList, func(i, k int) bool {
+		return jList[i].(map[string]interface{})["name"].(string) < jList[k].(map[string]interface{})["name"].(string)
+	})
+	if err := json.Unmarshal(b, &j2); err != nil {
+		return false, err
+	}
+	j2List := j2.([]interface{})
+	sort.Slice(j2List, func(i, k int) bool {
+		return j2List[i].(map[string]interface{})["name"].(string) < j2List[k].(map[string]interface{})["name"].(string)
+	})
+	return reflect.DeepEqual(j2List, jList), nil
+}
+
+// Compare the JSON strings are equal
+func bigQueryTableSchemaDiffSuppress(_, old, new string, _ *schema.ResourceData) bool {
+	oldBytes := []byte(old)
+	newBytes := []byte(new)
+
+	eq, err := JSONBytesEqual(oldBytes, newBytes)
+	if err != nil {
+		log.Printf("[DEBUG] Error comparing JSON bytes: %v, %v", old, new)
+	}
+
+	return eq
+}
+
 func resourceBigQueryTable() *schema.Resource {
 	return &schema.Resource{
 		Create: resourceBigQueryTableCreate,
@@ -299,7 +335,8 @@ func resourceBigQueryTable() *schema.Resource {
 					json, _ := structure.NormalizeJsonString(v)
 					return json
 				},
-				Description: `A JSON schema for the table.`,
+				DiffSuppressFunc: bigQueryTableSchemaDiffSuppress,
+				Description:      `A JSON schema for the table.`,
 			},
 
 			// View: [Optional] If specified, configures this table as a view.