diff --git a/.nextchanges/bundles/record-bind-history.md b/.nextchanges/bundles/record-bind-history.md new file mode 100644 index 00000000000..ceab2f6ea04 --- /dev/null +++ b/.nextchanges/bundles/record-bind-history.md @@ -0,0 +1 @@ +* Record a deployment history version for `bundle deployment bind` when deployment history is enabled. ([#7400](https://github.com/databricks/cli/pull/7400)) diff --git a/acceptance/bin/nostamp.py b/acceptance/bin/nostamp.py index 8a0c222630c..8f370edc657 100755 --- a/acceptance/bin/nostamp.py +++ b/acceptance/bin/nostamp.py @@ -7,13 +7,14 @@ is a 2-space indent, keys in input order, <>& left unescaped, and integers at full precision. Tests under bundle/dms assert the stamp itself and must not use it. -Removed in three shapes plus the plan header: +Removed in these shapes: 1. deployment_id/version_id nested in a deployment block, recognized by the neighbouring "kind" and "metadata_file_path", which are kept; version_id == "" is kept (a Terraform state dump carries that for an unstamped job). 2. changes entries keyed "deployment.deployment_id" / "deployment.version_id". 3. a changes object emptied by (2), or already empty. 4. the recorded plan header field features. + 5. deployment_id/latest_version_id in bundle.deployment; other settings are kept. """ import argparse @@ -23,6 +24,7 @@ _STAMP_KEYS = ("deployment_id", "version_id") _CHANGE_KEYS = ("deployment.deployment_id", "deployment.version_id") _PLAN_HEADER_KEYS = ("features",) +_BUNDLE_STAMP_KEYS = ("deployment_id", "latest_version_id") def scrub(node): @@ -52,6 +54,15 @@ def render(data, indent): if isinstance(data, dict): for k in _PLAN_HEADER_KEYS: data.pop(k, None) # 4. plan header, present only at the root + # 5. Strip the summary's DMS IDs, keeping deployment settings such as locks. + bundle = data.get("bundle") + if isinstance(bundle, dict): + deployment = bundle.get("deployment") + if isinstance(deployment, dict) and any(k in deployment for k in _BUNDLE_STAMP_KEYS): + for k in _BUNDLE_STAMP_KEYS: + deployment.pop(k, None) + if not deployment: + bundle.pop("deployment") return json.dumps(data, indent=indent, ensure_ascii=False, separators=(",", ": ")) diff --git a/acceptance/bundle/deployment/bind/dashboard/recreation/script b/acceptance/bundle/deployment/bind/dashboard/recreation/script index c9656879b7e..6d8f12f1821 100644 --- a/acceptance/bundle/deployment/bind/dashboard/recreation/script +++ b/acceptance/bundle/deployment/bind/dashboard/recreation/script @@ -13,7 +13,7 @@ cleanupRemoveDashboard() { trap cleanupRemoveDashboard EXIT trace $CLI bundle deployment bind dashboard1 "${DASHBOARD_ID}" --auto-approve -trace print_state.py --no-dms > out.state_after_bind.json +trace print_state.py --no-dms | nostamp.py --indent 1 > out.state_after_bind.json ETAG=$(jq '.state["resources.dashboards.dashboard1"].state.etag // .resources[0].instances[0].attributes.etag // "no-etag"' < out.state_after_bind.json) echo $ETAG add_repl $ETAG ETAG diff --git a/acceptance/bundle/deployment/bind/feature_spec/out.bind.plain.txt b/acceptance/bundle/deployment/bind/feature_spec/out.bind.plain.txt new file mode 100644 index 00000000000..bfe657bfd50 --- /dev/null +++ b/acceptance/bundle/deployment/bind/feature_spec/out.bind.plain.txt @@ -0,0 +1,4 @@ + +>>> [CLI] bundle deployment bind spec1 main.fspec_[UNIQUE_NAME].boundspec --auto-approve +Successfully bound feature_spec with an id 'main.fspec_[UNIQUE_NAME].boundspec' +Run 'bundle deploy' to deploy changes to your workspace diff --git a/acceptance/bundle/deployment/bind/feature_spec/out.bind.recorded.txt b/acceptance/bundle/deployment/bind/feature_spec/out.bind.recorded.txt new file mode 100644 index 00000000000..55c6316629b --- /dev/null +++ b/acceptance/bundle/deployment/bind/feature_spec/out.bind.recorded.txt @@ -0,0 +1,5 @@ + +>>> [CLI] bundle deployment bind spec1 main.fspec_[UNIQUE_NAME].boundspec --auto-approve +Warn: Failed to record bind history: failed to create deployment version: operations.resource_key must have a known resource type prefix (e.g. 'jobs.', 'pipelines.'): feature_specs.spec1 +Successfully bound feature_spec with an id 'main.fspec_[UNIQUE_NAME].boundspec' +Run 'bundle deploy' to deploy changes to your workspace diff --git a/acceptance/bundle/deployment/bind/feature_spec/out.test.toml b/acceptance/bundle/deployment/bind/feature_spec/out.test.toml index 0f167effef1..efa0d67e8c2 100644 --- a/acceptance/bundle/deployment/bind/feature_spec/out.test.toml +++ b/acceptance/bundle/deployment/bind/feature_spec/out.test.toml @@ -1,2 +1,3 @@ Cloud = true EnvMatrix.DMS = ["", "true"] +EnvMatrix.OUTPUT_MODE = ["plain", "recorded"] diff --git a/acceptance/bundle/deployment/bind/feature_spec/out.unbind.plain.txt b/acceptance/bundle/deployment/bind/feature_spec/out.unbind.plain.txt new file mode 100644 index 00000000000..aa9e81e6253 --- /dev/null +++ b/acceptance/bundle/deployment/bind/feature_spec/out.unbind.plain.txt @@ -0,0 +1,2 @@ + +>>> [CLI] bundle deployment unbind spec1 diff --git a/acceptance/bundle/deployment/bind/feature_spec/out.unbind.recorded.txt b/acceptance/bundle/deployment/bind/feature_spec/out.unbind.recorded.txt new file mode 100644 index 00000000000..aa9e81e6253 --- /dev/null +++ b/acceptance/bundle/deployment/bind/feature_spec/out.unbind.recorded.txt @@ -0,0 +1,2 @@ + +>>> [CLI] bundle deployment unbind spec1 diff --git a/acceptance/bundle/deployment/bind/feature_spec/output.txt b/acceptance/bundle/deployment/bind/feature_spec/output.txt index a859db162c0..871f04d4ed8 100644 --- a/acceptance/bundle/deployment/bind/feature_spec/output.txt +++ b/acceptance/bundle/deployment/bind/feature_spec/output.txt @@ -16,10 +16,6 @@ "name": "main.fspec_[UNIQUE_NAME].boundspec" } ->>> [CLI] bundle deployment bind spec1 main.fspec_[UNIQUE_NAME].boundspec --auto-approve -Successfully bound feature_spec with an id 'main.fspec_[UNIQUE_NAME].boundspec' -Run 'bundle deploy' to deploy changes to your workspace - >>> [CLI] bundle summary Name: test-bind-feature-spec-[UNIQUE_NAME] Target: default @@ -37,8 +33,6 @@ Resources: >>> [CLI] bundle plan Plan: 0 to add, 0 to change, 0 to delete, 1 unchanged ->>> [CLI] bundle deployment unbind spec1 - >>> [CLI] bundle summary Name: test-bind-feature-spec-[UNIQUE_NAME] Target: default diff --git a/acceptance/bundle/deployment/bind/feature_spec/script b/acceptance/bundle/deployment/bind/feature_spec/script index 608c7fc8edc..896a123e7ed 100644 --- a/acceptance/bundle/deployment/bind/feature_spec/script +++ b/acceptance/bundle/deployment/bind/feature_spec/script @@ -6,13 +6,13 @@ trace $CLI feature-engineering create-feature-spec --json "{ \"features\": [{\"feature_lookup\": {\"table\": \"$SCHEMA_FULL_NAME.user_features\", \"lookup_keys\": [\"user_id\"], \"feature_names\": [\"age\"]}}] }" | jq '{name}' -trace $CLI bundle deployment bind spec1 $SCHEMA_FULL_NAME.boundspec --auto-approve +trace $CLI bundle deployment bind spec1 $SCHEMA_FULL_NAME.boundspec --auto-approve &> out.bind.$OUTPUT_MODE.txt trace $CLI bundle summary title "The bound feature spec matches the config, so there is nothing to change" trace $CLI bundle plan -trace $CLI bundle deployment unbind spec1 +trace $CLI bundle deployment unbind spec1 &> out.unbind.$OUTPUT_MODE.txt trace $CLI bundle summary trace $CLI feature-engineering delete-feature-spec $SCHEMA_FULL_NAME.boundspec diff --git a/acceptance/bundle/deployment/bind/feature_spec/test.toml b/acceptance/bundle/deployment/bind/feature_spec/test.toml index 66cb91f3551..c9f32889dab 100644 --- a/acceptance/bundle/deployment/bind/feature_spec/test.toml +++ b/acceptance/bundle/deployment/bind/feature_spec/test.toml @@ -1,3 +1,9 @@ +# Keep history warnings in separate outputs. +EnvMatrix.OUTPUT_MODE = ["plain", "recorded"] +EnvMatrixExclude.plain_history = ["DMS=true", "OUTPUT_MODE=plain"] +EnvMatrixExclude.recorded_without_history = ["DMS=", "OUTPUT_MODE=recorded"] +EnvVaryOutput = "OUTPUT_MODE" + Ignore = [ ".databricks", ] diff --git a/acceptance/bundle/deployment/bind/pipelines/recreate/script b/acceptance/bundle/deployment/bind/pipelines/recreate/script index a9aa3403a35..0796fa0e9e6 100644 --- a/acceptance/bundle/deployment/bind/pipelines/recreate/script +++ b/acceptance/bundle/deployment/bind/pipelines/recreate/script @@ -12,7 +12,7 @@ rm -f "$OUT_REQUESTS" trace $CLI bundle deployment bind foo $NEW_PIPELINE_ID --auto-approve &> out.bind-success.txt trace print_requests.py '^//import-file/' '^//workspace/' -trace $CLI bundle summary -o json | jq .resources > out.summary.json +trace $CLI bundle summary -o json | jq .resources | nostamp.py > out.summary.json trace $CLI bundle plan trace musterr $CLI bundle deploy diff --git a/acceptance/bundle/deployment/bind/pipelines/update/script b/acceptance/bundle/deployment/bind/pipelines/update/script index 6bafa319765..77f95d4d3ed 100644 --- a/acceptance/bundle/deployment/bind/pipelines/update/script +++ b/acceptance/bundle/deployment/bind/pipelines/update/script @@ -9,7 +9,7 @@ rm -f "$OUT_REQUESTS" trace $CLI bundle deployment bind foo $NEW_PIPELINE_ID --auto-approve &> out.bind-success.txt print_requests.py '^//import-file/' '^//workspace/delete' -trace $CLI bundle summary -o json > out.summary.json +trace $CLI bundle summary -o json | nostamp.py > out.summary.json trace $CLI bundle plan rm -f "$OUT_REQUESTS" diff --git a/acceptance/bundle/dms/bind-history-failures/databricks.yml.tmpl b/acceptance/bundle/dms/bind-history-failures/databricks.yml.tmpl new file mode 100644 index 00000000000..6f6a7fba6a3 --- /dev/null +++ b/acceptance/bundle/dms/bind-history-failures/databricks.yml.tmpl @@ -0,0 +1,13 @@ +bundle: + name: dms-bind-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 diff --git a/acceptance/bundle/dms/bind-history-failures/out.test.toml b/acceptance/bundle/dms/bind-history-failures/out.test.toml new file mode 100644 index 00000000000..88e6fbd847c --- /dev/null +++ b/acceptance/bundle/dms/bind-history-failures/out.test.toml @@ -0,0 +1,2 @@ +Cloud = false +EnvMatrix.DMS = ["true"] diff --git a/acceptance/bundle/dms/bind-history-failures/output.txt b/acceptance/bundle/dms/bind-history-failures/output.txt new file mode 100644 index 00000000000..3a7009625f8 --- /dev/null +++ b/acceptance/bundle/dms/bind-history-failures/output.txt @@ -0,0 +1,79 @@ + +=== A version creation failure does not prevent binding + +>>> fault.py POST /api/2.0/bundle/deployments/*/versions 400 0 1 + +>>> [CLI] bundle deployment bind create_failed [JOB_ID] --auto-approve +Warn: Failed to record bind history: failed to create deployment version: Fault injected by test. +Successfully bound job with an id '[JOB_ID]' +Run 'bundle deploy' to deploy changes to your workspace + +=== An operation recording failure does not prevent binding + +>>> fault.py PATCH /api/2.0/bundle/** 400 0 1 + +>>> [CLI] bundle deployment bind record_failed [JOB_ID] --auto-approve +Warn: Failed to record deployment history: recording operation for resources.jobs.record_failed: Fault injected by test. +Successfully bound job with an id '[JOB_ID]' +Run 'bundle deploy' to deploy changes to your workspace + +=== A version completion failure does not prevent binding + +>>> fault.py POST /api/2.0/bundle/deployments/*/versions/*/complete 400 0 1 + +>>> [CLI] bundle deployment bind complete_failed [JOB_ID] --auto-approve +Warn: Failed to complete deployment history version: Fault injected by test. +Successfully bound job with an id '[JOB_ID]' +Run 'bundle deploy' to deploy changes to your workspace + +=== All bindings survived the remote state round trips + +>>> jq .state | map_values(.__id__) .databricks/bundle/default/resources.json +{ + "resources.jobs.complete_failed": "[JOB_ID]", + "resources.jobs.create_failed": "[JOB_ID]", + "resources.jobs.record_failed": "[JOB_ID]" +} + +>>> [CLI] jobs get [JOB_ID] +{ + "job_id": [JOB_ID], + "name": "bind-target-[UNIQUE_NAME]" +} + +>>> print_requests.py --dms //versions --oneline +{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions", "q": {"version_id": "1"}, "body": {"cli_version": "[CLI_VERSION]", "operations": [{"action_type": "OPERATION_ACTION_TYPE_UPDATE", "resource_key": "jobs.create_failed"}], "version_type": "VERSION_TYPE_DEPLOY"}} +{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions", "q": {"version_id": "2"}, "body": {"cli_version": "[CLI_VERSION]", "operations": [{"action_type": "OPERATION_ACTION_TYPE_UPDATE", "resource_key": "jobs.record_failed"}], "version_type": "VERSION_TYPE_DEPLOY"}} +{"method": "PATCH", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/2/operations/jobs.record_failed", "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-history-failures-[UNIQUE_NAME]/default/state/metadata.json\"},\"edit_mode\":\"UI_LOCKED\",\"format\":\"MULTI_TASK\",\"max_concurrent_runs\":1,\"name\":\"record_failed\",\"queue\":{\"enabled\":true}}}", "status": "OPERATION_STATUS_SUCCEEDED"}} +{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/2/complete", "body": {"completion_reason": "VERSION_COMPLETE_FAILURE"}} +{"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.complete_failed"}], "previous_version_id": "2", "version_type": "VERSION_TYPE_DEPLOY"}} +{"method": "PATCH", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/3/operations/jobs.complete_failed", "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-history-failures-[UNIQUE_NAME]/default/state/metadata.json\"},\"edit_mode\":\"UI_LOCKED\",\"format\":\"MULTI_TASK\",\"max_concurrent_runs\":1,\"name\":\"complete_failed\",\"queue\":{\"enabled\":true}}}", "status": "OPERATION_STATUS_SUCCEEDED"}} +{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/3/complete", "body": {"completion_reason": "VERSION_COMPLETE_SUCCESS"}} + +=== A remote state upload failure fails the bind version + +>>> fault.py POST /api/2.0/workspace-files/import-file/**resources.json 400 0 1 + +>>> musterr [CLI] bundle deployment bind upload_failed [JOB_ID] --auto-approve +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-bind-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": "4"}, "body": {"cli_version": "[CLI_VERSION]", "operations": [{"action_type": "OPERATION_ACTION_TYPE_UPDATE", "resource_key": "jobs.upload_failed"}], "previous_version_id": "3", "version_type": "VERSION_TYPE_DEPLOY"}} +{"method": "PATCH", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/4/operations/jobs.upload_failed", "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-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}}}", "status": "OPERATION_STATUS_SUCCEEDED"}} +{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/4/complete", "body": {"completion_reason": "VERSION_COMPLETE_FAILURE"}} + +=== Remote state still contains only the successful bindings + +>>> [CLI] bundle summary -o json +{ + "complete_failed": "[JOB_ID]", + "create_failed": "[JOB_ID]", + "record_failed": "[JOB_ID]", + "upload_failed": null +} diff --git a/acceptance/bundle/dms/bind-history-failures/script b/acceptance/bundle/dms/bind-history-failures/script new file mode 100644 index 00000000000..eecbabcd3e2 --- /dev/null +++ b/acceptance/bundle/dms/bind-history-failures/script @@ -0,0 +1,33 @@ +envsubst < databricks.yml.tmpl > databricks.yml +job_id=$($CLI jobs create --json '{"name": "bind-target-'$UNIQUE_NAME'"}' | jq -r '.job_id') +add_repl "$job_id" JOB_ID + +title "A version creation failure does not prevent binding" +trace fault.py "POST /api/2.0/bundle/deployments/*/versions" 400 0 1 +trace $CLI bundle deployment bind create_failed "$job_id" --auto-approve +rm -rf .databricks + +title "An operation recording failure does not prevent binding" +trace fault.py "PATCH /api/2.0/bundle/**" 400 0 1 +trace $CLI bundle deployment bind record_failed "$job_id" --auto-approve +rm -rf .databricks + +title "A version completion failure does not prevent binding" +trace fault.py "POST /api/2.0/bundle/deployments/*/versions/*/complete" 400 0 1 +trace $CLI bundle deployment bind complete_failed "$job_id" --auto-approve + +title "All bindings survived the remote state round trips" +trace jq '.state | map_values(.__id__)' .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 bind version" +trace fault.py "POST /api/2.0/workspace-files/import-file/**resources.json" 400 0 1 +trace musterr $CLI bundle deployment bind upload_failed "$job_id" --auto-approve +trace print_requests.py --dms //versions --oneline + +rm -rf .databricks +title "Remote state still contains only the successful bindings" +trace $CLI bundle summary -o json | jq '.resources.jobs | map_values(.id // null)' +rm -f "$OUT_REQUESTS" diff --git a/acceptance/bundle/dms/bind-history-failures/test.toml b/acceptance/bundle/dms/bind-history-failures/test.toml new file mode 100644 index 00000000000..0e4c9337799 --- /dev/null +++ b/acceptance/bundle/dms/bind-history-failures/test.toml @@ -0,0 +1 @@ +Cloud = false # Inject failures into the deployment history service. diff --git a/acceptance/bundle/dms/bind-immutable/databricks.yml.tmpl b/acceptance/bundle/dms/bind-immutable/databricks.yml.tmpl new file mode 100644 index 00000000000..4d6fc71467e --- /dev/null +++ b/acceptance/bundle/dms/bind-immutable/databricks.yml.tmpl @@ -0,0 +1,8 @@ +bundle: + name: dms-bind-immutable-$UNIQUE_NAME +workspace: + sync_mode: immutable +resources: + jobs: + foo: + name: foo diff --git a/acceptance/bundle/dms/bind-immutable/out.test.toml b/acceptance/bundle/dms/bind-immutable/out.test.toml new file mode 100644 index 00000000000..88e6fbd847c --- /dev/null +++ b/acceptance/bundle/dms/bind-immutable/out.test.toml @@ -0,0 +1,2 @@ +Cloud = false +EnvMatrix.DMS = ["true"] diff --git a/acceptance/bundle/dms/bind-immutable/output.txt b/acceptance/bundle/dms/bind-immutable/output.txt new file mode 100644 index 00000000000..451affad5d7 --- /dev/null +++ b/acceptance/bundle/dms/bind-immutable/output.txt @@ -0,0 +1,13 @@ + +>>> [CLI] bundle deployment bind foo [JOB_ID] --auto-approve +Successfully bound job with an id '[JOB_ID]' +Run 'bundle deploy' to deploy changes to your workspace + +>>> MSYS_NO_PATHCONV=1 [CLI] bundle-deployments list-resources deployments/[DEPLOYMENT_ID] -o json +[ + { + "last_action_type": "OPERATION_ACTION_TYPE_UPDATE", + "resource_id": "[JOB_ID]", + "resource_key": "jobs.foo" + } +] diff --git a/acceptance/bundle/dms/bind-immutable/script b/acceptance/bundle/dms/bind-immutable/script new file mode 100644 index 00000000000..929a499ddd6 --- /dev/null +++ b/acceptance/bundle/dms/bind-immutable/script @@ -0,0 +1,8 @@ +envsubst < databricks.yml.tmpl > databricks.yml +job_id=$($CLI jobs create --json '{"name": "bind-target-'$UNIQUE_NAME'"}' | jq -r '.job_id') +add_repl "$job_id" JOB_ID + +trace $CLI bundle deployment bind foo "$job_id" --auto-approve +deployment_id=$(MSYS_NO_PATHCONV=1 $CLI workspace get-status "/Workspace/Users/${CURRENT_USER_NAME}/.bundle/dms-bind-immutable-${UNIQUE_NAME}/default/state/resources.deployment.json" -o json | jq -r '.object_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" diff --git a/acceptance/bundle/dms/bind-immutable/test.toml b/acceptance/bundle/dms/bind-immutable/test.toml new file mode 100644 index 00000000000..ee99e628c60 --- /dev/null +++ b/acceptance/bundle/dms/bind-immutable/test.toml @@ -0,0 +1,4 @@ +# This test ensures that deployment history works with bind and immutable folders. This case is interesting +# because by default we record the snapshot path in deploy, but that is not available during bind. So it's important +# to ensure that we don't do that during deployment bind, and recording history continues to work. +Cloud = false diff --git a/acceptance/bundle/dms/bind-unbind/out.test.toml b/acceptance/bundle/dms/bind-unbind/out.test.toml index 88e6fbd847c..84b22ba6735 100644 --- a/acceptance/bundle/dms/bind-unbind/out.test.toml +++ b/acceptance/bundle/dms/bind-unbind/out.test.toml @@ -1,2 +1,2 @@ -Cloud = false +Cloud = true EnvMatrix.DMS = ["true"] diff --git a/acceptance/bundle/dms/bind-unbind/output.txt b/acceptance/bundle/dms/bind-unbind/output.txt index daaa7345a94..d3bffd7d8b5 100644 --- a/acceptance/bundle/dms/bind-unbind/output.txt +++ b/acceptance/bundle/dms/bind-unbind/output.txt @@ -1,11 +1,56 @@ === Bind an existing job with deployment history enabled +>>> musterr [CLI] bundle deployment bind foo [JOB_ID] +Plan: update resources.jobs.foo + +Changes detected: + ~ deployment: null -> {"kind":"BUNDLE","metadata_file_path":"/Workspace/Users/[USERNAME]/.bundle/dms-bind-unbind-[UNIQUE_NAME]/default/state/metadata.json"} + ~ edit_mode: null -> "UI_LOCKED" + ~ name: "bind-target-[UNIQUE_NAME]" -> "foo" + +Error: this bind operation requires user confirmation, but the current console does not support prompting. +To proceed, use --auto-approve after reviewing the plan above. + + +>>> assert_not_exists.py .databricks/bundle/default/resources.json .databricks/bundle/default/resources.json.wal + +>>> print_requests.py --dms //api/2.0/bundle + >>> [CLI] bundle deployment bind foo [JOB_ID] --auto-approve Successfully bound job with an id '[JOB_ID]' Run 'bundle deploy' to deploy changes to your workspace -=== Deploy keeps the bound job ID and enables shadow history +>>> jq {serial, features, resource_id: .state["resources.jobs.foo"].__id__} .databricks/bundle/default/resources.json +{ + "serial": 1, + "features": { + "deployment_history_shadow": {} + }, + "resource_id": "[JOB_ID]" +} + +>>> print_requests.py --dms //versions --oneline +{"method": "POST", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions", "q": {"version_id": "1"}, "body": {"cli_version": "[CLI_VERSION]", "operations": [{"action_type": "OPERATION_ACTION_TYPE_UPDATE", "resource_key": "jobs.foo"}], "version_type": "VERSION_TYPE_DEPLOY"}} +{"method": "PATCH", "path": "/api/2.0/bundle/deployments/[DEPLOYMENT_ID]/versions/1/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/1/complete", "body": {"completion_reason": "VERSION_COMPLETE_SUCCESS"}} + +>>> [CLI] jobs get [JOB_ID] +{ + "job_id": [JOB_ID], + "name": "bind-target-[UNIQUE_NAME]" +} + +>>> MSYS_NO_PATHCONV=1 [CLI] bundle-deployments list-resources deployments/[DEPLOYMENT_ID] -o json +[ + { + "last_action_type": "OPERATION_ACTION_TYPE_UPDATE", + "resource_id": "[JOB_ID]", + "resource_key": "jobs.foo" + } +] + +=== Deploy keeps the bound job ID with recorded history >>> [CLI] bundle deploy Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-bind-unbind-[UNIQUE_NAME]/default/files... @@ -38,9 +83,9 @@ Resources: 0 created, 1 changed, 0 deleted, 0 unchanged "job_id": [JOB_ID] } -=== Rebind preserves the existing shadow history marker +=== Rebind preserves the existing shadow history marker without configuration ->>> [CLI] bundle deployment bind foo [JOB_ID] --auto-approve +>>> DATABRICKS_BUNDLE_DEPLOYMENT_HISTORY= [CLI] bundle deployment bind foo [JOB_ID] --auto-approve Successfully bound job with an id '[JOB_ID]' Run 'bundle deploy' to deploy changes to your workspace @@ -52,6 +97,11 @@ Run 'bundle deploy' to deploy changes to your workspace "resource_id": "[JOB_ID]" } +>>> 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"}} + === A subsequent deploy continues managing the same job >>> [CLI] bundle deploy @@ -66,3 +116,13 @@ Resources: 0 created, 0 changed, 0 deleted, 1 unchanged }, "resource_id": "[JOB_ID]" } + +=== A rejected duplicate bind creates no history version + +>>> musterr [CLI] bundle deployment bind foo [JOB_ID] --auto-approve +Error: Resource already managed + +The bundle is already managing resource for resources.jobs.foo and it is bound to the requested ID [JOB_ID]. + + +>>> print_requests.py --dms //versions diff --git a/acceptance/bundle/dms/bind-unbind/script b/acceptance/bundle/dms/bind-unbind/script index 32fab5aa0e8..5d101b99f27 100644 --- a/acceptance/bundle/dms/bind-unbind/script +++ b/acceptance/bundle/dms/bind-unbind/script @@ -1,11 +1,29 @@ envsubst < databricks.yml.tmpl > databricks.yml title "Bind an existing job with deployment history enabled" -job_id=$($CLI jobs create --json '{"name": "bind-target-'$UNIQUE_NAME'"}' | jq -r '.job_id') +# Match Jobs API defaults so the bind preview is identical locally and on cloud. +job_id=$($CLI jobs create --json '{"name": "bind-target-'$UNIQUE_NAME'", "format": "MULTI_TASK", "max_concurrent_runs": 1, "queue": {"enabled": true}}' | jq -r '.job_id') add_repl "$job_id" JOB_ID +cleanup_bind_target() { + errcode $CLI bundle destroy --auto-approve >> LOG.cleanup 2>&1 + errcode $CLI jobs delete "$job_id" >> LOG.cleanup 2>&1 +} +trap cleanup_bind_target EXIT + +trace musterr $CLI bundle deployment bind foo "$job_id" +# This bundle starts without state. A rejected bind must leave no committed state +# or pending WAL that a later command could recover. +trace assert_not_exists.py .databricks/bundle/default/resources.json .databricks/bundle/default/resources.json.wal +trace print_requests.py --dms //api/2.0/bundle trace $CLI bundle deployment bind foo "$job_id" --auto-approve +trace jq '{serial, features, resource_id: .state["resources.jobs.foo"].__id__}' .databricks/bundle/default/resources.json +trace print_requests.py --dms //versions --oneline +trace $CLI jobs get "$job_id" | jq '{job_id, name: .settings.name}' +deployment_id=$(MSYS_NO_PATHCONV=1 $CLI workspace get-status "/Workspace/Users/${CURRENT_USER_NAME}/.bundle/dms-bind-unbind-${UNIQUE_NAME}/default/state/resources.deployment.json" -o json | jq -r '.object_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})' + -title "Deploy keeps the bound job ID and enables shadow history" +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 @@ -14,10 +32,20 @@ trace $CLI bundle deployment unbind foo trace jq '{features, state}' .databricks/bundle/default/resources.json trace $CLI jobs get "$job_id" | jq '{job_id}' -title "Rebind preserves the existing shadow history marker" -trace $CLI bundle deployment bind foo "$job_id" --auto-approve +rm -f "$OUT_REQUESTS" + +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 +trace print_requests.py --dms //versions --oneline + title "A subsequent deploy continues managing the same job" trace $CLI bundle deploy trace jq '{features, resource_id: .state["resources.jobs.foo"].__id__}' .databricks/bundle/default/resources.json + +rm -f "$OUT_REQUESTS" + +title "A rejected duplicate bind creates no history version" +trace musterr $CLI bundle deployment bind foo "$job_id" --auto-approve +trace print_requests.py --dms //versions diff --git a/acceptance/bundle/dms/bind-unbind/test.toml b/acceptance/bundle/dms/bind-unbind/test.toml index f620acda97e..b7cf7fdd9a0 100644 --- a/acceptance/bundle/dms/bind-unbind/test.toml +++ b/acceptance/bundle/dms/bind-unbind/test.toml @@ -1,3 +1,2 @@ -RecordRequests = false # Verify shadow history markers and resource IDs across bind, deploy, unbind, and rebind. -Cloud = false +Cloud = true diff --git a/acceptance/bundle/dms_fault/complete_version/output.txt b/acceptance/bundle/dms_fault/complete_version/output.txt index bbf04e469ad..2d6b9c60c94 100644 --- a/acceptance/bundle/dms_fault/complete_version/output.txt +++ b/acceptance/bundle/dms_fault/complete_version/output.txt @@ -51,6 +51,7 @@ >>> 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 + Warn: Failed to complete deployment history version: Fault injected by test. Successfully bound job with an id '[FOO_ID]' >>> bundle generate pipeline --existing-pipeline-id [BAR_ID] --key bar --config-dir exported --source-dir exported-src --force @@ -70,6 +71,7 @@ >>> 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 Pipeline configuration successfully saved to resources/bar.pipeline.yml + Warn: Failed to complete deployment history version: Fault injected by test. Successfully bound pipeline with an id '[BAR_ID]' >>> bundle validate diff --git a/acceptance/bundle/dms_fault/create_deployment/output.txt b/acceptance/bundle/dms_fault/create_deployment/output.txt index 2b1b3f5a082..3f346874945 100644 --- a/acceptance/bundle/dms_fault/create_deployment/output.txt +++ b/acceptance/bundle/dms_fault/create_deployment/output.txt @@ -42,6 +42,7 @@ >>> 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 + Warn: Failed to record bind history: failed to create deployment: Fault injected by test. Successfully bound job with an id '[FOO_ID]' >>> bundle generate pipeline --existing-pipeline-id [BAR_ID] --key bar --config-dir exported --source-dir exported-src --force @@ -61,6 +62,7 @@ >>> 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 Pipeline configuration successfully saved to resources/bar.pipeline.yml + Warn: Failed to record bind history: failed to create deployment: Fault injected by test. Successfully bound pipeline with an id '[BAR_ID]' >>> bundle validate diff --git a/acceptance/bundle/dms_fault/create_version/output.txt b/acceptance/bundle/dms_fault/create_version/output.txt index f58fd56b675..89e7730c044 100644 --- a/acceptance/bundle/dms_fault/create_version/output.txt +++ b/acceptance/bundle/dms_fault/create_version/output.txt @@ -50,6 +50,7 @@ >>> 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 + Warn: Failed to record bind history: failed to create deployment version: Fault injected by test. Successfully bound job with an id '[FOO_ID]' >>> bundle generate pipeline --existing-pipeline-id [BAR_ID] --key bar --config-dir exported --source-dir exported-src --force @@ -69,6 +70,7 @@ >>> 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 Pipeline configuration successfully saved to resources/bar.pipeline.yml + Warn: Failed to record bind history: failed to create deployment version: Fault injected by test. Successfully bound pipeline with an id '[BAR_ID]' >>> bundle validate diff --git a/acceptance/bundle/dms_fault/get_deployment/output.txt b/acceptance/bundle/dms_fault/get_deployment/output.txt index a2c05be253f..e7603c56e18 100644 --- a/acceptance/bundle/dms_fault/get_deployment/output.txt +++ b/acceptance/bundle/dms_fault/get_deployment/output.txt @@ -58,6 +58,9 @@ >>> 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 + 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 bind history: Fault injected by test. Successfully bound job with an id '[FOO_ID]' >>> bundle generate pipeline --existing-pipeline-id [BAR_ID] --key bar --config-dir exported --source-dir exported-src --force @@ -77,6 +80,9 @@ >>> 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 Pipeline configuration successfully saved to resources/bar.pipeline.yml + 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 bind history: Fault injected by test. Successfully bound pipeline with an id '[BAR_ID]' >>> bundle validate diff --git a/acceptance/bundle/dms_fault/update_operation/output.txt b/acceptance/bundle/dms_fault/update_operation/output.txt index caf22b6c307..eb9be000cfb 100644 --- a/acceptance/bundle/dms_fault/update_operation/output.txt +++ b/acceptance/bundle/dms_fault/update_operation/output.txt @@ -51,6 +51,7 @@ >>> 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 + Warn: Failed to record deployment history: recording operation for [RESOURCE_KEY]: Fault injected by test. Successfully bound job with an id '[FOO_ID]' >>> bundle generate pipeline --existing-pipeline-id [BAR_ID] --key bar --config-dir exported --source-dir exported-src --force @@ -70,6 +71,7 @@ >>> 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 Pipeline configuration successfully saved to resources/bar.pipeline.yml + Warn: Failed to record deployment history: recording operation for [RESOURCE_KEY]: Fault injected by test. Successfully bound pipeline with an id '[BAR_ID]' >>> bundle validate diff --git a/bundle/phases/bind.go b/bundle/phases/bind.go index 1c0beef2750..293d842dd78 100644 --- a/bundle/phases/bind.go +++ b/bundle/phases/bind.go @@ -7,17 +7,23 @@ import ( "fmt" "maps" "slices" + "strings" "github.com/databricks/cli/bundle" "github.com/databricks/cli/bundle/config/engine" "github.com/databricks/cli/bundle/deploy/lock" "github.com/databricks/cli/bundle/deploy/snapshot" "github.com/databricks/cli/bundle/deployplan" + "github.com/databricks/cli/bundle/direct/dstate" + bundleenv "github.com/databricks/cli/bundle/env" "github.com/databricks/cli/bundle/statemgmt" "github.com/databricks/cli/libs/agent" + "github.com/databricks/cli/libs/cmdctx" "github.com/databricks/cli/libs/cmdio" + "github.com/databricks/cli/libs/dms" "github.com/databricks/cli/libs/log" "github.com/databricks/cli/libs/logdiag" + "github.com/databricks/databricks-sdk-go/service/bundledeployments" ) type BindOptions struct { @@ -28,6 +34,23 @@ type BindOptions struct { ResourceId string } +// createBindingDeployment creates a deployment record for the first recorded bind, without a deployed file path. +func createBindingDeployment(ctx context.Context, b *bundle.Bundle) (string, error) { + // Bind does not upload bundle files, so it cannot report a deployed file path. + metadata := bundleMetadata(b) + deployment := metadata.Deployment() + deployment.InitialParentPath = b.Config.Workspace.StatePath + created, err := b.WorkspaceClient(ctx).BundleDeployments.CreateDeployment(ctx, bundledeployments.CreateDeploymentRequest{Deployment: deployment}) + if err != nil { + return "", fmt.Errorf("failed to create deployment: %w", err) + } + deploymentID, err := dms.DeploymentIDFromName(created.Name) + if err != nil { + return "", fmt.Errorf("failed to create deployment: %w", err) + } + return deploymentID, nil +} + func Bind(ctx context.Context, b *bundle.Bundle, opts *BindOptions, stateDesc *statemgmt.StateDesc) { log.Info(ctx, "Phase: bind") engine := stateDesc.Engine @@ -37,11 +60,17 @@ func Bind(ctx context.Context, b *bundle.Bundle, opts *BindOptions, stateDesc *s return } + if !cmdctx.HasWorkspaceClient(ctx) { + ctx = cmdctx.SetWorkspaceClient(ctx, b.WorkspaceClient(ctx)) + } db := &b.DeploymentBundle.StateDB defer func() { if _, err := db.Finalize(ctx); err != nil { logdiag.LogError(ctx, err) } + if _, err := db.CompleteVersion(ctx, !logdiag.HasError(ctx)); err != nil { + log.Warnf(ctx, "Failed to complete deployment history version: %s", err) + } bundle.ApplyContext(ctx, b, lock.Release(lock.GoalBind)) }() @@ -108,10 +137,25 @@ func Bind(ctx context.Context, b *bundle.Bundle, opts *BindOptions, stateDesc *s } } + var configured *bool + if b.Config.Experimental != nil { + configured = b.Config.Experimental.DeploymentHistory + } + if db.RecordsHistory() || bundleenv.RecordsDeploymentHistory(ctx, configured) { + if db.Data.Features == nil { + db.Data.Features = make(map[string]struct{}) + } + db.Data.Features[dstate.FeatureDeploymentHistoryShadow] = struct{}{} + } if err := db.UpgradeToWrite(); err != nil { logdiag.LogError(ctx, err) return } + if db.RecordsHistory() { + if err := prepareBindHistory(ctx, b, resourceKey); err != nil { + log.Warnf(ctx, "Failed to record bind history: %s", err) + } + } resource := result.Resource if err := db.SaveState(ctx, resourceKey, resource.ID, resource.State, resource.DependsOn); err != nil { logdiag.LogError(ctx, err) @@ -121,7 +165,6 @@ func Bind(ctx context.Context, b *bundle.Bundle, opts *BindOptions, stateDesc *s logdiag.LogError(ctx, err) return } - statemgmt.PushResourcesState(ctx, b) } @@ -163,3 +206,28 @@ func Unbind(ctx context.Context, b *bundle.Bundle, group, resourceKey string, en statemgmt.PushResourcesState(ctx, b) } + +// prepareBindHistory stages only the approved binding, preserving deployed file metadata. +func prepareBindHistory(ctx context.Context, b *bundle.Bundle, resourceKey string) error { + deploymentID, current, err := dms.FetchDeployment(ctx, b.WorkspaceClient(ctx), b.Config.Workspace.StatePath) + if err != nil { + return err + } + previous, err := dms.ParseLastVersionID(current) + if err != nil { + return err + } + // Existing metadata is refreshed by deploy, which applies the current configuration. + if current == nil { + deploymentID, err = createBindingDeployment(ctx, b) + if err != nil { + return err + } + } + db := &b.DeploymentBundle.StateDB + db.DeploymentID, db.VersionID = deploymentID, previous + return startVersion(ctx, b, dms.VersionTypeDeploy, []bundledeployments.StagedOperation{{ + ResourceKey: strings.TrimPrefix(resourceKey, dms.StatePrefix), + ActionType: bundledeployments.OperationActionTypeOperationActionTypeUpdate, + }}) +} diff --git a/bundle/phases/bind_test.go b/bundle/phases/bind_test.go new file mode 100644 index 00000000000..aadfd009a1e --- /dev/null +++ b/bundle/phases/bind_test.go @@ -0,0 +1,97 @@ +package phases_test + +import ( + "encoding/json" + "os" + "testing" + + "github.com/databricks/cli/bundle" + "github.com/databricks/cli/bundle/config" + "github.com/databricks/cli/bundle/config/engine" + "github.com/databricks/cli/bundle/direct/dstate" + "github.com/databricks/cli/bundle/phases" + "github.com/databricks/cli/bundle/statemgmt" + "github.com/databricks/cli/libs/cmdctx" + "github.com/databricks/cli/libs/cmdio" + "github.com/databricks/cli/libs/logdiag" + "github.com/databricks/cli/libs/testserver" + "github.com/databricks/databricks-sdk-go" + "github.com/databricks/databricks-sdk-go/service/bundledeployments" + "github.com/databricks/databricks-sdk-go/service/jobs" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +func TestBindLocalCommitFailureCompletesVersion(t *testing.T) { + ctx, _ := cmdio.NewTestContextWithStderr(t.Context()) + ctx = logdiag.InitContext(ctx) + b := &bundle.Bundle{BundleRootPath: t.TempDir()} + root, diags := config.LoadFromBytes("databricks.yml", []byte(`bundle: + name: test + target: default + deployment: + lock: + enabled: false +experimental: + deployment_history: true +workspace: + root_path: /Workspace/test + state_path: /Workspace/test/state +resources: + jobs: + bound: + name: configured +`)) + require.Empty(t, diags) + b.Config = *root + _, statePath := b.StateFilenameDirect(ctx) + + server := testserver.New(t) + server.Handle("GET", "/api/2.2/jobs/get", func(req testserver.Request) any { + return jobs.Job{JobId: 20, Settings: &jobs.JobSettings{Name: "remote"}} + }) + server.Handle("GET", "/api/2.0/workspace/get-status", func(req testserver.Request) any { + return map[string]any{"object_id": 123, "object_type": "FILE"} + }) + server.Handle("GET", "/api/2.0/bundle/deployments/123", func(req testserver.Request) any { + return bundledeployments.Deployment{Name: "deployments/123"} + }) + server.Handle("POST", "/api/2.0/bundle/deployments/123/versions", func(req testserver.Request) any { + // The WAL is already open. Make the atomic state replacement fail after SaveState. + require.FileExists(t, statePath+".wal") + require.NoError(t, os.Mkdir(statePath, 0o700)) + return bundledeployments.Version{Name: "deployments/123/versions/1", VersionId: "1"} + }) + server.Handle("PATCH", "/api/2.0/bundle/deployments/123/versions/1/operations/jobs.bound", func(req testserver.Request) any { + return bundledeployments.Operation{} + }) + var completion bundledeployments.CompleteVersionRequest + server.Handle("POST", "/api/2.0/bundle/deployments/123/versions/1/complete", func(req testserver.Request) any { + require.NoError(t, json.Unmarshal(req.Body, &completion)) + return bundledeployments.Version{} + }) + testserver.AddDefaultHandlers(server) + client, err := databricks.NewWorkspaceClient(&databricks.Config{Host: server.URL, Token: "testtoken"}) + require.NoError(t, err) + b.SetWorkpaceClient(client) + ctx = cmdctx.SetWorkspaceClient(ctx, client) + + phases.Bind(ctx, b, &phases.BindOptions{Group: "jobs", ResourceKey: "bound", ResourceId: "20", AutoApprove: true}, &statemgmt.StateDesc{Engine: engine.EngineDirect}) + + assert.True(t, logdiag.HasError(ctx)) + assert.False(t, b.DeploymentBundle.StateDB.IsOpen()) + assert.Equal(t, bundledeployments.VersionCompleteVersionCompleteFailure, completion.CompletionReason) + // Completion releases the operation buffer while retaining its final measurements. + require.NotNil(t, b.DeploymentBundle.StateDB.OperationBufferStats()) + completed, err := b.DeploymentBundle.StateDB.CompleteVersion(ctx, true) + require.NoError(t, err) + assert.False(t, completed) + + // Finalize closed the WAL even though persistence failed, so ordinary recovery can retry it. + require.NoError(t, os.Remove(statePath)) + var recovered dstate.DeploymentState + require.NoError(t, recovered.Open(ctx, statePath, dstate.ReadingFile, dstate.WithRecovery(true), dstate.OpenDmsArgs{})) + assert.Equal(t, "20", recovered.GetResourceID("resources.jobs.bound")) + _, err = recovered.Finalize(ctx) + require.NoError(t, err) +}