Fix bundle plan to not create workspace objects or upload the files (#3442)

andrewnester · web-flow · commit 429bedc290a6 · 2025-09-01T13:19:01.000Z
## Changes
Refactored `deployPrepare` to make it non-mutative. Moved artifact
folder cleanup and libraries upload to `uploadLibraries`, which is only
used by deploy.

## Why
This makes `bundle plan` non-mutative and safe to use to preview bundle
changes.

## Tests
Added acceptance test

&lt;!-- If your PR needs to be included in the release notes for next
release,
add a separate entry in NEXT_CHANGELOG.md as part of your PR. --&gt;
diff --git a/acceptance/bundle/paths/fallback_metric/output.txt b/acceptance/bundle/paths/fallback_metric/output.txt
@@ -23,11 +23,11 @@ Deployment complete!
     "value": false
   },
   {
-    "key": "skip_artifact_cleanup",
+    "key": "python_wheel_wrapper_is_set",
     "value": false
   },
   {
-    "key": "python_wheel_wrapper_is_set",
+    "key": "skip_artifact_cleanup",
     "value": false
   },
   {
@@ -57,11 +57,11 @@ Deployment complete!
     "value": true
   },
   {
-    "key": "skip_artifact_cleanup",
+    "key": "python_wheel_wrapper_is_set",
     "value": false
   },
   {
-    "key": "python_wheel_wrapper_is_set",
+    "key": "skip_artifact_cleanup",
     "value": false
   },
   {
diff --git a/acceptance/bundle/plan/no_upload/databricks.yml b/acceptance/bundle/plan/no_upload/databricks.yml
@@ -0,0 +1,19 @@
+bundle:
+  name: plan-no-upload
+
+resources:
+  jobs:
+    my_job:
+      name: my-job
+      tasks:
+        - task_key: task1
+          spark_python_task:
+            python_file: "./my_script.py"
+          environment_key: "env"
+
+      environments:
+        - environment_key: "env"
+          spec:
+            client: "1"
+            dependencies:
+              - "*.whl"
diff --git a/acceptance/bundle/plan/no_upload/my_script.py b/acceptance/bundle/plan/no_upload/my_script.py
@@ -0,0 +1 @@
+print("Hello, World!")
diff --git a/acceptance/bundle/plan/no_upload/out.test.toml b/acceptance/bundle/plan/no_upload/out.test.toml
@@ -0,0 +1,5 @@
+Local = true
+Cloud = false
+
+[EnvMatrix]
+  DATABRICKS_CLI_DEPLOYMENT = ["terraform", "direct-exp"]
diff --git a/acceptance/bundle/plan/no_upload/output.txt b/acceptance/bundle/plan/no_upload/output.txt
@@ -0,0 +1,5 @@
+
+>>> [CLI] bundle plan
+create jobs.my_job
+
+>>> jq -s .[] | select(.method != "GET") out.requests.txt
diff --git a/acceptance/bundle/plan/no_upload/script b/acceptance/bundle/plan/no_upload/script
@@ -0,0 +1,6 @@
+trace $CLI bundle plan
+
+# Expect no non-GET requests
+trace jq -s '.[] | select(.method != "GET")' out.requests.txt
+
+rm out.requests.txt
diff --git a/acceptance/bundle/plan/no_upload/test.toml b/acceptance/bundle/plan/no_upload/test.toml
@@ -0,0 +1,3 @@
+Local = true
+Cloud = false
+RecordRequests = true
diff --git a/acceptance/bundle/plan/no_upload/test.whl b/acceptance/bundle/plan/no_upload/test.whl
diff --git a/acceptance/bundle/resource_deps/missing_ingestion_definition/out.requests.txt b/acceptance/bundle/resource_deps/missing_ingestion_definition/out.requests.txt
@@ -29,18 +29,3 @@
   "method": "GET",
   "path": "/api/2.0/workspace/get-status"
 }
