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 deployment history for `bundle deployment unbind` when deployment history is enabled. ([#7818](https://github.com/databricks/cli/pull/7818))
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@

>>> [CLI] bundle deployment unbind spec1
Warn: Failed to record deployment history for unbind: 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": "5"}, "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": "4", "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,status"}, "body": {"error_message": "", "sequence_id": 0, "status": "OPERATION_STATUS_SUCCEEDED"}}
{"method": "PATCH", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/5/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/5/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": "7"}, "body": {"cli_version": "[CLI_VERSION]", "operations": [{"action_type": "OPERATION_ACTION_TYPE_UPDATE", "resource_key": "jobs.foo"}], "previous_version_id": "4", "version_type": "VERSION_TYPE_DEPLOY"}}
{"method": "PATCH", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/7/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/7/complete", "body": {"completion_reason": "VERSION_COMPLETE_SUCCESS"}}
{"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.foo"}], "previous_version_id": "5", "version_type": "VERSION_TYPE_DEPLOY"}}
{"method": "PATCH", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/8/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/8/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
Expand Up @@ -3,3 +3,4 @@ Warn: Could not enable deployment history for this deploy: failed to create depl
Warn: Failed to complete deployment history version: Internal error
Error: cannot create resources.secrets.foo: response body: stream error: stream ID 73; INTERNAL_ERROR; received from peer
Warn: Failed to record deployment history for bind: operations.resource_key must have a known resource type
Warn: Failed to record deployment history for unbind: operations.resource_key must have a known resource type
2 changes: 2 additions & 0 deletions acceptance/bundle/dms/suppress-transport-warnings/script
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,12 @@ echo "Warn: Could not delete deployment history: response body: stream error: st
echo "Warn: Failed to record deployment history: context deadline exceeded"

echo "Warn: Failed to record deployment history for bind: unexpected EOF"
echo "Warn: Failed to record deployment history for unbind: context deadline exceeded"

# Kept: errors the service returns, and transport errors outside deployment history.
echo "Warn: Could not enable deployment history for this deploy: failed to create deployment: "
echo "Warn: Could not enable deployment history for this deploy: failed to create deployment version: operations.resource_key must have a known resource type"
echo "Warn: Failed to complete deployment history version: Internal error"
echo "Error: cannot create resources.secrets.foo: response body: stream error: stream ID 73; INTERNAL_ERROR; received from peer"
echo "Warn: Failed to record deployment history for bind: operations.resource_key must have a known resource type"
echo "Warn: Failed to record deployment history for unbind: operations.resource_key must have a known resource type"
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
bundle:
name: dms-unbind-upload-failure-$UNIQUE_NAME

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

=== 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-upload-failure-[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 //complete --oneline
{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/4/complete", "body": {"completion_reason": "VERSION_COMPLETE_FAILURE"}}

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

>>> [CLI] bundle summary -o json
{
"upload_failed": "[JOB_ID]"
}
15 changes: 15 additions & 0 deletions acceptance/bundle/dms/unbind-upload-failure/script
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
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
$CLI bundle deployment bind upload_failed "$job_id" --auto-approve &> LOG.setup
rm -f "$OUT_REQUESTS"

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 //complete --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-upload-failure/test.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Cloud = false # Inject a remote state-upload failure.
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 deployment history for unbind: 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 deployment history for unbind: 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 deployment history for unbind: 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 deployment history for unbind: 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 deployment history for unbind: 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 deployment history for unbind: 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
1 change: 1 addition & 0 deletions acceptance/bundle/dms_fault/run.py
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,7 @@ def assert_destroyed(cwd, root, current):
assert (cwd / "exported-src/pipeline.sql").read_text() == (cwd / "pipeline.sql").read_text()
run(cwd, "bundle", "deployment", "unbind", key)
assert resource not in state(cwd)["state"]
assert resource not in remote_state(cwd, root)["state"]
generate(cwd, kind, key, current[resource], bind=True)
assert ids(cwd)[resource] == current[resource]
assert remote_state(cwd, root)["state"][resource]["__id__"] == current[resource]
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 for unbind: 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 for unbind: 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
47 changes: 41 additions & 6 deletions bundle/direct/bind.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"context"
"fmt"
"os"
"slices"
"strings"

"github.com/databricks/cli/bundle/config"
Expand Down Expand Up @@ -42,6 +43,12 @@ type DMSBindMetadata struct {
ResourceState dstate.ResourceEntry
}

// DMSUnbindMetadata holds removed keys to publish after the unbind commits.
type DMSUnbindMetadata struct {
Serial int
ResourceKeys []string
}

// BindResult contains the result of a bind operation including any detected changes.
type BindResult struct {
// DMSMetadata is nil when deployment history is disabled.
Expand Down Expand Up @@ -269,18 +276,40 @@ func (result *BindResult) Cancel() {

// 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 {
// It returns nil DMS metadata when deployment history is disabled.
func (b *DeploymentBundle) Unbind(ctx context.Context, configRoot *config.Root, statePath, resourceKey string) (*DMSUnbindMetadata, error) {
if err := b.StateDB.Open(ctx, statePath, dstate.ReadingFile, dstate.WithRecovery(true), dstate.OpenDmsArgs{}); err != nil {
return err
return nil, err
}
var configured *bool
if configRoot.Experimental != nil {
configured = configRoot.Experimental.DeploymentHistory
}
if b.StateDB.RecordsHistory() || bundleenv.RecordsDeploymentHistory(ctx, configured) {
if b.StateDB.Data.Features == nil {
b.StateDB.Data.Features = make(map[string]struct{})
}
b.StateDB.Data.Features[dstate.FeatureDeploymentHistoryShadow] = struct{}{}
}
if err := b.StateDB.UpgradeToWrite(); err != nil {
return err
return nil, err
}
var metadata *DMSUnbindMetadata
if b.StateDB.RecordsHistory() {
metadata = &DMSUnbindMetadata{Serial: b.StateDB.Data.Serial}
// Finalize commits the removals below as one existing WAL transaction.
if b.StateDB.Data.State != nil {
metadata.Serial++
}
if _, exists := b.StateDB.GetResourceEntry(resourceKey); exists {
metadata.ResourceKeys = append(metadata.ResourceKeys, resourceKey)
}
}

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

log.Infof(ctx, "Unbound %s", resourceKey)
Expand All @@ -294,12 +323,18 @@ func (b *DeploymentBundle) Unbind(ctx context.Context, statePath, resourceKey st
if key == permissionsKey || key == grantsKey || strings.HasPrefix(key, resourceKey+".") {
err = b.StateDB.DeleteState(ctx, key, false)
if err != nil {
return err
return nil, err
}
if metadata != nil {
metadata.ResourceKeys = append(metadata.ResourceKeys, key)
}
log.Infof(ctx, "Unbound %s", key)
}
}

if metadata != nil {
slices.Sort(metadata.ResourceKeys)
}
_, err = b.StateDB.Finalize(ctx)
return err
return metadata, err
}
Loading
Loading