direct: Add dashboards support

acceptance/.gitattributes

@@ -3,6 +3,7 @@
 # For example, an additional \r character in windows changes the upload payload if you are
 # uploading the file's content to a workspace.
 *.txt text eol=lf
+*.lvdash.json text eol=lf
 
 # The out.test.toml file is autogenerated based on the merged test.toml view.
 out.test.toml linguist-generated=true

acceptance/bundle/generate/dashboard-inplace/output.txt

@@ -19,7 +19,7 @@ Deployment complete!
   "lifecycle_state":"ACTIVE",
   "parent_path":"/Users/[USERNAME]/.bundle/dashboard update inplace/default/resources",
   "path":"/Users/[USERNAME]/.bundle/dashboard update inplace/default/resources/test dashboard.lvdash.json",
-  "serialized_dashboard":"{\"a\":\"b\"}",
+  "serialized_dashboard":"{\"a\":\"b\"}\n",
   "update_time":"[TIMESTAMP]",
   "warehouse_id":"my-warehouse-1234"
 }

acceptance/bundle/generate/dashboard-inplace/test.toml

@@ -3,3 +3,8 @@ EnvMatrix.DATABRICKS_BUNDLE_ENGINE = ["terraform"]  # dashboards not supported y
 [[Repls]]
 Old = "[0-9a-f]{32}"
 New = "[DASHBOARD_ID]"
+
+[[Repls]]
+Old = '2\d\d\d-\d\d-\d\d(T| )\d\d:\d\d:\d\d(\.\d+(Z|\+\d\d:\d\d)?)?Z'
+New = "[TIMESTAMP]"
+Order = 9

acceptance/bundle/refschema/out.fields.txt

@@ -415,6 +415,30 @@ resources.clusters.*.permissions.permissions[*].group_name	string	ALL
 resources.clusters.*.permissions.permissions[*].permission_level	iam.PermissionLevel	ALL
 resources.clusters.*.permissions.permissions[*].service_principal_name	string	ALL
 resources.clusters.*.permissions.permissions[*].user_name	string	ALL
+resources.dashboards.*.create_time	string	ALL
+resources.dashboards.*.dashboard_id	string	ALL
+resources.dashboards.*.display_name	string	ALL
+resources.dashboards.*.embed_credentials	bool	ALL
+resources.dashboards.*.etag	string	ALL
+resources.dashboards.*.file_path	string	INPUT
+resources.dashboards.*.id	string	INPUT
+resources.dashboards.*.lifecycle	resources.Lifecycle	INPUT
+resources.dashboards.*.lifecycle.prevent_destroy	bool	INPUT
+resources.dashboards.*.lifecycle_state	dashboards.LifecycleState	ALL
+resources.dashboards.*.modified_status	string	INPUT
+resources.dashboards.*.parent_path	string	ALL
+resources.dashboards.*.path	string	ALL
+resources.dashboards.*.permissions	[]resources.DashboardPermission	INPUT
+resources.dashboards.*.permissions[*]	resources.DashboardPermission	INPUT
+resources.dashboards.*.permissions[*].group_name	string	INPUT
+resources.dashboards.*.permissions[*].level	resources.DashboardPermissionLevel	INPUT
+resources.dashboards.*.permissions[*].service_principal_name	string	INPUT
+resources.dashboards.*.permissions[*].user_name	string	INPUT
+resources.dashboards.*.serialized_dashboard	any	ALL
+resources.dashboards.*.serialized_dashboard	string	ALL
+resources.dashboards.*.update_time	string	ALL
+resources.dashboards.*.url	string	INPUT
+resources.dashboards.*.warehouse_id	string	ALL
 resources.database_catalogs.*.create_database_if_not_exists	bool	ALL
 resources.database_catalogs.*.database_instance_name	string	ALL
 resources.database_catalogs.*.database_name	string	ALL

acceptance/bundle/resources/dashboards/change-embed-credentials/dash.lvdash.json

@@ -0,0 +1 @@
+{}

acceptance/bundle/resources/dashboards/change-embed-credentials/databricks.yml.tmpl

@@ -0,0 +1,10 @@
+bundle:
+  name: change-embed-credentials-$UNIQUE_NAME
+
+resources:
+  dashboards:
+    my_dashboard:
+      display_name: test dashboard
+      file_path: ./dash.lvdash.json
+      warehouse_id: $TEST_DEFAULT_WAREHOUSE_ID
+      embed_credentials: $EMBED_CREDENTIALS

