Add summary for 'bundle plan' output by andrewnester · Pull Request #3546 · databricks/cli

andrewnester · 2025-09-03T12:38:45Z

Changes

Changed plan output to be printed from stderr (cmdio.LogString) to stdout (fmt.Printf/fmt.Println)
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, 3 unchanged

Why

Improving the output before making the command publicly available

Tests

Updated acceptance test output
Existing acceptance test updated and passing

eng-dev-ecosystem-bot · 2025-09-03T12:53:35Z

Run: 17971815191

	Env	✅pass	🙈skip
✅	aws linux	311	529
✅	aws windows	312	528
✅	aws-ucws linux	423	427
✅	aws-ucws windows	424	426
✅	azure linux	311	528
✅	azure windows	312	527
✅	azure-ucws linux	423	426
✅	azure-ucws windows	424	425
✅	gcp linux	310	530
✅	gcp windows	311	529

denik · 2025-09-04T14:52:04Z

acceptance/bundle/resource_deps/bad_syntax/out.plan.terraform.txt

 An attribute name is required after a dot.


+No changes. Your infrastructure matches the configuration.


Would it be more informational to show count there as well? and perhaps normalize the message to

with changes:

Plan: 4 to add, 0 to change, 0 to delete, 26 unchanged

without changes:

Plan: 0 to add, 0 to change, 0 to delete, 30 unchanged

BTW, terraform shows this summary as last line, not first. Makes it easier to see on terminal if you have a lot of output.

Yeah I like having it at the last line. The problem is just this extra Building python_artifact... line that makes the output slightly messy :-/ That's why I'd propose to do the summary line at the top, signaling a start of the (more) useful output of the command.

We could separate all logging (there could be more than "Building python artifact") with an empty line on stderr flushed before plan output is printed.

We could separate all logging (there could be more than "Building python artifact") with an empty line on stderr flushed before plan output is printed.

Yes that could work.

So

random log lines # stderr: lines like "Building Python artifact" # stderr: newline create jobs.bar create ... Plan: 0 to add, 0 to change, 0 to delete, 30 unchanged

would work as an alternative to the original proposal.

@andrewnester thoughts on the above summary by @lennartkats-db ? I see plan is still printed before the rest and there does not seem to be separation from other log line.

I see plan is still printed before the rest

This has changed in the latest commit bcb4da7

denik · 2025-09-04T14:52:40Z

acceptance/bundle/resource_deps/create_error/output.txt

+  create jobs.bar
+  create jobs.baz
+  create jobs.foo
+  create jobs.independent


Why do we need the spaces in front? They make output processing harder, e.g. grep ^delete won't work anymore/

Two spaces:

We want some way to distinguish these lines from the heading and from any stderr log lines that we still show (right now just Building python_artifact...)

Consistency with

cli/acceptance/pipelines/e2e/output.txt

Lines 94 to 95 in 3c03fdd

delete pipeline my_project_pipeline

delete pipeline my_project_pipeline_2

We want some way to distinguish these lines from the heading and from any stderr log lines that we still show (right now just Building python_artifact...)

Makes sense. One other thing that can do regardless is insert newline on stderr if there was an output there.

Consistency with

This action will result in the **deletion** of the following Lakeflow Declarative Pipelines along with the Streaming Tables (STs) and Materialized Views (MVs) managed by them: **delete** pipeline my_project_pipeline **delete** pipeline my_project_pipeline_2

Regardless of bundle plan I was thinking of updating this message so that:

it does not mention delete twice (once in the sentence and one in the line item)

uses . format that we're adopting everywhere (pipelines.my_project_pipeline).

So it could look like this:

This action will result in the deletion of the following Lakeflow Declarative Pipelines along with the Streaming Tables (STs) and Materialized Views (MVs) managed by them: - pipelines.my_project_pipeline - pipelines.my_project_pipeline_2

acceptance/bundle/bundle_tag/url_ref/out.plan.direct-exp.txt

acceptance/bundle/deploy/pipeline/recreate/output.txt

pietern · 2025-09-08T12:20:30Z

