Add support for dashboards in deployment bind/unbind commands

NEXT_CHANGELOG.md

@@ -5,10 +5,10 @@
 ### CLI
 
 ### Bundles
-
 * Processing 'artifacts' section is now done in "bundle validate" (adding defaults, inferring "build", asserting required fields) ([#2526])(https://github.com/databricks/cli/pull/2526))
 * When uploading artifacts, include relative path in log message ([#2539])(https://github.com/databricks/cli/pull/2539))
 * Added support for clusters in deployment bind/unbind commands ([#2536](https://github.com/databricks/cli/pull/2536))
 * Added support for volumes in deployment bind/unbind commands ([#2527](https://github.com/databricks/cli/pull/2527))
+* Added support for dashboards in deployment bind/unbind commands ([#2516](https://github.com/databricks/cli/pull/2516))
 
 ### API Changes

acceptance/acceptance_test.go

@@ -290,6 +290,10 @@ func getSkipReason(config *internal.TestConfig, configPath string) string {
  return fmt.Sprintf("Disabled via RequiresUnityCatalog setting in %s (TEST_METASTORE_ID=%s)", configPath, os.Getenv("TEST_METASTORE_ID"))
  }
 
+ if isTruePtr(config.RequiresWarehouse) && os.Getenv("TEST_DEFAULT_WAREHOUSE_ID") == "" {
+ return fmt.Sprintf("Disabled via RequiresWarehouse setting in %s (TEST_DEFAULT_WAREHOUSE_ID=%s)", configPath, os.Getenv("TEST_DEFAULT_WAREHOUSE_ID"))
+ }
+
  if isTruePtr(config.RequiresCluster) && os.Getenv("TEST_DEFAULT_CLUSTER_ID") == "" {
  return fmt.Sprintf("Disabled via RequiresCluster setting in %s (TEST_DEFAULT_CLUSTER_ID=%s)", configPath, os.Getenv("TEST_DEFAULT_CLUSTER_ID"))
  }

acceptance/bundle/deployment/bind/dashboard/databricks.yml.tmpl

@@ -0,0 +1,12 @@
+bundle:
+ name: bind-dashboard-test-$UNIQUE_NAME
+
+resources:
+ dashboards:
+ dashboard1:
+ display_name: $DASHBOARD_DISPLAY_NAME
+ warehouse_id: $TEST_DEFAULT_WAREHOUSE_ID
+ embed_credentials: true
+ file_path: "sample-dashboard.lvdash.json"
+ parent_path: /Users/$CURRENT_USER_NAME
+

acceptance/bundle/deployment/bind/dashboard/output.txt

@@ -0,0 +1,37 @@
+
+>>> [CLI] bundle deployment bind dashboard1 [DASHBOARD_ID] --auto-approve
+Updating deployment state...
+Successfully bound databricks_dashboard with an id '[DASHBOARD_ID]'. Run 'bundle deploy' to deploy changes to your workspace
+
+>>> [CLI] bundle deploy
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/bind-dashboard-test-[UNIQUE_NAME]/default/files...
+Deploying resources...
+Updating deployment state...
+Deployment complete!
+
+>>> [CLI] lakeview get [DASHBOARD_ID]
+{
+ "display_name": "test dashboard [UUID]",
+ "lifecycle_state": "ACTIVE",
+ "path": "/Users/[USERNAME]/test dashboard [UUID].lvdash.json",
+ "parent_path": "/Users/[USERNAME]",
+ "serialized_dashboard": "{\"pages\":[{\"name\":\"02724bf2\",\"displayName\":\"Page One\"}]}"
+}
+
+>>> [CLI] bundle deployment unbind dashboard1
+Updating deployment state...
+
+>>> [CLI] bundle destroy --auto-approve
+All files and directories at the following location will be deleted: /Workspace/Users/[USERNAME]/.bundle/bind-dashboard-test-[UNIQUE_NAME]/default
+
+Deleting files...
+Destroy complete!
+
+>>> [CLI] lakeview get [DASHBOARD_ID]
+{
+ "display_name": "test dashboard [UUID]",
+ "lifecycle_state": "ACTIVE",
+ "path": "/Users/[USERNAME]/test dashboard [UUID].lvdash.json",
+ "parent_path": "/Users/[USERNAME]",
+ "serialized_dashboard": "{\"pages\":[{\"name\":\"02724bf2\",\"displayName\":\"Page One\"}]}"
+}

acceptance/bundle/deployment/bind/dashboard/recreation/databricks.yml.tmpl

@@ -0,0 +1,11 @@
+bundle:
+ name: bind-dashboard-recreation-test-$UNIQUE_NAME
+
+resources:
+ dashboards:
+ dashboard1:
+ display_name: $DASHBOARD_DISPLAY_NAME
+ warehouse_id: $TEST_DEFAULT_WAREHOUSE_ID
+ embed_credentials: true
+ file_path: "sample-dashboard.lvdash.json"
+

acceptance/bundle/deployment/bind/dashboard/recreation/output.txt

@@ -0,0 +1,30 @@
+
+>>> [CLI] bundle deployment bind dashboard1 [DASHBOARD_ID] --auto-approve
+Updating deployment state...
+Successfully bound databricks_dashboard with an id '[DASHBOARD_ID]'. Run 'bundle deploy' to deploy changes to your workspace
+
+>>> errcode [CLI] bundle deploy
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/bind-dashboard-recreation-test-[UNIQUE_NAME]/default/files...
+
+This action will result in the deletion or recreation of the following dashboards.
+This will result in changed IDs and permanent URLs of the dashboards that will be recreated:
+ recreate dashboard dashboard1
+Error: the deployment requires destructive actions, but current console does not support prompting. Please specify --auto-approve if you would like to skip prompts and proceed
+
+
+Exit code: 1
+
+>>> [CLI] bundle deployment unbind dashboard1
+Updating deployment state...
+
+>>> [CLI] bundle deploy --auto-approve
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/bind-dashboard-recreation-test-[UNIQUE_NAME]/default/files...
+Deploying resources...
+Updating deployment state...
+Deployment complete!
+
+>>> [CLI] lakeview get [DASHBOARD_ID]
+{
+ "display_name": "test dashboard [UUID]",
+ "lifecycle_state": "ACTIVE"
+}

acceptance/bundle/deployment/bind/dashboard/recreation/sample-dashboard.lvdash.json

@@ -0,0 +1 @@
+{"pages":[{"name":"02724bf2","displayName":"Page One"}]}

acceptance/bundle/deployment/bind/dashboard/recreation/script

@@ -0,0 +1,29 @@
+DASHBOARD_DISPLAY_NAME="test dashboard $(uuid)"
+if [ -z "$CLOUD_ENV" ]; then
+ DASHBOARD_DISPLAY_NAME="test dashboard 6260d50f-e8ff-4905-8f28-812345678903" # use hard-coded uuid when running locally
+ export TEST_DEFAULT_WAREHOUSE_ID="warehouse-1234"
+fi
+
+export DASHBOARD_DISPLAY_NAME
+envsubst < databricks.yml.tmpl > databricks.yml
+
+# Create a pre-defined dashboard:
+DASHBOARD_ID=$($CLI lakeview create --display-name "${DASHBOARD_DISPLAY_NAME}" --warehouse-id "${TEST_DEFAULT_WAREHOUSE_ID}" --serialized-dashboard '{"pages":[{"name":"02724bf2","displayName":"Untitled page"}]}' | jq -r '.dashboard_id')
+
+cleanupRemoveDashboard() {
+ $CLI lakeview trash "${DASHBOARD_ID}"
+}
+trap cleanupRemoveDashboard EXIT
+
+trace $CLI bundle deployment bind dashboard1 "${DASHBOARD_ID}" --auto-approve
+
+trace errcode $CLI bundle deploy
+
+trace $CLI bundle deployment unbind dashboard1
+
+trace $CLI bundle deploy --auto-approve
+
+trace $CLI lakeview get "${DASHBOARD_ID}" | jq '{display_name, lifecycle_state}'
+
+
+

acceptance/bundle/deployment/bind/dashboard/sample-dashboard.lvdash.json

@@ -0,0 +1 @@
+{"pages":[{"name":"02724bf2","displayName":"Page One"}]}

acceptance/bundle/deployment/bind/dashboard/script

@@ -0,0 +1,29 @@
+DASHBOARD_DISPLAY_NAME="test dashboard $(uuid)"
+if [ -z "$CLOUD_ENV" ]; then
+ DASHBOARD_DISPLAY_NAME="test dashboard 6260d50f-e8ff-4905-8f28-812345678903" # use hard-coded uuid when running locally
+ export TEST_DEFAULT_WAREHOUSE_ID="warehouse-1234"
+fi
+
+export DASHBOARD_DISPLAY_NAME
+envsubst < databricks.yml.tmpl > databricks.yml
+
+# Create a pre-defined dashboard:
+DASHBOARD_ID=$($CLI lakeview create --display-name "${DASHBOARD_DISPLAY_NAME}" --warehouse-id "${TEST_DEFAULT_WAREHOUSE_ID}" --serialized-dashboard '{"pages":[{"name":"02724bf2","displayName":"Untitled page"}]}' | jq -r '.dashboard_id')
+
+cleanupRemoveDashboard() {
+ $CLI lakeview trash "${DASHBOARD_ID}"
+}
+trap cleanupRemoveDashboard EXIT
+
+trace $CLI bundle deployment bind dashboard1 "${DASHBOARD_ID}" --auto-approve
+
+trace $CLI bundle deploy
+
+trace $CLI lakeview get "${DASHBOARD_ID}" | jq '{display_name, lifecycle_state, path, parent_path, serialized_dashboard}'
+
+trace $CLI bundle deployment unbind dashboard1
+
+trace $CLI bundle destroy --auto-approve
+
+# Read the pre-defined dashboard again (expecting it still exists and is not deleted):
+trace $CLI lakeview get "${DASHBOARD_ID}" | jq '{display_name, lifecycle_state, path, parent_path, serialized_dashboard}'

acceptance/bundle/deployment/bind/dashboard/test.toml

@@ -0,0 +1,41 @@
+Local = true
+Cloud = true
+RequiresWarehouse = true
+
+Ignore = [
+ "databricks.yml",
+]
+
+[[Repls]]
+Old = "[0-9a-f]{32}"
+New = "[DASHBOARD_ID]"
+
+[[Server]]
+Pattern = "POST /api/2.0/lakeview/dashboards"
+Response.Body = '''
+{
+ "dashboard_id":"1234567890abcdef1234567890abcdef"
+}
+'''
+
+[[Server]]
+Pattern = "POST /api/2.0/lakeview/dashboards/{dashboard_id}/published"
+
+[[Server]]
+Pattern = "PATCH /api/2.0/lakeview/dashboards/{dashboard_id}"
+
+[[Server]]
+Pattern = "GET /api/2.0/lakeview/dashboards/{dashboard_id}"
+Response.Body = '''
+{
+ "dashboard_id":"1234567890abcdef1234567890abcdef",
+ "display_name": "test dashboard 6260d50f-e8ff-4905-8f28-812345678903",
+ "lifecycle_state": "ACTIVE",
+ "path": "/Users/[USERNAME]/test dashboard [UUID].lvdash.json",
+ "parent_path": "/Users/tester@databricks.com",
+ "serialized_dashboard": "{\"pages\":[{\"name\":\"02724bf2\",\"displayName\":\"Page One\"}]}"
+}
+'''
+
+[[Server]]
+Pattern = "DELETE /api/2.0/lakeview/dashboards/{dashboard_id}"

acceptance/internal/config.go

@@ -42,6 +42,9 @@ type TestConfig struct {
 	// If true and Cloud=true, run this test only if a default test cluster is available in the cloud environment
 	RequiresCluster *bool
 
+	// If true and Cloud=true, run this test only if a default warehouse is available in the cloud environment
+	RequiresWarehouse *bool
+
 	// List of additional replacements to apply on this test.
 	// Old is a regexp, New is a replacement expression.
 	Repls []testdiff.Replacement

bundle/config/resources.go

@@ -136,6 +136,12 @@ func (r *Resources) FindResourceByConfigKey(key string) (ConfigResource, error)
  }
 	}
 
+	for k := range r.Dashboards {
+ if k == key {
+ found = append(found, r.Dashboards[k])
+ }
+	}
+
 	if len(found) == 0 {
  return nil, fmt.Errorf("no such resource: %s", key)
 	}

bundle/phases/deploy.go

@@ -69,9 +69,10 @@ func approvalForDeploy(ctx context.Context, b *bundle.Bundle) (bool, error) {
 	schemaActions := filterDeleteOrRecreateActions(plan.ResourceChanges, "databricks_schema")
 	dltActions := filterDeleteOrRecreateActions(plan.ResourceChanges, "databricks_pipeline")
 	volumeActions := filterDeleteOrRecreateActions(plan.ResourceChanges, "databricks_volume")
+	dashboardActions := filterDeleteOrRecreateActions(plan.ResourceChanges, "databricks_dashboard")
 
 	// We don't need to display any prompts in this case.
-	if len(schemaActions) == 0 && len(dltActions) == 0 && len(volumeActions) == 0 {
+	if len(schemaActions) == 0 && len(dltActions) == 0 && len(volumeActions) == 0 && len(dashboardActions) == 0 {
  return true, nil
 	}
 
@@ -109,6 +110,17 @@ is removed from the catalog, but the underlying files are not deleted:`
  }
 	}
 
+	// One or more dashboards is being recreated.
+	if len(dashboardActions) != 0 {
+ msg := `
+This action will result in the deletion or recreation of the following dashboards.
+This will result in changed IDs and permanent URLs of the dashboards that will be recreated:`
+ cmdio.LogString(ctx, msg)
+ for _, action := range dashboardActions {
+ cmdio.Log(ctx, action)
+ }
+	}
+
 	if b.AutoApprove {
  return true, nil
 	}