acceptance/bundle/resources/dashboards/change-embed-credentials/out.patch.requests.direct.txt

@@ -0,0 +1,10 @@
+{
+  "method": "PATCH",
+  "path": "/api/2.0/lakeview/dashboards/[DASHBOARD_ID]",
+  "body": {
+    "display_name": "test dashboard",
+    "parent_path": "/Workspace/Users/[USERNAME]/.bundle/change-embed-credentials-[UNIQUE_NAME]/default/resources",
+    "serialized_dashboard": "{}\n",
+    "warehouse_id": "[TEST_DEFAULT_WAREHOUSE_ID]"
+  }
+}

acceptance/bundle/resources/dashboards/change-embed-credentials/out.patch.requests.terraform.txt

@@ -0,0 +1,16 @@
+{
+  "method": "PATCH",
+  "path": "/api/2.0/lakeview/dashboards/[DASHBOARD_ID]",
+  "body": {
+    "create_time": "[TIMESTAMP]",
+    "dashboard_id": "[DASHBOARD_ID]",
+    "display_name": "test dashboard",
+    "etag": [ETAG],
+    "lifecycle_state": "ACTIVE",
+    "parent_path": "/Users/[USERNAME]/.bundle/change-embed-credentials-[UNIQUE_NAME]/default/resources",
+    "path": "/Users/[USERNAME]/.bundle/change-embed-credentials-[UNIQUE_NAME]/default/resources/test dashboard.lvdash.json",
+    "serialized_dashboard": "{}\n",
+    "update_time": "[TIMESTAMP]",
+    "warehouse_id": "[TEST_DEFAULT_WAREHOUSE_ID]"
+  }
+}

acceptance/bundle/resources/dashboards/change-embed-credentials/out.post.requests.txt

@@ -0,0 +1,43 @@
+{
+  "method": "POST",
+  "path": "/api/2.0/lakeview/dashboards",
+  "body": {
+    "display_name": "test dashboard",
+    "parent_path": "/Workspace/Users/[USERNAME]/.bundle/change-embed-credentials-[UNIQUE_NAME]/default/resources",
+    "serialized_dashboard": "{}\n",
+    "warehouse_id": "[TEST_DEFAULT_WAREHOUSE_ID]"
+  }
+}
+{
+  "method": "POST",
+  "path": "/api/2.0/workspace/mkdirs",
+  "body": {
+    "path": "/Workspace/Users/[USERNAME]/.bundle/change-embed-credentials-[UNIQUE_NAME]/default/resources"
+  }
+}
+{
+  "method": "POST",
+  "path": "/api/2.0/lakeview/dashboards",
+  "body": {
+    "display_name": "test dashboard",
+    "parent_path": "/Workspace/Users/[USERNAME]/.bundle/change-embed-credentials-[UNIQUE_NAME]/default/resources",
+    "serialized_dashboard": "{}\n",
+    "warehouse_id": "[TEST_DEFAULT_WAREHOUSE_ID]"
+  }
+}
+{
+  "method": "POST",
+  "path": "/api/2.0/lakeview/dashboards/[DASHBOARD_ID]/published",
+  "body": {
+    "embed_credentials": false,
+    "warehouse_id": "[TEST_DEFAULT_WAREHOUSE_ID]"
+  }
+}
+{
+  "method": "POST",
+  "path": "/api/2.0/lakeview/dashboards/[DASHBOARD_ID]/published",
+  "body": {
+    "embed_credentials": true,
+    "warehouse_id": "[TEST_DEFAULT_WAREHOUSE_ID]"
+  }
+}

acceptance/bundle/resources/dashboards/change-embed-credentials/output.txt

