Improve dashboards test server to match to the real server (#3743)

shreyas-goenka · web-flow · commit da9ac07beff3 · 2025-10-09T12:37:13.000Z
## Why Used in #3725 to provide local test coverage. ## Tests Existing tests pass with slight modifications.
diff --git a/acceptance/bundle/deploy/dashboard/nested-folders/test.toml b/acceptance/bundle/deploy/dashboard/nested-folders/test.toml
@@ -16,3 +16,7 @@ New = "[DASHBOARD_ID]"
 # Windows:
 Old = 'The system cannot find the file specified.'
 New = 'no such file or directory'
+
+[[Repls]]
+Old = "[0-9]{10,}"
+New = "[DASHBOARD_ID]"
diff --git a/acceptance/bundle/deploy/dashboard/simple/test.toml b/acceptance/bundle/deploy/dashboard/simple/test.toml
@@ -9,3 +9,7 @@ Ignore = [
 [[Repls]]
 Old = "[0-9a-f]{32}"
 New = "[DASHBOARD_ID]"
+
+[[Repls]]
+Old = "[0-9]{10,}"
+New = "[DASHBOARD_ID]"
diff --git a/acceptance/bundle/deploy/dashboard/simple_outside_bundle_root/test.toml b/acceptance/bundle/deploy/dashboard/simple_outside_bundle_root/test.toml
@@ -15,3 +15,7 @@ New = "[DASHBOARD_ID]"
 # Windows:
 Old = 'The system cannot find the file specified.'
 New = 'no such file or directory'
+
+[[Repls]]
+Old = "[0-9]{10,}"
+New = "[DASHBOARD_ID]"
diff --git a/acceptance/bundle/deploy/dashboard/simple_syncroot/test.toml b/acceptance/bundle/deploy/dashboard/simple_syncroot/test.toml
@@ -7,11 +7,15 @@ Ignore = [
     "sample-dashboard.lvdash.json",
 ]
 
+[[Repls]]
+# Windows:
+Old = 'The system cannot find the file specified.'
+New = 'no such file or directory'
+
 [[Repls]]
 Old = "[0-9a-f]{32}"
 New = "[DASHBOARD_ID]"
 
 [[Repls]]
-# Windows:
-Old = 'The system cannot find the file specified.'
-New = 'no such file or directory'
+Old = "[0-9]{10,}"
+New = "[DASHBOARD_ID]"
diff --git a/acceptance/bundle/generate/dashboard-inplace/output.txt b/acceptance/bundle/generate/dashboard-inplace/output.txt
@@ -10,11 +10,17 @@ Updating deployment state...
 Deployment complete!
 
 === update the dashboard
->>> [CLI] lakeview update [DASHBOARD_ID] --serialized-dashboard {"a":"b"}
+>>> [CLI] lakeview update [NUMID] --serialized-dashboard {"a":"b"}
 {
-  "etag":"[UUID]",
+  "create_time":"[TIMESTAMP]",
+  "dashboard_id":"[NUMID]",
+  "display_name":"test dashboard",
+  "etag":"[NUMID]",
   "lifecycle_state":"ACTIVE",
-  "serialized_dashboard":"{\"a\":\"b\"}"
+  "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\"}",
+  "update_time":"[TIMESTAMP]Z"
 }
 
 === update the dashboard file using bundle generate
diff --git a/acceptance/bundle/generate/dashboard-inplace/test.toml b/acceptance/bundle/generate/dashboard-inplace/test.toml
@@ -1,5 +1 @@
 EnvMatrix.DATABRICKS_BUNDLE_ENGINE = ["terraform"]  # dashboards not supported yet
-
-[[Repls]]
-Old = "[0-9a-f]{32}"
-New = "[DASHBOARD_ID]"
diff --git a/acceptance/bundle/generate/dashboard/dashboard.json.tmpl b/acceptance/bundle/generate/dashboard/dashboard.json.tmpl
@@ -1,5 +1,5 @@
 {
     "display_name": "test dashboard",
-    "parent_path": "/test",
+    "parent_path": "/Workspace/test-$UNIQUE_NAME",
     "serialized_dashboard": "{\"pages\":[{\"displayName\":\"New Page\",\"layout\":[],\"name\":\"12345678\"}]}"
 }
diff --git a/acceptance/bundle/generate/dashboard/output.txt b/acceptance/bundle/generate/dashboard/output.txt
@@ -1,4 +1,6 @@
 
->>> [CLI] bundle generate dashboard --existing-id [DASHBOARD_ID] --dashboard-dir out/dashboard --resource-dir out/resource
+>>> [CLI] workspace mkdirs /Workspace/test-[UNIQUE_NAME]
+
+>>> [CLI] bundle generate dashboard --existing-id [NUMID] --dashboard-dir out/dashboard --resource-dir out/resource
 Writing dashboard to "out/dashboard/test_dashboard.lvdash.json"
 Writing configuration to "out/resource/test_dashboard.dashboard.yml"
diff --git a/acceptance/bundle/generate/dashboard/script b/acceptance/bundle/generate/dashboard/script
@@ -1,4 +1,8 @@
+trace $CLI workspace mkdirs /Workspace/test-$UNIQUE_NAME
+
 # create a dashboard to import
+envsubst < dashboard.json.tmpl > dashboard.json
 dashboard_id=$($CLI lakeview create --json @dashboard.json | jq -r '.dashboard_id')
+rm dashboard.json
 
 trace $CLI bundle generate dashboard --existing-id $dashboard_id --dashboard-dir out/dashboard --resource-dir out/resource
diff --git a/acceptance/bundle/generate/dashboard/test.toml b/acceptance/bundle/generate/dashboard/test.toml
@@ -5,3 +5,6 @@ New = '/'
 [[Repls]]
 Old = "[0-9a-f]{32}"
 New = "[DASHBOARD_ID]"
+
+[Env]
+MSYS_NO_PATHCONV = "1"
diff --git a/libs/testserver/dashboards.go b/libs/testserver/dashboards.go
@@ -2,11 +2,15 @@ package testserver
 
 import (
 	"encoding/json"
+	"fmt"
+	"path"
+	"path/filepath"
+	"strconv"
 	"strings"
+	"time"
 
 	"github.com/databricks/databricks-sdk-go/service/dashboards"
 	"github.com/databricks/databricks-sdk-go/service/workspace"
-	"github.com/google/uuid"
 )
 
 func (s *FakeWorkspace) DashboardCreate(req Request) Response {
@@ -19,17 +23,34 @@ func (s *FakeWorkspace) DashboardCreate(req Request) Response {
 		}
 	}
 
-	// Lakeview API strips hyphens from a uuid for dashboards
-	dashboard.DashboardId = strings.ReplaceAll(uuid.New().String(), "-", "")
+	if _, ok := s.directories[dashboard.ParentPath]; !ok {
+		return Response{
+			StatusCode: 404,
+			Body: map[string]string{
+				"message": fmt.Sprintf("Path (%s) doesn't exist.", dashboard.ParentPath),
+			},
+		}
+	}
+
+	// Use nextID() to generate deterministic dashboard IDs for testing
+	dashboard.DashboardId = strconv.FormatInt(nextID(), 10)
 
 	// All dashboards are active by default:
 	dashboard.LifecycleState = dashboards.LifecycleStateActive
 
+	// Remove /Workspace prefix from parent_path. This matches the remote behavior.
+	if strings.HasPrefix(dashboard.ParentPath, "/Workspace/") {
+		dashboard.ParentPath = strings.TrimPrefix(dashboard.ParentPath, "/Workspace")
+	}
+
 	// Change path field if parent_path is provided
 	if dashboard.ParentPath != "" {
 		dashboard.Path = dashboard.ParentPath + "/" + dashboard.DisplayName + ".lvdash.json"
 	}
 
+	dashboard.CreateTime = strings.TrimSuffix(time.Now().UTC().Format(time.RFC3339), "Z")
+	dashboard.UpdateTime = dashboard.CreateTime
+
 	// Parse serializedDashboard into json and put it back as a string
 	if dashboard.SerializedDashboard != "" {
 		var dashboardContent map[string]any
@@ -43,46 +64,76 @@ func (s *FakeWorkspace) DashboardCreate(req Request) Response {
 				}
 			}
 			if updatedContent, err := json.Marshal(dashboardContent); err == nil {
-				dashboard.SerializedDashboard = string(updatedContent)
+				dashboard.SerializedDashboard = string(updatedContent) + "\n"
 			}
 		}
 	}
