Convert dashboard tests to acceptance tests (#3186)

shreyas-goenka · web-flow · commit b729ac28e680 · 2025-07-09T11:24:34.000+02:00
## Why
Cleaning up a bit. Will allow us to get rid of the `bundle.GetOrNil`
method.
diff --git a/acceptance/bundle/generate/dashboard/dashboard.json b/acceptance/bundle/generate/dashboard/dashboard.json
@@ -1,5 +1,5 @@
 {
     "display_name": "test dashboard",
     "parent_path": "/test",
-    "serialized_dashboard": "{}"
+    "serialized_dashboard": "{\"pages\":[{\"displayName\":\"New Page\",\"layout\":[],\"name\":\"12345678\"}]}"
 }
diff --git a/acceptance/bundle/generate/dashboard/out/dashboard/test_dashboard.lvdash.json b/acceptance/bundle/generate/dashboard/out/dashboard/test_dashboard.lvdash.json
@@ -1 +1,10 @@
-{}
+{
+  "pages": [
+    {
+      "displayName": "New Page",
+      "layout": [],
+      "name": "[NUMID]",
+      "pageType": "PAGE_TYPE_CANVAS"
+    }
+  ]
+}
diff --git a/acceptance/bundle/generate/dashboard_existing_id_not_found/out.test.toml b/acceptance/bundle/generate/dashboard_existing_id_not_found/out.test.toml
@@ -0,0 +1,5 @@
+Local = true
+Cloud = false
+
+[EnvMatrix]
+  DATABRICKS_CLI_DEPLOYMENT = ["terraform", "direct-exp"]
diff --git a/acceptance/bundle/generate/dashboard_existing_id_not_found/output.txt b/acceptance/bundle/generate/dashboard_existing_id_not_found/output.txt
@@ -0,0 +1,4 @@
+Error: dashboard with ID f00dcafe not found
+
+
+Exit code: 1
diff --git a/acceptance/bundle/generate/dashboard_existing_id_not_found/script b/acceptance/bundle/generate/dashboard_existing_id_not_found/script
@@ -0,0 +1,2 @@
+# Test that bundle generate dashboard fails when the existing ID is not found
+exec $CLI bundle generate dashboard --existing-id f00dcafe
diff --git a/acceptance/bundle/generate/dashboard_existing_path_nominal/databricks.yml b/acceptance/bundle/generate/dashboard_existing_path_nominal/databricks.yml
@@ -0,0 +1,2 @@
+bundle:
+  name: test-bundle
diff --git a/acceptance/bundle/generate/dashboard_existing_path_nominal/out.test.toml b/acceptance/bundle/generate/dashboard_existing_path_nominal/out.test.toml
@@ -0,0 +1,5 @@
+Local = true
+Cloud = false
+
+[EnvMatrix]
+  DATABRICKS_CLI_DEPLOYMENT = ["terraform", "direct-exp"]
diff --git a/acceptance/bundle/generate/dashboard_existing_path_nominal/out/dashboard/this_is_a_test_dashboard.lvdash.json b/acceptance/bundle/generate/dashboard_existing_path_nominal/out/dashboard/this_is_a_test_dashboard.lvdash.json
@@ -0,0 +1,9 @@
+{
+  "pages": [
+    {
+      "displayName": "New Page",
+      "layout": [],
+      "name": "[NUMID]"
+    }
+  ]
+}
diff --git a/acceptance/bundle/generate/dashboard_existing_path_nominal/out/resource/this_is_a_test_dashboard.dashboard.yml b/acceptance/bundle/generate/dashboard_existing_path_nominal/out/resource/this_is_a_test_dashboard.dashboard.yml
@@ -0,0 +1,6 @@
+resources:
+  dashboards:
+    this_is_a_test_dashboard:
+      display_name: "This is a test dashboard"
+      warehouse_id: w4r3h0us3
+      file_path: ../dashboard/this_is_a_test_dashboard.lvdash.json
diff --git a/acceptance/bundle/generate/dashboard_existing_path_nominal/output.txt b/acceptance/bundle/generate/dashboard_existing_path_nominal/output.txt
@@ -0,0 +1,4 @@
+
+>>> [CLI] bundle generate dashboard --existing-path /path/to/dashboard --dashboard-dir out/dashboard --resource-dir out/resource
+Writing dashboard to "out/dashboard/this_is_a_test_dashboard.lvdash.json"
+Writing configuration to "out/resource/this_is_a_test_dashboard.dashboard.yml"
diff --git a/acceptance/bundle/generate/dashboard_existing_path_nominal/script b/acceptance/bundle/generate/dashboard_existing_path_nominal/script
@@ -0,0 +1,2 @@
+# Test generating dashboard from existing path
+trace $CLI bundle generate dashboard --existing-path /path/to/dashboard --dashboard-dir out/dashboard --resource-dir out/resource
diff --git a/acceptance/bundle/generate/dashboard_existing_path_nominal/test.toml b/acceptance/bundle/generate/dashboard_existing_path_nominal/test.toml
@@ -0,0 +1,23 @@
+[[Repls]]
+Old = '\\\\'
+New = '/'
+
+[[Server]]
+Pattern = "GET /api/2.0/workspace/get-status"
+Response.Body = '''
+{
+  "object_type": "DASHBOARD",
+  "resource_id": "f00dcafe"
+}
+'''
+
+[[Server]]
+Pattern = "GET /api/2.0/lakeview/dashboards/f00dcafe"
+Response.Body = '''
+{
+  "dashboard_id": "f00dcafe",
+  "display_name": "This is a test dashboard",
+  "warehouse_id": "w4r3h0us3",
+  "serialized_dashboard": "{\"pages\":[{\"displayName\":\"New Page\",\"layout\":[],\"name\":\"12345678\"}]}"
+}
+'''
diff --git a/acceptance/bundle/generate/dashboard_existing_path_not_found/out.test.toml b/acceptance/bundle/generate/dashboard_existing_path_not_found/out.test.toml
@@ -0,0 +1,5 @@
+Local = true
+Cloud = false
+
+[EnvMatrix]
+  DATABRICKS_CLI_DEPLOYMENT = ["terraform", "direct-exp"]
diff --git a/acceptance/bundle/generate/dashboard_existing_path_not_found/output.txt b/acceptance/bundle/generate/dashboard_existing_path_not_found/output.txt
@@ -0,0 +1,4 @@
+Error: dashboard "dashboard" not found
+
+
+Exit code: 1
diff --git a/acceptance/bundle/generate/dashboard_existing_path_not_found/script b/acceptance/bundle/generate/dashboard_existing_path_not_found/script
@@ -0,0 +1,2 @@
+# Test that bundle generate dashboard fails when the existing path is not found
+exec $CLI bundle generate dashboard --existing-path /path/to/nonexistent/dashboard
diff --git a/cmd/bundle/generate/dashboard_test.go b/cmd/bundle/generate/dashboard_test.go
@@ -2,16 +2,12 @@ package generate
 
 import (
 	"context"
-	"os"
-	"path/filepath"
 	"testing"
 
 	"github.com/databricks/cli/bundle"
 	"github.com/databricks/cli/libs/logdiag"
 	"github.com/databricks/databricks-sdk-go/apierr"
 	"github.com/databricks/databricks-sdk-go/experimental/mocks"
-	"github.com/databricks/databricks-sdk-go/service/dashboards"
-	"github.com/databricks/databricks-sdk-go/service/workspace"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
@@ -52,141 +48,3 @@ func TestDashboard_ErrorOnLegacyDashboard(t *testing.T) {
 	require.Len(t, diags, 1)
 	assert.Equal(t, "dashboard \"legacy dashboard\" is a legacy dashboard", diags[0].Summary)
 }
-
-func TestDashboard_ExistingID_Nominal(t *testing.T) {
-	root := t.TempDir()
-	b := &bundle.Bundle{
-		BundleRootPath: root,
-	}
-
-	m := mocks.NewMockWorkspaceClient(t)
-	b.SetWorkpaceClient(m.WorkspaceClient)
-
-	dashboardsAPI := m.GetMockLakeviewAPI()
-	dashboardsAPI.EXPECT().GetByDashboardId(mock.Anything, "f00dcafe").Return(&dashboards.Dashboard{
-		DashboardId:         "f00dcafe",
-		DisplayName:         "This is a test dashboard",
-		SerializedDashboard: `{"pages":[{"displayName":"New Page","layout":[],"name":"12345678"}]}`,
-		WarehouseId:         "w4r3h0us3",
-	}, nil)
-
-	ctx := bundle.Context(context.Background(), b)
-	cmd := NewGenerateDashboardCommand()
-	cmd.SetContext(ctx)
-	err := cmd.Flag("existing-id").Value.Set("f00dcafe")
-	require.NoError(t, err)
-
-	err = cmd.RunE(cmd, []string{})
-	require.NoError(t, err)
-
-	// Assert the contents of the generated configuration
-	data, err := os.ReadFile(filepath.Join(root, "resources", "this_is_a_test_dashboard.dashboard.yml"))
-	require.NoError(t, err)
-	assert.Equal(t, `resources:
-  dashboards:
-    this_is_a_test_dashboard:
-      display_name: "This is a test dashboard"
-      warehouse_id: w4r3h0us3
-      file_path: ../src/this_is_a_test_dashboard.lvdash.json
-`, string(data))
-
-	data, err = os.ReadFile(filepath.Join(root, "src", "this_is_a_test_dashboard.lvdash.json"))
-	require.NoError(t, err)
-	assert.JSONEq(t, `{"pages":[{"displayName":"New Page","layout":[],"name":"12345678"}]}`, string(data))
-}
-
-func TestDashboard_ExistingID_NotFound(t *testing.T) {
-	root := t.TempDir()
-	b := &bundle.Bundle{
-		BundleRootPath: root,
-	}
-
-	m := mocks.NewMockWorkspaceClient(t)
-	b.SetWorkpaceClient(m.WorkspaceClient)
-
-	dashboardsAPI := m.GetMockLakeviewAPI()
-	dashboardsAPI.EXPECT().GetByDashboardId(mock.Anything, "f00dcafe").Return(nil, &apierr.APIError{
-		StatusCode: 404,
-	})
-
-	ctx := bundle.Context(context.Background(), b)
-	cmd := NewGenerateDashboardCommand()
-	cmd.SetContext(ctx)
-	err := cmd.Flag("existing-id").Value.Set("f00dcafe")
-	require.NoError(t, err)
-
-	err = cmd.RunE(cmd, []string{})
-	require.Error(t, err)
-}
-
-func TestDashboard_ExistingPath_Nominal(t *testing.T) {
-	root := t.TempDir()
-	b := &bundle.Bundle{
-		BundleRootPath: root,
-	}
-
-	m := mocks.NewMockWorkspaceClient(t)
-	b.SetWorkpaceClient(m.WorkspaceClient)
-
-	workspaceAPI := m.GetMockWorkspaceAPI()
-	workspaceAPI.EXPECT().GetStatusByPath(mock.Anything, "/path/to/dashboard").Return(&workspace.ObjectInfo{
-		ObjectType: workspace.ObjectTypeDashboard,
-		ResourceId: "f00dcafe",
-	}, nil)
-
-	dashboardsAPI := m.GetMockLakeviewAPI()
-	dashboardsAPI.EXPECT().GetByDashboardId(mock.Anything, "f00dcafe").Return(&dashboards.Dashboard{
-		DashboardId:         "f00dcafe",
-		DisplayName:         "This is a test dashboard",
-		SerializedDashboard: `{"pages":[{"displayName":"New Page","layout":[],"name":"12345678"}]}`,
-		WarehouseId:         "w4r3h0us3",
-	}, nil)
-
-	ctx := bundle.Context(context.Background(), b)
-	cmd := NewGenerateDashboardCommand()
-	cmd.SetContext(ctx)
-	err := cmd.Flag("existing-path").Value.Set("/path/to/dashboard")
-	require.NoError(t, err)
-
-	err = cmd.RunE(cmd, []string{})
-	require.NoError(t, err)
-
-	// Assert the contents of the generated configuration
-	data, err := os.ReadFile(filepath.Join(root, "resources", "this_is_a_test_dashboard.dashboard.yml"))
-	require.NoError(t, err)
-	assert.Equal(t, `resources:
-  dashboards:
-    this_is_a_test_dashboard:
-      display_name: "This is a test dashboard"
-      warehouse_id: w4r3h0us3
-      file_path: ../src/this_is_a_test_dashboard.lvdash.json
-`, string(data))
-
-	data, err = os.ReadFile(filepath.Join(root, "src", "this_is_a_test_dashboard.lvdash.json"))
-	require.NoError(t, err)
-	assert.JSONEq(t, `{"pages":[{"displayName":"New Page","layout":[],"name":"12345678"}]}`, string(data))
-}
-
-func TestDashboard_ExistingPath_NotFound(t *testing.T) {
-	root := t.TempDir()
-	b := &bundle.Bundle{
-		BundleRootPath: root,
-	}
-
-	m := mocks.NewMockWorkspaceClient(t)
-	b.SetWorkpaceClient(m.WorkspaceClient)
-
-	workspaceAPI := m.GetMockWorkspaceAPI()
-	workspaceAPI.EXPECT().GetStatusByPath(mock.Anything, "/path/to/dashboard").Return(nil, &apierr.APIError{
-		StatusCode: 404,
-	})
-
-	ctx := bundle.Context(context.Background(), b)
-	cmd := NewGenerateDashboardCommand()
-	cmd.SetContext(ctx)
-	err := cmd.Flag("existing-path").Value.Set("/path/to/dashboard")
-	require.NoError(t, err)
-
-	err = cmd.RunE(cmd, []string{})
-	require.Error(t, err)
-}

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"display_name": "test dashboard",`
`3`	`3`	`"parent_path": "/test",`
`4`		`- "serialized_dashboard": "{}"`
	`4`	`+ "serialized_dashboard": "{\"pages\":[{\"displayName\":\"New Page\",\"layout\":[],\"name\":\"12345678\"}]}"`
`5`	`5`	`}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +Error: dashboard with ID f00dcafe not found
++
++
 +Exit code: 1
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# Test that bundle generate dashboard fails when the existing ID is not found`
	`2`	`+exec $CLI bundle generate dashboard --existing-id f00dcafe`