Added datarbicks_directory data source (#1902)

* Add `datarbicks_directory` data source

It will be necessary for adding `parent` attribute to SQL queries/dashboards, especially
in exporter

* improve test coverage for `databricks_notebook` data source

Author: alexott

docs/data-sources/directory.md

@@ -0,0 +1,26 @@
+---
+subcategory: "Workspace"
+---
+# databricks_directory Data Source
+
+-> **Note** If you have a fully automated setup with workspaces created by [databricks_mws_workspaces](../resources/mws_workspaces.md) or [azurerm_databricks_workspace](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/databricks_workspace), please make sure to add [depends_on attribute](../index.md#data-resources-and-authentication-is-not-configured-errors) in order to prevent _authentication is not configured for provider_ errors.
+
+This data source allows to get information about a directory in a Databricks Workspace.
+
+## Example Usage
+
+```hcl
+data "databricks_notebook" "prod" {
+  path   = "/Production"
+}
+```
+
+## Argument Reference
+
+* `path` - (Required) Path to a directory in the workspace
+
+## Attribute Reference
+
+This data source exports the following attributes:
+
+* `object_id` - directory object ID

provider/provider.go

@@ -46,6 +46,7 @@ func DatabricksProvider() *schema.Provider {
 			"databricks_current_user":            scim.DataSourceCurrentUser(),
 			"databricks_dbfs_file":               storage.DataSourceDbfsFile(),
 			"databricks_dbfs_file_paths":         storage.DataSourceDbfsFilePaths(),
+			"databricks_directory":               workspace.DataSourceDirectory(),
 			"databricks_group":                   scim.DataSourceGroup(),
 			"databricks_jobs":                    jobs.DataSourceJobs(),
 			"databricks_job":                     jobs.DataSourceJob(),

workspace/data_directory.go

@@ -0,0 +1,42 @@
+package workspace
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+)
+
+// DataSourceDirectory ...
+func DataSourceDirectory() *schema.Resource {
+	s := map[string]*schema.Schema{
+		"path": {
+			Type:     schema.TypeString,
+			Required: true,
+			ForceNew: true,
+		},
+		"object_id": {
+			Type:     schema.TypeInt,
+			Optional: true,
+			Computed: true,
+		},
+	}
+	return &schema.Resource{
+		Schema: s,
+		ReadContext: func(ctx context.Context, d *schema.ResourceData, m any) diag.Diagnostics {
+			notebooksAPI := NewNotebooksAPI(ctx, m)
+			path := d.Get("path").(string)
+			data, err := notebooksAPI.Read(path)
+			if err != nil {
+				return diag.FromErr(err)
+			}
+			if data.ObjectType != Directory { // should we support Repos as well?
+				return diag.Errorf("'%s' isn't a directory", path)
+			}
+			d.SetId(data.Path)
+			d.Set("object_id", data.ObjectID)
+			d.Set("path", path)
+			return nil
+		},
+	}
+}

workspace/data_directory_test.go

@@ -0,0 +1,72 @@
+package workspace
+
+import (
+	"testing"
+
+	"github.com/databricks/terraform-provider-databricks/qa"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestDataSourceDirectory(t *testing.T) {
+	d, err := qa.ResourceFixture{
+		Fixtures: []qa.HTTPFixture{
+			{
+				Method:   "GET",
+				Resource: "/api/2.0/workspace/get-status?path=%2Fa%2Fb%2Fc",
+				Response: ObjectStatus{
+					ObjectID:   987,
+					ObjectType: "DIRECTORY",
+					Path:       "/a/b/c",
+				},
+			},
+		},
+		Read:        true,
+		NonWritable: true,
+		Resource:    DataSourceDirectory(),
+		ID:          ".",
+		State: map[string]any{
+			"path": "/a/b/c",
+		},
+	}.Apply(t)
+	require.NoError(t, err)
+	assert.Equal(t, "/a/b/c", d.Id())
+	assert.Equal(t, 987, d.Get("object_id").(int))
+}
+
+func TestDataSourceDirectory_NotDirectory(t *testing.T) {
+	qa.ResourceFixture{
+		Fixtures: []qa.HTTPFixture{
+			{
+				Method:   "GET",
+				Resource: "/api/2.0/workspace/get-status?path=%2Fa%2Fb%2Fc",
+				Response: ObjectStatus{
+					ObjectID:   987,
+					Language:   "PYTHON",
+					ObjectType: "NOTEBOOK",
+					Path:       "/a/b/c",
+				},
+			},
+		},
+		Read:        true,
+		NonWritable: true,
+		Resource:    DataSourceDirectory(),
+		ID:          ".",
+		State: map[string]any{
+			"path": "/a/b/c",
+		},
+	}.ExpectError(t, "'/a/b/c' isn't a directory")
+}
+
+func TestDataSourceDirectory_Error(t *testing.T) {
+	qa.ResourceFixture{
+		Fixtures:    qa.HTTPFailures,
+		Read:        true,
+		NonWritable: true,
+		Resource:    DataSourceDirectory(),
+		ID:          ".",
+		State: map[string]any{
+			"path": "/a/b/c",
+		},
+	}.ExpectError(t, "I'm a teapot")
+}

workspace/data_notebook_test.go

@@ -3,6 +3,7 @@ package workspace
 import (
 	"testing"
 
+	"github.com/databricks/terraform-provider-databricks/common"
 	"github.com/databricks/terraform-provider-databricks/qa"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -42,3 +43,52 @@ func TestDataSourceNotebook(t *testing.T) {
 	assert.Equal(t, "/a/b/c", d.Id())
 	assert.Equal(t, "SGVsbG8gd29ybGQK", d.Get("content"))
 }
+
+func TestDataSourceNotebook_ErrorExport(t *testing.T) {
+	qa.ResourceFixture{
+		Fixtures:    qa.HTTPFailures,
+		Read:        true,
+		NonWritable: true,
+		Resource:    DataSourceNotebook(),
+		ID:          ".",
+		State: map[string]any{
+			"path":   "/a/b/c",
+			"format": "SOURCE",
+		},
+	}.ExpectError(t, "I'm a teapot")
+}
+
+func TestDataSourceNotebook_ErrorStatus(t *testing.T) {
+	qa.ResourceFixture{
+		Fixtures: []qa.HTTPFixture{
+			{
+				Method:   "GET",
+				Resource: "/api/2.0/workspace/get-status?path=%2Fa%2Fb%2Fc",
+				Response: ObjectStatus{
+					ObjectID:   987,
+					Language:   "PYTHON",
+					ObjectType: "NOTEBOOK",
+					Path:       "/a/b/c",
+				},
+			},
+			{
+				Method:   "GET",
+				Resource: "/api/2.0/workspace/export?format=SOURCE&path=%2Fa%2Fb%2Fc",
+				Status:   401,
+				Response: common.APIError{
+					ErrorCode:  "Unauthorized",
+					StatusCode: 401,
+					Message:    "Unauthorized",
+				},
+			},
+		},
+		Read:        true,
+		NonWritable: true,
+		Resource:    DataSourceNotebook(),
+		ID:          ".",
+		State: map[string]any{
+			"path":   "/a/b/c",
+			"format": "SOURCE",
+		},
+	}.ExpectError(t, "Unauthorized")
+}