Fix infinite plan on user metadata

auth0 · Jul 18, 2022 · b94b80d · b94b80d
1 parent 82d87a1
commit b94b80d
Show file tree

Hide file tree

Showing 2 changed files with 61 additions and 43 deletions.
diff --git a/auth0/resource_auth0_user.go b/auth0/resource_auth0_user.go
@@ -250,21 +250,54 @@ func expandUser(d *schema.ResourceData) (*management.User, error) {
 		Blocked:       Bool(d, "blocked"),
 	}
 
-	userMeta, err := JSON(d, "user_metadata")
+	userMetadata, err := expandMetadata(d, "user")
 	if err != nil {
 		return nil, err
 	}
-	user.UserMetadata = &userMeta
+	user.UserMetadata = &userMetadata
 
-	appMeta, err := JSON(d, "app_metadata")
+	appMetadata, err := expandMetadata(d, "app")
 	if err != nil {
 		return nil, err
 	}
-	user.AppMetadata = &appMeta
+	user.AppMetadata = &appMetadata
 
 	return user, nil
 }
 
+func expandMetadata(d *schema.ResourceData, metadataType string) (map[string]interface{}, error) {
+	if !d.HasChange(metadataType + "_metadata") {
+		return map[string]interface{}{}, nil
+	}
+
+	oldMetadata, newMetadata := d.GetChange(metadataType + "_metadata")
+	if oldMetadata == "" {
+		return JSON(d, metadataType+"_metadata")
+	}
+
+	if newMetadata == "" || newMetadata == nil {
+		return map[string]interface{}{}, nil
+	}
+
+	oldMap, err := structure.ExpandJsonFromString(oldMetadata.(string))
+	if err != nil {
+		return map[string]interface{}{}, err
+	}
+
+	newMap, err := structure.ExpandJsonFromString(newMetadata.(string))
+	if err != nil {
+		return map[string]interface{}{}, err
+	}
+
+	for key := range oldMap {
+		if _, ok := newMap[key]; !ok {
+			newMap[key] = nil
+		}
+	}
+
+	return newMap, nil
+}
+
 func flattenUserRoles(roleList *management.RoleList) []interface{} {
 	var roles []interface{}
 	for _, role := range roleList.Roles {

diff --git a/auth0/resource_auth0_user_test.go b/auth0/resource_auth0_user_test.go
@@ -75,18 +75,14 @@ resource auth0_user user {
 	family_name = "Lastname"
 	nickname = "{{.testName}}"
 	picture = "https://www.example.com/picture.jpg"
-	user_metadata = <<EOF
-{
-  "foo": "bar",
-  "bar": { "baz": "qux" }
-}
-EOF
-	app_metadata = <<EOF
-{
-  "foo": "bar",
-  "bar": { "baz": "qux" }
-}
-EOF
+	user_metadata = jsonencode({
+		"foo": "bar",
+		"baz": "qux"
+	})
+	app_metadata = jsonencode({
+		"foo": "bar",
+		"baz": "qux"
+	})
 }
 `
 
@@ -104,18 +100,12 @@ resource auth0_user user {
 	nickname = "{{.testName}}"
 	picture = "https://www.example.com/picture.jpg"
 	roles = [ auth0_role.owner.id, auth0_role.admin.id ]
-	user_metadata = <<EOF
-{
-  "foo": "bar",
-  "bar": { "baz": "qux" }
-}
-EOF
-app_metadata = <<EOF
-{
-  "foo": "bar",
-  "bar": { "baz": "qux" }
-}
-EOF
+	user_metadata = jsonencode({
+		"foo": "bars",
+	})
+	app_metadata = jsonencode({
+		"foo": "bars",
+	})
 }
 
 resource auth0_role owner {
@@ -144,18 +134,6 @@ resource auth0_user user {
 	nickname = "{{.testName}}"
 	picture = "https://www.example.com/picture.jpg"
 	roles = [ auth0_role.admin.id ]
-	user_metadata = <<EOF
-{
-  	"foo": "bar",
-  	"bar": { "baz": "qux" }
-}
-EOF
-  app_metadata = <<EOF
-{
-  	"foo": "bar",
-  	"bar": { "baz": "qux" }
-}
-EOF
 }
 
 resource auth0_role admin {
@@ -173,15 +151,18 @@ func TestAccUser(t *testing.T) {
 			{
 				Config: template.ParseTestName(testAccUserCreate, strings.ToLower(t.Name())),
 				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr("auth0_user.user", "connection_name", "Username-Password-Authentication"),
+					resource.TestCheckResourceAttr("auth0_user.user", "username", strings.ToLower(t.Name())),
 					resource.TestCheckResourceAttr("auth0_user.user", "user_id", fmt.Sprintf("auth0|%s", strings.ToLower(t.Name()))),
 					resource.TestCheckResourceAttr("auth0_user.user", "email", fmt.Sprintf("%s@acceptance.test.com", strings.ToLower(t.Name()))),
 					resource.TestCheckResourceAttr("auth0_user.user", "name", "Firstname Lastname"),
-					resource.TestCheckResourceAttr("auth0_user.user", "family_name", "Lastname"),
 					resource.TestCheckResourceAttr("auth0_user.user", "given_name", "Firstname"),
+					resource.TestCheckResourceAttr("auth0_user.user", "family_name", "Lastname"),
 					resource.TestCheckResourceAttr("auth0_user.user", "nickname", strings.ToLower(t.Name())),
-					resource.TestCheckResourceAttr("auth0_user.user", "connection_name", "Username-Password-Authentication"),
-					resource.TestCheckResourceAttr("auth0_user.user", "roles.#", "0"),
 					resource.TestCheckResourceAttr("auth0_user.user", "picture", "https://www.example.com/picture.jpg"),
+					resource.TestCheckResourceAttr("auth0_user.user", "user_metadata", `{"baz":"qux","foo":"bar"}`),
+					resource.TestCheckResourceAttr("auth0_user.user", "app_metadata", `{"baz":"qux","foo":"bar"}`),
+					resource.TestCheckResourceAttr("auth0_user.user", "roles.#", "0"),
 				),
 			},
 			{
@@ -190,12 +171,16 @@ func TestAccUser(t *testing.T) {
 					resource.TestCheckResourceAttr("auth0_user.user", "roles.#", "2"),
 					resource.TestCheckResourceAttr("auth0_role.owner", "name", "owner"),
 					resource.TestCheckResourceAttr("auth0_role.admin", "name", "admin"),
+					resource.TestCheckResourceAttr("auth0_user.user", "user_metadata", `{"foo":"bars"}`),
+					resource.TestCheckResourceAttr("auth0_user.user", "app_metadata", `{"foo":"bars"}`),
 				),
 			},
 			{
 				Config: template.ParseTestName(testAccUserRemoveRole, strings.ToLower(t.Name())),
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr("auth0_user.user", "roles.#", "1"),
+					resource.TestCheckResourceAttr("auth0_user.user", "user_metadata", ""),
+					resource.TestCheckResourceAttr("auth0_user.user", "app_metadata", ""),
 				),
 			},
 		},