feat: Improves testing in search-index resource (#1635) INTMDB-1298

* create Mappings if not created (e.g. changing from vector to search index)

* move JSON comparison logic to a check function

* add tests

Author: lantoli

mongodbatlas/resource_mongodbatlas_search_index.go

@@ -218,11 +218,6 @@ func resourceMongoDBAtlasSearchIndexUpdate(ctx context.Context, d *schema.Resour
 		searchIndex.SearchAnalyzer = stringPtr(d.Get("search_analyzer").(string))
 	}
 
-	if d.HasChange("mappings_dynamic") {
-		dynamic := d.Get("mappings_dynamic").(bool)
-		searchIndex.Mappings.Dynamic = &dynamic
-	}
-
 	if d.HasChange("analyzers") {
 		analyzers, err := unmarshalSearchIndexAnalyzersFields(d.Get("analyzers").(string))
 		if err != nil {
@@ -231,11 +226,22 @@ func resourceMongoDBAtlasSearchIndexUpdate(ctx context.Context, d *schema.Resour
 		searchIndex.Analyzers = analyzers
 	}
 
+	if d.HasChange("mappings_dynamic") {
+		dynamic := d.Get("mappings_dynamic").(bool)
+		if searchIndex.Mappings == nil {
+			searchIndex.Mappings = &admin.ApiAtlasFTSMappings{}
+		}
+		searchIndex.Mappings.Dynamic = &dynamic
+	}
+
 	if d.HasChange("mappings_fields") {
 		mappingsFields, err := unmarshalSearchIndexMappingFields(d.Get("mappings_fields").(string))
 		if err != nil {
 			return err
 		}
+		if searchIndex.Mappings == nil {
+			searchIndex.Mappings = &admin.ApiAtlasFTSMappings{}
+		}
 		searchIndex.Mappings.Fields = mappingsFields
 	}
 

mongodbatlas/resource_mongodbatlas_search_index_test.go

@@ -2,15 +2,14 @@ package mongodbatlas
 
 import (
 	"context"
-	"encoding/json"
 	"fmt"
 	"os"
-	"reflect"
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-testing/helper/acctest"
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
 	"github.com/hashicorp/terraform-plugin-testing/terraform"
+	"github.com/mongodb/terraform-provider-mongodbatlas/mongodbatlas/testutils"
 )
 
 const (
@@ -257,7 +256,7 @@ func TestAccSearchIndexRS_withVector(t *testing.T) {
 					resource.TestCheckResourceAttr(resourceName, "collection_name", collectionName),
 					resource.TestCheckResourceAttr(resourceName, "type", "vectorSearch"),
 					resource.TestCheckResourceAttrSet(resourceName, "fields"),
-					testCheckResourceAttrJSON(resourceName, "fields", fields),
+					resource.TestCheckResourceAttrWith(resourceName, "fields", testutils.JSONEquals(fields)),
 
 					resource.TestCheckResourceAttr(datasourceName, "type", "vectorSearch"),
 					resource.TestCheckResourceAttr(datasourceName, "name", indexName),
@@ -268,7 +267,7 @@ func TestAccSearchIndexRS_withVector(t *testing.T) {
 					resource.TestCheckResourceAttr(datasourceName, "name", indexName),
 					resource.TestCheckResourceAttrSet(datasourceName, "index_id"),
 					resource.TestCheckResourceAttrSet(datasourceName, "fields"),
-					testCheckResourceAttrJSON(datasourceName, "fields", fields),
+					resource.TestCheckResourceAttrWith(datasourceName, "fields", testutils.JSONEquals(fields)),
 				),
 			},
 		},
@@ -522,28 +521,3 @@ func getClusterInfo(projectID string) (clusterName, clusterNameStr, clusterTerra
 	}
 	return clusterName, clusterNameStr, clusterTerraformStr
 }
-
-func testCheckResourceAttrJSON[T any](resourceName, attribute string, expected T) resource.TestCheckFunc {
-	return func(s *terraform.State) error {
-		rs, ok := s.RootModule().Resources[resourceName]
-		if !ok {
-			return fmt.Errorf("Not found: %s", resourceName)
-		}
-
-		attr, ok := rs.Primary.Attributes[attribute]
-		if !ok {
-			return fmt.Errorf("Attribute not found: %s", attribute)
-		}
-
-		var actual T
-		if err := json.Unmarshal([]byte(attr), &actual); err != nil {
-			return fmt.Errorf("Could not unmarshal json: %s", err)
-		}
-
-		if !reflect.DeepEqual(actual, expected) {
-			return fmt.Errorf("Expected `%v`, got `%v`", expected, actual)
-		}
-
-		return nil
-	}
-}

mongodbatlas/testutils/attribute_checks.go

@@ -1,7 +1,9 @@
 package testutils
 
 import (
+	"encoding/json"
 	"fmt"
+	"reflect"
 	"regexp"
 	"strconv"
 
@@ -33,3 +35,18 @@ func IntGreatThan(value int) resource.CheckResourceAttrWithFunc {
 		return nil
 	}
 }
+
+func JSONEquals[T any](value T) resource.CheckResourceAttrWithFunc {
+	return func(input string) error {
+		var actual T
+		if err := json.Unmarshal([]byte(input), &actual); err != nil {
+			return fmt.Errorf("could not unmarshal json: %s", err)
+		}
+
+		if !reflect.DeepEqual(actual, value) {
+			return fmt.Errorf("expected `%v`, got `%v`", value, actual)
+		}
+
+		return nil
+	}
+}

mongodbatlas/testutils/attribute_checks_test.go

@@ -29,3 +29,25 @@ func TestIntGreaterThan(t *testing.T) {
 		})
 	}
 }
+
+func TestJSONEquals(t *testing.T) {
+	objMap := map[string]interface{}{
+		"str":    "my_string",
+		"number": float64(1234),
+		"bool1":  true,
+		"bool2":  false,
+		"nilvar": nil,
+	}
+	strMap := `
+	{
+		"str": "my_string",
+		"number": 1234,
+		"bool1": true,
+		"bool2": false,
+		"nilvar": null
+	}
+`
+	if err := JSONEquals(objMap)(strMap); err != nil {
+		t.Errorf("JSONEquals() error = %v", err)
+	}
+}