-{
-  "method": "POST",
-  "path": "/api/2.0/workspace/delete",
-  "body": {
-    "path": "/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/artifacts/.internal",
-    "recursive": true
-  }
-}
-{
-  "method": "POST",
-  "path": "/api/2.0/workspace/mkdirs",
-  "body": {
-    "path": "/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/artifacts/.internal"
-  }
-}
diff --git a/acceptance/bundle/telemetry/deploy-compute-type/output.txt b/acceptance/bundle/telemetry/deploy-compute-type/output.txt
@@ -22,11 +22,11 @@ Deployment complete!
     "value": false
   },
   {
-    "key": "skip_artifact_cleanup",
+    "key": "python_wheel_wrapper_is_set",
     "value": false
   },
   {
-    "key": "python_wheel_wrapper_is_set",
+    "key": "skip_artifact_cleanup",
     "value": false
   },
   {
@@ -52,11 +52,11 @@ Deployment complete!
     "value": false
   },
   {
-    "key": "skip_artifact_cleanup",
+    "key": "python_wheel_wrapper_is_set",
     "value": false
   },
   {
-    "key": "python_wheel_wrapper_is_set",
+    "key": "skip_artifact_cleanup",
     "value": false
   },
   {
diff --git a/acceptance/bundle/telemetry/deploy-experimental/output.txt b/acceptance/bundle/telemetry/deploy-experimental/output.txt
@@ -21,11 +21,11 @@ Deployment complete!
       "value": false
     },
     {
-      "key": "skip_artifact_cleanup",
+      "key": "python_wheel_wrapper_is_set",
       "value": false
     },
     {
-      "key": "python_wheel_wrapper_is_set",
+      "key": "skip_artifact_cleanup",
       "value": false
     },
     {
diff --git a/acceptance/bundle/telemetry/deploy-name-prefix/custom/output.txt b/acceptance/bundle/telemetry/deploy-name-prefix/custom/output.txt
@@ -17,11 +17,11 @@ Deployment complete!
       "value": true
     },
     {
-      "key": "skip_artifact_cleanup",
+      "key": "python_wheel_wrapper_is_set",
       "value": false
     },
     {
-      "key": "python_wheel_wrapper_is_set",
+      "key": "skip_artifact_cleanup",
       "value": false
     },
     {
diff --git a/acceptance/bundle/telemetry/deploy-name-prefix/mode-development/output.txt b/acceptance/bundle/telemetry/deploy-name-prefix/mode-development/output.txt
@@ -17,11 +17,11 @@ Deployment complete!
       "value": true
     },
     {
-      "key": "skip_artifact_cleanup",
+      "key": "python_wheel_wrapper_is_set",
       "value": false
     },
     {
-      "key": "python_wheel_wrapper_is_set",
+      "key": "skip_artifact_cleanup",
       "value": false
     },
     {
diff --git a/acceptance/bundle/telemetry/deploy-whl-artifacts/output.txt b/acceptance/bundle/telemetry/deploy-whl-artifacts/output.txt
@@ -25,11 +25,11 @@ Deployment complete!
       "value": false
     },
     {
-      "key": "skip_artifact_cleanup",
+      "key": "python_wheel_wrapper_is_set",
       "value": false
     },
     {
-      "key": "python_wheel_wrapper_is_set",
+      "key": "skip_artifact_cleanup",
       "value": false
     },
     {
@@ -61,11 +61,11 @@ Deployment complete!
       "value": true
     },
     {
-      "key": "skip_artifact_cleanup",
+      "key": "python_wheel_wrapper_is_set",
       "value": true
     },
     {
-      "key": "python_wheel_wrapper_is_set",
+      "key": "skip_artifact_cleanup",
       "value": true
     },
     {
diff --git a/acceptance/bundle/telemetry/deploy/out.telemetry.txt b/acceptance/bundle/telemetry/deploy/out.telemetry.txt
@@ -51,11 +51,11 @@
               "value": false
             },
             {
-              "key": "skip_artifact_cleanup",
+              "key": "python_wheel_wrapper_is_set",
               "value": false
             },
             {
-              "key": "python_wheel_wrapper_is_set",
+              "key": "skip_artifact_cleanup",
               "value": false
             },
             {
diff --git a/bundle/libraries/filer.go b/bundle/libraries/filer.go
@@ -3,6 +3,7 @@ package libraries
 import (
 	"context"
 	"path"
+	"strings"
 
 	"github.com/databricks/cli/bundle"
 	"github.com/databricks/cli/libs/diag"
@@ -24,6 +25,7 @@ func GetFilerForLibraries(ctx context.Context, b *bundle.Bundle) (filer.Filer, s
 	}
 
 	uploadPath := path.Join(b.Config.Workspace.ArtifactPath, InternalDirName)
+	uploadPath = ensureWorkspaceOrVolumesPrefix(uploadPath)
 
 	switch {
 	case IsVolumesPath(artifactPath):
@@ -40,11 +42,23 @@ func GetFilerForLibrariesCleanup(ctx context.Context, b *bundle.Bundle) (filer.F
 		return nil, "", diag.Errorf("remote artifact path not configured")
 	}
 
+	artifactPath = ensureWorkspaceOrVolumesPrefix(artifactPath)
+
 	switch {
 	case IsVolumesPath(artifactPath):
-		return filerForVolume(b, b.Config.Workspace.ArtifactPath)
+		return filerForVolume(b, artifactPath)
 
 	default:
-		return filerForWorkspace(b, b.Config.Workspace.ArtifactPath)
+		return filerForWorkspace(b, artifactPath)
+	}
+}
+
+// If the remote path does not start with /Workspace or /Volumes, prepend /Workspace
+// Some of the bundle configuration might use workspace paths like /Users or /Shared.
+// While this is still a valid workspace path, the backend converts it to /Workspace/Users or /Workspace/Shared.
+func ensureWorkspaceOrVolumesPrefix(path string) string {
+	if !strings.HasPrefix(path, "/Workspace") && !strings.HasPrefix(path, "/Volumes") {
+		path = "/Workspace" + path
 	}
+	return path
 }
diff --git a/bundle/libraries/filer_test.go b/bundle/libraries/filer_test.go
@@ -28,7 +28,7 @@ func TestGetFilerForLibrariesValidWsfs(t *testing.T) {
 
 	client, uploadPath, diags := GetFilerForLibraries(context.Background(), b)
 	require.NoError(t, diags.Error())
-	assert.Equal(t, "/foo/bar/artifacts/.internal", uploadPath)
+	assert.Equal(t, "/Workspace/foo/bar/artifacts/.internal", uploadPath)
 
 	assert.IsType(t, &filer.WorkspaceFilesClient{}, client)
 }
@@ -48,7 +48,7 @@ func TestGetFilerForLibrariesCleanupValidWsfs(t *testing.T) {
 
 	client, uploadPath, diags := GetFilerForLibrariesCleanup(context.Background(), b)
 	require.NoError(t, diags.Error())
-	assert.Equal(t, "/foo/bar/artifacts", uploadPath)
+	assert.Equal(t, "/Workspace/foo/bar/artifacts", uploadPath)
 
 	assert.IsType(t, &filer.WorkspaceFilesClient{}, client)
 }
diff --git a/bundle/libraries/remote_path.go b/bundle/libraries/remote_path.go
diff --git a/bundle/libraries/upload.go b/bundle/libraries/upload.go
diff --git a/bundle/phases/deploy.go b/bundle/phases/deploy.go
diff --git a/bundle/phases/plan.go b/bundle/phases/plan.go

Original file line number	Diff line number	Diff line change
`@@ -23,11 +23,11 @@ Deployment complete!`
`23`	`23`	`"value": false`
`24`	`24`	`},`
`25`	`25`	`{`
`26`		`- "key": "skip_artifact_cleanup",`
	`26`	`+ "key": "python_wheel_wrapper_is_set",`
`27`	`27`	`"value": false`
`28`	`28`	`},`
`29`	`29`	`{`
`30`		`- "key": "python_wheel_wrapper_is_set",`
	`30`	`+ "key": "skip_artifact_cleanup",`
`31`	`31`	`"value": false`
`32`	`32`	`},`
`33`	`33`	`{`
`@@ -57,11 +57,11 @@ Deployment complete!`
`57`	`57`	`"value": true`
`58`	`58`	`},`
`59`	`59`	`{`
`60`		`- "key": "skip_artifact_cleanup",`
	`60`	`+ "key": "python_wheel_wrapper_is_set",`
`61`	`61`	`"value": false`
`62`	`62`	`},`
`63`	`63`	`{`
`64`		`- "key": "python_wheel_wrapper_is_set",`
	`64`	`+ "key": "skip_artifact_cleanup",`
`65`	`65`	`"value": false`
`66`	`66`	`},`
`67`	`67`	`{`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Local = true`
	`2`	`+Cloud = false`
	`3`	`+RecordRequests = true`
Original file line number	Diff line number	Diff line change
`@@ -22,11 +22,11 @@ Deployment complete!`
`22`	`22`	`"value": false`
`23`	`23`	`},`
`24`	`24`	`{`
`25`		`- "key": "skip_artifact_cleanup",`
	`25`	`+ "key": "python_wheel_wrapper_is_set",`
`26`	`26`	`"value": false`
`27`	`27`	`},`
`28`	`28`	`{`
`29`		`- "key": "python_wheel_wrapper_is_set",`
	`29`	`+ "key": "skip_artifact_cleanup",`
`30`	`30`	`"value": false`
`31`	`31`	`},`
`32`	`32`	`{`
`@@ -52,11 +52,11 @@ Deployment complete!`
`52`	`52`	`"value": false`
`53`	`53`	`},`
`54`	`54`	`{`
`55`		`- "key": "skip_artifact_cleanup",`
	`55`	`+ "key": "python_wheel_wrapper_is_set",`
`56`	`56`	`"value": false`
`57`	`57`	`},`
`58`	`58`	`{`
`59`		`- "key": "python_wheel_wrapper_is_set",`
	`59`	`+ "key": "skip_artifact_cleanup",`
`60`	`60`	`"value": false`
`61`	`61`	`},`
`62`	`62`	`{`