Add summary for 'bundle plan' output (#3546)

andrewnester · web-flow · commit efa69f401799 · 2025-09-24T09:28:26.000Z
## Changes
1. Changed plan output to be printed from stderr (cmdio.LogString) to
stdout (fmt.Printf/fmt.Println)
2. Added summary line with counts: Plan: X to add, Y to change, Z to
delete

Example output:
  ```
create job.my_project_job
delete job.sample_job
create pipeline.my_project_pipeline
delete pipeline.sample_etl
Plan: 2 to add, 0 to change, 2 to delete
```

## Why
Improving the output before making the command publicly available

## Tests
Updated acceptance test output
Existing acceptance test updated and passing

&lt;!-- If your PR needs to be included in the release notes for next release,
add a separate entry in NEXT_CHANGELOG.md as part of your PR. --&gt;
diff --git a/acceptance/bundle/apps/app_yaml/output.txt b/acceptance/bundle/apps/app_yaml/output.txt
@@ -11,6 +11,8 @@ Validation OK!
 >>> [CLI] bundle plan
 create apps.myapp
 
+Plan: 1 to add, 0 to change, 0 to delete, 0 unchanged
+
 >>> [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
 Deploying resources...
diff --git a/acceptance/bundle/bundle_tag/id/output.txt b/acceptance/bundle/bundle_tag/id/output.txt
@@ -32,6 +32,8 @@ Validation OK!
 >>> [CLI] bundle plan
 create jobs.foo
 
+Plan: 1 to add, 0 to change, 0 to delete, 0 unchanged
+
 >>> [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
 Deploying resources...
diff --git a/acceptance/bundle/bundle_tag/url/output.txt b/acceptance/bundle/bundle_tag/url/output.txt
@@ -32,6 +32,8 @@ Validation OK!
 >>> [CLI] bundle plan
 create jobs.foo
 
+Plan: 1 to add, 0 to change, 0 to delete, 0 unchanged
+
 >>> [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
 Deploying resources...
diff --git a/acceptance/bundle/bundle_tag/url_ref/out.plan.terraform.txt b/acceptance/bundle/bundle_tag/url_ref/out.plan.terraform.txt
@@ -1,2 +1,4 @@
 create jobs.bar
 create jobs.foo
+
+Plan: 2 to add, 0 to change, 0 to delete, 0 unchanged
diff --git a/acceptance/bundle/deploy/jobs/task-source/output.txt b/acceptance/bundle/deploy/jobs/task-source/output.txt
@@ -16,6 +16,8 @@ Deployment complete!
 >>> [CLI] bundle plan
 update jobs.git_job
 
+Plan: 0 to add, 1 to change, 0 to delete, 1 unchanged
+
 >>> [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/task-source/default/files...
 Deploying resources...
diff --git a/acceptance/bundle/deploy/pipeline/auto-approve/output.txt b/acceptance/bundle/deploy/pipeline/auto-approve/output.txt
@@ -39,6 +39,8 @@ Deployment complete!
 delete jobs.foo
 delete pipelines.bar
 
+Plan: 0 to add, 0 to change, 2 to delete, 0 unchanged
+
 === Try to redeploy the bundle - should fail without --auto-approve
 >>> errcode [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/[UNIQUE_NAME]/files...
diff --git a/acceptance/bundle/deploy/pipeline/recreate/output.txt b/acceptance/bundle/deploy/pipeline/recreate/output.txt
@@ -34,6 +34,8 @@ Deployment complete!
 recreate pipelines.foo
 recreate schemas.bar
 
+Plan: 2 to add, 0 to change, 2 to delete, 0 unchanged
+
 === Try to redeploy the bundle, pointing the DLT pipeline to a different UC catalog
 >>> errcode [CLI] bundle deploy --force-lock --var=catalog=another_catalog
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/[UNIQUE_NAME]/files...
diff --git a/acceptance/bundle/deploy/pipeline/recreate/script b/acceptance/bundle/deploy/pipeline/recreate/script
@@ -11,7 +11,7 @@ title "Assert the pipeline is created"
 PIPELINE_ID=$($CLI bundle summary -o json | jq -r '.resources.pipelines.foo.id')
 trace $CLI pipelines get "${PIPELINE_ID}" | jq "{spec}"
 
-trace $CLI bundle plan --var="catalog=another_catalog" 2>&1 | sort
+trace $CLI bundle plan --var="catalog=another_catalog" 2>&1
 
 title "Try to redeploy the bundle, pointing the DLT pipeline to a different UC catalog"
 trace errcode $CLI bundle deploy --force-lock --var="catalog=another_catalog"
diff --git a/acceptance/bundle/lifecycle/prevent-destroy/out.direct-exp.txt b/acceptance/bundle/lifecycle/prevent-destroy/out.direct-exp.txt
@@ -9,6 +9,8 @@ Exit code (musterr): 1
 >>> errcode [CLI] bundle plan
 recreate pipelines.my_pipelines
 
+Plan: 1 to add, 0 to change, 1 to delete, 1 unchanged
+
 >>> musterr [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/prevent-destroy/default/files...
 Error: resources.pipelines.my_pipelines has lifecycle.prevent_destroy set, but the plan calls for this resource to be recreated or destroyed. To avoid this error, disable lifecycle.prevent_destroy for resources.pipelines.my_pipelines
@@ -20,6 +22,8 @@ Exit code (musterr): 1
 recreate pipelines.my_pipelines
 recreate schemas.my_schema
 
+Plan: 2 to add, 0 to change, 2 to delete, 0 unchanged
+
 >>> musterr [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/prevent-destroy/default/files...
 Error: resources.pipelines.my_pipelines has lifecycle.prevent_destroy set, but the plan calls for this resource to be recreated or destroyed. To avoid this error, disable lifecycle.prevent_destroy for resources.pipelines.my_pipelines
@@ -32,6 +36,8 @@ Exit code (musterr): 1
 recreate pipelines.my_pipelines
 recreate schemas.my_schema
 
+Plan: 2 to add, 0 to change, 2 to delete, 0 unchanged
+
 >>> [CLI] bundle deploy --auto-approve
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/prevent-destroy/default/files...
 
@@ -51,6 +57,8 @@ Deployment complete!
 delete pipelines.my_pipelines
 delete schemas.my_schema
 
+Plan: 0 to add, 0 to change, 2 to delete, 0 unchanged
+
 >>> [CLI] bundle deploy --auto-approve
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/prevent-destroy/default/files...
 
diff --git a/acceptance/bundle/lifecycle/prevent-destroy/out.terraform.txt b/acceptance/bundle/lifecycle/prevent-destroy/out.terraform.txt
@@ -120,6 +120,8 @@ Exit code (musterr): 1
 recreate pipelines.my_pipelines
 recreate schemas.my_schema
 
+Plan: 2 to add, 0 to change, 2 to delete, 0 unchanged
+
 >>> [CLI] bundle deploy --auto-approve
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/prevent-destroy/default/files...
 
@@ -139,6 +141,8 @@ Deployment complete!
 delete pipelines.my_pipelines
 delete schemas.my_schema
 
+Plan: 0 to add, 0 to change, 2 to delete, 0 unchanged
+
 >>> [CLI] bundle deploy --auto-approve
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/prevent-destroy/default/files...
 
diff --git a/acceptance/bundle/lifecycle/prevent-destroy/output.txt b/acceptance/bundle/lifecycle/prevent-destroy/output.txt
@@ -15,3 +15,4 @@ Updating deployment state...
 Deployment complete!
 
 >>> errcode [CLI] bundle plan
+Plan: 0 to add, 0 to change, 0 to delete, 2 unchanged
diff --git a/acceptance/bundle/plan/no_upload/output.txt b/acceptance/bundle/plan/no_upload/output.txt
@@ -2,4 +2,6 @@
 >>> [CLI] bundle plan
 create jobs.my_job
 
+Plan: 1 to add, 0 to change, 0 to delete, 0 unchanged
+
 >>> jq -s .[] | select(.method != "GET") out.requests.txt
diff --git a/acceptance/bundle/resource_deps/bad_syntax/out.plan.direct-exp.txt b/acceptance/bundle/resource_deps/bad_syntax/out.plan.direct-exp.txt
@@ -1,2 +1,4 @@
 create volumes.bar
 create volumes.foo
+
+Plan: 2 to add, 0 to change, 0 to delete, 0 unchanged
diff --git a/acceptance/bundle/resource_deps/create_error/output.txt b/acceptance/bundle/resource_deps/create_error/output.txt
@@ -5,6 +5,8 @@ create jobs.baz
 create jobs.foo
 create jobs.independent
 
+Plan: 4 to add, 0 to change, 0 to delete, 0 unchanged
+
 >>> print_sorted_requests
 {
   "body": {
@@ -70,6 +72,8 @@ create jobs.bar
 create jobs.baz
 create jobs.foo
 
+Plan: 3 to add, 0 to change, 0 to delete, 1 unchanged
+
 === Expecting no difference in the output between first and second deploy
 >>> print_requests
 {
diff --git a/acceptance/bundle/resource_deps/id_chain/output.txt b/acceptance/bundle/resource_deps/id_chain/output.txt
@@ -6,6 +6,8 @@ create jobs.c
 create jobs.d
 create jobs.e
 
+Plan: 5 to add, 0 to change, 0 to delete, 0 unchanged
+
 >>> print_requests
 
 >>> [CLI] bundle deploy
@@ -32,6 +34,8 @@ update jobs.c
 update jobs.d
 update jobs.e
 
+Plan: 0 to add, 5 to change, 0 to delete, 0 unchanged
+
 >>> print_requests
 
 >>> [CLI] bundle deploy
diff --git a/acceptance/bundle/resource_deps/job_id/output.txt b/acceptance/bundle/resource_deps/job_id/output.txt
@@ -3,6 +3,8 @@
 create jobs.bar
 create jobs.foo
 
+Plan: 2 to add, 0 to change, 0 to delete, 0 unchanged
+
 >>> [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
 Deploying resources...
diff --git a/acceptance/bundle/resource_deps/jobs_update/output.txt b/acceptance/bundle/resource_deps/jobs_update/output.txt
@@ -3,6 +3,8 @@
 create jobs.bar
 create jobs.foo
 
+Plan: 2 to add, 0 to change, 0 to delete, 0 unchanged
+
 >>> [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
 Deploying resources...
@@ -63,13 +65,16 @@ Deployment complete!
 }
 
 >>> [CLI] bundle plan
+Plan: 0 to add, 0 to change, 0 to delete, 2 unchanged
 
 === Update trigger.periodic.unit and re-deploy; jobs.bar is unchanged
 >>> update_file.py databricks.yml DAYS HOURS
 
 >>> [CLI] bundle plan
 update jobs.foo
 
+Plan: 0 to add, 1 to change, 0 to delete, 1 unchanged
+
 >>> [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
 Deploying resources...
@@ -115,6 +120,7 @@ Deployment complete!
 }
 
 >>> [CLI] bundle plan
+Plan: 0 to add, 0 to change, 0 to delete, 2 unchanged
 
 === Fetch job ID and verify remote state
 >>> [CLI] jobs get [FOO_ID]
diff --git a/acceptance/bundle/resource_deps/missing_string_field/out.plan.direct-exp.txt b/acceptance/bundle/resource_deps/missing_string_field/out.plan.direct-exp.txt
@@ -4,3 +4,5 @@ Warning: expected a string value, found null
 
 create pipelines.bar
 create pipelines.foo
+
+Plan: 2 to add, 0 to change, 0 to delete, 0 unchanged
diff --git a/acceptance/bundle/resource_deps/missing_string_field/out.plan.terraform.txt b/acceptance/bundle/resource_deps/missing_string_field/out.plan.terraform.txt
@@ -1,2 +1,4 @@
 create pipelines.bar
 create pipelines.foo
+
+Plan: 2 to add, 0 to change, 0 to delete, 0 unchanged
diff --git a/acceptance/bundle/resource_deps/pipelines_recreate/output.txt b/acceptance/bundle/resource_deps/pipelines_recreate/output.txt
@@ -3,6 +3,8 @@
 create jobs.bar
 create pipelines.foo
 
+Plan: 2 to add, 0 to change, 0 to delete, 0 unchanged
+
 >>> [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
 Deploying resources...
@@ -44,6 +46,7 @@ Deployment complete!
 }
 
 >>> [CLI] bundle plan
+Plan: 0 to add, 0 to change, 0 to delete, 2 unchanged
 
 === Update catalog, triggering recreate for pipeline; this means updating downstream deps
 >>> update_file.py databricks.yml mycatalog mynewcatalog
@@ -52,6 +55,8 @@ Deployment complete!
 update jobs.bar
 recreate pipelines.foo
 
+Plan: 1 to add, 1 to change, 1 to delete, 0 unchanged
+
 >>> [CLI] bundle deploy --auto-approve
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
 
@@ -153,6 +158,7 @@ Exit code (musterr): 1
 
 === Follow up plan & deploy do nothing
 >>> [CLI] bundle plan
+Plan: 0 to add, 0 to change, 0 to delete, 2 unchanged
 
 >>> [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
diff --git a/acceptance/bundle/resource_deps/present_ingestion_definition/out.plan.direct-exp.txt b/acceptance/bundle/resource_deps/present_ingestion_definition/out.plan.direct-exp.txt
@@ -1,2 +1,4 @@
 create pipelines.bar
 create pipelines.foo
+
+Plan: 2 to add, 0 to change, 0 to delete, 0 unchanged
diff --git a/acceptance/bundle/resource_deps/remote_app_url/output.txt b/acceptance/bundle/resource_deps/remote_app_url/output.txt
@@ -12,6 +12,8 @@ Validation OK!
 create apps.myapp
 create pipelines.mypipeline
 
+Plan: 2 to add, 0 to change, 0 to delete, 0 unchanged
+
 >>> print_requests
 {
   "body": {
diff --git a/acceptance/bundle/resource_deps/remote_field_storage_location/output.txt b/acceptance/bundle/resource_deps/remote_field_storage_location/output.txt
@@ -29,6 +29,8 @@ create schemas.my
 create volumes.bar
 create volumes.foo
 
+Plan: 3 to add, 0 to change, 0 to delete, 0 unchanged
+
 >>> print_requests
 
 >>> [CLI] bundle deploy
diff --git a/acceptance/bundle/resources/apps/update/output.txt b/acceptance/bundle/resources/apps/update/output.txt
@@ -2,6 +2,8 @@
 >>> [CLI] bundle plan
 create apps.mykey
 
+Plan: 1 to add, 0 to change, 0 to delete, 0 unchanged
+
 >>> [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
 Deploying resources...
@@ -36,6 +38,8 @@ Resources:
 >>> [CLI] bundle plan
 update apps.mykey
 
+Plan: 0 to add, 1 to change, 0 to delete, 0 unchanged
+
 >>> [CLI] bundle deploy
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
 Deploying resources...
@@ -70,6 +74,8 @@ Resources:
 >>> [CLI] bundle plan
 recreate apps.mykey
 
+Plan: 1 to add, 0 to change, 1 to delete, 0 unchanged
+
 >>> [CLI] bundle summary
 Name: test-bundle
 Target: default
@@ -104,6 +110,7 @@ Deployment complete!
 }
 
 >>> [CLI] bundle plan
+Plan: 0 to add, 0 to change, 0 to delete, 1 unchanged
 
 >>> [CLI] bundle summary
 Name: test-bundle
diff --git a/acceptance/bundle/resources/jobs/update/output.txt b/acceptance/bundle/resources/jobs/update/output.txt
@@ -2,6 +2,8 @@
 >>> [CLI] bundle plan
 create jobs.foo
 
+Plan: 1 to add, 0 to change, 0 to delete, 0 unchanged
+
 >>> [CLI] bundle plan -o json
 {
   "plan": {
@@ -18,6 +20,7 @@ Updating deployment state...
 Deployment complete!
 
 >>> [CLI] bundle plan
+Plan: 0 to add, 0 to change, 0 to delete, 1 unchanged
 
 >>> [CLI] bundle plan -o json
 {
@@ -66,6 +69,8 @@ jobs foo id='[JOB_ID]' name='foo'
 >>> [CLI] bundle plan
 update jobs.foo
 
+Plan: 0 to add, 1 to change, 0 to delete, 0 unchanged
+
 >>> [CLI] bundle plan -o json
 {
   "plan": {
@@ -82,6 +87,7 @@ Updating deployment state...
 Deployment complete!
 
 >>> [CLI] bundle plan
+Plan: 0 to add, 0 to change, 0 to delete, 1 unchanged
 
 >>> [CLI] bundle plan -o json
 {
diff --git a/acceptance/bundle/resources/pipelines/recreate/change-catalog/output.txt b/acceptance/bundle/resources/pipelines/recreate/change-catalog/output.txt
@@ -17,6 +17,8 @@ resources:
 >>> [CLI] bundle plan
 create pipelines.my
 
+Plan: 1 to add, 0 to change, 0 to delete, 0 unchanged
+
 >>> [CLI] bundle plan -o json
 {
   "plan": {
@@ -60,6 +62,8 @@ Deployment complete!
 >>> [CLI] bundle plan
 recreate pipelines.my
 
+Plan: 1 to add, 0 to change, 1 to delete, 0 unchanged
+
 >>> [CLI] bundle plan -o json
 {
   "plan": {
diff --git a/acceptance/bundle/resources/pipelines/recreate/change-ingestion-definition/output.txt b/acceptance/bundle/resources/pipelines/recreate/change-ingestion-definition/output.txt
@@ -17,6 +17,8 @@ resources:
 >>> [CLI] bundle plan
 create pipelines.my
 
+Plan: 1 to add, 0 to change, 0 to delete, 0 unchanged
+
 >>> [CLI] bundle plan -o json
 {
   "plan": {
@@ -65,6 +67,8 @@ Deployment complete!
 >>> [CLI] bundle plan
 recreate pipelines.my
 
+Plan: 1 to add, 0 to change, 1 to delete, 0 unchanged
+
 >>> [CLI] bundle plan -o json
 {
   "plan": {
diff --git a/acceptance/bundle/resources/pipelines/recreate/change-storage/output.txt b/acceptance/bundle/resources/pipelines/recreate/change-storage/output.txt
diff --git a/acceptance/bundle/resources/schemas/recreate/output.txt b/acceptance/bundle/resources/schemas/recreate/output.txt
diff --git a/acceptance/bundle/resources/volumes/change-name/output.txt b/acceptance/bundle/resources/volumes/change-name/output.txt
diff --git a/acceptance/bundle/resources/volumes/change-schema-name/output.txt b/acceptance/bundle/resources/volumes/change-schema-name/output.txt
diff --git a/acceptance/bundle/resources/volumes/set-storage-location/output.txt b/acceptance/bundle/resources/volumes/set-storage-location/output.txt
diff --git a/cmd/bundle/plan.go b/cmd/bundle/plan.go
