diff --git a/.nextchanges/bundles/record-bind-history.md b/.nextchanges/bundles/record-bind-history.md new file mode 100644 index 00000000000..f1ae02d88be --- /dev/null +++ b/.nextchanges/bundles/record-bind-history.md @@ -0,0 +1 @@ +* Record deployment history when binding existing resources with `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/out.state_after_bind.json b/acceptance/bundle/deployment/bind/dashboard/recreation/out.state_after_bind.json index 05614d798bf..74e555c734d 100644 --- a/acceptance/bundle/deployment/bind/dashboard/recreation/out.state_after_bind.json +++ b/acceptance/bundle/deployment/bind/dashboard/recreation/out.state_after_bind.json @@ -2,7 +2,7 @@ "state_version": 3, "cli_version": "[CLI_VERSION]", "lineage": "[UUID]", - "serial": 2, + "serial": 1, "state": { "resources.dashboards.dashboard1": { "__id__": "[DASHBOARD_ID]", 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/job/job-abort-bind/output.txt b/acceptance/bundle/deployment/bind/job/job-abort-bind/output.txt index 8e212f477d7..fbe3c197c9c 100644 --- a/acceptance/bundle/deployment/bind/job/job-abort-bind/output.txt +++ b/acceptance/bundle/deployment/bind/job/job-abort-bind/output.txt @@ -9,6 +9,8 @@ To proceed, use --auto-approve after reviewing the plan above. Exit code: 1 +>>> assert_not_exists.py .databricks/bundle/default/resources.json .databricks/bundle/default/resources.json.wal .databricks/bundle/default/resources.json.temp-bind + === Deploy bundle: >>> [CLI] bundle deploy --force-lock diff --git a/acceptance/bundle/deployment/bind/job/job-abort-bind/script b/acceptance/bundle/deployment/bind/job/job-abort-bind/script index 63aedd7f285..748994da8c3 100644 --- a/acceptance/bundle/deployment/bind/job/job-abort-bind/script +++ b/acceptance/bundle/deployment/bind/job/job-abort-bind/script @@ -38,6 +38,7 @@ title "Expect binding to fail without an auto-approve flag:" trace errcode $CLI bundle deployment bind foo $JOB_ID &> out.bind-result.txt sed -n '/^Error:/,$p' out.bind-result.txt rm out.bind-result.txt +trace assert_not_exists.py .databricks/bundle/default/resources.json .databricks/bundle/default/resources.json.wal .databricks/bundle/default/resources.json.temp-bind title "Deploy bundle:" trace $CLI bundle deploy --force-lock diff --git a/acceptance/bundle/deployment/bind/job/noop-job/output.txt b/acceptance/bundle/deployment/bind/job/noop-job/output.txt index 956f90977b4..c9a42b9adf8 100644 --- a/acceptance/bundle/deployment/bind/job/noop-job/output.txt +++ b/acceptance/bundle/deployment/bind/job/noop-job/output.txt @@ -5,6 +5,14 @@ Successfully bound job with an id '[JOB_ID]' Run 'bundle deploy' to deploy changes to your workspace +>>> jq {serial, resource_id: .state["resources.jobs.job_1"].__id__} .databricks/bundle/default/resources.json +{ + "serial": 1, + "resource_id": "[JOB_ID]" +} + +>>> assert_not_exists.py .databricks/bundle/default/resources.json.wal .databricks/bundle/default/resources.json.temp-bind + >>> [CLI] bundle deploy Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/my_project/default/files... Updated jobs.job_1 diff --git a/acceptance/bundle/deployment/bind/job/noop-job/script b/acceptance/bundle/deployment/bind/job/noop-job/script index adafb1c4da4..7a2f30eba35 100644 --- a/acceptance/bundle/deployment/bind/job/noop-job/script +++ b/acceptance/bundle/deployment/bind/job/noop-job/script @@ -2,6 +2,8 @@ job_id=$(trace $CLI jobs create --json '{"name": "My Job"}' | jq -r '.job_id') add_repl "$job_id" JOB_ID trace $CLI bundle deployment bind job_1 $job_id --auto-approve +trace jq '{serial, resource_id: .state["resources.jobs.job_1"].__id__}' .databricks/bundle/default/resources.json +trace assert_not_exists.py .databricks/bundle/default/resources.json.wal .databricks/bundle/default/resources.json.temp-bind trace $CLI bundle deploy 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..4b9965c0b0d 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 .databricks/bundle/default/resources.json.temp-bind + +>>> 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..bc19499567e 100644 --- a/acceptance/bundle/dms/bind-unbind/script +++ b/acceptance/bundle/dms/bind-unbind/script @@ -1,11 +1,27 @@ 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" +trace assert_not_exists.py .databricks/bundle/default/resources.json .databricks/bundle/default/resources.json.wal .databricks/bundle/default/resources.json.temp-bind +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 +30,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 c7d574f4431..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 @@ -83,7 +85,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-complete_version-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=7 Updated pipelines.bar Files: 6 uploaded, 0 deleted Resources: 0 created, 1 changed, 0 deleted, 1 unchanged @@ -102,7 +104,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-complete_version-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=11 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 Updated jobs.foo Updated pipelines.bar Files: 2 uploaded, 0 deleted 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/delete_deployment/output.txt b/acceptance/bundle/dms_fault/delete_deployment/output.txt index 8efdbc07a0d..34db7ea5d7d 100644 --- a/acceptance/bundle/dms_fault/delete_deployment/output.txt +++ b/acceptance/bundle/dms_fault/delete_deployment/output.txt @@ -82,7 +82,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-delete_deployment-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=7 Updated pipelines.bar Files: 6 uploaded, 0 deleted Resources: 0 created, 1 changed, 0 deleted, 1 unchanged @@ -100,7 +100,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-delete_deployment-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=11 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 Updated jobs.foo Updated pipelines.bar Files: 2 uploaded, 0 deleted diff --git a/acceptance/bundle/dms_fault/get_deployment/output.txt b/acceptance/bundle/dms_fault/get_deployment/output.txt index 0dda68edc1e..f13a4533a8e 100644 --- a/acceptance/bundle/dms_fault/get_deployment/output.txt +++ b/acceptance/bundle/dms_fault/get_deployment/output.txt @@ -56,6 +56,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 @@ -75,6 +78,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 @@ -91,7 +97,7 @@ Warn: retrying after 500 Internal Server Error from GET /api/2.0/bundle/deployments/[DEPLOYMENT_ID] Warn: Could not read deployment history: Fault injected by test. Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-get_deployment-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=7 Updated jobs.foo Updated pipelines.bar Files: 6 uploaded, 0 deleted @@ -113,7 +119,7 @@ Warn: retrying after 500 Internal Server Error from GET /api/2.0/bundle/deployments/[DEPLOYMENT_ID] Warn: Could not read deployment history: Fault injected by test. Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-get_deployment-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=11 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 Updated jobs.foo Files: 2 uploaded, 0 deleted Resources: 0 created, 1 changed, 0 deleted, 1 unchanged diff --git a/acceptance/bundle/dms_fault/get_operation/output.txt b/acceptance/bundle/dms_fault/get_operation/output.txt index 65498809a65..77a30f34331 100644 --- a/acceptance/bundle/dms_fault/get_operation/output.txt +++ b/acceptance/bundle/dms_fault/get_operation/output.txt @@ -82,7 +82,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-get_operation-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=7 Updated pipelines.bar Files: 6 uploaded, 0 deleted Resources: 0 created, 1 changed, 0 deleted, 1 unchanged @@ -100,7 +100,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-get_operation-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=11 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 Updated jobs.foo Updated pipelines.bar Files: 2 uploaded, 0 deleted diff --git a/acceptance/bundle/dms_fault/get_resource/output.txt b/acceptance/bundle/dms_fault/get_resource/output.txt index a562c0f5264..1f73acc8286 100644 --- a/acceptance/bundle/dms_fault/get_resource/output.txt +++ b/acceptance/bundle/dms_fault/get_resource/output.txt @@ -82,7 +82,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-get_resource-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=7 Updated pipelines.bar Files: 6 uploaded, 0 deleted Resources: 0 created, 1 changed, 0 deleted, 1 unchanged @@ -100,7 +100,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-get_resource-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=11 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 Updated jobs.foo Updated pipelines.bar Files: 2 uploaded, 0 deleted diff --git a/acceptance/bundle/dms_fault/get_version/output.txt b/acceptance/bundle/dms_fault/get_version/output.txt index b4473435fe9..e2207b8defb 100644 --- a/acceptance/bundle/dms_fault/get_version/output.txt +++ b/acceptance/bundle/dms_fault/get_version/output.txt @@ -82,7 +82,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-get_version-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=7 Updated pipelines.bar Files: 6 uploaded, 0 deleted Resources: 0 created, 1 changed, 0 deleted, 1 unchanged @@ -100,7 +100,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-get_version-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=11 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 Updated jobs.foo Updated pipelines.bar Files: 2 uploaded, 0 deleted diff --git a/acceptance/bundle/dms_fault/heartbeat/output.txt b/acceptance/bundle/dms_fault/heartbeat/output.txt index b512e794a75..239581a481a 100644 --- a/acceptance/bundle/dms_fault/heartbeat/output.txt +++ b/acceptance/bundle/dms_fault/heartbeat/output.txt @@ -82,7 +82,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-heartbeat-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=7 Updated pipelines.bar Files: 6 uploaded, 0 deleted Resources: 0 created, 1 changed, 0 deleted, 1 unchanged @@ -100,7 +100,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-heartbeat-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=11 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 Updated jobs.foo Updated pipelines.bar Files: 2 uploaded, 0 deleted diff --git a/acceptance/bundle/dms_fault/list_deployments/output.txt b/acceptance/bundle/dms_fault/list_deployments/output.txt index 0710bf48939..907f90146fc 100644 --- a/acceptance/bundle/dms_fault/list_deployments/output.txt +++ b/acceptance/bundle/dms_fault/list_deployments/output.txt @@ -82,7 +82,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-list_deployments-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=7 Updated pipelines.bar Files: 6 uploaded, 0 deleted Resources: 0 created, 1 changed, 0 deleted, 1 unchanged @@ -100,7 +100,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-list_deployments-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=11 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 Updated jobs.foo Updated pipelines.bar Files: 2 uploaded, 0 deleted diff --git a/acceptance/bundle/dms_fault/list_operations/output.txt b/acceptance/bundle/dms_fault/list_operations/output.txt index 5764b81d690..37eb784a030 100644 --- a/acceptance/bundle/dms_fault/list_operations/output.txt +++ b/acceptance/bundle/dms_fault/list_operations/output.txt @@ -82,7 +82,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-list_operations-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=7 Updated pipelines.bar Files: 6 uploaded, 0 deleted Resources: 0 created, 1 changed, 0 deleted, 1 unchanged @@ -100,7 +100,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-list_operations-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=11 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 Updated jobs.foo Updated pipelines.bar Files: 2 uploaded, 0 deleted diff --git a/acceptance/bundle/dms_fault/list_resources/output.txt b/acceptance/bundle/dms_fault/list_resources/output.txt index 9f45951b03a..ce7a141c620 100644 --- a/acceptance/bundle/dms_fault/list_resources/output.txt +++ b/acceptance/bundle/dms_fault/list_resources/output.txt @@ -82,7 +82,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-list_resources-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=7 Updated pipelines.bar Files: 6 uploaded, 0 deleted Resources: 0 created, 1 changed, 0 deleted, 1 unchanged @@ -100,7 +100,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-list_resources-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=11 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 Updated jobs.foo Updated pipelines.bar Files: 2 uploaded, 0 deleted diff --git a/acceptance/bundle/dms_fault/list_versions/output.txt b/acceptance/bundle/dms_fault/list_versions/output.txt index dabee52cbcd..bb5d8e97403 100644 --- a/acceptance/bundle/dms_fault/list_versions/output.txt +++ b/acceptance/bundle/dms_fault/list_versions/output.txt @@ -82,7 +82,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-list_versions-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=7 Updated pipelines.bar Files: 6 uploaded, 0 deleted Resources: 0 created, 1 changed, 0 deleted, 1 unchanged @@ -100,7 +100,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-list_versions-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=11 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 Updated jobs.foo Updated pipelines.bar Files: 2 uploaded, 0 deleted diff --git a/acceptance/bundle/dms_fault/update_operation/output.txt b/acceptance/bundle/dms_fault/update_operation/output.txt index 308345c48c4..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 @@ -83,7 +85,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-update_operation-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=7 Updated pipelines.bar Warn: Failed to record deployment history: recording operation for [RESOURCE_KEY]: Fault injected by test. Files: 6 uploaded, 0 deleted @@ -102,7 +104,7 @@ >>> bundle deploy --auto-approve Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/dms-fault-update_operation-commands-[UNIQUE_NAME]/files... - Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=11 + Current Deployment Version: [DATABRICKS_URL]/deployments/[DEPLOYMENT_ID]?version=9 Updated jobs.foo Updated pipelines.bar Warn: Failed to record deployment history: recording operation for [RESOURCE_KEY]: Fault injected by test. diff --git a/bundle/direct/bind.go b/bundle/direct/bind.go index 73852cdde00..711635b53ed 100644 --- a/bundle/direct/bind.go +++ b/bundle/direct/bind.go @@ -2,8 +2,10 @@ package direct import ( "context" + "encoding/json" "fmt" - "os" + "maps" + "slices" "strings" "github.com/databricks/cli/bundle/config" @@ -35,46 +37,29 @@ func (e ErrResourceAlreadyBound) Error() string { e.ResourceKey, e.ExistingID) } -// BindResult contains the result of a bind operation including any detected changes. -type BindResult struct { - // HasChanges is true if deploying after bind would make changes to the resource +// PreparedBind holds the state to save after approval and the preview of the next deploy. +type PreparedBind struct { + Resource dstate.ResourceEntry + // HasChanges is true if deploying after bind would make changes to the resource. HasChanges bool - // Action is the planned action for the bound resource (e.g., "skip", "update", "recreate") + // Action is the planned action for the bound resource (e.g., "skip", "update", "recreate"). Action deployplan.ActionType - // Plan contains the full deployment plan for the bound resource + // Plan contains the full deployment plan for the bound resource. Plan *deployplan.Plan - // TempStatePath is the path to the temporary state file - TempStatePath string - // StatePath is the path to the final state file - StatePath string } -// Bind adds an existing workspace resource to a temporary state and calculates -// if there will be any changes when deploying. -// -// Flow: -// 1. Load current state file -// 2. Update id of the target resource -// 3. Update state path to temp file (state file + ".temp-bind") -// 4. Perform plan + update to populate state with resolved config -// 5. Calculate plan again - this is the plan presented to the user -// -// Call Finalize to commit the state or Cancel to discard. -func (b *DeploymentBundle) Bind(ctx context.Context, client *databricks.WorkspaceClient, configRoot *config.Root, statePath, resourceKey, resourceID string) (*BindResult, error) { +// Bind prepares a binding in memory and previews the next deploy. The actual state stays +// open read-only; the caller must finalize it after committing the prepared resource or aborting. +func (b *DeploymentBundle) Bind(ctx context.Context, client *databricks.WorkspaceClient, configRoot *config.Root, statePath, resourceKey, resourceID string) (*PreparedBind, error) { // Check if the resource is already managed (bound to a different ID) - var checkStateDB dstate.DeploymentState - if err := checkStateDB.Open(ctx, statePath, dstate.ReadingFile, dstate.WithRecovery(true), dstate.OpenDmsArgs{}); err != nil { + if err := b.StateDB.Open(ctx, statePath, dstate.ReadingFile, dstate.WithRecovery(true), dstate.OpenDmsArgs{}); err != nil { // State that cannot be read is not the same as state without a binding: // the resource may well be managed already, and binding on top of it // would take over a resource whose ownership was never checked. A state // file that does not exist yet opens successfully as an empty one. return nil, fmt.Errorf("cannot check whether %s is already bound: %w", resourceKey, err) } - existingID := checkStateDB.GetResourceID(resourceKey) - if _, err := checkStateDB.Finalize(ctx); err != nil { - log.Warnf(ctx, "failed to finalize state: %v", err) - } - if existingID != "" { + if existingID := b.StateDB.GetResourceID(resourceKey); existingID != "" { return nil, ErrResourceAlreadyBound{ ResourceKey: resourceKey, ExistingID: existingID, @@ -82,64 +67,35 @@ func (b *DeploymentBundle) Bind(ctx context.Context, client *databricks.Workspac } } - tmpStatePath := statePath + ".temp-bind" - - // Copy existing state to temp location if it exists - if data, err := os.ReadFile(statePath); err == nil { - if err := os.WriteFile(tmpStatePath, data, 0o600); err != nil { - return nil, err + // Keep the planner's state, caches, and locks separate from the approved state. + data := b.StateDB.Data + data.Features = maps.Clone(data.Features) + data.State = make(map[string]dstate.ResourceEntry, len(b.StateDB.Data.State)+1) + for key, entry := range b.StateDB.Data.State { + entry.State = slices.Clone(entry.State) + entry.DependsOn = slices.Clone(entry.DependsOn) + data.State[key] = entry + } + data.State[resourceKey] = dstate.ResourceEntry{ID: resourceID, State: json.RawMessage(`{}`)} + preview := &DeploymentBundle{Adapters: b.Adapters} + preview.StateDB.OpenWithData(statePath, data) + defer func() { + if _, err := preview.StateDB.Finalize(ctx); err != nil { + log.Warnf(ctx, "failed to finalize binding preview: %v", err) } - } - - // Open temp state - err := b.StateDB.Open(ctx, tmpStatePath, dstate.ReadingFile, dstate.WithRecovery(false), dstate.OpenDmsArgs{}) - if err != nil { - os.Remove(tmpStatePath) - return nil, err - } - if err := b.StateDB.UpgradeToWrite(); err != nil { - os.Remove(tmpStatePath) - return nil, err - } - - // Save state with ID and empty state (like migrate does) - err = b.StateDB.SaveState(ctx, resourceKey, resourceID, struct{}{}, nil) - if err != nil { - os.Remove(tmpStatePath) - return nil, err - } - - // Finalize to persist temp state to disk - _, err = b.StateDB.Finalize(ctx) - if err != nil { - os.Remove(tmpStatePath) - return nil, err - } - - log.Infof(ctx, "Bound %s to id=%s (in temp state)", resourceKey, resourceID) + }() // First plan + update: populate state with resolved config - err = b.StateDB.Open(ctx, tmpStatePath, dstate.ReadingFile, dstate.WithRecovery(true), dstate.OpenDmsArgs{}) - if err != nil { - os.Remove(tmpStatePath) - return nil, err - } - plan, err := b.CalculatePlan(ctx, client, configRoot) + plan, err := preview.CalculatePlan(ctx, client, configRoot) if err != nil { - os.Remove(tmpStatePath) return nil, err } - if _, err := b.StateDB.Finalize(ctx); err != nil { - log.Warnf(ctx, "failed to finalize state: %v", err) - } - - // Populate the state with the resolved config entry := plan.Plan[resourceKey] - sv, ok := b.StateCache.Load(resourceKey) + sv, ok := preview.StateCache.Load(resourceKey) if ok && sv != nil { var dependsOn []deployplan.DependsOnEntry if entry != nil { - dependsOn = entry.DependsOn + dependsOn = slices.Clone(entry.DependsOn) } // Copy etag from remote state for resources that use etag-based drift @@ -157,64 +113,37 @@ func (b *DeploymentBundle) Bind(ctx context.Context, client *databricks.Workspac // Compact hashed_fields fields so the persisted state stays small. Not needed for // correctness — the next plan (CalculatePlan) compacts the saved state on read. - adapter, err := b.getAdapterForKey(resourceKey) + adapter, err := preview.getAdapterForKey(resourceKey) if err != nil { - os.Remove(tmpStatePath) return nil, err } compacted, err := dresources.CompactState(adapter.ResourceConfig(), sv.Value) if err != nil { - os.Remove(tmpStatePath) return nil, fmt.Errorf("compacting state: %w", err) } - err = b.StateDB.Open(ctx, tmpStatePath, dstate.ReadingFile, dstate.WithRecovery(true), dstate.OpenDmsArgs{}) - if err != nil { - os.Remove(tmpStatePath) - return nil, err - } - if err := b.StateDB.UpgradeToWrite(); err != nil { - os.Remove(tmpStatePath) - return nil, err - } - - err = b.StateDB.SaveState(ctx, resourceKey, resourceID, compacted, dependsOn) + state, err := json.Marshal(compacted) if err != nil { - os.Remove(tmpStatePath) - return nil, err - } - - _, err = b.StateDB.Finalize(ctx) - if err != nil { - os.Remove(tmpStatePath) return nil, err } + data.State[resourceKey] = dstate.ResourceEntry{ID: resourceID, State: state, DependsOn: dependsOn} } - // Second plan: this is the plan to present to the user (change between remote resource and config) - err = b.StateDB.Open(ctx, tmpStatePath, dstate.ReadingFile, dstate.WithRecovery(true), dstate.OpenDmsArgs{}) - if err != nil { - os.Remove(tmpStatePath) + // Capture unredacted state before the second plan replaces cached values. + resource := data.State[resourceKey] + resource.State = slices.Clone(resource.State) + resource.DependsOn = slices.Clone(resource.DependsOn) + if _, err := preview.StateDB.Finalize(ctx); err != nil { return nil, err } - plan, err = b.CalculatePlan(ctx, client, configRoot) - if _, ferr := b.StateDB.Finalize(ctx); ferr != nil { - log.Warnf(ctx, "failed to finalize state: %v", ferr) - } + preview.StateDB.OpenWithData(statePath, data) + + // Second plan: this is the plan to present to the user (change between remote resource and config) + plan, err = preview.CalculatePlan(ctx, client, configRoot) if err != nil { - os.Remove(tmpStatePath) return nil, err } - - // Check if the bound resource has changes - result := &BindResult{ - HasChanges: false, - Action: deployplan.Skip, - Plan: plan, - TempStatePath: tmpStatePath, - StatePath: statePath, - } - + result := &PreparedBind{Resource: resource, Action: deployplan.Skip, Plan: plan} entry = plan.Plan[resourceKey] if entry != nil { result.Action = entry.Action @@ -222,25 +151,9 @@ func (b *DeploymentBundle) Bind(ctx context.Context, client *databricks.Workspac // does not write), so it changes nothing remotely. result.HasChanges = result.Action != deployplan.Skip && result.Action != deployplan.Undefined && !entry.IsStateOnly() } - return result, nil } -// Finalize completes the bind operation by renaming the temp state to the final location. -func (result *BindResult) Finalize() error { - if result == nil || result.TempStatePath == "" { - return nil - } - return os.Rename(result.TempStatePath, result.StatePath) -} - -// Cancel cleans up temp state without committing changes. -func (result *BindResult) Cancel() { - if result != nil && result.TempStatePath != "" { - os.Remove(result.TempStatePath) - } -} - // 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 { diff --git a/bundle/direct/bind_test.go b/bundle/direct/bind_test.go new file mode 100644 index 00000000000..dca935a25ef --- /dev/null +++ b/bundle/direct/bind_test.go @@ -0,0 +1,86 @@ +package direct_test + +import ( + "encoding/json" + "os" + "path/filepath" + "testing" + + "github.com/databricks/cli/bundle/config" + "github.com/databricks/cli/bundle/deployplan" + "github.com/databricks/cli/bundle/direct" + "github.com/databricks/cli/bundle/direct/dstate" + "github.com/databricks/cli/libs/logdiag" + "github.com/databricks/cli/libs/structs/structvar" + "github.com/databricks/cli/libs/testserver" + "github.com/databricks/databricks-sdk-go" + "github.com/databricks/databricks-sdk-go/service/jobs" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +func TestBindPreparesIsolatedState(t *testing.T) { + ctx := logdiag.InitContext(t.Context()) + statePath := filepath.Join(t.TempDir(), "resources.json") + data := dstate.NewDatabase("lineage", 4) + data.Features = map[string]struct{}{dstate.FeatureDeploymentHistoryShadow: {}} + data.State["resources.jobs.kept"] = dstate.ResourceEntry{ + ID: "10", State: json.RawMessage(`{"name":"kept"}`), + DependsOn: []deployplan.DependsOnEntry{{Node: "resources.jobs.old"}}, + } + original, err := json.Marshal(data) + require.NoError(t, err) + require.NoError(t, os.WriteFile(statePath, original, 0o600)) + + server := testserver.New(t) + server.Handle("GET", "/api/2.2/jobs/get", func(req testserver.Request) any { + assert.NoFileExists(t, statePath+".wal") + assert.NoFileExists(t, statePath+".temp-bind") + actual, err := os.ReadFile(statePath) + require.NoError(t, err) + assert.Equal(t, original, actual) + if req.URL.Query().Get("job_id") == "10" { + return jobs.Job{JobId: 10, Settings: &jobs.JobSettings{Name: "kept"}} + } + return jobs.Job{JobId: 20, Settings: &jobs.JobSettings{Name: "remote"}} + }) + client, err := databricks.NewWorkspaceClient(&databricks.Config{Host: server.URL, Token: "testtoken"}) + require.NoError(t, err) + root, diags := config.LoadFromBytes("databricks.yml", []byte(`resources: + jobs: + kept: + name: kept + bound: + name: configured + tags: + other: ${resources.jobs.kept.id} +`)) + require.Empty(t, diags) + var b direct.DeploymentBundle + cached := structvar.NewStructVar(&jobs.JobSettings{Name: "original cache"}, nil) + b.StateCache.Store("resources.jobs.bound", cached) + b.RemoteStateCache.Store("resources.jobs.bound", "original remote cache") + + prepared, err := b.Bind(ctx, client, root, statePath, "resources.jobs.bound", "20") + require.NoError(t, err) + t.Cleanup(func() { + _, err := b.StateDB.Finalize(ctx) + require.NoError(t, err) + }) + require.False(t, logdiag.HasError(ctx)) + assert.Equal(t, data, b.StateDB.Data) + assert.Empty(t, b.StateDB.GetResourceID("resources.jobs.bound")) + assert.Equal(t, "10", b.StateDB.GetResourceID("resources.jobs.kept")) + assert.Nil(t, b.Plan) + actualCache, ok := b.StateCache.Load("resources.jobs.bound") + require.True(t, ok) + assert.Same(t, cached, actualCache) + remoteCache, ok := b.RemoteStateCache.Load("resources.jobs.bound") + require.True(t, ok) + assert.Equal(t, "original remote cache", remoteCache) + assert.Equal(t, "20", prepared.Resource.ID) + assert.JSONEq(t, `{"name":"configured","tags":{"other":"10"}}`, string(prepared.Resource.State)) + assert.Contains(t, prepared.Resource.DependsOn, deployplan.DependsOnEntry{Node: "resources.jobs.kept", Label: "${resources.jobs.kept.id}"}) + assert.True(t, prepared.HasChanges) + assert.Equal(t, deployplan.Update, prepared.Action) +} diff --git a/bundle/phases/bind.go b/bundle/phases/bind.go index 8f19f67a7fa..002ccbbaf53 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,28 @@ 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 files or stage an immutable snapshot, so it cannot report a deployed file path. + created, err := b.WorkspaceClient(ctx).BundleDeployments.CreateDeployment(ctx, bundledeployments.CreateDeploymentRequest{ + Deployment: bundledeployments.Deployment{ + DisplayName: b.Config.Bundle.Name, + TargetName: b.Config.Bundle.Target, + DeploymentMode: deploymentModeToSDK(b.Config.Bundle.Mode), + WorkspaceInfo: &bundledeployments.WorkspaceInfo{RootPath: b.Config.Workspace.RootPath}, + InitialParentPath: b.Config.Workspace.StatePath, + }, + }) + 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,7 +65,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)) }() @@ -59,7 +97,7 @@ func Bind(ctx context.Context, b *bundle.Bundle, opts *BindOptions, stateDesc *s } } - // Direct engine: import into temp state, run plan, check for changes. + // Prepare the binding without writing state until the plan is approved. resourceKey := fmt.Sprintf("resources.%s.%s", opts.Group, opts.ResourceKey) _, statePath := b.StateFilenameDirect(ctx) @@ -89,31 +127,49 @@ func Bind(ctx context.Context, b *bundle.Bundle, opts *BindOptions, stateDesc *s } if !cmdio.IsPromptSupported(ctx) { - result.Cancel() logdiag.LogError(ctx, fmt.Errorf("this bind operation requires user confirmation, but the current console does not support prompting.\nTo proceed, use --auto-approve after reviewing the plan above.%s", agent.AgentNotice())) return } ans, err := cmdio.AskYesOrNo(ctx, "Confirm import changes? Changes will be remotely applied only after running 'bundle deploy'.") if err != nil { - result.Cancel() logdiag.LogError(ctx, err) return } if !ans { - result.Cancel() logdiag.LogError(ctx, errors.New("import aborted")) return } } - // Finalize: rename temp state to final location - err = result.Finalize() - if err != nil { + 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) + return + } + if _, err := db.Finalize(ctx); err != nil { logdiag.LogError(ctx, err) return } - statemgmt.PushResourcesState(ctx, b) } @@ -155,3 +211,27 @@ 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.LookupDeployment(ctx, b.WorkspaceClient(ctx), b.Config.Workspace.StatePath) + if err != nil { + return err + } + previous, err := dms.ParseLastVersionID(current) + if err != nil { + return err + } + 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) +} diff --git a/cmd/bundle/utils/process.go b/cmd/bundle/utils/process.go index 68798a4bb01..0f866174802 100644 --- a/cmd/bundle/utils/process.go +++ b/cmd/bundle/utils/process.go @@ -4,10 +4,8 @@ import ( "context" "errors" "fmt" - "path" "path/filepath" "slices" - "strconv" "time" "github.com/databricks/cli/bundle" @@ -32,14 +30,10 @@ import ( "github.com/databricks/cli/libs/dyn" "github.com/databricks/cli/libs/log" "github.com/databricks/cli/libs/logdiag" - "github.com/databricks/cli/libs/retry" "github.com/databricks/cli/libs/sync" "github.com/databricks/cli/libs/telemetry" "github.com/databricks/cli/libs/telemetry/protos" - "github.com/databricks/databricks-sdk-go" - "github.com/databricks/databricks-sdk-go/apierr" "github.com/databricks/databricks-sdk-go/service/bundledeployments" - "github.com/databricks/databricks-sdk-go/service/workspace" "github.com/databricks/databricks-sdk-go/useragent" "github.com/spf13/cobra" "golang.org/x/mod/semver" @@ -411,7 +405,7 @@ func ProcessBundleRet(cmd *cobra.Command, opts ProcessOptions) (b *bundle.Bundle if needDirectState && stateMode == dstate.WritingDeploymentHistoryOnly { var err error - dmsDeploymentID, dmsDeployment, err = fetchDeploymentFromStatePath(ctx, b.WorkspaceClient(ctx), b.Config.Workspace.StatePath) + dmsDeploymentID, dmsDeployment, err = dms.LookupDeployment(ctx, b.WorkspaceClient(ctx), b.Config.Workspace.StatePath) if err != nil { logdiag.LogError(ctx, err) return b, stateDesc, root.ErrAlreadyPrinted @@ -421,7 +415,7 @@ func ProcessBundleRet(cmd *cobra.Command, opts ProcessOptions) (b *bundle.Bundle // the plan carries them. version_id is always known (last recorded + 1); deployment_id // does not exist until a first deploy creates it, so it is left off here and the deploy // phase stamps the created id. - lastVersionID, err := parseLastVersionID(dmsDeployment) + lastVersionID, err := dms.ParseLastVersionID(dmsDeployment) if err != nil { logdiag.LogError(ctx, err) return b, stateDesc, root.ErrAlreadyPrinted @@ -637,53 +631,6 @@ func ValidateEngineSetting(ctx context.Context, b *bundle.Bundle) error { return nil } -// Lookup and return the deployment object from ${workspace.state_path}/resources.deployment.json -// -// TODO: a deployment is only usable when both the node and the service's record exist, and a -// half-created one - node present, record missing - blocks the bundle here even though -// CreateDeployment already recovers from it. Move this behind a dms.ReadDeployment(ctx, statePath) -// that returns an empty id and version unless both halves are there, leaving the caller to call -// CreateDeployment to create or finalize it. -// -// TODO: ask the service for a lookup by state path, so this is one round trip rather than two - a -// workspace lookup to turn the node into an id, then a get by that id. -func fetchDeploymentFromStatePath(ctx context.Context, w *databricks.WorkspaceClient, statePath string) (string, *bundledeployments.Deployment, error) { - nodePath := path.Join(statePath, dms.DeploymentNodeName) - - obj, err := retry.With(ctx, retry.IsTransientRead, func() (*workspace.ObjectInfo, error) { - return w.Workspace.GetStatusByPath(ctx, nodePath) - }) - if errors.Is(err, apierr.ErrNotFound) || errors.Is(err, apierr.ErrResourceDoesNotExist) { - return "", nil, nil - } - if err != nil { - return "", nil, fmt.Errorf("looking up deployment at %s: %w", nodePath, err) - } - deploymentID := strconv.FormatInt(obj.ObjectId, 10) - deployment, err := retry.With(ctx, retry.IsTransientRead, func() (*bundledeployments.Deployment, error) { - return w.BundleDeployments.GetDeployment(ctx, bundledeployments.GetDeploymentRequest{ - Name: dms.DeploymentName(deploymentID), - }) - }) - if err != nil { - return "", nil, err - } - return deploymentID, deployment, nil -} - -// parseLastVersionID parses the deployment's last recorded version, which the service reports -// as a string. It returns 0 when the deployment does not exist yet or has no recorded version. -func parseLastVersionID(dmsDeployment *bundledeployments.Deployment) (int, error) { - if dmsDeployment == nil || dmsDeployment.LastVersionId == "" { - return 0, nil - } - v, err := strconv.Atoi(dmsDeployment.LastVersionId) - if err != nil { - return 0, fmt.Errorf("failed to parse last_version_id %q: %w", dmsDeployment.LastVersionId, err) - } - return v, nil -} - // OpenDirectStateForRead opens the direct-engine state database read-only. When the bundle // records deployment history the local state file is only a tombstone, so the resources are // read from the deployment metadata service instead. @@ -696,11 +643,11 @@ func OpenDirectStateForRead(ctx context.Context, b *bundle.Bundle, stateDesc *st return nil } - dmsDeploymentID, dmsDeployment, err := fetchDeploymentFromStatePath(ctx, b.WorkspaceClient(ctx), b.Config.Workspace.StatePath) + dmsDeploymentID, dmsDeployment, err := dms.LookupDeployment(ctx, b.WorkspaceClient(ctx), b.Config.Workspace.StatePath) if err != nil { return err } - lastVersionID, err := parseLastVersionID(dmsDeployment) + lastVersionID, err := dms.ParseLastVersionID(dmsDeployment) if err != nil { return err } @@ -716,11 +663,11 @@ func OpenDirectStateForRead(ctx context.Context, b *bundle.Bundle, stateDesc *st // prepareDeploymentHistoryShadow reads version metadata, never resource state, from DMS. func prepareDeploymentHistoryShadow(ctx context.Context, b *bundle.Bundle) (*bundledeployments.Deployment, error) { - id, deployment, err := fetchDeploymentFromStatePath(ctx, b.WorkspaceClient(ctx), b.Config.Workspace.StatePath) + id, deployment, err := dms.LookupDeployment(ctx, b.WorkspaceClient(ctx), b.Config.Workspace.StatePath) if err != nil { return nil, err } - lastVersion, err := parseLastVersionID(deployment) + lastVersion, err := dms.ParseLastVersionID(deployment) if err != nil { return nil, err } diff --git a/cmd/bundle/utils/process_test.go b/cmd/bundle/utils/process_test.go index 21910039344..b05fb9b0a84 100644 --- a/cmd/bundle/utils/process_test.go +++ b/cmd/bundle/utils/process_test.go @@ -3,6 +3,7 @@ package utils import ( "testing" + "github.com/databricks/cli/libs/dms" "github.com/databricks/databricks-sdk-go/service/bundledeployments" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" @@ -61,7 +62,7 @@ func TestParseLastVersionID(t *testing.T) { for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - got, err := parseLastVersionID(tt.deployment) + got, err := dms.ParseLastVersionID(tt.deployment) if tt.wantErr { require.Error(t, err) return diff --git a/libs/dms/metadata.go b/libs/dms/metadata.go index f9e23a67db0..98010ac7b6f 100644 --- a/libs/dms/metadata.go +++ b/libs/dms/metadata.go @@ -1,12 +1,19 @@ package dms import ( + "context" + "errors" "fmt" + "path" "strconv" "strings" + "github.com/databricks/cli/libs/retry" "github.com/databricks/cli/libs/structs/structdiff" + "github.com/databricks/databricks-sdk-go" + "github.com/databricks/databricks-sdk-go/apierr" "github.com/databricks/databricks-sdk-go/service/bundledeployments" + "github.com/databricks/databricks-sdk-go/service/workspace" ) // VersionType identifies the kind of deployment a version records. @@ -68,6 +75,19 @@ func (m Metadata) StaleFields(current *bundledeployments.Deployment) string { return strings.Join(stale, ",") } +// ParseLastVersionID parses the deployment's last recorded version, which the service reports +// as a string. It returns 0 when the deployment does not exist yet or has no recorded version. +func ParseLastVersionID(dmsDeployment *bundledeployments.Deployment) (int, error) { + if dmsDeployment == nil || dmsDeployment.LastVersionId == "" { + return 0, nil + } + v, err := strconv.Atoi(dmsDeployment.LastVersionId) + if err != nil { + return 0, fmt.Errorf("failed to parse last_version_id %q: %w", dmsDeployment.LastVersionId, err) + } + return v, nil +} + // NextVersion is the version number this run will create, given the deployment's most recent // one. lastVersionID is empty before the deployment has any version. func NextVersion(lastVersionID string) (int, error) { @@ -132,3 +152,40 @@ func DeploymentUpdate(metadata Metadata, mask string) bundledeployments.Deployme } return dep } + +// LookupDeployment resolves the deployment node under statePath and reads its DMS record. +// A missing workspace node returns no deployment. +// +// Lookup and return the deployment object from ${workspace.state_path}/resources.deployment.json +// +// TODO: a deployment is only usable when both the node and the service's record exist, and a +// half-created one - node present, record missing - blocks the bundle here even though +// CreateDeployment already recovers from it. Move this behind a dms.ReadDeployment(ctx, statePath) +// that returns an empty id and version unless both halves are there, leaving the caller to call +// CreateDeployment to create or finalize it. +// +// TODO: ask the service for a lookup by state path, so this is one round trip rather than two - a +// workspace lookup to turn the node into an id, then a get by that id. +func LookupDeployment(ctx context.Context, w *databricks.WorkspaceClient, statePath string) (string, *bundledeployments.Deployment, error) { + nodePath := path.Join(statePath, DeploymentNodeName) + + obj, err := retry.With(ctx, retry.IsTransientRead, func() (*workspace.ObjectInfo, error) { + return w.Workspace.GetStatusByPath(ctx, nodePath) + }) + if errors.Is(err, apierr.ErrNotFound) || errors.Is(err, apierr.ErrResourceDoesNotExist) { + return "", nil, nil + } + if err != nil { + return "", nil, fmt.Errorf("looking up deployment at %s: %w", nodePath, err) + } + deploymentID := strconv.FormatInt(obj.ObjectId, 10) + deployment, err := retry.With(ctx, retry.IsTransientRead, func() (*bundledeployments.Deployment, error) { + return w.BundleDeployments.GetDeployment(ctx, bundledeployments.GetDeploymentRequest{ + Name: DeploymentName(deploymentID), + }) + }) + if err != nil { + return "", nil, err + } + return deploymentID, deployment, nil +}