Add warning when variable interpolation is used in bundle name (#3348)

shreyas-goenka · web-flow · commit 2798377d5c39 · 2025-08-05T16:13:11.000Z
## Why
Users should not be using variable interpolation in the bundle name.
Closes backlog item: DECO-827

## Tests
Acceptance test.
diff --git a/acceptance/bundle/debug/direct/out.stderr.txt b/acceptance/bundle/debug/direct/out.stderr.txt
@@ -19,6 +19,7 @@
 10:07:59 Info: Phase: initialize pid=12345
 10:07:59 Debug: Apply pid=12345 mutator=validate:AllResourcesHaveValues
 10:07:59 Debug: Apply pid=12345 mutator=validate:interpolation_in_auth_config
+10:07:59 Debug: Apply pid=12345 mutator=validate:no_interpolation_in_bundle_name
 10:07:59 Debug: Apply pid=12345 mutator=validate:scripts
 10:07:59 Debug: Apply pid=12345 mutator=RewriteSyncPaths
 10:07:59 Debug: Apply pid=12345 mutator=SyncDefaultPath
diff --git a/acceptance/bundle/debug/direct/output.txt b/acceptance/bundle/debug/direct/output.txt
@@ -14,7 +14,7 @@ Validation OK!
 +>>> [CLI] bundle validate --debug
  10:07:59 Info: start pid=12345 version=[DEV_VERSION] args="[CLI], bundle, validate, --debug"
  10:07:59 Debug: Found bundle root at [TEST_TMP_DIR] (file [TEST_TMP_DIR]/databricks.yml) pid=12345
-@@ -61,8 +63,4 @@
+@@ -62,8 +64,4 @@
  10:07:59 Debug: Apply pid=12345 mutator=metadata.AnnotateJobs
  10:07:59 Debug: Apply pid=12345 mutator=metadata.AnnotatePipelines
 -10:07:59 Debug: Apply pid=12345 mutator=terraform.Initialize
diff --git a/acceptance/bundle/debug/tf/out.stderr.txt b/acceptance/bundle/debug/tf/out.stderr.txt
@@ -17,6 +17,7 @@
 10:07:59 Info: Phase: initialize pid=12345
 10:07:59 Debug: Apply pid=12345 mutator=validate:AllResourcesHaveValues
 10:07:59 Debug: Apply pid=12345 mutator=validate:interpolation_in_auth_config
+10:07:59 Debug: Apply pid=12345 mutator=validate:no_interpolation_in_bundle_name
 10:07:59 Debug: Apply pid=12345 mutator=validate:scripts
 10:07:59 Debug: Apply pid=12345 mutator=RewriteSyncPaths
 10:07:59 Debug: Apply pid=12345 mutator=SyncDefaultPath
diff --git a/acceptance/bundle/validate/var_in_bundle_name/databricks.yml b/acceptance/bundle/validate/var_in_bundle_name/databricks.yml
@@ -0,0 +1,14 @@
+bundle:
+  name: trees are ${var.color}
+
+variables:
+  color:
+    default: "green"
+
+targets:
+  one:
+    default: true
+
+  two:
+    bundle:
+      name: trees are red
diff --git a/acceptance/bundle/validate/var_in_bundle_name/out.test.toml b/acceptance/bundle/validate/var_in_bundle_name/out.test.toml
@@ -0,0 +1,5 @@
+Local = true
+Cloud = false
+
+[EnvMatrix]
+  DATABRICKS_CLI_DEPLOYMENT = ["terraform", "direct-exp"]
diff --git a/acceptance/bundle/validate/var_in_bundle_name/output.txt b/acceptance/bundle/validate/var_in_bundle_name/output.txt
@@ -0,0 +1,25 @@
+
+>>> [CLI] bundle validate
+Warning: Please do not use variable interpolation in the name of your bundle. The name of your bundle
+is a part of the path at which your bundle state is stored at by default. Parameterizing it at
+runtime can have unexpected consequences like duplicate deployments or resources not being
+cleaned up during bundle destroy.
+  at bundle.name
+  in databricks.yml:2:9
+
+Name: trees are green
+Target: one
+Workspace:
+  User: [USERNAME]
+  Path: /Workspace/Users/[USERNAME]/.bundle/trees are green/one
+
+Found 1 warning
+
+>>> [CLI] bundle validate --target two
+Name: trees are red
+Target: two
+Workspace:
+  User: [USERNAME]
+  Path: /Workspace/Users/[USERNAME]/.bundle/trees are red/two
+
+Validation OK!
diff --git a/acceptance/bundle/validate/var_in_bundle_name/script b/acceptance/bundle/validate/var_in_bundle_name/script
@@ -0,0 +1,3 @@
+trace $CLI bundle validate
+
+trace $CLI bundle validate --target two
diff --git a/acceptance/bundle/variables/empty/output.txt b/acceptance/bundle/variables/empty/output.txt
@@ -1,3 +1,10 @@
+Warning: Please do not use variable interpolation in the name of your bundle. The name of your bundle
+is a part of the path at which your bundle state is stored at by default. Parameterizing it at
+runtime can have unexpected consequences like duplicate deployments or resources not being
+cleaned up during bundle destroy.
+  at bundle.name
+  in databricks.yml:7:9
+
 Error: no value assigned to required variable a. Assignment can be done using "--var", by setting the BUNDLE_VAR_a environment variable, or in .databricks/bundle/<target>/variable-overrides.json file
 
 Name: empty${var.a}
@@ -6,6 +13,6 @@ Workspace:
   User: [USERNAME]
   Path: /Workspace/Users/[USERNAME]/.bundle/empty${var.a}/default
 
-Found 1 error
+Found 1 error and 1 warning
 
 Exit code: 1
diff --git a/acceptance/bundle/variables/vanilla/databricks.yml b/acceptance/bundle/variables/vanilla/databricks.yml
@@ -7,4 +7,9 @@ variables:
     description: required variable
 
 bundle:
-  name: ${var.a} ${var.b}
+  name: foobar
+
+resources:
+  jobs:
+    one:
+      name: ${var.a} ${var.b}
diff --git a/acceptance/bundle/variables/vanilla/output.txt b/acceptance/bundle/variables/vanilla/output.txt
@@ -5,11 +5,11 @@
 >>> errcode [CLI] bundle validate
 Error: no value assigned to required variable b. Assignment can be done using "--var", by setting the BUNDLE_VAR_b environment variable, or in .databricks/bundle/<target>/variable-overrides.json file
 
-Name: ${var.a} ${var.b}
+Name: foobar
 Target: default
 Workspace:
   User: [USERNAME]
-  Path: /Workspace/Users/[USERNAME]/.bundle/${var.a} ${var.b}/default
+  Path: /Workspace/Users/[USERNAME]/.bundle/foobar/default
 
 Found 1 error
 
diff --git a/acceptance/bundle/variables/vanilla/script b/acceptance/bundle/variables/vanilla/script
@@ -1,2 +1,3 @@
-trace BUNDLE_VAR_b=def $CLI bundle validate -o json | jq .bundle.name
+trace BUNDLE_VAR_b=def $CLI bundle validate -o json | jq .resources.jobs.one.name
+
 trace errcode $CLI bundle validate
diff --git a/bundle/config/validate/no_interpolation_in_bundle_name.go b/bundle/config/validate/no_interpolation_in_bundle_name.go
@@ -0,0 +1,37 @@
+package validate
+
+import (
+	"context"
+
+	"github.com/databricks/cli/bundle"
+	"github.com/databricks/cli/libs/diag"
+	"github.com/databricks/cli/libs/dyn"
+	"github.com/databricks/cli/libs/dyn/dynvar"
+	"github.com/databricks/cli/libs/logdiag"
+)
+
+type noInterpolationInBundleName struct{}
+
+func NoInterpolationInBundleName() bundle.Mutator {
+	return &noInterpolationInBundleName{}
+}
+
+func (m *noInterpolationInBundleName) Name() string {
+	return "validate:no_interpolation_in_bundle_name"
+}
+
+func (m *noInterpolationInBundleName) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagnostics {
+	if dynvar.ContainsVariableReference(b.Config.Bundle.Name) {
+		logdiag.LogDiag(ctx, diag.Diagnostic{
+			Severity: diag.Warning,
+			Summary: `Please do not use variable interpolation in the name of your bundle. The name of your bundle
+is a part of the path at which your bundle state is stored at by default. Parameterizing it at
+runtime can have unexpected consequences like duplicate deployments or resources not being
+cleaned up during bundle destroy.`,
+			Locations: b.Config.GetLocations("bundle.name"),
+			Paths:     []dyn.Path{dyn.MustPathFromString("bundle.name")},
+		})
+	}
+
+	return nil
+}
diff --git a/bundle/phases/initialize.go b/bundle/phases/initialize.go
@@ -42,6 +42,7 @@ func Initialize(ctx context.Context, b *bundle.Bundle) {
 		// Checks that none of resources.<type>.<key> is nil. Raises error otherwise.
 		validate.AllResourcesHaveValues(),
 		validate.NoInterpolationInAuthConfig(),
+		validate.NoInterpolationInBundleName(),
 		validate.Scripts(),
 
 		// Updates (dynamic): sync.{paths,include,exclude} (makes them relative to bundle root rather than to definition file)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+trace $CLI bundle validate`
	`2`	`+`
	`3`	`+trace $CLI bundle validate --target two`