@@ -0,0 +1,63 @@
+
+>>> [CLI] bundle plan
+create dashboards.my_dashboard
+
+Plan: 1 to add, 0 to change, 0 to delete, 0 unchanged
+
+>>> [CLI] bundle deploy
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/change-embed-credentials-[UNIQUE_NAME]/default/files...
+Deploying resources...
+Updating deployment state...
+Deployment complete!
+
+>>> [CLI] lakeview get [DASHBOARD_ID]
+{
+  "display_name": "test dashboard",
+  "lifecycle_state": "ACTIVE",
+  "parent_path": "/Users/[USERNAME]/.bundle/change-embed-credentials-[UNIQUE_NAME]/default/resources",
+  "path": "/Users/[USERNAME]/.bundle/change-embed-credentials-[UNIQUE_NAME]/default/resources/test dashboard.lvdash.json",
+  "serialized_dashboard": "{}\n",
+  "warehouse_id": "[TEST_DEFAULT_WAREHOUSE_ID]"
+}
+
+>>> [CLI] lakeview get-published [DASHBOARD_ID]
+{
+  "warehouse_id": "[TEST_DEFAULT_WAREHOUSE_ID]",
+  "embed_credentials": false
+}
+
+>>> [CLI] bundle plan
+update dashboards.my_dashboard
+
+Plan: 0 to add, 1 to change, 0 to delete, 0 unchanged
+
+>>> [CLI] bundle deploy
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/change-embed-credentials-[UNIQUE_NAME]/default/files...
+Deploying resources...
+Updating deployment state...
+Deployment complete!
+
+>>> [CLI] lakeview get [DASHBOARD_ID]
+{
+  "display_name": "test dashboard",
+  "lifecycle_state": "ACTIVE",
+  "parent_path": "/Users/[USERNAME]/.bundle/change-embed-credentials-[UNIQUE_NAME]/default/resources",
+  "path": "/Users/[USERNAME]/.bundle/change-embed-credentials-[UNIQUE_NAME]/default/resources/test dashboard.lvdash.json",
+  "serialized_dashboard": "{}\n",
+  "warehouse_id": "[TEST_DEFAULT_WAREHOUSE_ID]"
+}
+
+>>> [CLI] lakeview get-published [DASHBOARD_ID]
+{
+  "warehouse_id": "[TEST_DEFAULT_WAREHOUSE_ID]",
+  "embed_credentials": true
+}
+
+>>> [CLI] bundle destroy --auto-approve
+The following resources will be deleted:
+  delete dashboard my_dashboard
+
+All files and directories at the following location will be deleted: /Workspace/Users/[USERNAME]/.bundle/change-embed-credentials-[UNIQUE_NAME]/default
+
+Deleting files...
+Destroy complete!

acceptance/bundle/resources/dashboards/change-embed-credentials/script

@@ -0,0 +1,44 @@
+export EMBED_CREDENTIALS="false"
+
+cleanup() {
+    trace $CLI bundle destroy --auto-approve
+    rm out.requests.txt
+}
+trap cleanup EXIT
+
+# Helper functions for dashboard change-* tests
+
+# Deploy the dashboard and capture the ID
+deploy_dashboard() {
+    envsubst < databricks.yml.tmpl > databricks.yml
+    trace $CLI bundle plan
+    trace $CLI bundle deploy
+    dashboard_id=$($CLI bundle summary --output json | jq -r '.resources.dashboards.my_dashboard.id')
+
+    trace $CLI lakeview get $dashboard_id | jq "{display_name, lifecycle_state, parent_path, path, serialized_dashboard, warehouse_id}"
+    trace $CLI lakeview get-published $dashboard_id | jq "{warehouse_id, embed_credentials}"
+}
+
+# Create the dashboard with embed_credentials=false
+deploy_dashboard
+
+# Capture the dashboard ID as a replacement.
+dashboard_id=$($CLI bundle summary --output json | jq -r '.resources.dashboards.my_dashboard.id')
+echo "$dashboard_id:DASHBOARD_ID" >> ACC_REPLS
+
+# Change embed_credentials to true - this should trigger an update
+export EMBED_CREDENTIALS="true"
+deploy_dashboard
+
+# Print API requests made to create parent_path or create / update the dashboard.
+# Terraform serialized OUTPUT_ONLY fields in the request body while direct does not.
+# That's why we write the requests to separate files.
+cat out.requests.txt | \
+ jq 'select(.method == "PATCH")' | \
+ jq 'select( (.path | contains("/api/2.0/lakeview/dashboards")) or ((.path == "/api/2.0/workspace/mkdirs") and (.body.path | contains("/default/resources"))))' \
+ > out.patch.requests.$DATABRICKS_BUNDLE_ENGINE.txt
+
+cat out.requests.txt | \
+ jq 'select(.method == "POST")' | \
+ jq 'select( (.path | contains("/api/2.0/lakeview/dashboards")) or ((.path == "/api/2.0/workspace/mkdirs") and (.body.path | contains("/default/resources"))))' \
+ > out.post.requests.txt

