[Fix] Suppressing diff for databricks_catalog attributes (#4976)

## Changes
- Suppressing diff for `databricks_catalog` attributes
- Switch to Go SDK
- Resolves #4971

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

- [x] `make test` run locally
- [x] covered with integration tests in `internal/acceptance`
- [x] using Go SDK
- [x] has entry in `NEXT_CHANGELOG.md` file

---------

Co-authored-by: Alex Ott <[email protected]>
Co-authored-by: Alex Ott <[email protected]>
Co-authored-by: Omer Lachish <[email protected]>

Author: 3 people

NEXT_CHANGELOG.md

@@ -11,6 +11,7 @@
 
 ### Bug Fixes
 
+* Suppress diff for `databricks_catalog` attributes ([#4975](https://github.com/databricks/terraform-provider-databricks/pull/4975))
 * Correct which file event fields should be reset in `databricks_external_location` ([#4945](https://github.com/databricks/terraform-provider-databricks/pull/4945))
 * Fix `ExactlyOneOf` in `databricks_app` ([#4946](https://github.com/databricks/terraform-provider-databricks/pull/4946))
 * Enable update of `databricks_mws_ncc_private_endpoint_rule` resource ([#4957](https://github.com/databricks/terraform-provider-databricks/pull/4957))

catalog/resource_catalog.go

@@ -28,34 +28,36 @@ func ucDirectoryPathSlashAndEmptySuppressDiff(k, old, new string, d *schema.Reso
 	return false
 }
 
-type CatalogInfo struct {
-	Name                         string            `json:"name"`
-	Comment                      string            `json:"comment,omitempty"`
-	StorageRoot                  string            `json:"storage_root,omitempty" tf:"force_new"`
-	ProviderName                 string            `json:"provider_name,omitempty" tf:"force_new,conflicts:storage_root"`
-	ShareName                    string            `json:"share_name,omitempty" tf:"force_new,conflicts:storage_root"`
-	ConnectionName               string            `json:"connection_name,omitempty" tf:"force_new,conflicts:storage_root"`
-	EnablePredictiveOptimization string            `json:"enable_predictive_optimization,omitempty" tf:"computed"`
-	Options                      map[string]string `json:"options,omitempty"`
-	Properties                   map[string]string `json:"properties,omitempty"`
-	Owner                        string            `json:"owner,omitempty" tf:"computed"`
-	IsolationMode                string            `json:"isolation_mode,omitempty" tf:"computed"`
-	MetastoreID                  string            `json:"metastore_id,omitempty" tf:"computed"`
-}
-
 func ResourceCatalog() common.Resource {
-	catalogSchema := common.StructToSchema(CatalogInfo{},
+	catalogSchema := common.StructToSchema(catalog.CatalogInfo{},
 		func(s map[string]*schema.Schema) map[string]*schema.Schema {
 			s["force_destroy"] = &schema.Schema{
 				Type:     schema.TypeBool,
 				Optional: true,
 				Default:  false,
 			}
-			common.CustomizeSchemaPath(s, "storage_root").SetCustomSuppressDiff(ucDirectoryPathSlashOnlySuppressDiff)
-			common.CustomizeSchemaPath(s, "name").SetCustomSuppressDiff(common.EqualFoldDiffSuppress)
+			// mark all computed values
+			for _, v := range []string{"owner", "isolation_mode", "metastore_id", "enable_predictive_optimization"} {
+				common.CustomizeSchemaPath(s, v).SetOptional().SetComputed()
+			}
+			// case sensitive suppress diff
+			for _, v := range []string{"name", "connection_name", "share_name", "provider_name"} {
+				common.CustomizeSchemaPath(s, v).SetCustomSuppressDiff(common.EqualFoldDiffSuppress)
+			}
+			// can only have one of provider_name + share_name, connection_name or storage_root
+			common.CustomizeSchemaPath(s, "connection_name").SetConflictsWith([]string{"storage_root", "provider_name", "share_name"}).SetForceNew()
+			for _, v := range []string{"provider_name", "share_name"} {
+				common.CustomizeSchemaPath(s, v).SetConflictsWith([]string{"connection_name", "storage_root"}).SetForceNew()
+			}
+			common.CustomizeSchemaPath(s, "storage_root").SetCustomSuppressDiff(ucDirectoryPathSlashOnlySuppressDiff).SetForceNew()
 			common.CustomizeSchemaPath(s, "enable_predictive_optimization").SetValidateFunc(
 				validation.StringInSlice([]string{"DISABLE", "ENABLE", "INHERIT"}, false),
 			)
+			for _, v := range []string{"catalog_type", "created_at", "created_by",
+				"updated_at", "updated_by", "securable_type", "full_name"} {
+				common.CustomizeSchemaPath(s, v).SetReadOnly()
+			}
+			common.CustomizeSchemaPath(s, "effective_predictive_optimization_flag").SetComputed().SetSuppressDiff()
 			return s
 		})
 	return common.Resource{

catalog/resource_catalog_test.go

@@ -773,6 +773,14 @@ func TestCatalogSuppressCaseSensitivity(t *testing.T) {
 			"isolation_mode":                 {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
 			"owner":                          {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
 			"enable_predictive_optimization": {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
+			"updated_by":                     {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
+			"updated_at":                     {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
+			"created_by":                     {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
+			"created_at":                     {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
+			"securable_type":                 {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
+			"catalog_type":                   {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
+			"effective_predictive_optimization_flag.#": {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
+			"full_name": {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
 		},
 		HCL: `
 		name = "A"

exporter/impl_uc.go

@@ -45,7 +45,7 @@ func listUcCatalogs(ic *importContext) error {
 }
 
 func importUcCatalog(ic *importContext, r *resource) error {
-	var cat tf_uc.CatalogInfo
+	var cat catalog.CatalogInfo
 	s := ic.Resources["databricks_catalog"].Schema
 	common.DataToStructPointer(r.Data, s, &cat)
 
@@ -59,7 +59,7 @@ func importUcCatalog(ic *importContext, r *resource) error {
 	if cat.ConnectionName != "" {
 		ic.Emit(&resource{
 			Resource: "databricks_connection",
-			ID:       cat.MetastoreID + "|" + cat.ConnectionName,
+			ID:       cat.MetastoreId + "|" + cat.ConnectionName,
 		})
 	} else if cat.ShareName == "" {
 		// TODO: We need to be careful here if we add more catalog types... Really we need to have CatalogType in resource