testserver: Add CRUD for apps and quality monitors (#2629)

denik · web-flow · commit dc257ec2fe1a · 2025-04-02T11:01:02.000Z
## Changes
- Add support for create/update/get/delete for apps and quality monitors
to testserver.

## Why
This replaces manually encoding responses in existing tests. I'm using
this in terraform removal branch to run experiments.

## Tests
Existing tests that hard-coded responses now use the testserver
directly.
diff --git a/acceptance/bundle/apps/test.toml b/acceptance/bundle/apps/test.toml
@@ -4,23 +4,3 @@ RecordRequests = true
 Ignore = [
     '.databricks',
 ]
-
-[[Server]]
-Pattern = "POST /api/2.0/apps"
-
-[[Server]]
-Pattern = "GET /api/2.0/apps/myapp"
-Response.Body = '''
-{
-  "name": "myapp",
-  "description": "",
-  "compute_status": {
-    "state": "ACTIVE",
-    "message": "App compute is active."
-  },
-  "app_status": {
-    "state": "RUNNING",
-    "message": "Application is running."
-  }
-}
-'''
diff --git a/acceptance/bundle/deployment/bind/quality-monitor/input.json b/acceptance/bundle/deployment/bind/quality-monitor/input.json
@@ -0,0 +1,5 @@
+{
+  "assets_dir":"/Users/user/databricks_lakehouse_monitoring",
+  "output_schema_name":"catalog.schema",
+  "snapshot": {}
+}
diff --git a/acceptance/bundle/deployment/bind/quality-monitor/output.txt b/acceptance/bundle/deployment/bind/quality-monitor/output.txt
@@ -1,4 +1,16 @@
 
+>>> [CLI] quality-monitors create catalog.schema.table --json @input.json
+{
+  "assets_dir":"/Users/user/databricks_lakehouse_monitoring",
+  "drift_metrics_table_name":"",
+  "monitor_version":"",
+  "output_schema_name":"catalog.schema",
+  "profile_metrics_table_name":"",
+  "snapshot": {},
+  "status":"MONITOR_STATUS_ACTIVE",
+  "table_name":"catalog.schema.table"
+}
+
 >>> [CLI] bundle deployment bind monitor1 catalog.schema.table
 Updating deployment state...
 Successfully bound quality_monitor with an id 'catalog.schema.table'. Run 'bundle deploy' to deploy changes to your workspace
diff --git a/acceptance/bundle/deployment/bind/quality-monitor/script b/acceptance/bundle/deployment/bind/quality-monitor/script
@@ -1,2 +1,3 @@
+trace $CLI quality-monitors create catalog.schema.table --json @input.json
 trace $CLI bundle deployment bind monitor1 "catalog.schema.table"
 trace $CLI bundle deploy
diff --git a/acceptance/bundle/deployment/bind/quality-monitor/test.toml b/acceptance/bundle/deployment/bind/quality-monitor/test.toml
@@ -1,21 +1,2 @@
 Local = true
 Cloud = false
-
-[[Server]]
-Pattern = "GET /api/2.1/unity-catalog/tables/catalog.schema.table/monitor"
-Response.Body = '''
-{
-  "assets_dir":"/Users/user/databricks_lakehouse_monitoring",
-  "dashboard_id":"01f00b1c15de19c7945fa190201813df",
-  "drift_metrics_table_name":"catalog.schema.table_drift_metrics",
-  "monitor_version":"0",
-  "output_schema_name":"catalog.schema",
-  "profile_metrics_table_name":"catalog.schema.table_profile_metrics",
-  "snapshot": {},
-  "status":"MONITOR_STATUS_ACTIVE",
-  "table_name":"catalog.schema.table"
-}
-'''
-
-[[Server]]
-Pattern = "PUT /api/2.1/unity-catalog/tables/users.user.table/monitor"
diff --git a/acceptance/cmd/workspace/apps/input.json b/acceptance/cmd/workspace/apps/input.json
@@ -1,4 +1,5 @@
 {
+    "name": "test-name",
     "description": "My app description.",
     "resources": [
         {
diff --git a/acceptance/cmd/workspace/apps/out.requests.txt b/acceptance/cmd/workspace/apps/out.requests.txt
@@ -1,9 +1,32 @@
+{
+  "method": "POST",
+  "path": "/api/2.0/apps",
+  "body": {
+    "description": "My app description.",
+    "name": "test-name",
+    "resources": [
+      {
+        "description": "API key for external service.",
+        "name": "api-key",
+        "secret": {
+          "key": "my-key",
+          "permission": "READ",
+          "scope": "my-scope"
+        }
+      }
+    ]
+  }
+}
+{
+  "method": "GET",
+  "path": "/api/2.0/apps/test-name"
+}
 {
   "method": "PATCH",
   "path": "/api/2.0/apps/test-name",
   "body": {
     "description": "My app description.",
-    "name": "",
+    "name": "test-name",
     "resources": [
       {
         "description": "API key for external service.",
diff --git a/acceptance/cmd/workspace/apps/output.txt b/acceptance/cmd/workspace/apps/output.txt
@@ -1,17 +1,45 @@
 
+=== Apps create with correct input
+>>> [CLI] apps create --json @input.json
+{
+  "app_status": {
+    "message":"Application is running.",
+    "state":"RUNNING"
+  },
+  "compute_status": {
+    "message":"App compute is active.",
+    "state":"ACTIVE"
+  },
+  "description":"My app description.",
+  "id":"1000",
+  "name":"test-name",
+  "resources": [
+    {
+      "description":"API key for external service.",
+      "name":"api-key",
+      "secret": {
+        "key":"my-key",
+        "permission":"READ",
+        "scope":"my-scope"
+      }
+    }
+  ],
+  "url":"test-name-123.cloud.databricksapps.com"
+}
+
 === Apps update with correct input
 >>> [CLI] apps update test-name --json @input.json
 {
   "app_status": {
     "message":"Application is running.",
-    "state":"DEPLOYING"
+    "state":"RUNNING"
   },
   "compute_status": {
     "message":"App compute is active.",
-    "state":"ERROR"
+    "state":"ACTIVE"
   },
   "description":"My app description.",
-  "id":"12345",
+  "id":"1001",
   "name":"test-name",
   "resources": [
     {
diff --git a/acceptance/cmd/workspace/apps/script b/acceptance/cmd/workspace/apps/script
@@ -1,3 +1,6 @@
+title "Apps create with correct input"
+trace $CLI apps create --json @input.json
+
 title "Apps update with correct input"
 trace $CLI apps update test-name --json @input.json
 
diff --git a/acceptance/cmd/workspace/apps/test.toml b/acceptance/cmd/workspace/apps/test.toml
@@ -1,30 +1 @@
 RecordRequests = true
-
-[[Server]]
-Pattern = "PATCH /api/2.0/apps/test-name"
-Response.Body = '''
-{
-  "name": "test-name",
-  "description": "My app description.",
-  "compute_status": {
-    "state": "ERROR",
-    "message": "App compute is active."
-  },
-  "app_status": {
-    "state": "DEPLOYING",
-    "message": "Application is running."
-  },
-  "url": "test-name-123.cloud.databricksapps.com",
-  "resources": [
-    {
-      "name": "api-key",
-      "description": "API key for external service.",
-      "secret": {
-        "scope": "my-scope",
-        "key": "my-key",
-        "permission": "READ"
-      }
-    }
-  ],
-  "id": "12345"
-}'''
diff --git a/acceptance/internal/server.go b/acceptance/internal/server.go
@@ -204,4 +204,40 @@ func AddHandlers(server *testserver.Server) {
 			NumProtoSuccess: 1,
 		}
 	})
+
+	// Quality monitors:
+
+	server.Handle("GET", "/api/2.1/unity-catalog/tables/{table_name}/monitor", func(req testserver.Request) any {
+		return req.Workspace.QualityMonitorGet(req, req.Vars["table_name"])
+	})
+
+	server.Handle("POST", "/api/2.1/unity-catalog/tables/{table_name}/monitor", func(req testserver.Request) any {
+		return req.Workspace.QualityMonitorUpsert(req, req.Vars["table_name"], false)
+	})
+
+	server.Handle("PUT", "/api/2.1/unity-catalog/tables/{table_name}/monitor", func(req testserver.Request) any {
+		return req.Workspace.QualityMonitorUpsert(req, req.Vars["table_name"], true)
+	})
+
+	server.Handle("DELETE", "/api/2.1/unity-catalog/tables/{table_name}/monitor", func(req testserver.Request) any {
+		return req.Workspace.QualityMonitorDelete(req, req.Vars["table_name"])
+	})
+
+	// Apps:
+
+	server.Handle("GET", "/api/2.0/apps/{name}", func(req testserver.Request) any {
+		return req.Workspace.AppsGet(req.Vars["name"])
+	})
+
+	server.Handle("POST", "/api/2.0/apps", func(req testserver.Request) any {
+		return req.Workspace.AppsUpsert(req, "")
+	})
+
+	server.Handle("PATCH", "/api/2.0/apps/{name}", func(req testserver.Request) any {
+		return req.Workspace.AppsUpsert(req, req.Vars["name"])
+	})
+
+	server.Handle("PATCH", "/api/2.0/apps/{name}", func(req testserver.Request) any {
+		return req.Workspace.AppsDelete(req.Vars["name"])
+	})
 }
diff --git a/libs/testserver/apps.go b/libs/testserver/apps.go
@@ -0,0 +1,83 @@
+package testserver
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/http"
+	"strconv"
+
+	"github.com/databricks/databricks-sdk-go/service/apps"
+)
+
+func (s *FakeWorkspace) AppsUpsert(req Request, name string) Response {
+	var app apps.App
+
+	if err := json.Unmarshal(req.Body, &app); err != nil {
+		return Response{
+			Body:       fmt.Sprintf("internal error: %s", err),
+			StatusCode: http.StatusInternalServerError,
+		}
+	}
+
+	if name != "" {
+		_, ok := s.apps[name]
+		if !ok {
+			return Response{
+				StatusCode: 404,
+			}
+		}
+	} else {
+		name = app.Name
+		if name == "" {
+			return Response{
+				StatusCode: 400,
+				Body:       "name is required",
+			}
+		}
+	}
+
+	app.AppStatus = &apps.ApplicationStatus{
+		State:   "RUNNING",
+		Message: "Application is running.",
+	}
+
+	app.ComputeStatus = &apps.ComputeStatus{
+		State:   "ACTIVE",
+		Message: "App compute is active.",
+	}
+
+	app.Url = name + "-123.cloud.databricksapps.com"
+	app.Id = strconv.Itoa(len(s.apps) + 1000)
+
+	s.apps[name] = app
+	return Response{
+		Body: app,
+	}
+}
+
+func (s *FakeWorkspace) AppsGet(name string) Response {
+	info, ok := s.apps[name]
+
+	if !ok {
+		return Response{
+			StatusCode: 404,
+		}
+	}
+
+	return Response{
+		Body: info,
+	}
+}
+
+func (s *FakeWorkspace) AppsDelete(name string) Response {
+	_, ok := s.apps[name]
+
+	if !ok {
+		return Response{
+			StatusCode: 404,
+		}
+	}
+
+	delete(s.apps, name)
+	return Response{}
+}
diff --git a/libs/testserver/fake_workspace.go b/libs/testserver/fake_workspace.go
@@ -9,6 +9,8 @@ import (
 	"strconv"
 	"strings"
 
+	"github.com/databricks/databricks-sdk-go/service/apps"
+	"github.com/databricks/databricks-sdk-go/service/catalog"
 	"github.com/databricks/databricks-sdk-go/service/jobs"
 	"github.com/databricks/databricks-sdk-go/service/pipelines"
 	"github.com/databricks/databricks-sdk-go/service/workspace"
@@ -24,6 +26,8 @@ type FakeWorkspace struct {
 	jobs      map[int64]jobs.Job
 
 	pipelines map[string]pipelines.PipelineSpec
+	monitors  map[string]catalog.MonitorInfo
+	apps      map[string]apps.App
 }
 
 func NewFakeWorkspace() *FakeWorkspace {
@@ -36,6 +40,8 @@ func NewFakeWorkspace() *FakeWorkspace {
 		nextJobId: 1,
 
 		pipelines: map[string]pipelines.PipelineSpec{},
+		monitors:  map[string]catalog.MonitorInfo{},
+		apps:      map[string]apps.App{},
 	}
 }
 
diff --git a/libs/testserver/quality_monitors.go b/libs/testserver/quality_monitors.go

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
	`1`	`+trace $CLI quality-monitors create catalog.schema.table --json @input.json`
`1`	`2`	`trace $CLI bundle deployment bind monitor1 "catalog.schema.table"`
`2`	`3`	`trace $CLI bundle deploy`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`{`
	`2`	`+ "name": "test-name",`
`2`	`3`	`"description": "My app description.",`
`3`	`4`	`"resources": [`
`4`	`5`	`{`