acceptance/bundle/resources/dashboards/change-name/dash.lvdash.json

@@ -0,0 +1 @@
+{}

acceptance/bundle/resources/dashboards/change-name/databricks.yml.tmpl

@@ -0,0 +1,9 @@
+bundle:
+  name: change-name-$UNIQUE_NAME
+
+resources:
+  dashboards:
+    my_dashboard:
+      display_name: $NAME
+      file_path: ./dash.lvdash.json
+      warehouse_id: $TEST_DEFAULT_WAREHOUSE_ID

acceptance/bundle/resources/dashboards/change-name/out.patch.requests.direct.txt

@@ -0,0 +1,10 @@
+{
+  "method": "PATCH",
+  "path": "/api/2.0/lakeview/dashboards/[DASHBOARD_ID]",
+  "body": {
+    "display_name": "dashboard2",
+    "parent_path": "/Workspace/Users/[USERNAME]/.bundle/change-name-[UNIQUE_NAME]/default/resources",
+    "serialized_dashboard": "{}\n",
+    "warehouse_id": "[TEST_DEFAULT_WAREHOUSE_ID]"
+  }
+}

acceptance/bundle/resources/dashboards/change-name/out.patch.requests.terraform.txt

@@ -0,0 +1,16 @@
+{
+  "method": "PATCH",
+  "path": "/api/2.0/lakeview/dashboards/[DASHBOARD_ID]",
+  "body": {
+    "create_time": "[TIMESTAMP]",
+    "dashboard_id": "[DASHBOARD_ID]",
+    "display_name": "dashboard2",
+    "etag": [ETAG],
+    "lifecycle_state": "ACTIVE",
+    "parent_path": "/Users/[USERNAME]/.bundle/change-name-[UNIQUE_NAME]/default/resources",
+    "path": "/Users/[USERNAME]/.bundle/change-name-[UNIQUE_NAME]/default/resources/dashboard1.lvdash.json",
+    "serialized_dashboard": "{}\n",
+    "update_time": "[TIMESTAMP]",
+    "warehouse_id": "[TEST_DEFAULT_WAREHOUSE_ID]"
+  }
+}

acceptance/bundle/resources/dashboards/change-name/out.post.requests.txt

@@ -0,0 +1,43 @@
+{
+  "method": "POST",
+  "path": "/api/2.0/lakeview/dashboards",
+  "body": {
+    "display_name": "dashboard1",
+    "parent_path": "/Workspace/Users/[USERNAME]/.bundle/change-name-[UNIQUE_NAME]/default/resources",
+    "serialized_dashboard": "{}\n",
+    "warehouse_id": "[TEST_DEFAULT_WAREHOUSE_ID]"
+  }
+}
+{
+  "method": "POST",
+  "path": "/api/2.0/workspace/mkdirs",
+  "body": {
+    "path": "/Workspace/Users/[USERNAME]/.bundle/change-name-[UNIQUE_NAME]/default/resources"
+  }
+}
+{
+  "method": "POST",
+  "path": "/api/2.0/lakeview/dashboards",
+  "body": {
+    "display_name": "dashboard1",
+    "parent_path": "/Workspace/Users/[USERNAME]/.bundle/change-name-[UNIQUE_NAME]/default/resources",
+    "serialized_dashboard": "{}\n",
+    "warehouse_id": "[TEST_DEFAULT_WAREHOUSE_ID]"
+  }
+}
+{
+  "method": "POST",
+  "path": "/api/2.0/lakeview/dashboards/[DASHBOARD_ID]/published",
+  "body": {
+    "embed_credentials": false,
+    "warehouse_id": "[TEST_DEFAULT_WAREHOUSE_ID]"
+  }
+}
+{
+  "method": "POST",
+  "path": "/api/2.0/lakeview/dashboards/[DASHBOARD_ID]/published",
+  "body": {
+    "embed_credentials": false,
+    "warehouse_id": "[TEST_DEFAULT_WAREHOUSE_ID]"
+  }
+}