Fix bind/unbind for Python support (#3063)

kanterov · web-flow · commit 7163e5e767cb · 2025-06-17T07:19:53.000Z
## Changes Support bind/unbind for resources declared in Python. It requires initializing the bundle before we allow selecting a resource to bind/unbind, because otherwise, Python resources are not yet loaded. ## Why Fixes #3019 ## Tests Add acceptance tests for bind/unbind of YAML and Python jobs.
diff --git a/acceptance/bundle/deployment/bind/job/databricks.yml b/acceptance/bundle/deployment/bind/job/databricks.yml
@@ -0,0 +1,7 @@
+bundle:
+  name: my_project
+
+resources:
+  jobs:
+    job_1:
+      name: Updated Job
diff --git a/acceptance/bundle/deployment/bind/job/output.txt b/acceptance/bundle/deployment/bind/job/output.txt
@@ -0,0 +1,30 @@
+
+>>> [CLI] jobs create --json {"name": "My Job"}
+
+>>> [CLI] bundle deployment bind job_1 [NUMID] --auto-approve
+Updating deployment state...
+Successfully bound job with an id '[NUMID]'. Run 'bundle deploy' to deploy changes to your workspace
+
+>>> [CLI] bundle deploy
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/my_project/default/files...
+Deploying resources...
+Updating deployment state...
+Deployment complete!
+
+>>> [CLI] jobs get [NUMID] --output json
+{
+  "job_id":[NUMID],
+  "settings": {
+    "deployment": {
+      "kind":"BUNDLE",
+      "metadata_file_path":"/Workspace/Users/[USERNAME]/.bundle/my_project/default/state/metadata.json"
+    },
+    "edit_mode":"UI_LOCKED",
+    "format":"MULTI_TASK",
+    "max_concurrent_runs":1,
+    "name":"Updated Job",
+    "queue": {
+      "enabled":true
+    }
+  }
+}
diff --git a/acceptance/bundle/deployment/bind/job/script b/acceptance/bundle/deployment/bind/job/script
@@ -0,0 +1,7 @@
+job_id=$(trace $CLI jobs create --json '{"name": "My Job"}' | jq -r '.job_id')
+
+trace $CLI bundle deployment bind job_1 $job_id --auto-approve
+
+trace $CLI bundle deploy
+
+trace $CLI jobs get $job_id --output json
diff --git a/acceptance/bundle/deployment/bind/job/test.toml b/acceptance/bundle/deployment/bind/job/test.toml
@@ -0,0 +1 @@
+Cloud = false # test leaves deployed job
diff --git a/acceptance/bundle/deployment/bind/python-job/databricks.yml b/acceptance/bundle/deployment/bind/python-job/databricks.yml
@@ -0,0 +1,7 @@
+bundle:
+  name: my_project
+
+experimental:
+  python:
+    resources:
+      - "resources:load_resources"
diff --git a/acceptance/bundle/deployment/bind/python-job/output.txt b/acceptance/bundle/deployment/bind/python-job/output.txt
@@ -0,0 +1,30 @@
+
+>>> [CLI] jobs create --json {"name": "My Job"}
+
+>>> uv run --with [DATABRICKS_BUNDLES_WHEEL] -q [CLI] bundle deployment bind job_1 [NUMID] --auto-approve
+Updating deployment state...
+Successfully bound job with an id '[NUMID]'. Run 'bundle deploy' to deploy changes to your workspace
+
+>>> uv run --with [DATABRICKS_BUNDLES_WHEEL] -q [CLI] bundle deploy
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/my_project/default/files...
+Deploying resources...
+Updating deployment state...
+Deployment complete!
+
+>>> [CLI] jobs get [NUMID] --output json
+{
+  "job_id":[NUMID],
+  "settings": {
+    "deployment": {
+      "kind":"BUNDLE",
+      "metadata_file_path":"/Workspace/Users/[USERNAME]/.bundle/my_project/default/state/metadata.json"
+    },
+    "edit_mode":"UI_LOCKED",
+    "format":"MULTI_TASK",
+    "max_concurrent_runs":1,
+    "name":"Updated Job",
+    "queue": {
+      "enabled":true
+    }
+  }
+}
diff --git a/acceptance/bundle/deployment/bind/python-job/resources.py b/acceptance/bundle/deployment/bind/python-job/resources.py
@@ -0,0 +1,12 @@
+from databricks.bundles.core import Resources
+
+
+def load_resources() -> Resources:
+    resources = Resources()
+
+    resources.add_job(
+        resource_name="job_1",
+        job={"name": "Updated Job"},
+    )
+
+    return resources
diff --git a/acceptance/bundle/deployment/bind/python-job/script b/acceptance/bundle/deployment/bind/python-job/script
@@ -0,0 +1,9 @@
+UV_RUN="uv run --with $DATABRICKS_BUNDLES_WHEEL -q"
+
+job_id=$(trace $CLI jobs create --json '{"name": "My Job"}' | jq -r '.job_id')
+
+trace $UV_RUN $CLI bundle deployment bind job_1 $job_id --auto-approve
+
+trace $UV_RUN $CLI bundle deploy
+
+trace $CLI jobs get $job_id --output json
diff --git a/acceptance/bundle/deployment/bind/python-job/test.toml b/acceptance/bundle/deployment/bind/python-job/test.toml
@@ -0,0 +1 @@
+Cloud = false # test leaves deployed job
diff --git a/acceptance/bundle/deployment/unbind/job/databricks.yml b/acceptance/bundle/deployment/unbind/job/databricks.yml
@@ -0,0 +1,11 @@
+bundle:
+  name: my_project
+
+variables:
+  job_name:
+    description: "Job name"
+
+resources:
+  jobs:
+    job_1:
+      name: ${var.job_name}
diff --git a/acceptance/bundle/deployment/unbind/job/output.txt b/acceptance/bundle/deployment/unbind/job/output.txt
@@ -0,0 +1,35 @@
+
+>>> [CLI] bundle deploy --var job_name=My Job
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/my_project/default/files...
+Deploying resources...
+Updating deployment state...
+Deployment complete!
+
+>>> [CLI] bundle summary --var job_name=My Job --output json
+
+>>> [CLI] bundle deployment unbind job_1 --var job_name=My Job
+Updating deployment state...
+
+>>> [CLI] bundle deploy --var job_name=Updated Job
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/my_project/default/files...
+Deploying resources...
+Updating deployment state...
+Deployment complete!
+
+>>> [CLI] jobs get [NUMID] --output json
+{
+  "job_id":[NUMID],
+  "settings": {
+    "deployment": {
+      "kind":"BUNDLE",
+      "metadata_file_path":"/Workspace/Users/[USERNAME]/.bundle/my_project/default/state/metadata.json"
+    },
+    "edit_mode":"UI_LOCKED",
+    "format":"MULTI_TASK",
+    "max_concurrent_runs":1,
+    "name":"My Job",
+    "queue": {
+      "enabled":true
+    }
+  }
+}
diff --git a/acceptance/bundle/deployment/unbind/job/script b/acceptance/bundle/deployment/unbind/job/script
@@ -0,0 +1,9 @@
+trace $CLI bundle deploy --var "job_name=My Job"
+
+job_id=$(trace $CLI bundle summary --var "job_name=My Job" --output json | jq -r '.resources.jobs.job_1.id')
+
+trace $CLI bundle deployment unbind job_1 --var "job_name=My Job"
+
+trace $CLI bundle deploy --var "job_name=Updated Job"
+
+trace $CLI jobs get $job_id --output json
diff --git a/acceptance/bundle/deployment/unbind/job/test.toml b/acceptance/bundle/deployment/unbind/job/test.toml
@@ -0,0 +1,2 @@
+Cloud = false # test leaves deployed job
+Ignore = [".databricks"]
diff --git a/acceptance/bundle/deployment/unbind/python-job/databricks.yml b/acceptance/bundle/deployment/unbind/python-job/databricks.yml
@@ -0,0 +1,11 @@
+bundle:
+  name: my_project
+
+variables:
+  job_name:
+    description: "Job name"
+
+experimental:
+  python:
+    resources:
+      - "resources:load_resources"
diff --git a/acceptance/bundle/deployment/unbind/python-job/output.txt b/acceptance/bundle/deployment/unbind/python-job/output.txt
@@ -0,0 +1,35 @@
+
+>>> uv run --with [DATABRICKS_BUNDLES_WHEEL] -q [CLI] bundle deploy --var job_name=My Job
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/my_project/default/files...
+Deploying resources...
+Updating deployment state...
+Deployment complete!
+
+>>> uv run --with [DATABRICKS_BUNDLES_WHEEL] -q [CLI] bundle summary --var job_name=My Job --output json
+
+>>> uv run --with [DATABRICKS_BUNDLES_WHEEL] -q [CLI] bundle deployment unbind job_1 --var job_name=My Job
+Updating deployment state...
+
+>>> uv run --with [DATABRICKS_BUNDLES_WHEEL] -q [CLI] bundle deploy --var job_name=Updated Job
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/my_project/default/files...
+Deploying resources...
+Updating deployment state...
+Deployment complete!
+
+>>> [CLI] jobs get [NUMID] --output json
+{
+  "job_id":[NUMID],
+  "settings": {
+    "deployment": {
+      "kind":"BUNDLE",
+      "metadata_file_path":"/Workspace/Users/[USERNAME]/.bundle/my_project/default/state/metadata.json"
+    },
+    "edit_mode":"UI_LOCKED",
+    "format":"MULTI_TASK",
+    "max_concurrent_runs":1,
+    "name":"My Job",
+    "queue": {
+      "enabled":true
+    }
+  }
+}
diff --git a/acceptance/bundle/deployment/unbind/python-job/resources.py b/acceptance/bundle/deployment/unbind/python-job/resources.py
@@ -0,0 +1,12 @@
+from databricks.bundles.core import Resources
+
+
+def load_resources() -> Resources:
+    resources = Resources()
+
+    resources.add_job(
+        resource_name="job_1",
+        job={"name": "${var.job_name}"},
+    )
+
+    return resources
diff --git a/acceptance/bundle/deployment/unbind/python-job/script b/acceptance/bundle/deployment/unbind/python-job/script
@@ -0,0 +1,11 @@
+UV_RUN="uv run --with $DATABRICKS_BUNDLES_WHEEL -q"
+
+trace $UV_RUN $CLI bundle deploy --var "job_name=My Job"
+
+job_id=$(trace $UV_RUN $CLI bundle summary --var "job_name=My Job" --output json | jq -r '.resources.jobs.job_1.id')
+
+trace $UV_RUN $CLI bundle deployment unbind job_1 --var "job_name=My Job"
+
+trace $UV_RUN $CLI bundle deploy --var "job_name=Updated Job"
+
+trace $CLI jobs get $job_id --output json
diff --git a/acceptance/bundle/deployment/unbind/python-job/test.toml b/acceptance/bundle/deployment/unbind/python-job/test.toml
@@ -0,0 +1,2 @@
+Cloud = false # test leaves deployed job
+Ignore = [".databricks"]
diff --git a/acceptance/internal/handlers.go b/acceptance/internal/handlers.go
@@ -187,6 +187,11 @@ func addDefaultHandlers(server *testserver.Server) {
 		return req.Workspace.JobsReset(request)
 	})
 
