From 2495c84d5235b6a9b41e966b69121c015e2aec27 Mon Sep 17 00:00:00 2001 From: "denis.bilenko" Date: Wed, 18 Nov 2026 13:56:10 +0000 Subject: [PATCH 1/4] Add acceptance tests for the engine user-agent tag on a terraform state Record which engine tag each request carries when a bundle still has terraform state: - race: the local terraform state disappears between the state pull and the auto-migration (as with two concurrent deploys). The deploy is tagged engine/terraform and then panics. - bind-unbind: pull-only commands tag engine/terraform before rejecting the terraform state. - engine-pinned: a terraform engine pinned via DATABRICKS_BUNDLE_ENGINE or bundle.engine. Co-authored-by: Isaac --- .../user-agent/bind-unbind/databricks.yml | 7 ++ .../user-agent/bind-unbind/out.test.toml | 2 + .../migrate/user-agent/bind-unbind/output.txt | 35 ++++++ .../migrate/user-agent/bind-unbind/script | 16 +++ .../bind-unbind/terraform-requests.json | 19 +++ .../user-agent/bind-unbind/terraform.tfstate | 110 ++++++++++++++++++ .../user-agent/engine-pinned/databricks.yml | 7 ++ .../user-agent/engine-pinned/out.test.toml | 2 + .../user-agent/engine-pinned/output.txt | 43 +++++++ .../migrate/user-agent/engine-pinned/script | 21 ++++ .../engine-pinned/terraform-requests.json | 19 +++ .../engine-pinned/terraform.tfstate | 110 ++++++++++++++++++ .../migrate/user-agent/race/databricks.yml | 13 +++ .../migrate/user-agent/race/out.test.toml | 2 + .../bundle/migrate/user-agent/race/output.txt | 18 +++ .../bundle/migrate/user-agent/race/script | 10 ++ .../user-agent/race/terraform-requests.json | 19 +++ .../migrate/user-agent/race/terraform.tfstate | 110 ++++++++++++++++++ .../bundle/migrate/user-agent/script.prepare | 4 + 19 files changed, 567 insertions(+) create mode 100644 acceptance/bundle/migrate/user-agent/bind-unbind/databricks.yml create mode 100644 acceptance/bundle/migrate/user-agent/bind-unbind/out.test.toml create mode 100644 acceptance/bundle/migrate/user-agent/bind-unbind/output.txt create mode 100644 acceptance/bundle/migrate/user-agent/bind-unbind/script create mode 100644 acceptance/bundle/migrate/user-agent/bind-unbind/terraform-requests.json create mode 100644 acceptance/bundle/migrate/user-agent/bind-unbind/terraform.tfstate create mode 100644 acceptance/bundle/migrate/user-agent/engine-pinned/databricks.yml create mode 100644 acceptance/bundle/migrate/user-agent/engine-pinned/out.test.toml create mode 100644 acceptance/bundle/migrate/user-agent/engine-pinned/output.txt create mode 100644 acceptance/bundle/migrate/user-agent/engine-pinned/script create mode 100644 acceptance/bundle/migrate/user-agent/engine-pinned/terraform-requests.json create mode 100644 acceptance/bundle/migrate/user-agent/engine-pinned/terraform.tfstate create mode 100644 acceptance/bundle/migrate/user-agent/race/databricks.yml create mode 100644 acceptance/bundle/migrate/user-agent/race/out.test.toml create mode 100644 acceptance/bundle/migrate/user-agent/race/output.txt create mode 100644 acceptance/bundle/migrate/user-agent/race/script create mode 100644 acceptance/bundle/migrate/user-agent/race/terraform-requests.json create mode 100644 acceptance/bundle/migrate/user-agent/race/terraform.tfstate create mode 100644 acceptance/bundle/migrate/user-agent/script.prepare diff --git a/acceptance/bundle/migrate/user-agent/bind-unbind/databricks.yml b/acceptance/bundle/migrate/user-agent/bind-unbind/databricks.yml new file mode 100644 index 00000000000..8eed9482e74 --- /dev/null +++ b/acceptance/bundle/migrate/user-agent/bind-unbind/databricks.yml @@ -0,0 +1,7 @@ +bundle: + name: test-bundle + +resources: + jobs: + test_job: + name: "Test Auto-Migrate Plan Failure" diff --git a/acceptance/bundle/migrate/user-agent/bind-unbind/out.test.toml b/acceptance/bundle/migrate/user-agent/bind-unbind/out.test.toml new file mode 100644 index 00000000000..19b5b15d11f --- /dev/null +++ b/acceptance/bundle/migrate/user-agent/bind-unbind/out.test.toml @@ -0,0 +1,2 @@ +Cloud = false +EnvMatrix.DMS = [""] diff --git a/acceptance/bundle/migrate/user-agent/bind-unbind/output.txt b/acceptance/bundle/migrate/user-agent/bind-unbind/output.txt new file mode 100644 index 00000000000..20164152ea8 --- /dev/null +++ b/acceptance/bundle/migrate/user-agent/bind-unbind/output.txt @@ -0,0 +1,35 @@ + +=== Replay a prior terraform deployment + +>>> replay_tfstate.py terraform-requests.json terraform.tfstate + +=== bind on a terraform state + +>>> musterr [CLI] bundle deployment bind test_job [TEST_JOB_ID] --auto-approve +Error: this deployment's state uses the Terraform engine, which has been removed in Databricks CLI v1.20.0 + +Run "databricks bundle deploy" to migrate the state to the direct engine, or install Databricks CLI v1.19.x + + +>>> print_engines + 2 MISSING GET /api/2.0/workspace/export + 2 engine/terraform GET /api/2.0/workspace/export + 3 engine/terraform GET /api/2.0/workspace/get-status + 1 engine/terraform GET /api/2.2/jobs/get + 1 engine/terraform POST /api/2.0/workspace-files/import-file/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/state/deploy.lock + 1 engine/terraform POST /api/2.0/workspace/delete + +=== unbind on a terraform state + +>>> musterr [CLI] bundle deployment unbind test_job +Error: this deployment's state uses the Terraform engine, which has been removed in Databricks CLI v1.20.0 + +Run "databricks bundle deploy" to migrate the state to the direct engine, or install Databricks CLI v1.19.x + + +>>> print_engines + 2 MISSING GET /api/2.0/workspace/export + 2 engine/terraform GET /api/2.0/workspace/export + 3 engine/terraform GET /api/2.0/workspace/get-status + 1 engine/terraform POST /api/2.0/workspace-files/import-file/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/state/deploy.lock + 1 engine/terraform POST /api/2.0/workspace/delete diff --git a/acceptance/bundle/migrate/user-agent/bind-unbind/script b/acceptance/bundle/migrate/user-agent/bind-unbind/script new file mode 100644 index 00000000000..1f3caf375f6 --- /dev/null +++ b/acceptance/bundle/migrate/user-agent/bind-unbind/script @@ -0,0 +1,16 @@ +export DATABRICKS_BUNDLE_ENGINE= + +title "Replay a prior terraform deployment" +trace replay_tfstate.py terraform-requests.json terraform.tfstate +replace_ids.py +rm -f "$OUT_REQUESTS" +JOB_ID=$(jq -r '.resources[] | select(.type == "databricks_job") | .instances[0].attributes.id' .databricks/bundle/default/terraform/terraform.tfstate) + +# bind and unbind only pull the state, so a terraform state is not migrated and they reject it. +title "bind on a terraform state" +trace musterr $CLI bundle deployment bind test_job "$JOB_ID" --auto-approve +trace print_engines + +title "unbind on a terraform state" +trace musterr $CLI bundle deployment unbind test_job +trace print_engines diff --git a/acceptance/bundle/migrate/user-agent/bind-unbind/terraform-requests.json b/acceptance/bundle/migrate/user-agent/bind-unbind/terraform-requests.json new file mode 100644 index 00000000000..514877afead --- /dev/null +++ b/acceptance/bundle/migrate/user-agent/bind-unbind/terraform-requests.json @@ -0,0 +1,19 @@ +[ + { + "method": "POST", + "path": "/api/2.2/jobs/create", + "body": { + "deployment": { + "kind": "BUNDLE", + "metadata_file_path": "/Workspace/Users/tester@databricks.com/.bundle/test-bundle/default/state/metadata.json" + }, + "edit_mode": "UI_LOCKED", + "format": "MULTI_TASK", + "max_concurrent_runs": 1, + "name": "Test Auto-Migrate Plan Failure", + "queue": { + "enabled": true + } + } + } +] diff --git a/acceptance/bundle/migrate/user-agent/bind-unbind/terraform.tfstate b/acceptance/bundle/migrate/user-agent/bind-unbind/terraform.tfstate new file mode 100644 index 00000000000..5f749b73a1d --- /dev/null +++ b/acceptance/bundle/migrate/user-agent/bind-unbind/terraform.tfstate @@ -0,0 +1,110 @@ +{ + "version": 4, + "terraform_version": "1.5.5", + "serial": 1, + "lineage": "115ec518-3f72-3614-4e56-01411863558a", + "outputs": {}, + "resources": [ + { + "mode": "managed", + "type": "databricks_job", + "name": "test_job", + "provider": "provider[\"registry.terraform.io/databricks/databricks\"]", + "instances": [ + { + "schema_version": 2, + "attributes": { + "always_running": false, + "budget_policy_id": null, + "continuous": [], + "control_run_state": false, + "dbt_task": [], + "deployment": [ + { + "deployment_id": "", + "kind": "BUNDLE", + "metadata_file_path": "/Workspace/Users/tester@databricks.com/.bundle/test-bundle/default/state/metadata.json", + "version_id": "" + } + ], + "description": null, + "edit_mode": "UI_LOCKED", + "email_notifications": [ + { + "no_alert_for_skipped_runs": false, + "on_duration_warning_threshold_exceeded": [], + "on_failure": [], + "on_start": [], + "on_streaming_backlog_exceeded": [], + "on_success": [] + } + ], + "environment": [], + "existing_cluster_id": null, + "format": "MULTI_TASK", + "git_source": [], + "health": [], + "id": "8790613902942848000", + "job_cluster": [], + "library": [], + "max_concurrent_runs": 1, + "max_retries": 0, + "min_retry_interval_millis": 0, + "name": "Test Auto-Migrate Plan Failure", + "new_cluster": [], + "notebook_task": [], + "notification_settings": [], + "parameter": [], + "parent_path": null, + "performance_target": null, + "pipeline_task": [], + "provider_config": [ + { + "workspace_id": "900800700600" + } + ], + "python_wheel_task": [], + "queue": [ + { + "enabled": true + } + ], + "retry_on_timeout": false, + "run_as": [ + { + "group_name": "", + "service_principal_name": "", + "user_name": "tester@databricks.com" + } + ], + "run_job_task": [], + "schedule": [], + "spark_jar_task": [], + "spark_python_task": [], + "spark_submit_task": [], + "tags": null, + "task": [], + "timeout_seconds": 0, + "timeouts": null, + "trigger": [], + "triggers": [], + "url": "[DATABRICKS_URL]/#job/8790613902942848000", + "usage_policy_id": null, + "webhook_notifications": [ + { + "on_duration_warning_threshold_exceeded": [], + "on_failure": [], + "on_start": [], + "on_streaming_backlog_exceeded": [], + "on_success": [] + } + ] + }, + "sensitive_attributes": [], + "private": "eyJlMmJmYjczMC1lY2FhLTExZTYtOGY4OC0zNDM2M2JjN2M0YzAiOnsiY3JlYXRlIjoxODAwMDAwMDAwMDAwLCJ1cGRhdGUiOjE4MDAwMDAwMDAwMDB9LCJzY2hlbWFfdmVyc2lvbiI6IjIifQ==" + } + ] + } + ], + "check_results": null +} diff --git a/acceptance/bundle/migrate/user-agent/engine-pinned/databricks.yml b/acceptance/bundle/migrate/user-agent/engine-pinned/databricks.yml new file mode 100644 index 00000000000..8eed9482e74 --- /dev/null +++ b/acceptance/bundle/migrate/user-agent/engine-pinned/databricks.yml @@ -0,0 +1,7 @@ +bundle: + name: test-bundle + +resources: + jobs: + test_job: + name: "Test Auto-Migrate Plan Failure" diff --git a/acceptance/bundle/migrate/user-agent/engine-pinned/out.test.toml b/acceptance/bundle/migrate/user-agent/engine-pinned/out.test.toml new file mode 100644 index 00000000000..19b5b15d11f --- /dev/null +++ b/acceptance/bundle/migrate/user-agent/engine-pinned/out.test.toml @@ -0,0 +1,2 @@ +Cloud = false +EnvMatrix.DMS = [""] diff --git a/acceptance/bundle/migrate/user-agent/engine-pinned/output.txt b/acceptance/bundle/migrate/user-agent/engine-pinned/output.txt new file mode 100644 index 00000000000..5f5d93222e2 --- /dev/null +++ b/acceptance/bundle/migrate/user-agent/engine-pinned/output.txt @@ -0,0 +1,43 @@ + +=== Replay a prior terraform deployment + +>>> replay_tfstate.py terraform-requests.json terraform.tfstate + +=== deploy with DATABRICKS_BUNDLE_ENGINE=terraform + +>>> DATABRICKS_BUNDLE_ENGINE=terraform musterr [CLI] bundle deploy +Error: the Terraform deployment engine has been removed in Databricks CLI v1.20.0 + +Unset the DATABRICKS_BUNDLE_ENGINE environment variable (or set it to "direct") to deploy with the direct engine; existing Terraform state is migrated automatically. To keep using Terraform, revert to Databricks CLI v1.19.x. +See https://docs.databricks.com/dev-tools/bundles/direct for details + +>>> print_engines + 1 MISSING POST /telemetry-ext + +=== deploy with bundle.engine: terraform + +>>> musterr [CLI] bundle deploy +Error: the Terraform deployment engine has been removed in Databricks CLI v1.20.0 + in databricks.yml:3:11 + +Remove the "bundle.engine" setting (or set it to "direct") to deploy with the direct engine; existing Terraform state is migrated automatically. To keep using Terraform, revert to Databricks CLI v1.19.x. +See https://docs.databricks.com/dev-tools/bundles/direct for details + + +>>> print_engines + 1 MISSING POST /telemetry-ext + +=== summary with bundle.engine: terraform + +>>> [CLI] bundle summary +Warning: the Terraform deployment engine has been removed in Databricks CLI v1.20.0 + in databricks.yml:3:11 + +Remove the "bundle.engine" setting (or set it to "direct") to deploy with the direct engine; existing Terraform state is migrated automatically. To keep using Terraform, revert to Databricks CLI v1.19.x. +See https://docs.databricks.com/dev-tools/bundles/direct for details + +Notice: migrating your bundle to direct deployment engine (https://github.com/databricks/cli/issues/6765). + +>>> print_engines + 1 MISSING GET /api/2.2/jobs/get + 1 engine/direct GET /api/2.0/preview/scim/v2/Me diff --git a/acceptance/bundle/migrate/user-agent/engine-pinned/script b/acceptance/bundle/migrate/user-agent/engine-pinned/script new file mode 100644 index 00000000000..751a5bee2af --- /dev/null +++ b/acceptance/bundle/migrate/user-agent/engine-pinned/script @@ -0,0 +1,21 @@ +export DATABRICKS_BUNDLE_ENGINE= + +title "Replay a prior terraform deployment" +trace replay_tfstate.py terraform-requests.json terraform.tfstate +replace_ids.py +rm -f "$OUT_REQUESTS" + +title "deploy with DATABRICKS_BUNDLE_ENGINE=terraform" +trace DATABRICKS_BUNDLE_ENGINE=terraform musterr $CLI bundle deploy +trace print_engines + +title "deploy with bundle.engine: terraform" +update_file.py databricks.yml ' name: test-bundle' ' name: test-bundle + engine: terraform' +trace musterr $CLI bundle deploy +trace print_engines + +# summary allows a terraform bundle.engine (warning only) and migrates the state in memory. +title "summary with bundle.engine: terraform" +trace $CLI bundle summary > /dev/null +trace print_engines diff --git a/acceptance/bundle/migrate/user-agent/engine-pinned/terraform-requests.json b/acceptance/bundle/migrate/user-agent/engine-pinned/terraform-requests.json new file mode 100644 index 00000000000..514877afead --- /dev/null +++ b/acceptance/bundle/migrate/user-agent/engine-pinned/terraform-requests.json @@ -0,0 +1,19 @@ +[ + { + "method": "POST", + "path": "/api/2.2/jobs/create", + "body": { + "deployment": { + "kind": "BUNDLE", + "metadata_file_path": "/Workspace/Users/tester@databricks.com/.bundle/test-bundle/default/state/metadata.json" + }, + "edit_mode": "UI_LOCKED", + "format": "MULTI_TASK", + "max_concurrent_runs": 1, + "name": "Test Auto-Migrate Plan Failure", + "queue": { + "enabled": true + } + } + } +] diff --git a/acceptance/bundle/migrate/user-agent/engine-pinned/terraform.tfstate b/acceptance/bundle/migrate/user-agent/engine-pinned/terraform.tfstate new file mode 100644 index 00000000000..5f749b73a1d --- /dev/null +++ b/acceptance/bundle/migrate/user-agent/engine-pinned/terraform.tfstate @@ -0,0 +1,110 @@ +{ + "version": 4, + "terraform_version": "1.5.5", + "serial": 1, + "lineage": "115ec518-3f72-3614-4e56-01411863558a", + "outputs": {}, + "resources": [ + { + "mode": "managed", + "type": "databricks_job", + "name": "test_job", + "provider": "provider[\"registry.terraform.io/databricks/databricks\"]", + "instances": [ + { + "schema_version": 2, + "attributes": { + "always_running": false, + "budget_policy_id": null, + "continuous": [], + "control_run_state": false, + "dbt_task": [], + "deployment": [ + { + "deployment_id": "", + "kind": "BUNDLE", + "metadata_file_path": "/Workspace/Users/tester@databricks.com/.bundle/test-bundle/default/state/metadata.json", + "version_id": "" + } + ], + "description": null, + "edit_mode": "UI_LOCKED", + "email_notifications": [ + { + "no_alert_for_skipped_runs": false, + "on_duration_warning_threshold_exceeded": [], + "on_failure": [], + "on_start": [], + "on_streaming_backlog_exceeded": [], + "on_success": [] + } + ], + "environment": [], + "existing_cluster_id": null, + "format": "MULTI_TASK", + "git_source": [], + "health": [], + "id": "8790613902942848000", + "job_cluster": [], + "library": [], + "max_concurrent_runs": 1, + "max_retries": 0, + "min_retry_interval_millis": 0, + "name": "Test Auto-Migrate Plan Failure", + "new_cluster": [], + "notebook_task": [], + "notification_settings": [], + "parameter": [], + "parent_path": null, + "performance_target": null, + "pipeline_task": [], + "provider_config": [ + { + "workspace_id": "900800700600" + } + ], + "python_wheel_task": [], + "queue": [ + { + "enabled": true + } + ], + "retry_on_timeout": false, + "run_as": [ + { + "group_name": "", + "service_principal_name": "", + "user_name": "tester@databricks.com" + } + ], + "run_job_task": [], + "schedule": [], + "spark_jar_task": [], + "spark_python_task": [], + "spark_submit_task": [], + "tags": null, + "task": [], + "timeout_seconds": 0, + "timeouts": null, + "trigger": [], + "triggers": [], + "url": "[DATABRICKS_URL]/#job/8790613902942848000", + "usage_policy_id": null, + "webhook_notifications": [ + { + "on_duration_warning_threshold_exceeded": [], + "on_failure": [], + "on_start": [], + "on_streaming_backlog_exceeded": [], + "on_success": [] + } + ] + }, + "sensitive_attributes": [], + "private": "eyJlMmJmYjczMC1lY2FhLTExZTYtOGY4OC0zNDM2M2JjN2M0YzAiOnsiY3JlYXRlIjoxODAwMDAwMDAwMDAwLCJ1cGRhdGUiOjE4MDAwMDAwMDAwMDB9LCJzY2hlbWFfdmVyc2lvbiI6IjIifQ==" + } + ] + } + ], + "check_results": null +} diff --git a/acceptance/bundle/migrate/user-agent/race/databricks.yml b/acceptance/bundle/migrate/user-agent/race/databricks.yml new file mode 100644 index 00000000000..cd06518a480 --- /dev/null +++ b/acceptance/bundle/migrate/user-agent/race/databricks.yml @@ -0,0 +1,13 @@ +bundle: + name: test-bundle + +experimental: + scripts: + # Simulates a concurrent deploy migrating the state: postbuild runs after the state pull and + # before the auto-migration, so the migration finds no local terraform state. + postbuild: rm -f .databricks/bundle/default/terraform/terraform.tfstate + +resources: + jobs: + test_job: + name: "Test Auto-Migrate Plan Failure" diff --git a/acceptance/bundle/migrate/user-agent/race/out.test.toml b/acceptance/bundle/migrate/user-agent/race/out.test.toml new file mode 100644 index 00000000000..19b5b15d11f --- /dev/null +++ b/acceptance/bundle/migrate/user-agent/race/out.test.toml @@ -0,0 +1,2 @@ +Cloud = false +EnvMatrix.DMS = [""] diff --git a/acceptance/bundle/migrate/user-agent/race/output.txt b/acceptance/bundle/migrate/user-agent/race/output.txt new file mode 100644 index 00000000000..80a81191363 --- /dev/null +++ b/acceptance/bundle/migrate/user-agent/race/output.txt @@ -0,0 +1,18 @@ + +=== Replay a prior terraform deployment + +>>> replay_tfstate.py terraform-requests.json terraform.tfstate + +=== Deploy where the local terraform state disappears between the pull and the migration +Panic Payload: internal error: DeploymentState must be opened first +Exit code: 1 + +>>> print_engines + 2 MISSING GET /api/2.0/workspace/export + 3 engine/terraform GET /api/2.0/workspace/export + 4 engine/terraform GET /api/2.0/workspace/get-status + 1 engine/terraform POST /api/2.0/workspace-files/import-file/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files/databricks.yml + 1 engine/terraform POST /api/2.0/workspace-files/import-file/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/state/deploy.lock + 1 engine/terraform POST /api/2.0/workspace-files/import-file/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/state/deployment.json + 2 engine/terraform POST /api/2.0/workspace/delete + 1 engine/terraform POST /api/2.0/workspace/mkdirs diff --git a/acceptance/bundle/migrate/user-agent/race/script b/acceptance/bundle/migrate/user-agent/race/script new file mode 100644 index 00000000000..1262300c234 --- /dev/null +++ b/acceptance/bundle/migrate/user-agent/race/script @@ -0,0 +1,10 @@ +export DATABRICKS_BUNDLE_ENGINE= + +title "Replay a prior terraform deployment" +trace replay_tfstate.py terraform-requests.json terraform.tfstate +replace_ids.py +rm -f "$OUT_REQUESTS" + +title "Deploy where the local terraform state disappears between the pull and the migration" +trace errcode $CLI bundle deploy 2>&1 | grep -E '^(Panic Payload|Exit code)' +trace print_engines diff --git a/acceptance/bundle/migrate/user-agent/race/terraform-requests.json b/acceptance/bundle/migrate/user-agent/race/terraform-requests.json new file mode 100644 index 00000000000..514877afead --- /dev/null +++ b/acceptance/bundle/migrate/user-agent/race/terraform-requests.json @@ -0,0 +1,19 @@ +[ + { + "method": "POST", + "path": "/api/2.2/jobs/create", + "body": { + "deployment": { + "kind": "BUNDLE", + "metadata_file_path": "/Workspace/Users/tester@databricks.com/.bundle/test-bundle/default/state/metadata.json" + }, + "edit_mode": "UI_LOCKED", + "format": "MULTI_TASK", + "max_concurrent_runs": 1, + "name": "Test Auto-Migrate Plan Failure", + "queue": { + "enabled": true + } + } + } +] diff --git a/acceptance/bundle/migrate/user-agent/race/terraform.tfstate b/acceptance/bundle/migrate/user-agent/race/terraform.tfstate new file mode 100644 index 00000000000..5f749b73a1d --- /dev/null +++ b/acceptance/bundle/migrate/user-agent/race/terraform.tfstate @@ -0,0 +1,110 @@ +{ + "version": 4, + "terraform_version": "1.5.5", + "serial": 1, + "lineage": "115ec518-3f72-3614-4e56-01411863558a", + "outputs": {}, + "resources": [ + { + "mode": "managed", + "type": "databricks_job", + "name": "test_job", + "provider": "provider[\"registry.terraform.io/databricks/databricks\"]", + "instances": [ + { + "schema_version": 2, + "attributes": { + "always_running": false, + "budget_policy_id": null, + "continuous": [], + "control_run_state": false, + "dbt_task": [], + "deployment": [ + { + "deployment_id": "", + "kind": "BUNDLE", + "metadata_file_path": "/Workspace/Users/tester@databricks.com/.bundle/test-bundle/default/state/metadata.json", + "version_id": "" + } + ], + "description": null, + "edit_mode": "UI_LOCKED", + "email_notifications": [ + { + "no_alert_for_skipped_runs": false, + "on_duration_warning_threshold_exceeded": [], + "on_failure": [], + "on_start": [], + "on_streaming_backlog_exceeded": [], + "on_success": [] + } + ], + "environment": [], + "existing_cluster_id": null, + "format": "MULTI_TASK", + "git_source": [], + "health": [], + "id": "8790613902942848000", + "job_cluster": [], + "library": [], + "max_concurrent_runs": 1, + "max_retries": 0, + "min_retry_interval_millis": 0, + "name": "Test Auto-Migrate Plan Failure", + "new_cluster": [], + "notebook_task": [], + "notification_settings": [], + "parameter": [], + "parent_path": null, + "performance_target": null, + "pipeline_task": [], + "provider_config": [ + { + "workspace_id": "900800700600" + } + ], + "python_wheel_task": [], + "queue": [ + { + "enabled": true + } + ], + "retry_on_timeout": false, + "run_as": [ + { + "group_name": "", + "service_principal_name": "", + "user_name": "tester@databricks.com" + } + ], + "run_job_task": [], + "schedule": [], + "spark_jar_task": [], + "spark_python_task": [], + "spark_submit_task": [], + "tags": null, + "task": [], + "timeout_seconds": 0, + "timeouts": null, + "trigger": [], + "triggers": [], + "url": "[DATABRICKS_URL]/#job/8790613902942848000", + "usage_policy_id": null, + "webhook_notifications": [ + { + "on_duration_warning_threshold_exceeded": [], + "on_failure": [], + "on_start": [], + "on_streaming_backlog_exceeded": [], + "on_success": [] + } + ] + }, + "sensitive_attributes": [], + "private": "eyJlMmJmYjczMC1lY2FhLTExZTYtOGY4OC0zNDM2M2JjN2M0YzAiOnsiY3JlYXRlIjoxODAwMDAwMDAwMDAwLCJ1cGRhdGUiOjE4MDAwMDAwMDAwMDB9LCJzY2hlbWFfdmVyc2lvbiI6IjIifQ==" + } + ] + } + ], + "check_results": null +} diff --git a/acceptance/bundle/migrate/user-agent/script.prepare b/acceptance/bundle/migrate/user-agent/script.prepare new file mode 100644 index 00000000000..812dfae45a7 --- /dev/null +++ b/acceptance/bundle/migrate/user-agent/script.prepare @@ -0,0 +1,4 @@ +# Per request: the engine tags in the User-Agent (MISSING if none), method and path. +print_engines() { + print_requests.py --get --oneline | jq -r 'select(.path | startswith("/__testserver/") | not) | ((.headers["User-Agent"][0] | [scan("engine/[a-z]+")] | join(",")) as $e | (if $e == "" then "MISSING" else $e end)) + " " + .method + " " + .path' | sort | uniq -c +} From 35cf2cf3c2e2d86f46ff18e3697f8a8acc0fafbe Mon Sep 17 00:00:00 2001 From: "denis.bilenko" Date: Wed, 18 Nov 2026 18:19:46 +0000 Subject: [PATCH 2/4] Strip uniq -c padding in print_engines so the goldens match on macOS BSD uniq pads the count differently from GNU uniq, so the migrate/user-agent goldens failed on the macOS CI leg. Co-authored-by: Isaac --- .../migrate/user-agent/bind-unbind/output.txt | 22 +++++++++---------- .../user-agent/engine-pinned/output.txt | 8 +++---- .../bundle/migrate/user-agent/race/output.txt | 16 +++++++------- .../bundle/migrate/user-agent/script.prepare | 3 ++- 4 files changed, 25 insertions(+), 24 deletions(-) diff --git a/acceptance/bundle/migrate/user-agent/bind-unbind/output.txt b/acceptance/bundle/migrate/user-agent/bind-unbind/output.txt index 20164152ea8..a48a1137832 100644 --- a/acceptance/bundle/migrate/user-agent/bind-unbind/output.txt +++ b/acceptance/bundle/migrate/user-agent/bind-unbind/output.txt @@ -12,12 +12,12 @@ Run "databricks bundle deploy" to migrate the state to the direct engine, or ins >>> print_engines - 2 MISSING GET /api/2.0/workspace/export - 2 engine/terraform GET /api/2.0/workspace/export - 3 engine/terraform GET /api/2.0/workspace/get-status - 1 engine/terraform GET /api/2.2/jobs/get - 1 engine/terraform POST /api/2.0/workspace-files/import-file/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/state/deploy.lock - 1 engine/terraform POST /api/2.0/workspace/delete +2 MISSING GET /api/2.0/workspace/export +2 engine/terraform GET /api/2.0/workspace/export +3 engine/terraform GET /api/2.0/workspace/get-status +1 engine/terraform GET /api/2.2/jobs/get +1 engine/terraform POST /api/2.0/workspace-files/import-file/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/state/deploy.lock +1 engine/terraform POST /api/2.0/workspace/delete === unbind on a terraform state @@ -28,8 +28,8 @@ Run "databricks bundle deploy" to migrate the state to the direct engine, or ins >>> print_engines - 2 MISSING GET /api/2.0/workspace/export - 2 engine/terraform GET /api/2.0/workspace/export - 3 engine/terraform GET /api/2.0/workspace/get-status - 1 engine/terraform POST /api/2.0/workspace-files/import-file/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/state/deploy.lock - 1 engine/terraform POST /api/2.0/workspace/delete +2 MISSING GET /api/2.0/workspace/export +2 engine/terraform GET /api/2.0/workspace/export +3 engine/terraform GET /api/2.0/workspace/get-status +1 engine/terraform POST /api/2.0/workspace-files/import-file/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/state/deploy.lock +1 engine/terraform POST /api/2.0/workspace/delete diff --git a/acceptance/bundle/migrate/user-agent/engine-pinned/output.txt b/acceptance/bundle/migrate/user-agent/engine-pinned/output.txt index 5f5d93222e2..d84306f89c9 100644 --- a/acceptance/bundle/migrate/user-agent/engine-pinned/output.txt +++ b/acceptance/bundle/migrate/user-agent/engine-pinned/output.txt @@ -12,7 +12,7 @@ Unset the DATABRICKS_BUNDLE_ENGINE environment variable (or set it to "direct") See https://docs.databricks.com/dev-tools/bundles/direct for details >>> print_engines - 1 MISSING POST /telemetry-ext +1 MISSING POST /telemetry-ext === deploy with bundle.engine: terraform @@ -25,7 +25,7 @@ See https://docs.databricks.com/dev-tools/bundles/direct for details >>> print_engines - 1 MISSING POST /telemetry-ext +1 MISSING POST /telemetry-ext === summary with bundle.engine: terraform @@ -39,5 +39,5 @@ See https://docs.databricks.com/dev-tools/bundles/direct for details Notice: migrating your bundle to direct deployment engine (https://github.com/databricks/cli/issues/6765). >>> print_engines - 1 MISSING GET /api/2.2/jobs/get - 1 engine/direct GET /api/2.0/preview/scim/v2/Me +1 MISSING GET /api/2.2/jobs/get +1 engine/direct GET /api/2.0/preview/scim/v2/Me diff --git a/acceptance/bundle/migrate/user-agent/race/output.txt b/acceptance/bundle/migrate/user-agent/race/output.txt index 80a81191363..ff80ab78724 100644 --- a/acceptance/bundle/migrate/user-agent/race/output.txt +++ b/acceptance/bundle/migrate/user-agent/race/output.txt @@ -8,11 +8,11 @@ Panic Payload: internal error: DeploymentState must be opened first Exit code: 1 >>> print_engines - 2 MISSING GET /api/2.0/workspace/export - 3 engine/terraform GET /api/2.0/workspace/export - 4 engine/terraform GET /api/2.0/workspace/get-status - 1 engine/terraform POST /api/2.0/workspace-files/import-file/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files/databricks.yml - 1 engine/terraform POST /api/2.0/workspace-files/import-file/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/state/deploy.lock - 1 engine/terraform POST /api/2.0/workspace-files/import-file/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/state/deployment.json - 2 engine/terraform POST /api/2.0/workspace/delete - 1 engine/terraform POST /api/2.0/workspace/mkdirs +2 MISSING GET /api/2.0/workspace/export +3 engine/terraform GET /api/2.0/workspace/export +4 engine/terraform GET /api/2.0/workspace/get-status +1 engine/terraform POST /api/2.0/workspace-files/import-file/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files/databricks.yml +1 engine/terraform POST /api/2.0/workspace-files/import-file/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/state/deploy.lock +1 engine/terraform POST /api/2.0/workspace-files/import-file/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/state/deployment.json +2 engine/terraform POST /api/2.0/workspace/delete +1 engine/terraform POST /api/2.0/workspace/mkdirs diff --git a/acceptance/bundle/migrate/user-agent/script.prepare b/acceptance/bundle/migrate/user-agent/script.prepare index 812dfae45a7..dde8c4af13f 100644 --- a/acceptance/bundle/migrate/user-agent/script.prepare +++ b/acceptance/bundle/migrate/user-agent/script.prepare @@ -1,4 +1,5 @@ # Per request: the engine tags in the User-Agent (MISSING if none), method and path. +# The sed strips uniq -c's padding, which differs between GNU and BSD (macOS). print_engines() { - print_requests.py --get --oneline | jq -r 'select(.path | startswith("/__testserver/") | not) | ((.headers["User-Agent"][0] | [scan("engine/[a-z]+")] | join(",")) as $e | (if $e == "" then "MISSING" else $e end)) + " " + .method + " " + .path' | sort | uniq -c + print_requests.py --get --oneline | jq -r 'select(.path | startswith("/__testserver/") | not) | ((.headers["User-Agent"][0] | [scan("engine/[a-z]+")] | join(",")) as $e | (if $e == "" then "MISSING" else $e end)) + " " + .method + " " + .path' | sort | uniq -c | sed -E 's/^ +//' } From 2f9d1c955f0be185e88cbbb2401e4a7471cfd517 Mon Sep 17 00:00:00 2001 From: "denis.bilenko" Date: Thu, 19 Nov 2026 09:28:54 +0000 Subject: [PATCH 3/4] Share the terraform replay fixtures across the user-agent tests The three tests replayed byte-identical terraform-requests.json and terraform.tfstate copies; keep one in the parent directory and read it via $TESTDIR/.. like other acceptance tests with shared fixtures. Co-authored-by: Isaac --- .../migrate/user-agent/bind-unbind/output.txt | 2 +- .../migrate/user-agent/bind-unbind/script | 2 +- .../user-agent/engine-pinned/output.txt | 2 +- .../migrate/user-agent/engine-pinned/script | 2 +- .../engine-pinned/terraform-requests.json | 19 --- .../engine-pinned/terraform.tfstate | 110 ------------------ .../bundle/migrate/user-agent/race/output.txt | 2 +- .../bundle/migrate/user-agent/race/script | 2 +- .../user-agent/race/terraform-requests.json | 19 --- .../migrate/user-agent/race/terraform.tfstate | 110 ------------------ .../{bind-unbind => }/terraform-requests.json | 0 .../{bind-unbind => }/terraform.tfstate | 0 12 files changed, 6 insertions(+), 264 deletions(-) delete mode 100644 acceptance/bundle/migrate/user-agent/engine-pinned/terraform-requests.json delete mode 100644 acceptance/bundle/migrate/user-agent/engine-pinned/terraform.tfstate delete mode 100644 acceptance/bundle/migrate/user-agent/race/terraform-requests.json delete mode 100644 acceptance/bundle/migrate/user-agent/race/terraform.tfstate rename acceptance/bundle/migrate/user-agent/{bind-unbind => }/terraform-requests.json (100%) rename acceptance/bundle/migrate/user-agent/{bind-unbind => }/terraform.tfstate (100%) diff --git a/acceptance/bundle/migrate/user-agent/bind-unbind/output.txt b/acceptance/bundle/migrate/user-agent/bind-unbind/output.txt index a48a1137832..b482426fab4 100644 --- a/acceptance/bundle/migrate/user-agent/bind-unbind/output.txt +++ b/acceptance/bundle/migrate/user-agent/bind-unbind/output.txt @@ -1,7 +1,7 @@ === Replay a prior terraform deployment ->>> replay_tfstate.py terraform-requests.json terraform.tfstate +>>> replay_tfstate.py [TESTROOT]/bundle/migrate/user-agent/bind-unbind/../terraform-requests.json [TESTROOT]/bundle/migrate/user-agent/bind-unbind/../terraform.tfstate === bind on a terraform state diff --git a/acceptance/bundle/migrate/user-agent/bind-unbind/script b/acceptance/bundle/migrate/user-agent/bind-unbind/script index 1f3caf375f6..7f039fb43e7 100644 --- a/acceptance/bundle/migrate/user-agent/bind-unbind/script +++ b/acceptance/bundle/migrate/user-agent/bind-unbind/script @@ -1,7 +1,7 @@ export DATABRICKS_BUNDLE_ENGINE= title "Replay a prior terraform deployment" -trace replay_tfstate.py terraform-requests.json terraform.tfstate +trace replay_tfstate.py "$TESTDIR/../terraform-requests.json" "$TESTDIR/../terraform.tfstate" replace_ids.py rm -f "$OUT_REQUESTS" JOB_ID=$(jq -r '.resources[] | select(.type == "databricks_job") | .instances[0].attributes.id' .databricks/bundle/default/terraform/terraform.tfstate) diff --git a/acceptance/bundle/migrate/user-agent/engine-pinned/output.txt b/acceptance/bundle/migrate/user-agent/engine-pinned/output.txt index d84306f89c9..1a6a4db4b1c 100644 --- a/acceptance/bundle/migrate/user-agent/engine-pinned/output.txt +++ b/acceptance/bundle/migrate/user-agent/engine-pinned/output.txt @@ -1,7 +1,7 @@ === Replay a prior terraform deployment ->>> replay_tfstate.py terraform-requests.json terraform.tfstate +>>> replay_tfstate.py [TESTROOT]/bundle/migrate/user-agent/engine-pinned/../terraform-requests.json [TESTROOT]/bundle/migrate/user-agent/engine-pinned/../terraform.tfstate === deploy with DATABRICKS_BUNDLE_ENGINE=terraform diff --git a/acceptance/bundle/migrate/user-agent/engine-pinned/script b/acceptance/bundle/migrate/user-agent/engine-pinned/script index 751a5bee2af..1cc92d9825e 100644 --- a/acceptance/bundle/migrate/user-agent/engine-pinned/script +++ b/acceptance/bundle/migrate/user-agent/engine-pinned/script @@ -1,7 +1,7 @@ export DATABRICKS_BUNDLE_ENGINE= title "Replay a prior terraform deployment" -trace replay_tfstate.py terraform-requests.json terraform.tfstate +trace replay_tfstate.py "$TESTDIR/../terraform-requests.json" "$TESTDIR/../terraform.tfstate" replace_ids.py rm -f "$OUT_REQUESTS" diff --git a/acceptance/bundle/migrate/user-agent/engine-pinned/terraform-requests.json b/acceptance/bundle/migrate/user-agent/engine-pinned/terraform-requests.json deleted file mode 100644 index 514877afead..00000000000 --- a/acceptance/bundle/migrate/user-agent/engine-pinned/terraform-requests.json +++ /dev/null @@ -1,19 +0,0 @@ -[ - { - "method": "POST", - "path": "/api/2.2/jobs/create", - "body": { - "deployment": { - "kind": "BUNDLE", - "metadata_file_path": "/Workspace/Users/tester@databricks.com/.bundle/test-bundle/default/state/metadata.json" - }, - "edit_mode": "UI_LOCKED", - "format": "MULTI_TASK", - "max_concurrent_runs": 1, - "name": "Test Auto-Migrate Plan Failure", - "queue": { - "enabled": true - } - } - } -] diff --git a/acceptance/bundle/migrate/user-agent/engine-pinned/terraform.tfstate b/acceptance/bundle/migrate/user-agent/engine-pinned/terraform.tfstate deleted file mode 100644 index 5f749b73a1d..00000000000 --- a/acceptance/bundle/migrate/user-agent/engine-pinned/terraform.tfstate +++ /dev/null @@ -1,110 +0,0 @@ -{ - "version": 4, - "terraform_version": "1.5.5", - "serial": 1, - "lineage": "115ec518-3f72-3614-4e56-01411863558a", - "outputs": {}, - "resources": [ - { - "mode": "managed", - "type": "databricks_job", - "name": "test_job", - "provider": "provider[\"registry.terraform.io/databricks/databricks\"]", - "instances": [ - { - "schema_version": 2, - "attributes": { - "always_running": false, - "budget_policy_id": null, - "continuous": [], - "control_run_state": false, - "dbt_task": [], - "deployment": [ - { - "deployment_id": "", - "kind": "BUNDLE", - "metadata_file_path": "/Workspace/Users/tester@databricks.com/.bundle/test-bundle/default/state/metadata.json", - "version_id": "" - } - ], - "description": null, - "edit_mode": "UI_LOCKED", - "email_notifications": [ - { - "no_alert_for_skipped_runs": false, - "on_duration_warning_threshold_exceeded": [], - "on_failure": [], - "on_start": [], - "on_streaming_backlog_exceeded": [], - "on_success": [] - } - ], - "environment": [], - "existing_cluster_id": null, - "format": "MULTI_TASK", - "git_source": [], - "health": [], - "id": "8790613902942848000", - "job_cluster": [], - "library": [], - "max_concurrent_runs": 1, - "max_retries": 0, - "min_retry_interval_millis": 0, - "name": "Test Auto-Migrate Plan Failure", - "new_cluster": [], - "notebook_task": [], - "notification_settings": [], - "parameter": [], - "parent_path": null, - "performance_target": null, - "pipeline_task": [], - "provider_config": [ - { - "workspace_id": "900800700600" - } - ], - "python_wheel_task": [], - "queue": [ - { - "enabled": true - } - ], - "retry_on_timeout": false, - "run_as": [ - { - "group_name": "", - "service_principal_name": "", - "user_name": "tester@databricks.com" - } - ], - "run_job_task": [], - "schedule": [], - "spark_jar_task": [], - "spark_python_task": [], - "spark_submit_task": [], - "tags": null, - "task": [], - "timeout_seconds": 0, - "timeouts": null, - "trigger": [], - "triggers": [], - "url": "[DATABRICKS_URL]/#job/8790613902942848000", - "usage_policy_id": null, - "webhook_notifications": [ - { - "on_duration_warning_threshold_exceeded": [], - "on_failure": [], - "on_start": [], - "on_streaming_backlog_exceeded": [], - "on_success": [] - } - ] - }, - "sensitive_attributes": [], - "private": "eyJlMmJmYjczMC1lY2FhLTExZTYtOGY4OC0zNDM2M2JjN2M0YzAiOnsiY3JlYXRlIjoxODAwMDAwMDAwMDAwLCJ1cGRhdGUiOjE4MDAwMDAwMDAwMDB9LCJzY2hlbWFfdmVyc2lvbiI6IjIifQ==" - } - ] - } - ], - "check_results": null -} diff --git a/acceptance/bundle/migrate/user-agent/race/output.txt b/acceptance/bundle/migrate/user-agent/race/output.txt index ff80ab78724..af5e32e2a12 100644 --- a/acceptance/bundle/migrate/user-agent/race/output.txt +++ b/acceptance/bundle/migrate/user-agent/race/output.txt @@ -1,7 +1,7 @@ === Replay a prior terraform deployment ->>> replay_tfstate.py terraform-requests.json terraform.tfstate +>>> replay_tfstate.py [TESTROOT]/bundle/migrate/user-agent/race/../terraform-requests.json [TESTROOT]/bundle/migrate/user-agent/race/../terraform.tfstate === Deploy where the local terraform state disappears between the pull and the migration Panic Payload: internal error: DeploymentState must be opened first diff --git a/acceptance/bundle/migrate/user-agent/race/script b/acceptance/bundle/migrate/user-agent/race/script index 1262300c234..7b88b5cf085 100644 --- a/acceptance/bundle/migrate/user-agent/race/script +++ b/acceptance/bundle/migrate/user-agent/race/script @@ -1,7 +1,7 @@ export DATABRICKS_BUNDLE_ENGINE= title "Replay a prior terraform deployment" -trace replay_tfstate.py terraform-requests.json terraform.tfstate +trace replay_tfstate.py "$TESTDIR/../terraform-requests.json" "$TESTDIR/../terraform.tfstate" replace_ids.py rm -f "$OUT_REQUESTS" diff --git a/acceptance/bundle/migrate/user-agent/race/terraform-requests.json b/acceptance/bundle/migrate/user-agent/race/terraform-requests.json deleted file mode 100644 index 514877afead..00000000000 --- a/acceptance/bundle/migrate/user-agent/race/terraform-requests.json +++ /dev/null @@ -1,19 +0,0 @@ -[ - { - "method": "POST", - "path": "/api/2.2/jobs/create", - "body": { - "deployment": { - "kind": "BUNDLE", - "metadata_file_path": "/Workspace/Users/tester@databricks.com/.bundle/test-bundle/default/state/metadata.json" - }, - "edit_mode": "UI_LOCKED", - "format": "MULTI_TASK", - "max_concurrent_runs": 1, - "name": "Test Auto-Migrate Plan Failure", - "queue": { - "enabled": true - } - } - } -] diff --git a/acceptance/bundle/migrate/user-agent/race/terraform.tfstate b/acceptance/bundle/migrate/user-agent/race/terraform.tfstate deleted file mode 100644 index 5f749b73a1d..00000000000 --- a/acceptance/bundle/migrate/user-agent/race/terraform.tfstate +++ /dev/null @@ -1,110 +0,0 @@ -{ - "version": 4, - "terraform_version": "1.5.5", - "serial": 1, - "lineage": "115ec518-3f72-3614-4e56-01411863558a", - "outputs": {}, - "resources": [ - { - "mode": "managed", - "type": "databricks_job", - "name": "test_job", - "provider": "provider[\"registry.terraform.io/databricks/databricks\"]", - "instances": [ - { - "schema_version": 2, - "attributes": { - "always_running": false, - "budget_policy_id": null, - "continuous": [], - "control_run_state": false, - "dbt_task": [], - "deployment": [ - { - "deployment_id": "", - "kind": "BUNDLE", - "metadata_file_path": "/Workspace/Users/tester@databricks.com/.bundle/test-bundle/default/state/metadata.json", - "version_id": "" - } - ], - "description": null, - "edit_mode": "UI_LOCKED", - "email_notifications": [ - { - "no_alert_for_skipped_runs": false, - "on_duration_warning_threshold_exceeded": [], - "on_failure": [], - "on_start": [], - "on_streaming_backlog_exceeded": [], - "on_success": [] - } - ], - "environment": [], - "existing_cluster_id": null, - "format": "MULTI_TASK", - "git_source": [], - "health": [], - "id": "8790613902942848000", - "job_cluster": [], - "library": [], - "max_concurrent_runs": 1, - "max_retries": 0, - "min_retry_interval_millis": 0, - "name": "Test Auto-Migrate Plan Failure", - "new_cluster": [], - "notebook_task": [], - "notification_settings": [], - "parameter": [], - "parent_path": null, - "performance_target": null, - "pipeline_task": [], - "provider_config": [ - { - "workspace_id": "900800700600" - } - ], - "python_wheel_task": [], - "queue": [ - { - "enabled": true - } - ], - "retry_on_timeout": false, - "run_as": [ - { - "group_name": "", - "service_principal_name": "", - "user_name": "tester@databricks.com" - } - ], - "run_job_task": [], - "schedule": [], - "spark_jar_task": [], - "spark_python_task": [], - "spark_submit_task": [], - "tags": null, - "task": [], - "timeout_seconds": 0, - "timeouts": null, - "trigger": [], - "triggers": [], - "url": "[DATABRICKS_URL]/#job/8790613902942848000", - "usage_policy_id": null, - "webhook_notifications": [ - { - "on_duration_warning_threshold_exceeded": [], - "on_failure": [], - "on_start": [], - "on_streaming_backlog_exceeded": [], - "on_success": [] - } - ] - }, - "sensitive_attributes": [], - "private": "eyJlMmJmYjczMC1lY2FhLTExZTYtOGY4OC0zNDM2M2JjN2M0YzAiOnsiY3JlYXRlIjoxODAwMDAwMDAwMDAwLCJ1cGRhdGUiOjE4MDAwMDAwMDAwMDB9LCJzY2hlbWFfdmVyc2lvbiI6IjIifQ==" - } - ] - } - ], - "check_results": null -} diff --git a/acceptance/bundle/migrate/user-agent/bind-unbind/terraform-requests.json b/acceptance/bundle/migrate/user-agent/terraform-requests.json similarity index 100% rename from acceptance/bundle/migrate/user-agent/bind-unbind/terraform-requests.json rename to acceptance/bundle/migrate/user-agent/terraform-requests.json diff --git a/acceptance/bundle/migrate/user-agent/bind-unbind/terraform.tfstate b/acceptance/bundle/migrate/user-agent/terraform.tfstate similarity index 100% rename from acceptance/bundle/migrate/user-agent/bind-unbind/terraform.tfstate rename to acceptance/bundle/migrate/user-agent/terraform.tfstate From 7f47413466c1bf67e1f4223a0a5d6612f92f12b4 Mon Sep 17 00:00:00 2001 From: "denis.bilenko" Date: Thu, 19 Nov 2026 09:43:48 +0000 Subject: [PATCH 4/4] Follow the acceptance test rules in the user-agent tests - race: require the failure with musterr and assert the panic with contains.py on LOG.deploy instead of a bare errcode piped into grep. - bind-unbind: read the job id with read_id.py. - engine-pinned: send summary output to LOG.summary, not /dev/null. - Move print_engines to bundle/migrate/script.prepare so other migrate tests can use it, and keep LOG.* files out of the bundle upload. Co-authored-by: Isaac --- acceptance/bundle/migrate/script.prepare | 10 ++++++++-- .../bundle/migrate/user-agent/bind-unbind/script | 2 +- .../bundle/migrate/user-agent/engine-pinned/script | 2 +- acceptance/bundle/migrate/user-agent/race/output.txt | 2 -- acceptance/bundle/migrate/user-agent/race/script | 3 ++- acceptance/bundle/migrate/user-agent/script.prepare | 5 ----- 6 files changed, 12 insertions(+), 12 deletions(-) delete mode 100644 acceptance/bundle/migrate/user-agent/script.prepare diff --git a/acceptance/bundle/migrate/script.prepare b/acceptance/bundle/migrate/script.prepare index 559d2cec52e..cbc9a0b8715 100644 --- a/acceptance/bundle/migrate/script.prepare +++ b/acceptance/bundle/migrate/script.prepare @@ -6,7 +6,13 @@ print_migration_telemetry() { print_telemetry_bool_values | grep '^direct_' || true } -# The replay fixtures and the generated out.* files live in the bundle root but are not bundle +# The replay fixtures and the generated out.* and LOG.* files live in the bundle root but are not bundle # files, so keep them out of `bundle deploy`'s upload. The list excludes .gitignore itself so it is # not uploaded either; test.toml adds .gitignore to Ignore so the harness does not flag it. -printf '%s\n' '.gitignore' 'out.*' 'terraform*.tfstate' 'terraform*-requests.json' > .gitignore +printf '%s\n' '.gitignore' 'out.*' 'LOG.*' 'terraform*.tfstate' 'terraform*-requests.json' > .gitignore + +# Per request: the engine tags in the User-Agent (MISSING if none), method and path. +# The sed strips uniq -c's padding, which differs between GNU and BSD (macOS). +print_engines() { + print_requests.py --get --oneline | jq -r 'select(.path | startswith("/__testserver/") | not) | ((.headers["User-Agent"][0] | [scan("engine/[a-z]+")] | join(",")) as $e | (if $e == "" then "MISSING" else $e end)) + " " + .method + " " + .path' | sort | uniq -c | sed -E 's/^ +//' +} diff --git a/acceptance/bundle/migrate/user-agent/bind-unbind/script b/acceptance/bundle/migrate/user-agent/bind-unbind/script index 7f039fb43e7..bfcd4457f18 100644 --- a/acceptance/bundle/migrate/user-agent/bind-unbind/script +++ b/acceptance/bundle/migrate/user-agent/bind-unbind/script @@ -4,7 +4,7 @@ title "Replay a prior terraform deployment" trace replay_tfstate.py "$TESTDIR/../terraform-requests.json" "$TESTDIR/../terraform.tfstate" replace_ids.py rm -f "$OUT_REQUESTS" -JOB_ID=$(jq -r '.resources[] | select(.type == "databricks_job") | .instances[0].attributes.id' .databricks/bundle/default/terraform/terraform.tfstate) +JOB_ID=$(read_id.py test_job) # bind and unbind only pull the state, so a terraform state is not migrated and they reject it. title "bind on a terraform state" diff --git a/acceptance/bundle/migrate/user-agent/engine-pinned/script b/acceptance/bundle/migrate/user-agent/engine-pinned/script index 1cc92d9825e..11514a2eae7 100644 --- a/acceptance/bundle/migrate/user-agent/engine-pinned/script +++ b/acceptance/bundle/migrate/user-agent/engine-pinned/script @@ -17,5 +17,5 @@ trace print_engines # summary allows a terraform bundle.engine (warning only) and migrates the state in memory. title "summary with bundle.engine: terraform" -trace $CLI bundle summary > /dev/null +trace $CLI bundle summary > LOG.summary trace print_engines diff --git a/acceptance/bundle/migrate/user-agent/race/output.txt b/acceptance/bundle/migrate/user-agent/race/output.txt index af5e32e2a12..648a28750fb 100644 --- a/acceptance/bundle/migrate/user-agent/race/output.txt +++ b/acceptance/bundle/migrate/user-agent/race/output.txt @@ -4,8 +4,6 @@ >>> replay_tfstate.py [TESTROOT]/bundle/migrate/user-agent/race/../terraform-requests.json [TESTROOT]/bundle/migrate/user-agent/race/../terraform.tfstate === Deploy where the local terraform state disappears between the pull and the migration -Panic Payload: internal error: DeploymentState must be opened first -Exit code: 1 >>> print_engines 2 MISSING GET /api/2.0/workspace/export diff --git a/acceptance/bundle/migrate/user-agent/race/script b/acceptance/bundle/migrate/user-agent/race/script index 7b88b5cf085..49caea90aa1 100644 --- a/acceptance/bundle/migrate/user-agent/race/script +++ b/acceptance/bundle/migrate/user-agent/race/script @@ -6,5 +6,6 @@ replace_ids.py rm -f "$OUT_REQUESTS" title "Deploy where the local terraform state disappears between the pull and the migration" -trace errcode $CLI bundle deploy 2>&1 | grep -E '^(Panic Payload|Exit code)' +musterr $CLI bundle deploy &> LOG.deploy +contains.py 'Panic Payload: internal error: DeploymentState must be opened first' < LOG.deploy > /dev/null trace print_engines diff --git a/acceptance/bundle/migrate/user-agent/script.prepare b/acceptance/bundle/migrate/user-agent/script.prepare deleted file mode 100644 index dde8c4af13f..00000000000 --- a/acceptance/bundle/migrate/user-agent/script.prepare +++ /dev/null @@ -1,5 +0,0 @@ -# Per request: the engine tags in the User-Agent (MISSING if none), method and path. -# The sed strips uniq -c's padding, which differs between GNU and BSD (macOS). -print_engines() { - print_requests.py --get --oneline | jq -r 'select(.path | startswith("/__testserver/") | not) | ((.headers["User-Agent"][0] | [scan("engine/[a-z]+")] | join(",")) as $e | (if $e == "" then "MISSING" else $e end)) + " " + .method + " " + .path' | sort | uniq -c | sed -E 's/^ +//' -}