Add Terraform Provider for DefaultNamespaceSettings (#2710)

* Terraform Provider for DefaultNamespaceSettings

* Add resource to providers

* Initial docuentation

* Update Delete method and tests

* More fixes

* Rename tests

* Add acceptance tests

* Fix typo

* Change retry strategy

* Change function name

* Update test

* Small fixes

* Update test

* Update comment

* Add some comments

* Enable test

Author: hectorcast-db

common/client.go

@@ -107,16 +107,26 @@ func (c *DatabricksClient) Post(ctx context.Context, path string, request any, r
 	return c.Do(ctx, http.MethodPost, path, nil, request, response, c.addApiPrefix)
 }
 
-// Delete on path
+// Delete on path. Ignores succesfull responses from the server.
 func (c *DatabricksClient) Delete(ctx context.Context, path string, request any) error {
 	return c.Do(ctx, http.MethodDelete, path, nil, request, nil, c.addApiPrefix)
 }
 
-// Patch on path
+// Delete on path. Deserializes the response into the response parameter.
+func (c *DatabricksClient) DeleteWithResponse(ctx context.Context, path string, request any, response any) error {
+	return c.Do(ctx, http.MethodDelete, path, nil, request, response, c.addApiPrefix)
+}
+
+// Patch on path. Ignores succesfull responses from the server.
 func (c *DatabricksClient) Patch(ctx context.Context, path string, request any) error {
 	return c.Do(ctx, http.MethodPatch, path, nil, request, nil, c.addApiPrefix)
 }
 
+// Patch on path. Deserializes the response into the response parameter.
+func (c *DatabricksClient) PatchWithResponse(ctx context.Context, path string, request any, response any) error {
+	return c.Do(ctx, http.MethodPatch, path, nil, request, response, c.addApiPrefix)
+}
+
 // Put on path
 func (c *DatabricksClient) Put(ctx context.Context, path string, request any) error {
 	return c.Do(ctx, http.MethodPut, path, nil, request, nil, c.addApiPrefix)

docs/resources/default_namespace_settings.md

@@ -0,0 +1,30 @@
+---
+subcategory: "Settings"
+---
+
+# databricks_namespace_settings Resource
+
+The `databricks_default_namespace_settings` resource allows you to operate the setting configuration for the default namespace in the Databricks workspace.
+Setting the default catalog for the workspace determines the catalog that is used when queries do not reference
+a fully qualified 3 level name. For example, if the default catalog is set to 'retail_prod' then a query
+'SELECT * FROM myTable' would reference the object 'retail_prod.default.myTable'
+(the schema 'default' is always assumed).
+This setting requires a restart of clusters and SQL warehouses to take effect. Additionally, the default namespace only applies when using Unity Catalog-enabled compute.
+## Example Usage
+
+```hcl
+resource "databricks_default_namespace_settings" "this" {
+		namespace {
+			value = "namespace_value"
+		}
+}
+```
+
+## Argument Reference
+
+The resource supports the following arguments:
+
+* `namespace` - (Required) The configuration details.
+* `value` - (Required) The value for the setting.
+
+

internal/acceptance/default_namespace_test.go

@@ -0,0 +1,71 @@
+package acceptance
+
+import (
+	"context"
+	"errors"
+	"testing"
+
+	"github.com/databricks/databricks-sdk-go/apierr"
+	"github.com/databricks/databricks-sdk-go/service/settings"
+	"github.com/databricks/terraform-provider-databricks/common"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestAccDefaultNamespaceSetting(t *testing.T) {
+	workspaceLevel(t, step{
+		Template: `
+		resource "databricks_default_namespace_settings" "this" {
+			namespace {
+				value = "namespace_value"
+			}
+		}
+		`,
+		Check: resourceCheck("databricks_default_namespace_settings.this", func(ctx context.Context, client *common.DatabricksClient, id string) error {
+			ctx = context.WithValue(ctx, common.Api, common.API_2_1)
+			w, err := client.WorkspaceClient()
+			assert.NoError(t, err)
+			res, err := w.Settings.ReadDefaultWorkspaceNamespace(ctx, settings.ReadDefaultWorkspaceNamespaceRequest{
+				Etag: id,
+			})
+			assert.NoError(t, err)
+			// Check that the resource has been created and that it has the correct value.
+			assert.Equal(t, res.Namespace.Value, "namespace_value")
+			return nil
+		}),
+	},
+		step{
+			Destroy: true,
+			Check: resourceCheck("databricks_default_namespace_settings.this", func(ctx context.Context, client *common.DatabricksClient, id string) error {
+				ctx = context.WithValue(ctx, common.Api, common.API_2_1)
+				w, err := client.WorkspaceClient()
+				assert.NoError(t, err)
+				// Terraform Check returns the latest resource status before it is destroyed, which has an outdated eTag.
+				// We are making an update call to get the correct eTag in the response error.
+				_, err = w.Settings.UpdateDefaultWorkspaceNamespace(ctx, settings.UpdateDefaultWorkspaceNamespaceRequest{
+					AllowMissing: true,
+					Setting: &settings.DefaultNamespaceSetting{
+						Namespace: settings.StringMessage{
+							Value: "this_call_should_fail",
+						},
+					},
+					FieldMask: "namespace.value",
+				})
+				assert.Error(t, err)
+				var aerr *apierr.APIError
+				if !errors.As(err, &aerr) {
+					assert.FailNow(t, "cannot parse error message %v", err)
+				}
+				etag := aerr.Details[0].Metadata["etag"]
+				_, err = w.Settings.ReadDefaultWorkspaceNamespace(ctx, settings.ReadDefaultWorkspaceNamespaceRequest{
+					Etag: etag,
+				})
+				if !errors.As(err, &aerr) {
+					assert.FailNow(t, "cannot parse error message %v", err)
+				}
+
+				assert.Equal(t, aerr.ErrorCode, "RESOURCE_DOES_NOT_EXIST")
+				return nil
+			}),
+		},
+	)
+}

provider/provider.go

@@ -36,6 +36,7 @@ import (
 	"github.com/databricks/terraform-provider-databricks/scim"
 	"github.com/databricks/terraform-provider-databricks/secrets"
 	"github.com/databricks/terraform-provider-databricks/serving"
+	"github.com/databricks/terraform-provider-databricks/settings"
 	"github.com/databricks/terraform-provider-databricks/sharing"
 	"github.com/databricks/terraform-provider-databricks/sql"
 	"github.com/databricks/terraform-provider-databricks/storage"
@@ -103,6 +104,7 @@ func DatabricksProvider() *schema.Provider {
 			"databricks_cluster":                     clusters.ResourceCluster(),
 			"databricks_cluster_policy":              policies.ResourceClusterPolicy(),
 			"databricks_dbfs_file":                   storage.ResourceDbfsFile(),
+			"databricks_default_namespace_settings":  settings.ResourceDefaultNamespaceSettings(),
 			"databricks_directory":                   workspace.ResourceDirectory(),
 			"databricks_entitlements":                scim.ResourceEntitlements(),
 			"databricks_external_location":           catalog.ResourceExternalLocation(),

settings/resource_default_namespace_settings.go

@@ -0,0 +1,178 @@
+package settings
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"net/http"
+
+	"github.com/databricks/databricks-sdk-go/apierr"
+	"github.com/databricks/databricks-sdk-go/service/settings"
+	"github.com/databricks/terraform-provider-databricks/common"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+)
+
+// NewDefaultNamespaceSettingsAPI creates a DefaultNamespaceSettingsAPI instance
+func NewDefaultNamespaceSettingsAPI(ctx context.Context, m any) DefaultNamespaceSettingsAPI {
+	client := m.(*common.DatabricksClient)
+	return DefaultNamespaceSettingsAPI{client, ctx}
+}
+
+// DefaultNamespaceSettingsAPI exposes the Default Namespace Settings API
+type DefaultNamespaceSettingsAPI struct {
+	client  *common.DatabricksClient
+	context context.Context
+}
+
+func (a DefaultNamespaceSettingsAPI) isEtagVersionError(err error) bool {
+	var aerr *apierr.APIError
+	if !errors.As(err, &aerr) {
+		return false
+	}
+	return aerr.StatusCode == http.StatusNotFound || (aerr.StatusCode == http.StatusConflict && aerr.ErrorCode == "RESOURCE_CONFLICT")
+}
+
+func (a DefaultNamespaceSettingsAPI) getEtagFromError(err error) (string, error) {
+	if !a.isEtagVersionError(err) {
+		return "", err
+	}
+	errorInfos := apierr.GetErrorInfo(err)
+	if len(errorInfos) > 0 {
+		metadata := errorInfos[0].Metadata
+		if etag, ok := metadata["etag"]; ok {
+			return etag, nil
+		}
+	}
+	return "", fmt.Errorf("error fetching the default workspace namespace settings: %w", err)
+}
+
+func (a DefaultNamespaceSettingsAPI) DeleteWithRetry(etag string) (string, error) {
+	etag, err := a.executeDelete(etag)
+	if err == nil {
+		return etag, nil
+	}
+	etag, err = a.getEtagFromError(err)
+	if err != nil {
+		return "", err
+	}
+	return a.executeDelete(etag)
+}
+
+func (a DefaultNamespaceSettingsAPI) executeDelete(etag string) (string, error) {
+	var response settings.DefaultNamespaceSetting
+	err := a.client.DeleteWithResponse(a.context, "/settings/types/default_namespace_ws/names/default", map[string]string{
+		"etag": etag,
+	}, &response)
+	if err != nil {
+		return "", err
+	}
+	return response.Etag, nil
+}
+
+func (a DefaultNamespaceSettingsAPI) UpdateWithRetry(request settings.UpdateDefaultWorkspaceNamespaceRequest) (string, error) {
+	etag, err := a.executeUpdate(request)
+	if err == nil {
+		return etag, nil
+	}
+	etag, err = a.getEtagFromError(err)
+	if err != nil {
+		return "", err
+	}
+	request.Setting.Etag = etag
+	return a.executeUpdate(request)
+}
+
+func (a DefaultNamespaceSettingsAPI) executeUpdate(request settings.UpdateDefaultWorkspaceNamespaceRequest) (string, error) {
+	var response settings.DefaultNamespaceSetting
+	err := a.client.PatchWithResponse(a.context, "/settings/types/default_namespace_ws/names/default", request, &response)
+	if err != nil {
+		return "", err
+	}
+	return response.Etag, nil
+}
+
+func (a DefaultNamespaceSettingsAPI) Read(etag string) (settings.DefaultNamespaceSetting, error) {
+	var setting settings.DefaultNamespaceSetting
+	err := a.client.Get(a.context, "/settings/types/default_namespace_ws/names/default", map[string]string{
+		"etag": etag,
+	}, &setting)
+	return setting, err
+}
+
+var resourceSchema = common.StructToSchema(settings.DefaultNamespaceSetting{},
+	func(s map[string]*schema.Schema) map[string]*schema.Schema {
+		s["etag"].Computed = true
+		s["setting_name"].Computed = true
+
+		return s
+	})
+
+func ResourceDefaultNamespaceSettings() *schema.Resource {
+	return common.Resource{
+		Schema: resourceSchema,
+		Create: func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error {
+			var setting settings.DefaultNamespaceSetting
+			common.DataToStructPointer(d, resourceSchema, &setting)
+			setting.SettingName = "default"
+			request := settings.UpdateDefaultWorkspaceNamespaceRequest{
+				AllowMissing: true,
+				Setting:      &setting,
+				FieldMask:    "namespace.value",
+			}
+			settingAPI := NewDefaultNamespaceSettingsAPI(ctx, c)
+			etag, err := settingAPI.UpdateWithRetry(request)
+			if err != nil {
+				return err
+			}
+			d.SetId(etag)
+			return nil
+		},
+		Read: func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error {
+			settingAPI := NewDefaultNamespaceSettingsAPI(ctx, c)
+			res, err := settingAPI.Read(d.Id())
+			if err != nil {
+				return err
+			}
+			err = common.StructToData(res, resourceSchema, d)
+			if err != nil {
+				return err
+			}
+			// Update the etag. The server will accept any etag and respond
+			// with a response which is at least as recent as the etag.
+			// Updating, while not always necessary, ensures that the
+			// server responds with an updated response.
+			d.SetId(res.Etag)
+			return nil
+		},
+		Update: func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error {
+			var setting settings.DefaultNamespaceSetting
+			common.DataToStructPointer(d, resourceSchema, &setting)
+			setting.SettingName = "default"
+			setting.Etag = d.Id()
+			request := settings.UpdateDefaultWorkspaceNamespaceRequest{
+				AllowMissing: true,
+				Setting:      &setting,
+				FieldMask:    "namespace.value",
+			}
+			settingAPI := NewDefaultNamespaceSettingsAPI(ctx, c)
+			etag, err := settingAPI.UpdateWithRetry(request)
+			if err != nil {
+				return err
+			}
+			// Update the etag. The server will accept any etag and respond
+			// with a response which is at least as recent as the etag.
+			// Updating, while not always necessary, ensures that the
+			// server responds with an updated response.
+			d.SetId(etag)
+			return nil
+		},
+		Delete: func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error {
+			etag, err := NewDefaultNamespaceSettingsAPI(ctx, c).DeleteWithRetry(d.Id())
+			if err != nil {
+				return err
+			}
+			d.SetId(etag)
+			return nil
+		},
+	}.ToResource()
+}