Expose the workspace context to bundle templates as .workspace

.nextchanges/bundles/workspace-template-variable.md

@@ -0,0 +1 @@
+* Expose the workspace of the selected profile to bundle templates as `.workspace`, with `Hostname`, `ID`, and `URL`, so templates can address a workspace on a host shared by several workspaces. A template input named `workspace` takes precedence. ([#7349](https://github.com/databricks/cli/pull/7349))

acceptance/bundle/templates-machinery/workspace_variable/input/boolean/databricks_template_schema.json

@@ -0,0 +1,9 @@
+{
+    "properties": {
+        "workspace": {
+            "type": "boolean",
+            "description": "Create a workspace",
+            "default": false
+        }
+    }
+}

acceptance/bundle/templates-machinery/workspace_variable/input/boolean/template/workspace.txt.tmpl

@@ -0,0 +1 @@
+workspace: {{ .workspace }}

acceptance/bundle/templates-machinery/workspace_variable/input/input.empty.json

@@ -0,0 +1 @@
+{"workspace": ""}

acceptance/bundle/templates-machinery/workspace_variable/input/input.false.json

@@ -0,0 +1 @@
+{"workspace": false}

acceptance/bundle/templates-machinery/workspace_variable/input/input.invalid.json

@@ -0,0 +1 @@
+{"workspace": "Team Dev"}

acceptance/bundle/templates-machinery/workspace_variable/input/input.value.json

@@ -0,0 +1 @@
+{"workspace": "team-dev"}

acceptance/bundle/templates-machinery/workspace_variable/input/input.zero.json

@@ -0,0 +1 @@
+{"workspace": 0}

acceptance/bundle/templates-machinery/workspace_variable/input/integer/databricks_template_schema.json

@@ -0,0 +1,9 @@
+{
+    "properties": {
+        "workspace": {
+            "type": "integer",
+            "description": "Workspace number",
+            "default": 0
+        }
+    }
+}

acceptance/bundle/templates-machinery/workspace_variable/input/integer/template/workspace.txt.tmpl

@@ -0,0 +1 @@
+workspace: {{ .workspace }}

acceptance/bundle/templates-machinery/workspace_variable/input/no_value/databricks_template_schema.json

@@ -0,0 +1,10 @@
+{
+    "welcome_message": "Welcome, {{ .workspace }}",
+    "properties": {
+        "workspace": {
+            "type": "string",
+            "description": "Workspace name",
+            "default": "team-prod"
+        }
+    }
+}

acceptance/bundle/templates-machinery/workspace_variable/input/no_value/template/workspace.txt.tmpl

@@ -0,0 +1 @@
+workspace: {{ .workspace }}

acceptance/bundle/templates-machinery/workspace_variable/input/out.test.toml

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

acceptance/bundle/templates-machinery/workspace_variable/input/output.txt

@@ -0,0 +1,108 @@
+
+=== String input
+
+>>> [CLI] bundle debug render-template-schema ./string
+{
+  "welcome_message": null,
+  "success_message": "Created for \"\"",
+  "properties": {
+    "message": {
+      "description": "Message for ",
+      "default": "Deploying to "
+    },
+    "workspace": {
+      "description": "Workspace name",
+      "default": ""
+    }
+  }
+}
+
+>>> [CLI] bundle debug render-template-schema ./string --input-file input.value.json
+{
+  "welcome_message": null,
+  "success_message": "Created for \"team-dev\"",
+  "properties": {
+    "message": {
+      "description": "Message for team-dev",
+      "default": "Deploying to team-dev"
+    },
+    "workspace": {
+      "description": "Workspace name",
+      "default": ""
+    }
+  }
+}
+
+>>> [CLI] bundle init ./string
+Created for ""
+workspace_name: ""
+message: "Deploying to "
+
+>>> [CLI] bundle init ./string --config-file input.empty.json
+Created for ""
+workspace_name: ""
+message: "Deploying to "
+
+>>> [CLI] bundle init ./string --config-file input.value.json
+Created for "team-dev"
+workspace_name: "team-dev"
+message: "Deploying to team-dev"
+
+>>> musterr [CLI] bundle init ./string --config-file input.invalid.json
+Error: failed to load config from file input.invalid.json: invalid value for workspace: "Team Dev". Use lowercase letters and dashes
+
+=== Input without a value yet
+
+>>> [CLI] bundle debug render-template-schema ./no_value
+{
+  "welcome_message": "Welcome, team-prod",
+  "success_message": null,
+  "properties": {
+    "workspace": {
+      "description": "Workspace name",
+      "default": "team-prod"
+    }
+  }
+}
+
+>>> musterr [CLI] bundle init ./no_value
+Error: variable "workspace" not defined
+
+>>> [CLI] bundle init ./no_value --config-file input.value.json
+Welcome, team-dev
+✨ Successfully initialized template
+workspace: team-dev
+
+=== Boolean input
+
+>>> [CLI] bundle init ./boolean
+✨ Successfully initialized template
+workspace: false
+
+>>> [CLI] bundle init ./boolean --config-file input.false.json
+✨ Successfully initialized template
+workspace: false
+
+=== Integer input
+
+>>> [CLI] bundle init ./integer
+✨ Successfully initialized template
+workspace: 0
+
+>>> [CLI] bundle init ./integer --config-file input.zero.json
+✨ Successfully initialized template
+workspace: 0
+
+=== Undeclared input
+
+>>> [CLI] bundle debug render-template-schema ./undeclared --input-file input.value.json
+{
+  "welcome_message": "workspace: {[CUSTOM_HOSTNAME] [CUSTOM_HOST] [WORKSPACE_ID] [WORKSPACE_ID]}",
+  "success_message": null,
+  "properties": {}
+}
+
+>>> [CLI] bundle init ./undeclared --config-file input.value.json
+workspace: {[CUSTOM_HOSTNAME] [CUSTOM_HOST] [WORKSPACE_ID] [WORKSPACE_ID]}
+✨ Successfully initialized template
+workspace: {[CUSTOM_HOSTNAME] [CUSTOM_HOST] [WORKSPACE_ID] [WORKSPACE_ID]}

acceptance/bundle/templates-machinery/workspace_variable/input/script

@@ -0,0 +1,44 @@
+# A template input named "workspace" takes precedence over the workspace
+# context, with and without a value supplied.
+export DATABRICKS_CONFIG_PROFILE=workspace_custom_host
+
+title "String input\n"
+trace $CLI bundle debug render-template-schema ./string | schema_fields
+trace $CLI bundle debug render-template-schema ./string --input-file input.value.json | schema_fields
+for config in "" "--config-file input.empty.json" "--config-file input.value.json"; do
+  trace $CLI bundle init ./string $config
+  cat workspace.txt
+  rm workspace.txt
+done
+trace musterr $CLI bundle init ./string --config-file input.invalid.json
+
+# The welcome message is rendered before inputs get their values. The input
+# still owns the name, so the workspace context isn't used in its place.
+title "Input without a value yet\n"
+trace $CLI bundle debug render-template-schema ./no_value | schema_fields
+trace musterr $CLI bundle init ./no_value
+trace $CLI bundle init ./no_value --config-file input.value.json
+cat workspace.txt
+rm workspace.txt
+
+title "Boolean input\n"
+for config in "" "--config-file input.false.json"; do
+  trace $CLI bundle init ./boolean $config
+  cat workspace.txt
+  rm workspace.txt
+done
+
+title "Integer input\n"
+for config in "" "--config-file input.zero.json"; do
+  trace $CLI bundle init ./integer $config
+  cat workspace.txt
+  rm workspace.txt
+done
+
+# An input value that the schema doesn't declare doesn't claim the name, so
+# schema rendering and bundle init both use the workspace context.
+title "Undeclared input\n"
+trace $CLI bundle debug render-template-schema ./undeclared --input-file input.value.json | schema_fields
+trace $CLI bundle init ./undeclared --config-file input.value.json
+cat workspace.txt
+rm workspace.txt

acceptance/bundle/templates-machinery/workspace_variable/input/string/databricks_template_schema.json

@@ -0,0 +1,19 @@
+{
+    "properties": {
+        "workspace": {
+            "type": "string",
+            "description": "Workspace name",
+            "default": "",
+            "pattern": "^[a-z-]*$",
+            "pattern_match_failure_message": "Use lowercase letters and dashes",
+            "order": 1
+        },
+        "message": {
+            "type": "string",
+            "description": "Message for {{ .workspace }}",
+            "default": "Deploying to {{ .workspace }}",
+            "order": 2
+        }
+    },
+    "success_message": "Created for \"{{ .workspace }}\""
+}

acceptance/bundle/templates-machinery/workspace_variable/input/string/template/workspace.txt.tmpl

@@ -0,0 +1,2 @@
+workspace_name: "{{ .workspace }}"
+message: "{{ .message }}"

acceptance/bundle/templates-machinery/workspace_variable/input/undeclared/databricks_template_schema.json

@@ -0,0 +1,3 @@
+{
+    "welcome_message": "workspace: {{ .workspace }}"
+}

acceptance/bundle/templates-machinery/workspace_variable/input/undeclared/template/workspace.txt.tmpl

@@ -0,0 +1 @@
+workspace: {{ .workspace }}

acceptance/bundle/templates-machinery/workspace_variable/runtime/id/databricks_template_schema.json

@@ -0,0 +1 @@
+{}

acceptance/bundle/templates-machinery/workspace_variable/runtime/id/template/id.txt.tmpl

@@ -0,0 +1 @@
+ID: {{ .workspace.ID }}

acceptance/bundle/templates-machinery/workspace_variable/runtime/input.absolute-url.json

@@ -0,0 +1 @@
+{"path": "https://other.test/jobs"}

acceptance/bundle/templates-machinery/workspace_variable/runtime/input.edited.json

@@ -0,0 +1 @@
+{"path": "/pipelines?tab=all", "jobs_url": "https://example.test/my-jobs"}

acceptance/bundle/templates-machinery/workspace_variable/runtime/input.semicolon.json

@@ -0,0 +1 @@
+{"path": "/jobs?w=999;x=1"}

acceptance/bundle/templates-machinery/workspace_variable/runtime/input.workspace-selector.json

@@ -0,0 +1 @@
+{"path": "/jobs?o=123"}

acceptance/bundle/templates-machinery/workspace_variable/runtime/out.test.toml

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