Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .nextchanges/bundles/record-unbind-history.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* Record a deployment history version for `bundle deployment unbind` when deployment history is enabled. ([#7401](https://github.com/databricks/cli/pull/7401))
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@

>>> [CLI] bundle deployment unbind spec1
Warn: Failed to record unbind history: failed to create deployment version: operations.resource_key must have a known resource type prefix (e.g. 'jobs.', 'pipelines.'): feature_specs.spec1
3 changes: 3 additions & 0 deletions acceptance/bundle/dms/bind-unbind/databricks.yml.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@ resources:
jobs:
foo:
name: foo
permissions:
- group_name: users
level: CAN_VIEW
27 changes: 22 additions & 5 deletions acceptance/bundle/dms/bind-unbind/output.txt
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,10 @@ Run 'bundle deploy' to deploy changes to your workspace

>>> [CLI] bundle deploy
Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-bind-unbind-[UNIQUE_NAME]/default/files...
Created jobs.foo.permissions
Updated jobs.foo
Files: 2 uploaded, 0 deleted
Resources: 0 created, 1 changed, 0 deleted, 0 unchanged
Resources: 1 created, 1 changed, 0 deleted, 0 unchanged

>>> jq {features, resource_id: .state["resources.jobs.foo"].__id__} .databricks/bundle/default/resources.json
{
Expand All @@ -70,6 +71,12 @@ Resources: 0 created, 1 changed, 0 deleted, 0 unchanged

>>> [CLI] bundle deployment unbind foo

>>> print_requests.py --dms //versions //jobs //permissions --oneline
{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions", "q": {"version_id": "3"}, "body": {"cli_version": "[CLI_VERSION]", "operations": [{"action_type": "OPERATION_ACTION_TYPE_UPDATE", "resource_key": "jobs.foo"}, {"action_type": "OPERATION_ACTION_TYPE_UPDATE", "resource_key": "jobs.foo.permissions"}], "previous_version_id": "2", "version_type": "VERSION_TYPE_DEPLOY"}}
{"method": "PATCH", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/3/operations/jobs.foo", "q": {"update_mask": "state,error_message,status"}, "body": {"error_message": "", "sequence_id": 0, "status": "OPERATION_STATUS_SUCCEEDED"}}
{"method": "PATCH", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/3/operations/jobs.foo.permissions", "q": {"update_mask": "state,error_message,status"}, "body": {"error_message": "", "sequence_id": 0, "status": "OPERATION_STATUS_SUCCEEDED"}}
{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/3/complete", "body": {"completion_reason": "VERSION_COMPLETE_SUCCESS"}}

>>> jq {features, state} .databricks/bundle/default/resources.json
{
"features": {
Expand All @@ -83,6 +90,15 @@ Resources: 0 created, 1 changed, 0 deleted, 0 unchanged
"job_id": [JOB_ID]
}

>>> MSYS_NO_PATHCONV=1 [CLI] bundle-deployments list-resources deployments/[DEPLOYMENT_ID] -o json
[]

=== Unbinding an already unbound resource creates no history version

>>> [CLI] bundle deployment unbind foo

>>> print_requests.py --dms //versions

=== Rebind preserves the existing shadow history marker without configuration

>>> DATABRICKS_BUNDLE_DEPLOYMENT_HISTORY= [CLI] bundle deployment bind foo [JOB_ID] --auto-approve
Expand All @@ -98,16 +114,17 @@ Run 'bundle deploy' to deploy changes to your workspace
}

>>> print_requests.py --dms //versions --oneline
{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions", "q": {"version_id": "4"}, "body": {"cli_version": "[CLI_VERSION]", "operations": [{"action_type": "OPERATION_ACTION_TYPE_UPDATE", "resource_key": "jobs.foo"}], "previous_version_id": "2", "version_type": "VERSION_TYPE_DEPLOY"}}
{"method": "PATCH", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/4/operations/jobs.foo", "q": {"update_mask": "state,error_message,resource_id,status"}, "body": {"error_message": "", "resource_id": "[JOB_ID]", "sequence_id": 0, "state": "{\"state\":{\"deployment\":{\"kind\":\"BUNDLE\",\"metadata_file_path\":\"/Workspace/Users/[USERNAME]/.bundle/dms-bind-unbind-[UNIQUE_NAME]/default/state/metadata.json\"},\"edit_mode\":\"UI_LOCKED\",\"format\":\"MULTI_TASK\",\"max_concurrent_runs\":1,\"name\":\"foo\",\"queue\":{\"enabled\":true}}}", "status": "OPERATION_STATUS_SUCCEEDED"}}
{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/4/complete", "body": {"completion_reason": "VERSION_COMPLETE_SUCCESS"}}
{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions", "q": {"version_id": "5"}, "body": {"cli_version": "[CLI_VERSION]", "operations": [{"action_type": "OPERATION_ACTION_TYPE_UPDATE", "resource_key": "jobs.foo"}], "previous_version_id": "3", "version_type": "VERSION_TYPE_DEPLOY"}}
{"method": "PATCH", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/5/operations/jobs.foo", "q": {"update_mask": "state,error_message,resource_id,status"}, "body": {"error_message": "", "resource_id": "[JOB_ID]", "sequence_id": 0, "state": "{\"state\":{\"deployment\":{\"kind\":\"BUNDLE\",\"metadata_file_path\":\"/Workspace/Users/[USERNAME]/.bundle/dms-bind-unbind-[UNIQUE_NAME]/default/state/metadata.json\"},\"edit_mode\":\"UI_LOCKED\",\"format\":\"MULTI_TASK\",\"max_concurrent_runs\":1,\"name\":\"foo\",\"queue\":{\"enabled\":true}}}", "status": "OPERATION_STATUS_SUCCEEDED"}}
{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/5/complete", "body": {"completion_reason": "VERSION_COMPLETE_SUCCESS"}}

=== A subsequent deploy continues managing the same job

>>> [CLI] bundle deploy
Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-bind-unbind-[UNIQUE_NAME]/default/files...
Created jobs.foo.permissions
Files: 0 uploaded, 0 deleted
Resources: 0 created, 0 changed, 0 deleted, 1 unchanged
Resources: 1 created, 0 changed, 0 deleted, 1 unchanged

>>> jq {features, resource_id: .state["resources.jobs.foo"].__id__} .databricks/bundle/default/resources.json
{
Expand Down
9 changes: 9 additions & 0 deletions acceptance/bundle/dms/bind-unbind/script
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,22 @@ title "Deploy keeps the bound job ID with recorded history"
trace $CLI bundle deploy
trace jq '{features, resource_id: .state["resources.jobs.foo"].__id__}' .databricks/bundle/default/resources.json

rm -f "$OUT_REQUESTS"

title "Unbind preserves the shadow history marker and leaves the job intact"
trace $CLI bundle deployment unbind foo
trace print_requests.py --dms //versions //jobs //permissions --oneline
trace jq '{features, state}' .databricks/bundle/default/resources.json
trace $CLI jobs get "$job_id" | jq '{job_id}'
trace MSYS_NO_PATHCONV=1 $CLI bundle-deployments list-resources "deployments/${deployment_id}" -o json | jq -S 'map({resource_key, resource_id, last_action_type})'


rm -f "$OUT_REQUESTS"

title "Unbinding an already unbound resource creates no history version"
trace $CLI bundle deployment unbind foo
trace print_requests.py --dms //versions

title "Rebind preserves the existing shadow history marker without configuration"
trace DATABRICKS_BUNDLE_DEPLOYMENT_HISTORY= $CLI bundle deployment bind foo "$job_id" --auto-approve
trace jq '{features, resource_id: .state["resources.jobs.foo"].__id__}' .databricks/bundle/default/resources.json
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
bundle:
name: dms-unbind-history-failures-$UNIQUE_NAME

resources:
jobs:
create_failed:
name: create_failed
record_failed:
name: record_failed
complete_failed:
name: complete_failed
upload_failed:
name: upload_failed
2 changes: 2 additions & 0 deletions acceptance/bundle/dms/unbind-history-failures/out.test.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Cloud = false
EnvMatrix.DMS = ["true"]
86 changes: 86 additions & 0 deletions acceptance/bundle/dms/unbind-history-failures/output.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@

=== A version creation failure does not prevent unbinding

>>> fault.py POST /api/2.0/bundle/deployments/*/versions 400 0 1

>>> [CLI] bundle deployment unbind create_failed
Warn: Failed to record unbind history: failed to create deployment version: Fault injected by test.

=== An operation recording failure does not prevent unbinding

>>> fault.py PATCH /api/2.0/bundle/** 400 0 1

>>> [CLI] bundle deployment unbind record_failed
Warn: Failed to record deployment history: recording operation for resources.jobs.record_failed: Fault injected by test.

=== A version completion failure does not prevent unbinding

>>> fault.py POST /api/2.0/bundle/deployments/*/versions/*/complete 400 0 1

>>> [CLI] bundle deployment unbind complete_failed
Warn: Failed to complete deployment history version: Fault injected by test.

=== Successful unbindings survived the remote state round trips and the job still exists

>>> jq .state .databricks/bundle/default/resources.json
{
"resources.jobs.upload_failed": {
"__id__": "[JOB_ID]",
"state": {
"deployment": {
"kind": "BUNDLE",
"metadata_file_path": "/Workspace/Users/[USERNAME]/.bundle/dms-unbind-history-failures-[UNIQUE_NAME]/default/state/metadata.json"
},
"edit_mode": "UI_LOCKED",
"format": "MULTI_TASK",
"max_concurrent_runs": 1,
"name": "upload_failed",
"queue": {
"enabled": true
}
}
}
}

>>> [CLI] jobs get [JOB_ID]
{
"job_id": [JOB_ID],
"name": "unbind-target-[UNIQUE_NAME]"
}

>>> print_requests.py --dms //versions --oneline
{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions", "q": {"version_id": "5"}, "body": {"cli_version": "[CLI_VERSION]", "operations": [{"action_type": "OPERATION_ACTION_TYPE_UPDATE", "resource_key": "jobs.create_failed"}], "previous_version_id": "4", "version_type": "VERSION_TYPE_DEPLOY"}}
{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions", "q": {"version_id": "6"}, "body": {"cli_version": "[CLI_VERSION]", "operations": [{"action_type": "OPERATION_ACTION_TYPE_UPDATE", "resource_key": "jobs.record_failed"}], "previous_version_id": "4", "version_type": "VERSION_TYPE_DEPLOY"}}
{"method": "PATCH", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/6/operations/jobs.record_failed", "q": {"update_mask": "state,error_message,status"}, "body": {"error_message": "", "sequence_id": 0, "status": "OPERATION_STATUS_SUCCEEDED"}}
{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/6/complete", "body": {"completion_reason": "VERSION_COMPLETE_FAILURE"}}
{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions", "q": {"version_id": "7"}, "body": {"cli_version": "[CLI_VERSION]", "operations": [{"action_type": "OPERATION_ACTION_TYPE_UPDATE", "resource_key": "jobs.complete_failed"}], "previous_version_id": "6", "version_type": "VERSION_TYPE_DEPLOY"}}
{"method": "PATCH", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/7/operations/jobs.complete_failed", "q": {"update_mask": "state,error_message,status"}, "body": {"error_message": "", "sequence_id": 0, "status": "OPERATION_STATUS_SUCCEEDED"}}
{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/7/complete", "body": {"completion_reason": "VERSION_COMPLETE_SUCCESS"}}

=== A remote state upload failure fails the unbind version

>>> fault.py POST /api/2.0/workspace-files/import-file/**resources.json 400 0 1

>>> musterr [CLI] bundle deployment unbind upload_failed
Error: Fault injected by test. (400 INJECTED)

Endpoint: POST [DATABRICKS_URL]/api/2.0/workspace-files/import-file/Workspace%2FUsers%2F[USERNAME]%2F.bundle%2Fdms-unbind-history-failures-[UNIQUE_NAME]%2Fdefault%2Fstate%2Fresources.json?overwrite=true
HTTP Status: 400 Bad Request
API error_code: INJECTED
API message: Fault injected by test.


>>> print_requests.py --dms //versions --oneline
{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions", "q": {"version_id": "8"}, "body": {"cli_version": "[CLI_VERSION]", "operations": [{"action_type": "OPERATION_ACTION_TYPE_UPDATE", "resource_key": "jobs.upload_failed"}], "previous_version_id": "7", "version_type": "VERSION_TYPE_DEPLOY"}}
{"method": "PATCH", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/8/operations/jobs.upload_failed", "q": {"update_mask": "state,error_message,status"}, "body": {"error_message": "", "sequence_id": 0, "status": "OPERATION_STATUS_SUCCEEDED"}}
{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/8/complete", "body": {"completion_reason": "VERSION_COMPLETE_FAILURE"}}

=== Remote state still contains the binding whose upload failed

>>> [CLI] bundle summary -o json
{
"complete_failed": null,
"create_failed": null,
"record_failed": null,
"upload_failed": "[JOB_ID]"
}
37 changes: 37 additions & 0 deletions acceptance/bundle/dms/unbind-history-failures/script
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
envsubst < databricks.yml.tmpl > databricks.yml
job_id=$($CLI jobs create --json '{"name": "unbind-target-'$UNIQUE_NAME'"}' | jq -r '.job_id')
add_repl "$job_id" JOB_ID
for key in create_failed record_failed complete_failed upload_failed; do
$CLI bundle deployment bind "$key" "$job_id" --auto-approve >> LOG.setup 2>&1
done
rm -f "$OUT_REQUESTS"

title "A version creation failure does not prevent unbinding"
trace fault.py "POST /api/2.0/bundle/deployments/*/versions" 400 0 1
trace $CLI bundle deployment unbind create_failed
rm -rf .databricks

title "An operation recording failure does not prevent unbinding"
trace fault.py "PATCH /api/2.0/bundle/**" 400 0 1
trace $CLI bundle deployment unbind record_failed
rm -rf .databricks

title "A version completion failure does not prevent unbinding"
trace fault.py "POST /api/2.0/bundle/deployments/*/versions/*/complete" 400 0 1
trace $CLI bundle deployment unbind complete_failed

title "Successful unbindings survived the remote state round trips and the job still exists"
trace jq '.state' .databricks/bundle/default/resources.json
trace $CLI jobs get "$job_id" | jq '{job_id, name: .settings.name}'
trace print_requests.py --dms //versions --oneline


title "A remote state upload failure fails the unbind version"
trace fault.py "POST /api/2.0/workspace-files/import-file/**resources.json" 400 0 1
trace musterr $CLI bundle deployment unbind upload_failed
trace print_requests.py --dms //versions --oneline

rm -rf .databricks
title "Remote state still contains the binding whose upload failed"
trace $CLI bundle summary -o json | jq '.resources.jobs | map_values(.id // null)'
rm -f "$OUT_REQUESTS"
1 change: 1 addition & 0 deletions acceptance/bundle/dms/unbind-history-failures/test.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Cloud = false # Inject failures into the deployment history service.
2 changes: 2 additions & 0 deletions acceptance/bundle/dms_fault/complete_version/output.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@


>>> bundle deployment unbind foo
Warn: Failed to complete deployment history version: Fault injected by test.

>>> bundle generate job --existing-job-id [FOO_ID] --key foo --config-dir resources --source-dir src --force --bind
Job configuration successfully saved to resources/foo.job.yml
Expand All @@ -67,6 +68,7 @@


>>> bundle deployment unbind bar
Warn: Failed to complete deployment history version: Fault injected by test.

>>> bundle generate pipeline --existing-pipeline-id [BAR_ID] --key bar --config-dir resources --source-dir src --force --bind
File successfully saved to src/pipeline.sql
Expand Down
2 changes: 2 additions & 0 deletions acceptance/bundle/dms_fault/create_deployment/output.txt
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@


>>> bundle deployment unbind foo
Warn: Failed to record unbind history: failed to create deployment: Fault injected by test.

>>> bundle generate job --existing-job-id [FOO_ID] --key foo --config-dir resources --source-dir src --force --bind
Job configuration successfully saved to resources/foo.job.yml
Expand All @@ -58,6 +59,7 @@


>>> bundle deployment unbind bar
Warn: Failed to record unbind history: failed to create deployment: Fault injected by test.

>>> bundle generate pipeline --existing-pipeline-id [BAR_ID] --key bar --config-dir resources --source-dir src --force --bind
File successfully saved to src/pipeline.sql
Expand Down
2 changes: 2 additions & 0 deletions acceptance/bundle/dms_fault/create_version/output.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@


>>> bundle deployment unbind foo
Warn: Failed to record unbind history: failed to create deployment version: Fault injected by test.

>>> bundle generate job --existing-job-id [FOO_ID] --key foo --config-dir resources --source-dir src --force --bind
Job configuration successfully saved to resources/foo.job.yml
Expand All @@ -66,6 +67,7 @@


>>> bundle deployment unbind bar
Warn: Failed to record unbind history: failed to create deployment version: Fault injected by test.

>>> bundle generate pipeline --existing-pipeline-id [BAR_ID] --key bar --config-dir resources --source-dir src --force --bind
File successfully saved to src/pipeline.sql
Expand Down
6 changes: 6 additions & 0 deletions acceptance/bundle/dms_fault/get_deployment/output.txt
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,9 @@


>>> bundle deployment unbind foo
Warn: retrying after 500 Internal Server Error from GET /api/2.0/bundle/deployments/[DEPLOYMENT_ID]
Warn: retrying after 500 Internal Server Error from GET /api/2.0/bundle/deployments/[DEPLOYMENT_ID]
Warn: Failed to record unbind history: Fault injected by test.

>>> bundle generate job --existing-job-id [FOO_ID] --key foo --config-dir resources --source-dir src --force --bind
Job configuration successfully saved to resources/foo.job.yml
Expand All @@ -76,6 +79,9 @@


>>> bundle deployment unbind bar
Warn: retrying after 500 Internal Server Error from GET /api/2.0/bundle/deployments/[DEPLOYMENT_ID]
Warn: retrying after 500 Internal Server Error from GET /api/2.0/bundle/deployments/[DEPLOYMENT_ID]
Warn: Failed to record unbind history: Fault injected by test.

>>> bundle generate pipeline --existing-pipeline-id [BAR_ID] --key bar --config-dir resources --source-dir src --force --bind
File successfully saved to src/pipeline.sql
Expand Down
2 changes: 2 additions & 0 deletions acceptance/bundle/dms_fault/update_operation/output.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@


>>> bundle deployment unbind foo
Warn: Failed to record deployment history: recording operation for [RESOURCE_KEY]: Fault injected by test.

>>> bundle generate job --existing-job-id [FOO_ID] --key foo --config-dir resources --source-dir src --force --bind
Job configuration successfully saved to resources/foo.job.yml
Expand All @@ -67,6 +68,7 @@


>>> bundle deployment unbind bar
Warn: Failed to record deployment history: recording operation for [RESOURCE_KEY]: Fault injected by test.

>>> bundle generate pipeline --existing-pipeline-id [BAR_ID] --key bar --config-dir resources --source-dir src --force --bind
File successfully saved to src/pipeline.sql
Expand Down
50 changes: 21 additions & 29 deletions bundle/direct/bind.go
Original file line number Diff line number Diff line change
Expand Up @@ -147,39 +147,31 @@ func (b *DeploymentBundle) Bind(ctx context.Context, client *databricks.Workspac
return result, nil
}

// Unbind removes a resource from direct engine state without deleting
// the workspace resource. Also removes associated permissions/grants entries.
func (b *DeploymentBundle) Unbind(ctx context.Context, statePath, resourceKey string) error {
if err := b.StateDB.Open(ctx, statePath, dstate.ReadingFile, dstate.WithRecovery(true), dstate.OpenDmsArgs{}); err != nil {
return err
}
if err := b.StateDB.UpgradeToWrite(); err != nil {
return err
}

// Delete the main resource
err := b.StateDB.DeleteState(ctx, resourceKey, false)
if err != nil {
return err
}

log.Infof(ctx, "Unbound %s", resourceKey)

// UnbindResourceKeys returns the sorted resource and child keys present in the open state.
func (b *DeploymentBundle) UnbindResourceKeys(resourceKey string) []string {
// Also delete associated permissions/grants if they exist
// These are stored as "resources.jobs.foo.permissions" or "resources.schemas.bar.grants"
permissionsKey := resourceKey + ".permissions"
grantsKey := resourceKey + ".grants"

var keys []string
for key := range b.StateDB.Data.State {
if key == permissionsKey || key == grantsKey || strings.HasPrefix(key, resourceKey+".") {
err = b.StateDB.DeleteState(ctx, key, false)
if err != nil {
return err
}
log.Infof(ctx, "Unbound %s", key)
if key == resourceKey || strings.HasPrefix(key, resourceKey+".") {
keys = append(keys, key)
}
}
slices.Sort(keys)
return keys
}

_, err = b.StateDB.Finalize(ctx)
return err
// Unbind removes the selected keys from open writable state without deleting workspace resources.
func (b *DeploymentBundle) Unbind(ctx context.Context, resourceKey string, keys []string) error {
if len(keys) == 0 {
// Preserve the existing local transaction when the resource is already absent.
keys = []string{resourceKey}
}
for _, key := range keys {
if err := b.StateDB.DeleteState(ctx, key, false); err != nil {
return err
}
log.Infof(ctx, "Unbound %s", key)
}
return nil
}
Loading
Loading