add data sources databricks_external_locations and databricks_external_location (#3464)

nkvuong · web-flow · commit b2286ca14482 · 2024-04-16T09:21:55.000Z
* add data source `databricks_external_locations`

* feedback

* feedback
diff --git a/catalog/data_external_location.go b/catalog/data_external_location.go
@@ -0,0 +1,24 @@
+package catalog
+
+import (
+	"context"
+
+	"github.com/databricks/databricks-sdk-go"
+	"github.com/databricks/databricks-sdk-go/service/catalog"
+	"github.com/databricks/terraform-provider-databricks/common"
+)
+
+func DataSourceExternalLocation() common.Resource {
+	type ExternalLocationByID struct {
+		Name             string                        `json:"name"`
+		ExternalLocation *catalog.ExternalLocationInfo `json:"external_location_info,omitempty" tf:"computed" `
+	}
+	return common.WorkspaceData(func(ctx context.Context, data *ExternalLocationByID, w *databricks.WorkspaceClient) error {
+		location, err := w.ExternalLocations.GetByName(ctx, data.Name)
+		if err != nil {
+			return err
+		}
+		data.ExternalLocation = location
+		return nil
+	})
+}
diff --git a/catalog/data_external_location_test.go b/catalog/data_external_location_test.go
@@ -0,0 +1,49 @@
+package catalog
+
+import (
+	"testing"
+
+	"github.com/databricks/databricks-sdk-go/experimental/mocks"
+	"github.com/databricks/databricks-sdk-go/service/catalog"
+	"github.com/databricks/terraform-provider-databricks/qa"
+	"github.com/stretchr/testify/mock"
+)
+
+func TestExternalLocationDataVerify(t *testing.T) {
+	qa.ResourceFixture{
+		MockWorkspaceClientFunc: func(w *mocks.MockWorkspaceClient) {
+			e := w.GetMockExternalLocationsAPI().EXPECT()
+			e.GetByName(mock.Anything, "abc").Return(
+				&catalog.ExternalLocationInfo{
+					Name:           "abc",
+					Owner:          "admin",
+					CredentialName: "test",
+					Url:            "s3://test",
+					ReadOnly:       true,
+				},
+				nil)
+		},
+		Resource:    DataSourceExternalLocation(),
+		Read:        true,
+		NonWritable: true,
+		ID:          "_",
+		HCL: `
+		name = "abc"
+		`,
+	}.ApplyAndExpectData(t, map[string]any{
+		"external_location_info.0.owner":           "admin",
+		"external_location_info.0.url":             "s3://test",
+		"external_location_info.0.credential_name": "test",
+		"external_location_info.0.read_only":       true,
+	})
+}
+
+func TestExternalLocationDataError(t *testing.T) {
+	qa.ResourceFixture{
+		Fixtures:    qa.HTTPFailures,
+		Resource:    DataSourceExternalLocation(),
+		Read:        true,
+		NonWritable: true,
+		ID:          "_",
+	}.ExpectError(t, "i'm a teapot")
+}
diff --git a/catalog/data_external_locations.go b/catalog/data_external_locations.go
@@ -0,0 +1,26 @@
+package catalog
+
+import (
+	"context"
+
+	"github.com/databricks/databricks-sdk-go"
+	"github.com/databricks/databricks-sdk-go/service/catalog"
+	"github.com/databricks/terraform-provider-databricks/common"
+)
+
+func DataSourceExternalLocations() common.Resource {
+	type externalLocationsData struct {
+		Names []string `json:"names,omitempty" tf:"computed"`
+	}
+	return common.WorkspaceData(func(ctx context.Context, data *externalLocationsData, w *databricks.WorkspaceClient) error {
+		locations, err := w.ExternalLocations.ListAll(ctx, catalog.ListExternalLocationsRequest{})
+		if err != nil {
+			return err
+		}
+		data.Names = make([]string, 0, len(locations))
+		for _, v := range locations {
+			data.Names = append(data.Names, v.Name)
+		}
+		return nil
+	})
+}
diff --git a/catalog/data_external_locations_test.go b/catalog/data_external_locations_test.go
@@ -0,0 +1,39 @@
+package catalog
+
+import (
+	"testing"
+
+	"github.com/databricks/databricks-sdk-go/experimental/mocks"
+	"github.com/databricks/databricks-sdk-go/service/catalog"
+	"github.com/databricks/terraform-provider-databricks/qa"
+	"github.com/stretchr/testify/mock"
+)
+
+func TestExternalLocationsData(t *testing.T) {
+	qa.ResourceFixture{
+		MockWorkspaceClientFunc: func(w *mocks.MockWorkspaceClient) {
+			e := w.GetMockExternalLocationsAPI().EXPECT()
+			e.ListAll(mock.Anything, catalog.ListExternalLocationsRequest{}).Return(
+				[]catalog.ExternalLocationInfo{
+					{Name: "a"}, {Name: "b"},
+				},
+				nil)
+		},
+		Resource:    DataSourceExternalLocations(),
+		Read:        true,
+		NonWritable: true,
+		ID:          "_",
+	}.ApplyAndExpectData(t, map[string]any{
+		"names": []interface{}{"a", "b"},
+	})
+}
+
+func TestExternalLocationsData_Error(t *testing.T) {
+	qa.ResourceFixture{
+		Fixtures:    qa.HTTPFailures,
+		Resource:    DataSourceExternalLocations(),
+		Read:        true,
+		NonWritable: true,
+		ID:          "_",
+	}.ExpectError(t, "i'm a teapot")
+}
diff --git a/docs/data-sources/external_location.md b/docs/data-sources/external_location.md
@@ -0,0 +1,44 @@
+---
+subcategory: "Unity Catalog"
+---
+# databricks_external_location Data Source
+
+-> **Note** This data source could be only used with workspace-level provider!
+
+Retrieves details about a [databricks_external_location](../resources/external_location.md) that were created by Terraform or manually.
+
+## Example Usage
+
+Getting details of an existing external location in the metastore
+
+```hcl
+data "databricks_external_location" "this" {
+  name = "this"
+}
+
+output "created_by" {
+  value     = data.databricks_external_location.this.created_by
+  sensitive = false
+}
+```
+
+## Argument Reference
+
+* `name` - (Required) The name of the storage credential
+
+## Attribute Reference
+
+* `url` - Path URL in cloud storage, of the form: `s3://[bucket-host]/[bucket-dir]` (AWS), `abfss://[user]@[host]/[path]` (Azure), `gs://[bucket-host]/[bucket-dir]` (GCP).
+* `credential_name` - Name of the [databricks_storage_credential](storage_credential.md) to use with this external location.
+* `owner` - Username/groupname/sp application_id of the external location owner.
+* `comment` - User-supplied comment.
+* `read_only` - Indicates whether the external location is read-only.
+* `access_point` - The ARN of the s3 access point to use with the external location (AWS).
+* `encryption_details` - The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
+
+## Related Resources
+
+The following resources are used in the same context:
+
+* [databricks_external_locations](./external_locations.md) to get names of all external locations
+* [databricks_external_location](../resources/external_location.md) to manage external locations within Unity Catalog.
diff --git a/docs/data-sources/external_locations.md b/docs/data-sources/external_locations.md
@@ -0,0 +1,33 @@
+---
+subcategory: "Unity Catalog"
+---
+# databricks_external_locations Data Source
+
+-> **Note** This data source could be only used with workspace-level provider!
+
+Retrieves a list of [databricks_external_location](./external_location.md) objects, that were created by Terraform or manually, so that special handling could be applied.
+
+## Example Usage
+
+List all external locations in the metastore
+
+```hcl
+data "databricks_external_locations" "all" {}
+
+output "all_external_locations" {
+  value = data.databricks_external_locations.all.names
+}
+```
+
+## Attribute Reference
+
+This data source exports the following attributes:
+
+* `names` - List of names of [databricks_external_location](./external_location.md) in the metastore
+
+## Related Resources
+
+The following resources are used in the same context:
+
+* [databricks_external_location](./external_location.md) to get information about a single external location
+* [databricks_external_location](../resources/external_location.md) to manage external locations within Unity Catalog.
diff --git a/internal/acceptance/data_external_locations_test.go b/internal/acceptance/data_external_locations_test.go
@@ -0,0 +1,27 @@
+package acceptance
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
+)
+
+func TestUcAccDataSourceExternalLocations(t *testing.T) {
+	unityWorkspaceLevel(t, step{
+		Template: `
+		data "databricks_external_locations" "this" {
+		}`,
+		Check: func(s *terraform.State) error {
+			r, ok := s.RootModule().Resources["data.databricks_external_locations.this"]
+			if !ok {
+				return fmt.Errorf("data not found in state")
+			}
+			names := r.Primary.Attributes["names.#"]
+			if names == "" {
+				return fmt.Errorf("names are empty: %v", r.Primary.Attributes)
+			}
+			return nil
+		},
+	})
+}
diff --git a/provider/provider.go b/provider/provider.go
@@ -67,6 +67,8 @@ func DatabricksProvider() *schema.Provider {
 			"databricks_dbfs_file":                storage.DataSourceDbfsFile().ToResource(),
 			"databricks_dbfs_file_paths":          storage.DataSourceDbfsFilePaths().ToResource(),
 			"databricks_directory":                workspace.DataSourceDirectory().ToResource(),
+			"databricks_external_location":        catalog.DataSourceExternalLocation().ToResource(),
+			"databricks_external_locations":       catalog.DataSourceExternalLocations().ToResource(),
 			"databricks_group":                    scim.DataSourceGroup().ToResource(),
 			"databricks_instance_pool":            pools.DataSourceInstancePool().ToResource(),
 			"databricks_instance_profiles":        aws.DataSourceInstanceProfiles().ToResource(),
