Use .workspace.URL for the host in built-in templates

.nextchanges/bundles/builtin-templates-workspace-url.md

@@ -0,0 +1 @@
+* Built-in templates add the workspace ID to `workspace.host` (`?w=<id>`) when the profile or an environment variable sets it, so generated bundles select the right workspace on hosts shared by several workspaces. Welcome messages show the same URL, and `dbt-sql` also adds `?o=<id>` to the HTTP path it suggests for `dbt init`. ([#7350](https://github.com/databricks/cli/pull/7350))

acceptance/bundle/templates/dbt-sql-workspace-id/input.json

@@ -0,0 +1,6 @@
+{
+    "project_name": "my_dbt_sql",
+    "http_path": "/sql/2.0/warehouses/f00dcafe",
+    "default_catalog": "main",
+    "personal_schemas": "yes"
+}

acceptance/bundle/templates/dbt-sql-workspace-id/out.test.toml

@@ -0,0 +1,2 @@
+Cloud = false
+EnvMatrix.DMS = [""]

acceptance/bundle/templates/dbt-sql-workspace-id/output.txt

@@ -0,0 +1,48 @@
+
+=== Profile no_workspace_id
+
+>>> [CLI] bundle init dbt-sql --config-file ./input.json --profile no_workspace_id
+
+Welcome to the dbt template for Declarative Automation Bundles!
+
+A workspace was selected based on your current profile. For information about how to change this, see https://docs.databricks.com/dev-tools/cli/profiles.html.
+workspace_host: [DATABRICKS_URL]
+
+📊 Your new project has been created in the 'my_dbt_sql' directory!
+If you already have dbt installed, just type 'cd my_dbt_sql; dbt init' to get started.
+Refer to the README.md file for full "getting started" guide and production setup instructions.
+
+
+>>> grep host: my_dbt_sql/databricks.yml
+      host: [DATABRICKS_URL]
+      host: [DATABRICKS_URL]
+
+>>> grep -E ^    default: [^{] my_dbt_sql/profile_template.yml
+    default: [DATABRICKS_HOST]
+    default: /sql/2.0/warehouses/f00dcafe
+    default: main
+    default: 4
+
+=== Profile custom_host
+
+>>> [CLI] bundle init dbt-sql --config-file ./input.json --profile custom_host
+
+Welcome to the dbt template for Declarative Automation Bundles!
+
+A workspace was selected based on your current profile. For information about how to change this, see https://docs.databricks.com/dev-tools/cli/profiles.html.
+workspace_host: [CUSTOM_HOST]?w=[WORKSPACE_ID]
+
+📊 Your new project has been created in the 'my_dbt_sql' directory!
+If you already have dbt installed, just type 'cd my_dbt_sql; dbt init' to get started.
+Refer to the README.md file for full "getting started" guide and production setup instructions.
+
+
+>>> grep host: my_dbt_sql/databricks.yml
+      host: [CUSTOM_HOST]?w=[WORKSPACE_ID]
+      host: [CUSTOM_HOST]?w=[WORKSPACE_ID]
+
+>>> grep -E ^    default: [^{] my_dbt_sql/profile_template.yml
+    default: [CUSTOM_HOSTNAME]
+    default: /sql/2.0/warehouses/f00dcafe?o=[WORKSPACE_ID]
+    default: main
+    default: 4

acceptance/bundle/templates/dbt-sql-workspace-id/script

@@ -0,0 +1,25 @@
+setup_custom_host
+
+cat > .databrickscfg <<EOT
+[no_workspace_id]
+host = $DATABRICKS_HOST
+token = $DATABRICKS_TOKEN
+
+[custom_host]
+host = $CUSTOM_HOST
+workspace_id = $WORKSPACE_ID
+token = $DATABRICKS_TOKEN
+EOT
+export DATABRICKS_CONFIG_FILE=$PWD/.databrickscfg
+unset DATABRICKS_HOST
+unset DATABRICKS_TOKEN
+
+# dbt reads the workspace ID from ?o= in the HTTP path. The template adds it
+# when the profile sets the ID, like ?w= in the bundle host.
+for profile in no_workspace_id custom_host; do
+  title "Profile $profile\n"
+  trace $CLI bundle init dbt-sql --config-file ./input.json --profile $profile
+  trace grep 'host:' my_dbt_sql/databricks.yml
+  trace grep -E "^    default: [^{]" my_dbt_sql/profile_template.yml
+  rm -r my_dbt_sql
+done

acceptance/bundle/templates/dbt-sql-workspace-id/test.toml

@@ -0,0 +1 @@
+Ignore = [".databrickscfg"]

acceptance/bundle/templates/default-minimal/profiles/input.json

@@ -0,0 +1,4 @@
+{
+    "project_name": "my_default_minimal",
+    "language_choice": "python"
+}

acceptance/bundle/templates/default-minimal/profiles/out.test.toml

@@ -0,0 +1,2 @@
+Cloud = false
+EnvMatrix.DMS = [""]

acceptance/bundle/templates/default-minimal/profiles/output.txt

@@ -0,0 +1,68 @@
+
+=== Profile classic
+
+>>> [CLI] bundle init default-minimal --config-file ./input.json --profile classic
+Welcome to the minimal Declarative Automation Bundle template!
+
+This template creates a minimal project structure without sample code, ideal for advanced users.
+(For getting started with Python or SQL code, use the default-python or default-sql templates instead.)
+
+Your workspace at [DATABRICKS_URL] is used for initialization.
+(See https://docs.databricks.com/dev-tools/cli/profiles.html for how to change your profile.)
+
+✨ Your new project has been created in the 'my_default_minimal' directory!
+
+To get started, refer to the project README.md file and the documentation at https://docs.databricks.com/dev-tools/bundles/index.html.
+
+>>> grep host: databricks.yml
+      host: [DATABRICKS_URL]
+      host: [DATABRICKS_URL]
+
+>>> DATABRICKS_BUNDLE_STRICT_PROFILE_MATCH=1 [CLI] bundle validate -t dev
+Name: my_default_minimal
+Target: dev
+Workspace:
+  Host: [DATABRICKS_URL]
+  User: [USERNAME]
+  Path: /Workspace/Users/[USERNAME]/.bundle/my_default_minimal/dev
+
+Validation OK!
+
+>>> [CLI] bundle deploy -t dev
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/my_default_minimal/dev/files...
+Files: 10 uploaded, 0 deleted
+Resources: 0 created, 0 changed, 0 deleted, 0 unchanged
+
+=== Profile custom_host
+
+>>> [CLI] bundle init default-minimal --config-file ./input.json --profile custom_host
+Welcome to the minimal Declarative Automation Bundle template!
+
+This template creates a minimal project structure without sample code, ideal for advanced users.
+(For getting started with Python or SQL code, use the default-python or default-sql templates instead.)
+
+Your workspace at [CUSTOM_HOST]?w=[WORKSPACE_ID] is used for initialization.
+(See https://docs.databricks.com/dev-tools/cli/profiles.html for how to change your profile.)
+
+✨ Your new project has been created in the 'my_default_minimal' directory!
+
+To get started, refer to the project README.md file and the documentation at https://docs.databricks.com/dev-tools/bundles/index.html.
+
+>>> grep host: databricks.yml
+      host: [CUSTOM_HOST]?w=[WORKSPACE_ID]
+      host: [CUSTOM_HOST]?w=[WORKSPACE_ID]
+
+>>> DATABRICKS_BUNDLE_STRICT_PROFILE_MATCH=1 [CLI] bundle validate -t dev
+Name: my_default_minimal
+Target: dev
+Workspace:
+  Host: [CUSTOM_HOST]?w=[WORKSPACE_ID]
+  User: [USERNAME]
+  Path: /Workspace/Users/[USERNAME]/.bundle/my_default_minimal/dev
+
+Validation OK!
+
+>>> [CLI] bundle deploy -t dev
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/my_default_minimal/dev/files...
+Files: 10 uploaded, 0 deleted
+Resources: 0 created, 0 changed, 0 deleted, 0 unchanged

acceptance/bundle/templates/default-minimal/profiles/script

@@ -0,0 +1,29 @@
+setup_custom_host
+
+# The classic profile has no workspace_id. The SDK resolves the ID from host
+# metadata, but the generated host stays without ?w= so that it matches the
+# profile in strict mode too.
+cat > .databrickscfg <<EOT
+[classic]
+host = $DATABRICKS_HOST
+token = $DATABRICKS_TOKEN
+
+[custom_host]
+host = $CUSTOM_HOST
+workspace_id = $WORKSPACE_ID
+token = $DATABRICKS_TOKEN
+EOT
+export DATABRICKS_CONFIG_FILE=$PWD/.databrickscfg
+unset DATABRICKS_HOST
+unset DATABRICKS_TOKEN
+
+for profile in classic custom_host; do
+  title "Profile $profile\n"
+  trace $CLI bundle init default-minimal --config-file ./input.json --profile $profile
+  cd my_default_minimal
+  trace grep 'host:' databricks.yml
+  trace DATABRICKS_BUNDLE_STRICT_PROFILE_MATCH=1 $CLI bundle validate -t dev
+  trace $CLI bundle deploy -t dev
+  cd ..
+  rm -r my_default_minimal
+done

acceptance/bundle/templates/default-minimal/profiles/test.toml

@@ -0,0 +1,2 @@
+# The script writes .databrickscfg.
+Ignore = [".databrickscfg"]

libs/template/renderer_test.go

@@ -19,6 +19,7 @@ import (
 	"github.com/databricks/cli/libs/cmdctx"
 	"github.com/databricks/cli/libs/dbr"
 	"github.com/databricks/cli/libs/filer"
+	"github.com/databricks/cli/libs/jsonschema"
 	"github.com/databricks/cli/libs/logdiag"
 	"github.com/databricks/cli/libs/tags"
 	"github.com/databricks/databricks-sdk-go"
@@ -49,6 +50,10 @@ func assertBuiltinTemplateValid(t *testing.T, template string, settings map[stri
 
 	renderer, err := newRenderer(ctx, settings, helpers, templateFS, templateDirName, libraryDirName)
 	require.NoError(t, err)
+	schema, err := jsonschema.LoadFS(templateFS, schemaFileName)
+	require.NoError(t, err)
+	renderer.workspace, err = loadWorkspaceContext(ctx, schema)
+	require.NoError(t, err)
 
 	// Evaluate template
 	err = renderer.walk()

libs/template/templates/dbt-sql/databricks_template_schema.json

@@ -1,5 +1,5 @@
 {
-    "welcome_message": "\nWelcome to the dbt template for Declarative Automation Bundles!\n\nA workspace was selected based on your current profile. For information about how to change this, see https://docs.databricks.com/dev-tools/cli/profiles.html.\nworkspace_host: {{workspace_host}}",
+    "welcome_message": "\nWelcome to the dbt template for Declarative Automation Bundles!\n\nA workspace was selected based on your current profile. For information about how to change this, see https://docs.databricks.com/dev-tools/cli/profiles.html.\nworkspace_host: {{.workspace.URL}}",
     "properties": {
         "project_name": {
             "type": "string",

libs/template/templates/dbt-sql/template/{{.project_name}}/databricks.yml.tmpl

@@ -20,12 +20,12 @@ targets:
     mode: development
     default: true
     workspace:
-      host: {{workspace_host}}
+      host: {{.workspace.URL}}
 
   prod:
     mode: production
     workspace:
-      host: {{workspace_host}}
+      host: {{.workspace.URL}}
       # We explicitly deploy to /Workspace/Users/{{user_name}} to make sure we only have a single copy.
       root_path: /Workspace/Users/{{user_name}}/.bundle/${bundle.name}/${bundle.target}
     permissions:

libs/template/templates/dbt-sql/template/{{.project_name}}/profile_template.yml.tmpl

@@ -5,13 +5,15 @@ fixed:
   type: databricks
 prompts:
   host:
-    default: {{(regexp "^https?://").ReplaceAllString workspace_host ""}}
+    default: {{.workspace.Hostname}}
   token:
     hint: 'personal access token to use, dapiXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
     hide_input: true
   http_path:
     hint: 'HTTP path of SQL warehouse to use'
-    default: {{.http_path}}
+    {{- /* dbt selects the workspace on a host shared by several workspaces with ?o=<id> in the
+    HTTP path. Add it when the workspace URL has the ID. */}}
+    default: {{.http_path}}{{with .workspace.URLID}}?o={{urlquery .}}{{end}}
   {{- if eq .default_catalog ""}}
   _choose_unity_catalog:
     'use the default workspace catalog (or do not use Unity Catalog)':

libs/template/templates/default-minimal/databricks_template_schema.json

@@ -1,6 +1,6 @@
 {
     "template_dir": "../default",
-    "welcome_message": "Welcome to the minimal Declarative Automation Bundle template!\n\nThis template creates a minimal project structure without sample code, ideal for advanced users.\n(For getting started with Python or SQL code, use the default-python or default-sql templates instead.)\n\nYour workspace at {{workspace_host}} is used for initialization.\n(See https://docs.databricks.com/dev-tools/cli/profiles.html for how to change your profile.)",
+    "welcome_message": "Welcome to the minimal Declarative Automation Bundle template!\n\nThis template creates a minimal project structure without sample code, ideal for advanced users.\n(For getting started with Python or SQL code, use the default-python or default-sql templates instead.)\n\nYour workspace at {{.workspace.URL}} is used for initialization.\n(See https://docs.databricks.com/dev-tools/cli/profiles.html for how to change your profile.)",
     "properties": {
         "template_name": {
             "//": "This property is always set to 'default-minimal'",

libs/template/templates/default-python/databricks_template_schema.json

@@ -1,6 +1,6 @@
 {
     "template_dir": "../default",
-    "welcome_message": "Welcome to the default Python template for Declarative Automation Bundles!\n\nAnswer the following questions to customize your project.\nYou can always change your configuration in the databricks.yml file later.\n\nNote that {{workspace_host}} is used for initialization.\n(For information on how to change your profile, see https://docs.databricks.com/dev-tools/cli/profiles.html.)",
+    "welcome_message": "Welcome to the default Python template for Declarative Automation Bundles!\n\nAnswer the following questions to customize your project.\nYou can always change your configuration in the databricks.yml file later.\n\nNote that {{.workspace.URL}} is used for initialization.\n(For information on how to change your profile, see https://docs.databricks.com/dev-tools/cli/profiles.html.)",
     "properties": {
         "template_name": {
             "//": "This property is always set to 'default-python'",

libs/template/templates/default-scala/databricks_template_schema.json

@@ -1,5 +1,5 @@
 {
-  "welcome_message": "\nWelcome to the default-scala template for Declarative Automation Bundles!\n\nA workspace was selected based on your current profile. For information about how to change this, see https://docs.databricks.com/dev-tools/cli/profiles.html.\nworkspace_host: {{workspace_host}}",
+  "welcome_message": "\nWelcome to the default-scala template for Declarative Automation Bundles!\n\nA workspace was selected based on your current profile. For information about how to change this, see https://docs.databricks.com/dev-tools/cli/profiles.html.\nworkspace_host: {{.workspace.URL}}",
   "properties": {
     "project_name": {
       "type": "string",

libs/template/templates/default-scala/template/{{.project_name}}/databricks.yml.tmpl

@@ -22,7 +22,7 @@ variables:
 {{- end}}
 
 workspace:
-  host: {{workspace_host}}
+  host: {{.workspace.URL}}
   artifact_path: {{.artifacts_dest_path}}/${bundle.name}/${bundle.target}/${workspace.current_user.short_name}
 
 artifacts:
@@ -42,15 +42,15 @@ targets:
     mode: development
     default: true
     workspace:
-      host: {{workspace_host}}
+      host: {{.workspace.URL}}
     variables:
       catalog: {{.default_catalog}}
       schema: {{$dev_schema}}
 
   prod:
     mode: production
     workspace:
-      host: {{workspace_host}}
+      host: {{.workspace.URL}}
       # We explicitly deploy to /Workspace/Users/{{user_name}} to make sure we only have a single copy.
       root_path: /Workspace/Users/{{user_name}}/.bundle/${bundle.name}/${bundle.target}
     permissions:

libs/template/templates/default-sql/databricks_template_schema.json

@@ -1,5 +1,5 @@
 {
-    "welcome_message": "\nWelcome to the default SQL template for Declarative Automation Bundles!\n\nA workspace was selected based on your current profile. For information about how to change this, see https://docs.databricks.com/dev-tools/cli/profiles.html.\nworkspace_host: {{workspace_host}}",
+    "welcome_message": "\nWelcome to the default SQL template for Declarative Automation Bundles!\n\nA workspace was selected based on your current profile. For information about how to change this, see https://docs.databricks.com/dev-tools/cli/profiles.html.\nworkspace_host: {{.workspace.URL}}",
     "properties": {
         "project_name": {
             "type": "string",

libs/template/templates/default-sql/template/{{.project_name}}/databricks.yml.tmpl

@@ -33,7 +33,7 @@ targets:
     mode: development
     default: true
     workspace:
-      host: {{workspace_host}}
+      host: {{.workspace.URL}}
     variables:
       warehouse_id: {{index ((regexp "[^/]+$").FindStringSubmatch .http_path) 0}}
       catalog: {{.default_catalog}}
@@ -42,7 +42,7 @@ targets:
   prod:
     mode: production
     workspace:
-      host: {{workspace_host}}
+      host: {{.workspace.URL}}
       # We explicitly deploy to /Workspace/Users/{{user_name}} to make sure we only have a single copy.
       root_path: /Workspace/Users/{{user_name}}/.bundle/${bundle.name}/${bundle.target}
     variables:

libs/template/templates/default/template/{{.project_name}}/databricks.yml.tmpl

@@ -49,7 +49,7 @@ targets:
     mode: development
     default: true
     workspace:
-      host: {{workspace_host}}
+      host: {{.workspace.URL}}
     variables:
       catalog: {{.default_catalog}}
       schema: {{$dev_schema}}
@@ -60,7 +60,7 @@ targets:
   prod:
     mode: production
     workspace:
-      host: {{workspace_host}}
+      host: {{.workspace.URL}}
       # We explicitly deploy to /Workspace/Users/{{user_name}} to make sure we only have a single copy.
       root_path: /Workspace/Users/{{user_name}}/.bundle/${bundle.name}/${bundle.target}
     variables:

libs/template/templates/lakeflow-integrations/template/{{.project_name}}/databricks.yml.tmpl

@@ -38,11 +38,11 @@ targets:
     mode: development
     default: true
     workspace:
-      host: {{workspace_host}}
+      host: {{.workspace.URL}}
   prod:
     mode: production
     workspace:
-      host: {{workspace_host}}
+      host: {{.workspace.URL}}
       # We explicitly deploy to /Workspace/Users/{{user_name}} to make sure we only have a single copy.
       root_path: /Workspace/Users/{{user_name}}/.bundle/${bundle.name}/${bundle.target}
     permissions:

libs/template/templates/lakeflow-pipelines/databricks_template_schema.json

@@ -1,6 +1,6 @@
 {
     "template_dir": "../default",
-    "welcome_message": "Welcome to the template for Lakeflow Spark Declarative Pipelines!\n\nPlease answer the below to tailor your project to your preferences.\nYou can always change your mind and change your configuration in the databricks.yml file later.\n\nNote that {{workspace_host}} is used for initialization\n(see https://docs.databricks.com/dev-tools/cli/profiles.html for how to change your profile).",
+    "welcome_message": "Welcome to the template for Lakeflow Spark Declarative Pipelines!\n\nPlease answer the below to tailor your project to your preferences.\nYou can always change your mind and change your configuration in the databricks.yml file later.\n\nNote that {{.workspace.URL}} is used for initialization\n(see https://docs.databricks.com/dev-tools/cli/profiles.html for how to change your profile).",
     "properties": {
         "template_name": {
             "//": "This property is always set to 'lakeflow-pipelines'",

libs/template/templates/pydabs/databricks_template_schema.json

@@ -1,6 +1,6 @@
 {
     "template_dir": "../default",
-    "welcome_message": "Welcome to PyDABs template for Declarative Automation Bundles!\n\nAnswer the following questions to customize your project.\nYou can always change your configuration in the databricks.yml file later.\n\nNote that {{workspace_host}} is used for initialization.\n(For information on how to change your profile, see https://docs.databricks.com/dev-tools/cli/profiles.html.)",
+    "welcome_message": "Welcome to PyDABs template for Declarative Automation Bundles!\n\nAnswer the following questions to customize your project.\nYou can always change your configuration in the databricks.yml file later.\n\nNote that {{.workspace.URL}} is used for initialization.\n(For information on how to change your profile, see https://docs.databricks.com/dev-tools/cli/profiles.html.)",
     "properties": {
         "template_name": {
             "//": "This property is always set to 'PyDABs'",