Suppress diff for databricks_group.external_id (#1100)

Fixes #1099

Author: nfx

CHANGELOG.md

@@ -3,7 +3,9 @@
 ## 0.4.9
 
 * Prevent creation of `databricks_group` with `users` and `admins` reserved names ([#1089](https://github.com/databrickslabs/terraform-provider-databricks/issues/1089)).
-* Shared job cluster functionality added. ([#1082](https://github.com/databrickslabs/terraform-provider-databricks/issues/1082))
+* Added support for shared clusters in multi-task `databricks_job` ([#1082](https://github.com/databrickslabs/terraform-provider-databricks/issues/1082)).
+* Added diff suppression for `external_id` in `databricks_group` ([#1099](https://github.com/databrickslabs/terraform-provider-databricks/issues/1099)).
+* Various documentation improvements.
 
 ## 0.4.8
 

scim/acceptance/group_test.go

@@ -1,17 +1,56 @@
 package acceptance
 
 import (
+	"context"
 	"fmt"
 	"os"
 
+	"github.com/databrickslabs/terraform-provider-databricks/common"
 	"github.com/databrickslabs/terraform-provider-databricks/internal/acceptance"
+	"github.com/databrickslabs/terraform-provider-databricks/qa"
+	"github.com/databrickslabs/terraform-provider-databricks/scim"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
 
 	"testing"
 )
 
+// https://github.com/databrickslabs/terraform-provider-databricks/issues/1099
+func TestAccGroupsExternalIdAndScimProvisioning(t *testing.T) {
+	if _, ok := os.LookupEnv("CLOUD_ENV"); !ok {
+		t.Skip("Acceptance tests skipped unless env 'CLOUD_ENV' is set")
+	}
+	name := qa.RandomName("tfgroup")
+	acceptance.AccTest(t, resource.TestCase{
+		Steps: []resource.TestStep{
+			{
+				Config: `resource "databricks_group" "this" {
+					display_name = "` + name + `"
+					allow_cluster_create = true
+				}`,
+				Check: acceptance.ResourceCheck("databricks_group.this",
+					func(ctx context.Context, client *common.DatabricksClient, id string) error {
+						groupsAPI := scim.NewGroupsAPI(ctx, client)
+						group, err := groupsAPI.Read(id)
+						if err != nil {
+							return err
+						}
+						// external SCIM change
+						return groupsAPI.UpdateNameAndEntitlements(
+							id, group.DisplayName, qa.RandomName("ext-id"), group.Entitlements)
+					}),
+			},
+			{
+				Config: `resource "databricks_group" "this" {
+					display_name = "` + name + `"
+					allow_cluster_create = true
+				}`,
+			},
+		},
+	})
+}
+
 func TestAccGroupResource(t *testing.T) {
 	if _, ok := os.LookupEnv("CLOUD_ENV"); !ok {
 		t.Skip("Acceptance tests skipped unless env 'CLOUD_ENV' is set")

scim/resource_group.go

@@ -12,35 +12,28 @@ import (
 
 // ResourceGroup manages user groups
 func ResourceGroup() *schema.Resource {
-	groupSchema := map[string]*schema.Schema{
-		"display_name": {
-			Type: schema.TypeString,
-			ValidateDiagFunc: validation.ToDiagFunc(
-				validation.StringNotInSlice(
-					[]string{"users", "admins"}, false)),
-			Required: true,
-			ForceNew: true,
-		},
-		"url": {
-			Type:     schema.TypeString,
-			Computed: true,
-		},
-		"external_id": {
-			Type:     schema.TypeString,
-			Optional: true,
-			ForceNew: true,
-		},
-		"force": {
-			Type:     schema.TypeBool,
-			Optional: true,
-		},
+	type entity struct {
+		DisplayName string `json:"display_name" tf:"force_new"`
+		ExternalID  string `json:"external_id,omitempty" tf:"force_new,suppress_diff"`
+		URL         string `json:"url,omitempty" tf:"computed"`
 	}
+	groupSchema := common.StructToSchema(entity{},
+		func(m map[string]*schema.Schema) map[string]*schema.Schema {
+			addEntitlementsToSchema(&m)
+			// https://github.com/databrickslabs/terraform-provider-databricks/issues/1089
+			m["display_name"].ValidateDiagFunc = validation.ToDiagFunc(
+				validation.StringNotInSlice([]string{"users", "admins"}, false))
+			m["force"] = &schema.Schema{
+				Type:     schema.TypeBool,
+				Optional: true,
+			}
+			return m
+		})
 	addEntitlementsToSchema(&groupSchema)
 	return common.Resource{
 		Create: func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error {
-			groupName := d.Get("display_name").(string)
 			g := Group{
-				DisplayName:  groupName,
+				DisplayName:  d.Get("display_name").(string),
 				Entitlements: readEntitlementsFromData(d),
 				ExternalID:   d.Get("external_id").(string),
 			}