+	server.Handle("GET", "/api/2.0/jobs/get", func(req testserver.Request) any {
+		jobId := req.URL.Query().Get("job_id")
+		return req.Workspace.JobsGet(jobId)
+	})
+
 	server.Handle("GET", "/api/2.2/jobs/get", func(req testserver.Request) any {
 		jobId := req.URL.Query().Get("job_id")
 		return req.Workspace.JobsGet(jobId)
diff --git a/cmd/bundle/deployment/bind.go b/cmd/bundle/deployment/bind.go
@@ -33,6 +33,11 @@ func newBindCommand() *cobra.Command {
 			return diags.Error()
 		}
 
+		diags = phases.Initialize(ctx, b)
+		if err := diags.Error(); err != nil {
+			return fmt.Errorf("failed to initialize bundle, err: %w", err)
+		}
+
 		resource, err := b.Config.Resources.FindResourceByConfigKey(args[0])
 		if err != nil {
 			return err
@@ -53,15 +58,12 @@ func newBindCommand() *cobra.Command {
 			return nil
 		})
 
-		diags = phases.Initialize(ctx, b)
-		if !diags.HasError() {
-			diags = diags.Extend(phases.Bind(ctx, b, &terraform.BindOptions{
-				AutoApprove:  autoApprove,
-				ResourceType: resource.ResourceDescription().TerraformResourceName,
-				ResourceKey:  args[0],
-				ResourceId:   args[1],
-			}))
-		}
+		diags = diags.Extend(phases.Bind(ctx, b, &terraform.BindOptions{
+			AutoApprove:  autoApprove,
+			ResourceType: resource.ResourceDescription().TerraformResourceName,
+			ResourceKey:  args[0],
+			ResourceId:   args[1],
+		}))
 		if err := diags.Error(); err != nil {
 			return fmt.Errorf("failed to bind the resource, err: %w", err)
 		}
diff --git a/cmd/bundle/deployment/unbind.go b/cmd/bundle/deployment/unbind.go
@@ -2,6 +2,7 @@ package deployment
 
 import (
 	"context"
+	"fmt"
 
 	"github.com/databricks/cli/bundle"
 	"github.com/databricks/cli/bundle/phases"
@@ -28,6 +29,11 @@ func newUnbindCommand() *cobra.Command {
 			return diags.Error()
 		}
 
+		diags = phases.Initialize(ctx, b)
+		if err := diags.Error(); err != nil {
+			return fmt.Errorf("failed to initialize bundle, err: %w", err)
+		}
+
 		resource, err := b.Config.Resources.FindResourceByConfigKey(args[0])
 		if err != nil {
 			return err
@@ -38,12 +44,9 @@ func newUnbindCommand() *cobra.Command {
 			return nil
 		})
 
-		diags = phases.Initialize(ctx, b)
-		if !diags.HasError() {
-			diags = diags.Extend(phases.Unbind(ctx, b, resource.ResourceDescription().TerraformResourceName, args[0]))
-		}
+		diags = diags.Extend(phases.Unbind(ctx, b, resource.ResourceDescription().TerraformResourceName, args[0]))
 		if err := diags.Error(); err != nil {
-			return err
+			return fmt.Errorf("failed to unbind the resource, err: %w", err)
 		}
 		return nil
 	}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Cloud = false # test leaves deployed job`