[Feature] add databricks_dashboards data source (#4521)

## Changes
- Add `databricks_dashboards` data source. Resolve #4451

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

- [x] `make test` run locally
- [x] relevant change in `docs/` folder
- [x] covered with integration tests in `internal/acceptance`
- [x] using Go SDK
- [x] using TF Plugin Framework

---------

Co-authored-by: Miles Yucht <[email protected]>

Author: nkvuong

NEXT_CHANGELOG.md

@@ -6,6 +6,7 @@
 
  * Add support for cluster logs delivery to UC Volumes ([#4492](https://github.com/databricks/terraform-provider-databricks/pull/4492)).
  * Expose more attributes for `databricks_connection` resource ([#4502](https://github.com/databricks/terraform-provider-databricks/pull/4502)).
+ * Add `databricks_dashboards` resource ([#4521](https://github.com/databricks/terraform-provider-databricks/pull/4521))
 
 ### Bug Fixes
 

docs/data-sources/dashboards.md

@@ -0,0 +1,43 @@
+---
+subcategory: "Workspace"
+---
+# databricks_dashboards Data Source
+
+This data source allows you to retrieve information about Databricks [Dashboards](https://docs.databricks.com/en/dashboards/index.html).
+
+## Example Usage
+
+```hcl
+data "databricks_dashboards" "all" {
+}
+
+resource "databricks_permissions" "dashboards_permissions" {
+  depends = [ data.databricks_dashboards.all ]
+  for_each = data.databricks_dashboards.all.dashboards[*].dashboard_id
+
+  dashboard_id = each.value
+
+  access_control {
+    group_name       = "Example Group"
+    permission_level = "CAN_MANAGE"
+  }
+}
+
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `dashboard_name_contains` - (Optional) A **case-insensitive** substring to filter Dashboards by their name.
+
+## Attribute Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+* `dashboards` - A list of dashboards matching the specified criteria. Each element contains the following attributes:
+  * `dashboard_id` - The unique ID of the dashboard.
+  * `display_name` - The display name of the dashboard.
+  * `create_time` - The timestamp of when the dashboard was created.
+
+If no matches are found, an empty list will be returned.

internal/providers/pluginfw/pluginfw_rollout_utils.go

@@ -15,6 +15,7 @@ import (
 	"github.com/databricks/terraform-provider-databricks/internal/providers/pluginfw/products/app"
 	"github.com/databricks/terraform-provider-databricks/internal/providers/pluginfw/products/catalog"
 	"github.com/databricks/terraform-provider-databricks/internal/providers/pluginfw/products/cluster"
+	"github.com/databricks/terraform-provider-databricks/internal/providers/pluginfw/products/dashboards"
 	"github.com/databricks/terraform-provider-databricks/internal/providers/pluginfw/products/library"
 	"github.com/databricks/terraform-provider-databricks/internal/providers/pluginfw/products/notificationdestinations"
 	"github.com/databricks/terraform-provider-databricks/internal/providers/pluginfw/products/qualitymonitor"
@@ -56,6 +57,7 @@ var pluginFwOnlyDataSources = append(
 		app.DataSourceApp,
 		app.DataSourceApps,
 		catalog.DataSourceFunctions,
+		dashboards.DataSourceDashboards,
 		notificationdestinations.DataSourceNotificationDestinations,
 		registered_model.DataSourceRegisteredModel,
 		registered_model.DataSourceRegisteredModelVersions,

internal/providers/pluginfw/products/dashboards/data_dashboards.go

@@ -0,0 +1,111 @@
+package dashboards
+
+import (
+	"context"
+	"reflect"
+	"strings"
+
+	"github.com/databricks/databricks-sdk-go/service/dashboards"
+	"github.com/databricks/terraform-provider-databricks/common"
+	pluginfwcommon "github.com/databricks/terraform-provider-databricks/internal/providers/pluginfw/common"
+	pluginfwcontext "github.com/databricks/terraform-provider-databricks/internal/providers/pluginfw/context"
+	"github.com/databricks/terraform-provider-databricks/internal/providers/pluginfw/converters"
+	"github.com/databricks/terraform-provider-databricks/internal/providers/pluginfw/tfschema"
+	"github.com/databricks/terraform-provider-databricks/internal/service/dashboards_tf"
+	"github.com/hashicorp/terraform-plugin-framework/attr"
+	"github.com/hashicorp/terraform-plugin-framework/datasource"
+	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/diag"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+)
+
+const dataSourceName = "dashboards"
+
+func DataSourceDashboards() datasource.DataSource {
+	return &DashboardsDataSource{}
+}
+
+var _ datasource.DataSourceWithConfigure = &DashboardsDataSource{}
+
+type DashboardsDataSource struct {
+	Client *common.DatabricksClient
+}
+
+type DashboardsInfo struct {
+	DashboardNameContains types.String `tfsdk:"dashboard_name_contains"`
+	Dashboards            types.List   `tfsdk:"dashboards"`
+}
+
+func (DashboardsInfo) ApplySchemaCustomizations(attrs map[string]tfschema.AttributeBuilder) map[string]tfschema.AttributeBuilder {
+	attrs["dashboard_name_contains"] = attrs["dashboard_name_contains"].SetOptional()
+	attrs["dashboards"] = attrs["dashboards"].SetComputed()
+
+	return attrs
+}
+
+func (DashboardsInfo) GetComplexFieldTypes(context.Context) map[string]reflect.Type {
+	return map[string]reflect.Type{
+		"dashboards": reflect.TypeOf(dashboards_tf.Dashboard{}),
+	}
+}
+
+func (d *DashboardsDataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
+	resp.TypeName = pluginfwcommon.GetDatabricksProductionName(dataSourceName)
+}
+
+func (d *DashboardsDataSource) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {
+	attrs, blocks := tfschema.DataSourceStructToSchemaMap(ctx, DashboardsInfo{}, nil)
+	resp.Schema = schema.Schema{
+		Attributes: attrs,
+		Blocks:     blocks,
+	}
+}
+
+func (d *DashboardsDataSource) Configure(_ context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
+	if d.Client == nil {
+		d.Client = pluginfwcommon.ConfigureDataSource(req, resp)
+	}
+}
+
+func AppendDiagAndCheckErrors(resp *datasource.ReadResponse, diags diag.Diagnostics) bool {
+	resp.Diagnostics.Append(diags...)
+	return resp.Diagnostics.HasError()
+}
+
+func (d *DashboardsDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
+	ctx = pluginfwcontext.SetUserAgentInDataSourceContext(ctx, dataSourceName)
+	w, diags := d.Client.GetWorkspaceClient()
+	if AppendDiagAndCheckErrors(resp, diags) {
+		return
+	}
+
+	var dashboardInfo DashboardsInfo
+	if AppendDiagAndCheckErrors(resp, req.Config.Get(ctx, &dashboardInfo)) {
+		return
+	}
+
+	dashboardName := strings.ToLower(dashboardInfo.DashboardNameContains.ValueString())
+
+	dashboardsGoSdk, err := w.Lakeview.ListAll(ctx, dashboards.ListDashboardsRequest{})
+	if err != nil {
+		resp.Diagnostics.AddError("Failed to fetch Dashboards", err.Error())
+		return
+	}
+
+	var dashboardsTfSdk []attr.Value
+	for _, dashboard := range dashboardsGoSdk {
+		if dashboardName != "" && !strings.Contains(strings.ToLower(dashboard.DisplayName), dashboardName) {
+			continue
+		}
+
+		var dashboardResponse dashboards_tf.Dashboard
+		if AppendDiagAndCheckErrors(resp, converters.GoSdkToTfSdkStruct(ctx, dashboard, &dashboardResponse)) {
+			return
+		}
+		dashboardsTfSdk = append(dashboardsTfSdk, dashboardResponse.ToObjectValue(ctx))
+	}
+
+	dashboardInfo.Dashboards = types.ListValueMust(dashboards_tf.Dashboard{}.Type(ctx), dashboardsTfSdk)
+	resp.Diagnostics.Append(resp.State.Set(ctx, dashboardInfo)...)
+
+}

internal/providers/pluginfw/products/dashboards/data_dashboards_acc_test.go

@@ -0,0 +1,43 @@
+package dashboards_test
+
+import (
+	"strconv"
+	"testing"
+
+	"github.com/databricks/terraform-provider-databricks/internal/acceptance"
+	"github.com/hashicorp/terraform-plugin-testing/terraform"
+	"github.com/stretchr/testify/require"
+)
+
+func CheckDataSourceDashboardsPopulated(t *testing.T) func(s *terraform.State) error {
+	return func(s *terraform.State) error {
+		ds, ok := s.Modules[0].Resources["data.databricks_dashboards.this"]
+		require.True(t, ok, "data.databricks_dashboards.this has to be there")
+
+		dashboardsCount := ds.Primary.Attributes["dashboards.#"]
+		dashboardsCountInt, err := strconv.Atoi(dashboardsCount)
+		require.NoError(t, err, "dashboards count is not a number")
+		require.NotEqual(t, 0, dashboardsCountInt, "dashboard list is empty")
+
+		return nil
+	}
+}
+
+func TestAccDashboardsDataSource(t *testing.T) {
+	acceptance.WorkspaceLevel(t, acceptance.Step{
+		Template: `
+			resource "databricks_dashboard" "dashboard" {
+				display_name         = "New Dashboard"
+				warehouse_id         = "{env.TEST_DEFAULT_WAREHOUSE_ID}"
+				serialized_dashboard = "{\"pages\":[{\"name\":\"new_name\",\"displayName\":\"New Page\"}]}"
+				embed_credentials    = false // Optional
+				parent_path          = "/Shared/provider-test"
+			}
+
+			data "databricks_dashboards" "this" {
+				depends_on = [databricks_dashboard.dashboard]
+			}
+		`,
+		Check: CheckDataSourceDashboardsPopulated(t),
+	})
+}