apps: inject default description="" to match TF (#3519)

denik · web-flow · commit 98e835ceb334 · 2025-09-01T09:24:30.000Z
## Why
To ensure that direct backend sends the same payload as terraform and
there are unexpected updates in pla when users migrate. It also
simplifies testing where we record request payload and expect it match
in both cases.
diff --git a/acceptance/bundle/resources/apps/default_description/app.py b/acceptance/bundle/resources/apps/default_description/app.py
diff --git a/acceptance/bundle/resources/apps/default_description/databricks.yml b/acceptance/bundle/resources/apps/default_description/databricks.yml
@@ -0,0 +1,5 @@
+resources:
+  apps:
+    mykey:
+      name: myappname
+      source_code_path: .
diff --git a/acceptance/bundle/resources/apps/default_description/out.test.toml b/acceptance/bundle/resources/apps/default_description/out.test.toml
diff --git a/acceptance/bundle/resources/apps/default_description/output.txt b/acceptance/bundle/resources/apps/default_description/output.txt
@@ -0,0 +1,16 @@
+
+>>> [CLI] bundle deploy
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
+Deploying resources...
+Updating deployment state...
+Deployment complete!
+
+>>> print_requests
+{
+  "body": {
+    "description": "",
+    "name": "myappname"
+  },
+  "method": "POST",
+  "path": "/api/2.0/apps"
+}
diff --git a/acceptance/bundle/resources/apps/default_description/script b/acceptance/bundle/resources/apps/default_description/script
@@ -0,0 +1,7 @@
+print_requests() {
+    jq --sort-keys 'select(.method != "GET" and (.path | contains("/apps")))' < out.requests.txt
+    rm out.requests.txt
+}
+
+trace $CLI bundle deploy
+trace print_requests
diff --git a/acceptance/bundle/resources/apps/update/app/app.py b/acceptance/bundle/resources/apps/update/app/app.py
@@ -0,0 +1 @@
+print("Hello world!")
diff --git a/acceptance/bundle/resources/apps/update/databricks.yml b/acceptance/bundle/resources/apps/update/databricks.yml
diff --git a/acceptance/bundle/resources/apps/update/out.test.toml b/acceptance/bundle/resources/apps/update/out.test.toml
@@ -0,0 +1,5 @@
+Local = true
+Cloud = false
+
+[EnvMatrix]
+  DATABRICKS_CLI_DEPLOYMENT = ["terraform", "direct-exp"]
diff --git a/acceptance/bundle/resources/apps/update/output.txt b/acceptance/bundle/resources/apps/update/output.txt
diff --git a/acceptance/bundle/resources/apps/update/script b/acceptance/bundle/resources/apps/update/script
diff --git a/acceptance/bundle/validate/empty_resources/empty_dict/output.txt b/acceptance/bundle/validate/empty_resources/empty_dict/output.txt
@@ -166,6 +166,7 @@ app resource 'rname' is missing required source_code_path field
 {
   "apps": {
     "rname": {
+      "description": "",
       "permissions": []
     }
   }
diff --git a/acceptance/bundle/validate/empty_resources/with_grants/output.txt b/acceptance/bundle/validate/empty_resources/with_grants/output.txt
@@ -203,6 +203,7 @@ app resource 'rname' is missing required source_code_path field
 {
   "apps": {
     "rname": {
+      "description": "",
       "permissions": []
     }
   }
diff --git a/acceptance/bundle/validate/empty_resources/with_permissions/output.txt b/acceptance/bundle/validate/empty_resources/with_permissions/output.txt
@@ -184,6 +184,7 @@ app resource 'rname' is missing required source_code_path field
 {
   "apps": {
     "rname": {
+      "description": "",
       "permissions": []
     }
   }
diff --git a/acceptance/bundle/variables/resolve-resources-fields/output.txt b/acceptance/bundle/variables/resolve-resources-fields/output.txt
@@ -11,6 +11,7 @@
 {
   "apps": {
     "baz": {
+      "description": "",
       "name": "myapp",
       "permissions": [],
       "source_code_path": "/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files"
diff --git a/bundle/config/mutator/resourcemutator/resource_mutator.go b/bundle/config/mutator/resourcemutator/resource_mutator.go
@@ -87,6 +87,9 @@ func applyInitializeMutators(ctx context.Context, b *bundle.Bundle) {
 		{"resources.sql_warehouses.*.enable_photon", true},
 		{"resources.sql_warehouses.*.max_num_clusters", 1},
 		{"resources.sql_warehouses.*.spot_instance_policy", "COST_OPTIMIZED"},
+
+		// Apps:
+		{"resources.apps.*.description", ""},
 	}
 
 	for _, defaultDef := range defaults {
