refactor some common functions for workspace bindings (#3702)

Author: nkvuong

catalog/bindings/bindings.go

@@ -0,0 +1,31 @@
+package bindings
+
+import (
+	"context"
+
+	"github.com/databricks/databricks-sdk-go"
+	"github.com/databricks/databricks-sdk-go/service/catalog"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+)
+
+func AddCurrentWorkspaceBindings(ctx context.Context, d *schema.ResourceData, w *databricks.WorkspaceClient, securableName string, securableType string) error {
+	if d.Get("isolation_mode") != "ISOLATED" {
+		return nil
+	}
+	// Bind the current workspace if the catalog is isolated, otherwise the read will fail
+	currentMetastoreAssignment, err := w.Metastores.Current(ctx)
+	if err != nil {
+		return err
+	}
+	_, err = w.WorkspaceBindings.UpdateBindings(ctx, catalog.UpdateWorkspaceBindingsParameters{
+		SecurableName: securableName,
+		SecurableType: securableType,
+		Add: []catalog.WorkspaceBinding{
+			{
+				BindingType: catalog.WorkspaceBindingBindingTypeBindingTypeReadWrite,
+				WorkspaceId: currentMetastoreAssignment.WorkspaceId,
+			},
+		},
+	})
+	return err
+}

catalog/resource_catalog.go

@@ -6,6 +6,7 @@ import (
 	"log"
 
 	"github.com/databricks/databricks-sdk-go/service/catalog"
+	"github.com/databricks/terraform-provider-databricks/catalog/bindings"
 	"github.com/databricks/terraform-provider-databricks/common"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
@@ -86,14 +87,7 @@ func ResourceCatalog() common.Resource {
 			d.SetId(ci.Name)
 
 			// Update owner, isolation mode or predictive optimization if it is provided
-			updateRequired := false
-			for _, key := range []string{"owner", "isolation_mode", "enable_predictive_optimization"} {
-				if d.Get(key) != "" {
-					updateRequired = true
-					break
-				}
-			}
-			if !updateRequired {
+			if !updateRequired(d, []string{"owner", "isolation_mode", "enable_predictive_optimization"}) {
 				return nil
 			}
 			var updateCatalogRequest catalog.UpdateCatalog
@@ -104,25 +98,7 @@ func ResourceCatalog() common.Resource {
 				return err
 			}
 
-			if d.Get("isolation_mode") != "ISOLATED" {
-				return nil
-			}
-			// Bind the current workspace if the catalog is isolated, otherwise the read will fail
-			currentMetastoreAssignment, err := w.Metastores.Current(ctx)
-			if err != nil {
-				return err
-			}
-			_, err = w.WorkspaceBindings.UpdateBindings(ctx, catalog.UpdateWorkspaceBindingsParameters{
-				SecurableName: ci.Name,
-				SecurableType: "catalog",
-				Add: []catalog.WorkspaceBinding{
-					{
-						BindingType: catalog.WorkspaceBindingBindingTypeBindingTypeReadWrite,
-						WorkspaceId: currentMetastoreAssignment.WorkspaceId,
-					},
-				},
-			})
-			return err
+			return bindings.AddCurrentWorkspaceBindings(ctx, d, w, ci.Name, "catalog")
 		},
 		Read: func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error {
 			w, err := c.WorkspaceClient()
@@ -191,21 +167,7 @@ func ResourceCatalog() common.Resource {
 				return nil
 			}
 			// Bind the current workspace if the catalog is isolated, otherwise the read will fail
-			currentMetastoreAssignment, err := w.Metastores.Current(ctx)
-			if err != nil {
-				return err
-			}
-			_, err = w.WorkspaceBindings.UpdateBindings(ctx, catalog.UpdateWorkspaceBindingsParameters{
-				SecurableName: ci.Name,
-				SecurableType: "catalog",
-				Add: []catalog.WorkspaceBinding{
-					{
-						BindingType: catalog.WorkspaceBindingBindingTypeBindingTypeReadWrite,
-						WorkspaceId: currentMetastoreAssignment.WorkspaceId,
-					},
-				},
-			})
-			return err
+			return bindings.AddCurrentWorkspaceBindings(ctx, d, w, ci.Name, "catalog")
 		},
 		Delete: func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error {
 			w, err := c.WorkspaceClient()

catalog/utils.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 
 	"github.com/databricks/databricks-sdk-go"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
 // UC catalog resources accept an optional metastore_id parameter. This is required for account-level operations, but it is not used
@@ -46,3 +47,13 @@ func GetSqlColumnInfoHCL(columnInfos []SqlColumnInfo) string {
 	}
 	return columnsTemplate
 }
+
+// check if a UC resource needs the additional update call during create operation
+func updateRequired(d *schema.ResourceData, updateOnly []string) bool {
+	for _, key := range updateOnly {
+		if d.Get(key) != "" {
+			return true
+		}
+	}
+	return false
+}