+	dashboard.Etag = "80611980"
 
 	s.Dashboards[dashboard.DashboardId] = dashboard
-	s.files[dashboard.Path] = FileEntry{
+	workspacePath := path.Join("/Workspace", dashboard.Path)
+	s.files[workspacePath] = FileEntry{
 		Info: workspace.ObjectInfo{
 			ObjectType: "DASHBOARD",
-			Path:       dashboard.Path,
-			ObjectId:   nextID(),
+			// Include the /Workspace prefix for workspace get-status API.
+			Path:       workspacePath,
+			ResourceId: dashboard.DashboardId,
 		},
 		Data: []byte(dashboard.SerializedDashboard),
 	}
 
 	return Response{
-		Body: dashboards.Dashboard{
-			DashboardId: dashboard.DashboardId,
-			Etag:        uuid.New().String(),
-		},
+		Body: dashboard,
 	}
 }
 
 func (s *FakeWorkspace) DashboardUpdate(req Request) Response {
 	defer s.LockUnlock()()
 
-	var dashboard dashboards.Dashboard
-	if err := json.Unmarshal(req.Body, &dashboard); err != nil {
+	var updateReq dashboards.Dashboard
+	if err := json.Unmarshal(req.Body, &updateReq); err != nil {
 		return Response{
 			StatusCode: 400,
 		}
 	}
 
-	// Update the etag for the dashboard.
-	dashboard.Etag = uuid.New().String()
+	dashboardId := req.Vars["dashboard_id"]
+	dashboard, ok := s.Dashboards[dashboardId]
+	if !ok {
+		return Response{
+			StatusCode: 404,
+		}
+	}
 
-	// All dashboards are active by default:
+	// Update etag.
+	prevEtag, err := strconv.Atoi(dashboard.Etag)
+	if err != nil {
+		return Response{
+			Body: map[string]string{
+				"message": "Invalid etag: " + dashboard.Etag,
+			},
+			StatusCode: 400,
+		}
+	}
+	nextEtag := prevEtag + 1
+	dashboard.Etag = strconv.Itoa(nextEtag)
+
+	// Update the dashboard.
 	dashboard.LifecycleState = dashboards.LifecycleStateActive
+	if updateReq.DisplayName != "" {
+		dashboard.DisplayName = updateReq.DisplayName
+		dir := filepath.Dir(dashboard.Path)
+		base := updateReq.DisplayName + ".lvdash.json"
+		dashboard.Path = filepath.Join(dir, base)
+	}
+	if updateReq.SerializedDashboard != "" {
+		dashboard.SerializedDashboard = updateReq.SerializedDashboard
+	}
+	if updateReq.WarehouseId != "" {
+		dashboard.WarehouseId = updateReq.WarehouseId
+	}
+	dashboard.UpdateTime = time.Now().UTC().Format(time.RFC3339)
 
-	dashboardId := req.Vars["dashboard_id"]
 	s.Dashboards[dashboardId] = dashboard
 
 	return Response{
@@ -93,16 +144,41 @@ func (s *FakeWorkspace) DashboardUpdate(req Request) Response {
 func (s *FakeWorkspace) DashboardPublish(req Request) Response {
 	defer s.LockUnlock()()
 
-	var dashboard dashboards.Dashboard
-	if err := json.Unmarshal(req.Body, &dashboard); err != nil {
+	var publishReq dashboards.PublishRequest
+	if err := json.Unmarshal(req.Body, &publishReq); err != nil {
 		return Response{
 			StatusCode: 400,
 		}
 	}
 
+	dashboardId := req.Vars["dashboard_id"]
+	dashboard, ok := s.Dashboards[dashboardId]
+	if !ok {
+		return Response{
+			StatusCode: 404,
+		}
+	}
+
+	publishedDashboard := dashboards.PublishedDashboard{
+		WarehouseId:      dashboard.WarehouseId,
+		DisplayName:      dashboard.DisplayName,
+		EmbedCredentials: publishReq.EmbedCredentials,
+	}
+
+	if publishReq.WarehouseId != "" {
+		publishedDashboard.WarehouseId = publishReq.WarehouseId
+	}
+	if publishReq.EmbedCredentials {
+		publishedDashboard.EmbedCredentials = publishReq.EmbedCredentials
+	}
+
+	s.PublishedDashboards[dashboardId] = publishedDashboard
+
 	return Response{
 		Body: dashboards.PublishedDashboard{
-			WarehouseId: dashboard.WarehouseId,
+			WarehouseId:      publishedDashboard.WarehouseId,
+			DisplayName:      publishedDashboard.DisplayName,
+			EmbedCredentials: publishedDashboard.EmbedCredentials,
 		},
 	}
 }
diff --git a/libs/testserver/fake_workspace.go b/libs/testserver/fake_workspace.go
@@ -89,6 +89,7 @@ type FakeWorkspace struct {
 	SchemasGrants       map[string][]catalog.PrivilegeAssignment
 	Volumes             map[string]catalog.VolumeInfo
 	Dashboards          map[string]dashboards.Dashboard
+	PublishedDashboards map[string]dashboards.PublishedDashboard
 	SqlWarehouses       map[string]sql.GetWarehouseResponse
 	Alerts              map[string]sql.AlertV2
 	Experiments         map[string]ml.GetExperimentResponse
@@ -192,6 +193,7 @@ func NewFakeWorkspace(url, token string) *FakeWorkspace {
 		RegisteredModels:     map[string]catalog.RegisteredModelInfo{},
 		Volumes:              map[string]catalog.VolumeInfo{},
 		Dashboards:           map[string]dashboards.Dashboard{},
+		PublishedDashboards:  map[string]dashboards.PublishedDashboard{},
 		SqlWarehouses:        map[string]sql.GetWarehouseResponse{},
 		Repos:                map[string]workspace.RepoInfo{},
 		Acls:                 map[string][]workspace.AclItem{},
diff --git a/libs/testserver/handlers.go b/libs/testserver/handlers.go
@@ -238,6 +238,9 @@ func AddDefaultHandlers(server *Server) {
 	server.Handle("DELETE", "/api/2.0/lakeview/dashboards/{dashboard_id}", func(req Request) any {
 		return MapDelete(req.Workspace, req.Workspace.Dashboards, req.Vars["dashboard_id"])
 	})
+	server.Handle("GET", "/api/2.0/lakeview/dashboards/{dashboard_id}/published", func(req Request) any {
+		return MapGet(req.Workspace, req.Workspace.PublishedDashboards, req.Vars["dashboard_id"])
+	})
 
 	// Pipelines:
 

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"display_name": "test dashboard",`
`3`		`- "parent_path": "/test",`
	`3`	`+ "parent_path": "/Workspace/test-$UNIQUE_NAME",`
`4`	`4`	`"serialized_dashboard": "{\"pages\":[{\"displayName\":\"New Page\",\"layout\":[],\"name\":\"12345678\"}]}"`
`5`	`5`	`}`