cmd/bundle/plan.go

+				fmt.Println(action)
+			}
+		} else {
+			fmt.Println("No changes. Your infrastructure matches the configuration.")


Instead of fmt.Printf and fmt.Println, we should use fmt.Fprintf and friends with cmd.OutOrStdout(). That enables redirection elsewhere and is in line with the rest of the code under cmd. Looking into a linter for this.

As for the wording here, I suggest:

No resource changes. Your deployment matches the configuration.

Because:

Code might have changed, and we're not tracking that here

We don't use "infrastructure" anywhere to refer to a bundle resources

@pietern I quite like the proposal from @denik

with changes: Plan: 4 to add, 0 to change, 0 to delete, 26 unchanged without changes: Plan: 0 to add, 0 to change, 0 to delete, 30 unchanged

what do you think?

Yeah it would be good if we consistently show that summary based on the thread above

## Changes Reject directly writing to global stdout/stderr. The "forbidigo" linter includes this rule by default. Also see https://golangci-lint.run/docs/linters/configuration/#forbidigo ## Why The CLI uses Cobra and should therefore use `cmd.OutOrStdout()` and friends. Saw this here: #3546 (comment)

cmd/bundle/plan.go

denik · 2025-09-22T11:28:35Z

acceptance/bundle/deployment/bind/alert/out.test.toml

@@ -1,4 +1,4 @@
-Local = true
+Local = false


Why was this test disabled?

It's already disabled on main but I guess out.test.toml was not updated there

denik · 2025-09-22T11:29:15Z

cmd/bundle/plan.go

+					fmt.Fprintf(out, "%s %s\n", action.ActionType.StringShort(), key)
+				}
+			} else {
+				fmt.Fprintf(out, "Plan: 0 to add, 0 to change, 0 to delete, %d unchanged\n", unchanged)


Should not summary go to stderr? So that you can process the per-resource stats.

Why is this a branch if the other branch prints the same output?

@denik I'd prefer users to use JSON output instead of parsing text in such scenarios. Since this command is summary I also prefer summary to be printed to stdout

@pietern good point, no need to have it anymore

Having JSON output does not mean we should not get the most value our of text output. grep / sort are much easier than JSON parsing.

I find it confusing that the plan command shows the summary line in stderr, but the rest of the plan in stdout. I'd prefer to keep all of it in stdout. Parsing text output is error-prone, as we might change this output later with some styling, which can break. Hence, I suggest using JSON for parsing purposes.

cmd/bundle/plan.go

pietern · 2025-09-22T13:19:42Z

cmd/bundle/plan.go

+					fmt.Fprintf(out, "%s %s\n", action.ActionType.StringShort(), key)
+				}
+			} else {
+				fmt.Fprintf(out, "Plan: 0 to add, 0 to change, 0 to delete, %d unchanged\n", unchanged)


Why is this a branch if the other branch prints the same output?

cmd/bundle/plan.go

acceptance/bundle/resources/volumes/set-storage-location/output.txt

cmd/bundle/plan.go

## Changes Linter will error for switch statements on an enum where not all enum values are covered. The statement can still use a `default:` clause to explicitly fall through. ## Why Observation here: #3546 (comment)

denik

I'd still prefer stdout to be structured even in text mode and all unstructured stuff go to stderr, but it's a minor thing, we can revisit/discuss it later.

## 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

Add summary for 'bundle plan' output and print to stdout

8486481

andrewnester requested review from anton-107, denik, pietern and shreyas-goenka as code owners September 3, 2025 12:38

andrewnester temporarily deployed to test-trigger-is September 3, 2025 12:38 — with GitHub Actions Inactive

andrewnester mentioned this pull request Sep 3, 2025

Added 'databricks bundle plan' command #3530

Merged

fix bundle debug test output

f517a40

andrewnester temporarily deployed to test-trigger-is September 3, 2025 12:57 — with GitHub Actions Inactive

denik reviewed Sep 4, 2025

View reviewed changes

pietern reviewed Sep 8, 2025

View reviewed changes

pietern mentioned this pull request Sep 8, 2025

Reject use of fmt.Printf under cmd/ #3570

Merged

update plan output

5e5c01d

andrewnester temporarily deployed to test-trigger-is September 10, 2025 13:40 — with GitHub Actions Inactive

andrewnester requested review from denik, lennartkats-db and pietern September 10, 2025 13:41

Merge branch 'main' into fix/bundle-plan-output

c056981

andrewnester temporarily deployed to test-trigger-is September 16, 2025 15:11 — with GitHub Actions Inactive

Merge branch 'main' into fix/bundle-plan-output

b7c67c7

andrewnester temporarily deployed to test-trigger-is September 19, 2025 09:49 — with GitHub Actions Inactive

denik reviewed Sep 19, 2025

View reviewed changes

cmd/bundle/plan.go Show resolved Hide resolved

denik reviewed Sep 19, 2025

View reviewed changes

cmd/bundle/plan.go Outdated Show resolved Hide resolved

denik reviewed Sep 19, 2025

View reviewed changes

cmd/bundle/plan.go Outdated Show resolved Hide resolved

update output

c32e4a8

andrewnester temporarily deployed to test-trigger-is September 19, 2025 10:14 — with GitHub Actions Inactive

andrewnester requested a review from denik September 19, 2025 10:22

Merge branch 'main' into fix/bundle-plan-output

87f315e

andrewnester temporarily deployed to test-trigger-is September 22, 2025 11:05 — with GitHub Actions Inactive

denik reviewed Sep 22, 2025

View reviewed changes

pietern reviewed Sep 22, 2025

View reviewed changes

pietern mentioned this pull request Sep 22, 2025

Enable linter for exhaustive coverage in enum switch statements #3641

Merged

andrewnester changed the title ~~Add summary for 'bundle plan' output and print to stdout~~ Add summary for 'bundle plan' output Sep 23, 2025

Merge branch 'main' into fix/bundle-plan-output

e1fe97c

andrewnester temporarily deployed to test-trigger-is September 23, 2025 13:27 — with GitHub Actions Inactive

fixes

bcb4da7

andrewnester temporarily deployed to test-trigger-is September 23, 2025 13:43 — with GitHub Actions Inactive

andrewnester requested review from denik and pietern September 23, 2025 13:43

pietern reviewed Sep 23, 2025

View reviewed changes

cmd/bundle/plan.go Outdated Show resolved Hide resolved

acceptance/bundle/resources/volumes/set-storage-location/output.txt Outdated Show resolved Hide resolved

fix unchanged cout

b96241f

andrewnester temporarily deployed to test-trigger-is September 23, 2025 14:16 — with GitHub Actions Inactive

andrewnester requested a review from pietern September 23, 2025 14:17

explicit switch

9bfc2eb

andrewnester temporarily deployed to test-trigger-is September 23, 2025 14:28 — with GitHub Actions Inactive

pietern approved these changes Sep 23, 2025

View reviewed changes

cmd/bundle/plan.go Show resolved Hide resolved

denik approved these changes Sep 24, 2025

View reviewed changes

added new line

5fc9ac6

andrewnester temporarily deployed to test-trigger-is September 24, 2025 09:02 — with GitHub Actions Inactive

andrewnester enabled auto-merge September 24, 2025 09:02

andrewnester added this pull request to the merge queue Sep 24, 2025

Merged via the queue into main with commit efa69f4 Sep 24, 2025
13 checks passed

andrewnester deleted the fix/bundle-plan-output branch September 24, 2025 09:48

		An attribute name is required after a dot.


		No changes. Your infrastructure matches the configuration.

	delete pipeline my_project_pipeline
	delete pipeline my_project_pipeline_2

Conversation

andrewnester commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Why

Tests

Uh oh!

eng-dev-ecosystem-bot commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lennartkats-db Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

denik left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

andrewnester commented Sep 3, 2025 •

edited

Loading

eng-dev-ecosystem-bot commented Sep 3, 2025 •

edited

Loading

lennartkats-db Sep 5, 2025 •

edited

Loading