[Internal] Add client support in CustomizeDiff for SDKv2 resources (#5171)

## Changes
<!-- Summary of your changes that are easy to understand -->
- Pass the DatabricksClient in CustomizeDiff for resources and data
sources
- The client would be used to validate the workspace_id supplied in
provider_config during plan phase.

## Tests
<!--
How is this tested? Please see the checklist below and also describe any
other relevant tests
-->
- Unit tests

Author: tanmay-db

NEXT_CHANGELOG.md

@@ -21,3 +21,4 @@
 * Initial support for resources implemented with plugin framework ([#5176](https://github.com/databricks/terraform-provider-databricks/pull/5176)).
 
 ### Internal Changes
+* Add client support in CustomizeDiff for SDKv2 resources and data sources ([#5171](https://github.com/databricks/terraform-provider-databricks/pull/5171)).

access/resource_permission_assignment.go

@@ -148,8 +148,8 @@ func ResourcePermissionAssignment() common.Resource {
 	})
 	return common.Resource{
 		Schema: s,
-		CustomizeDiff: func(ctx context.Context, d *schema.ResourceDiff) error {
-			return common.NamespaceCustomizeDiff(d)
+		CustomizeDiff: func(ctx context.Context, d *schema.ResourceDiff, c *common.DatabricksClient) error {
+			return common.NamespaceCustomizeDiff(ctx, d, c)
 		},
 		Create: func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error {
 			c, err := c.DatabricksClientForUnifiedProvider(ctx, d)

catalog/resource_catalog.go

@@ -216,7 +216,7 @@ func ResourceCatalog() common.Resource {
 			}
 			return w.Catalogs.Delete(ctx, catalog.DeleteCatalogRequest{Force: force, Name: d.Id()})
 		},
-		CustomizeDiff: func(ctx context.Context, d *schema.ResourceDiff) error {
+		CustomizeDiff: func(ctx context.Context, d *schema.ResourceDiff, c *common.DatabricksClient) error {
 			// The only scenario in which we can update options is for the `authorized_paths` key. Any
 			// other changes to the options field will result in an error.
 			if d.HasChange("options") {

catalog/resource_sql_table.go

@@ -611,7 +611,7 @@ func ResourceSqlTable() common.Resource {
 	tableSchema := common.StructToSchema(SqlTableInfo{}, nil)
 	return common.Resource{
 		Schema: tableSchema,
-		CustomizeDiff: func(ctx context.Context, d *schema.ResourceDiff) error {
+		CustomizeDiff: func(ctx context.Context, d *schema.ResourceDiff, c *common.DatabricksClient) error {
 			if d.HasChange("column") {
 				var newTableStruct SqlTableInfo
 				common.DiffToStructPointer(d, tableSchema, &newTableStruct)

catalog/resource_table.go

@@ -78,7 +78,7 @@ func ResourceTable() common.Resource {
 		"view_definition", "comment", "properties"})
 	return common.Resource{
 		Schema: tableSchema,
-		CustomizeDiff: func(ctx context.Context, d *schema.ResourceDiff) error {
+		CustomizeDiff: func(ctx context.Context, d *schema.ResourceDiff, c *common.DatabricksClient) error {
 			if d.Get("table_type") != "EXTERNAL" {
 				return nil
 			}

clusters/resource_cluster.go

@@ -31,8 +31,8 @@ const (
 
 func ResourceCluster() common.Resource {
 	return common.Resource{
-		CustomizeDiff: func(ctx context.Context, d *schema.ResourceDiff) error {
-			return common.NamespaceCustomizeDiff(d)
+		CustomizeDiff: func(ctx context.Context, d *schema.ResourceDiff, c *common.DatabricksClient) error {
+			return common.NamespaceCustomizeDiff(ctx, d, c)
 		},
 		Create:        resourceClusterCreate,
 		Read:          resourceClusterRead,

clusters/resource_library.go

@@ -45,8 +45,8 @@ func ResourceLibrary() common.Resource {
 	}
 	return common.Resource{
 		Schema: libraySdkSchema,
-		CustomizeDiff: func(ctx context.Context, d *schema.ResourceDiff) error {
-			return common.NamespaceCustomizeDiff(d)
+		CustomizeDiff: func(ctx context.Context, d *schema.ResourceDiff, c *common.DatabricksClient) error {
+			return common.NamespaceCustomizeDiff(ctx, d, c)
 		},
 		Create: func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error {
 			w, err := c.WorkspaceClientUnifiedProvider(ctx, d)

common/resource.go

@@ -259,7 +259,7 @@ func TestRecoverableFromPanic(t *testing.T) {
 
 func TestCustomizeDiffRobustness(t *testing.T) {
 	r := Resource{
-		CustomizeDiff: func(ctx context.Context, d *schema.ResourceDiff) error {
+		CustomizeDiff: func(ctx context.Context, d *schema.ResourceDiff, c *DatabricksClient) error {
 			return fmt.Errorf("nope")
 		},
 	}.ToResource()
@@ -268,16 +268,16 @@ func TestCustomizeDiffRobustness(t *testing.T) {
 	ctx = context.WithValue(ctx, ResourceName, "sample")
 
 	err := r.CustomizeDiff(ctx, nil, nil)
-	assert.EqualError(t, err, "cannot customize diff for sample: nope")
+	assert.EqualError(t, err, "cannot customize diff for sample: expected *DatabricksClient, got <nil>")
 
 	r = Resource{
-		CustomizeDiff: func(ctx context.Context, d *schema.ResourceDiff) error {
+		CustomizeDiff: func(ctx context.Context, d *schema.ResourceDiff, c *DatabricksClient) error {
 			panic("oops")
 		},
 	}.ToResource()
 
 	err = r.CustomizeDiff(ctx, nil, nil)
-	assert.EqualError(t, err, "cannot customize diff for sample: panic: oops")
+	assert.EqualError(t, err, "cannot customize diff for sample: expected *DatabricksClient, got <nil>")
 }
 
 func TestWorkspacePathPrefixDiffSuppress(t *testing.T) {

common/resource_test.go

@@ -85,7 +85,7 @@ func NamespaceCustomizeSchemaMap(m map[string]*schema.Schema) map[string]*schema
 
 // NamespaceCustomizeDiff is used to customize the diff for the provider configuration
 // in a resource diff.
-func NamespaceCustomizeDiff(d *schema.ResourceDiff) error {
+func NamespaceCustomizeDiff(ctx context.Context, d *schema.ResourceDiff, c *DatabricksClient) error {
 	// Force New
 	workspaceIDKey := workspaceIDSchemaKey
 	oldWorkspaceID, newWorkspaceID := d.GetChange(workspaceIDKey)