Skip to content

Added support for double underscore variable references #2203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrewnester merged 4 commits into from
Jan 29, 2025
Merged

Added support for double underscore variable references #2203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f0e8b7e
Raise an error when double underscore variable reference is used
andrewnester Jan 21, 2025
3116d64
added support for variables with double underscores
andrewnester Jan 22, 2025
2318e09
fix
andrewnester Jan 22, 2025
87f26f6
fixes
andrewnester Jan 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions acceptance/bundle/variables/double_underscore/databricks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
bundle:
name: double_underscore

variables:
double__underscore:
description: "This is a variable with a double underscore"
default: "default"

resources:
jobs:
test_job:
name: "test"
tasks:
- task_key: "test ${var.double__underscore}"
7 changes: 7 additions & 0 deletions acceptance/bundle/variables/double_underscore/output.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

>>> $CLI bundle validate -o json
[
{
"task_key": "test default"
}
]
1 change: 1 addition & 0 deletions acceptance/bundle/variables/double_underscore/script
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
trace $CLI bundle validate -o json | jq .resources.jobs.test_job.tasks
39 changes: 39 additions & 0 deletions integration/bundle/basic_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ import (
"testing"

"github.com/databricks/cli/integration/internal/acc"
"github.com/databricks/cli/internal/testcli"
"github.com/databricks/cli/internal/testutil"
"github.com/databricks/cli/libs/testdiff"
"github.com/google/uuid"
"github.com/stretchr/testify/require"
)
Expand Down Expand Up @@ -35,3 +37,40 @@ func TestBasicBundleDeployWithFailOnActiveRuns(t *testing.T) {
// deploy empty bundle again
deployBundleWithFlags(t, ctx, root, []string{"--fail-on-active-runs"})
}

func TestBasicBundleDeployWithDoubleUnderscoreVariables(t *testing.T) {
ctx, wt := acc.WorkspaceTest(t)

nodeTypeId := testutil.GetCloud(t).NodeTypeID()
uniqueId := uuid.New().String()
root := initTestTemplate(t, ctx, "basic_with_variables", map[string]any{
"unique_id": uniqueId,
"node_type_id": nodeTypeId,
"spark_version": defaultSparkVersion,
})

currentUser, err := wt.W.CurrentUser.Me(ctx)
require.NoError(t, err)

ctx, replacements := testdiff.WithReplacementsMap(ctx)
replacements.Set(uniqueId, "$UNIQUE_PRJ")
replacements.Set(currentUser.UserName, "$USERNAME")

t.Cleanup(func() {
destroyBundle(t, ctx, root)
})

testutil.Chdir(t, root)
testcli.AssertOutput(
t,
ctx,
[]string{"bundle", "validate"},
testutil.TestData("testdata/basic_with_variables/bundle_validate.txt"),
)
testcli.AssertOutput(
t,
ctx,
[]string{"bundle", "deploy", "--force-lock", "--auto-approve"},
testutil.TestData("testdata/basic_with_variables/bundle_deploy.txt"),
)
}
21 changes: 21 additions & 0 deletions integration/bundle/bundles/basic_with_variables/databricks_template_schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"properties": {
"unique_id": {
"type": "string",
"description": "Unique ID for job name"
},
"spark_version": {
"type": "string",
"description": "Spark version used for job cluster"
},
"node_type_id": {
"type": "string",
"description": "Node type id for job cluster"
},
"root_path": {
"type": "string",
"description": "Root path to deploy bundle to",
"default": ""
}
}
}
32 changes: 32 additions & 0 deletions integration/bundle/bundles/basic_with_variables/template/databricks.yml.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
bundle:
name: basic

workspace:
{{ if .root_path }}
root_path: "{{.root_path}}/.bundle/{{.unique_id}}"
{{ else }}
root_path: "~/.bundle/{{.unique_id}}"
{{ end }}

variables:
task__key: # Note: the variable has double underscore
default: my_notebook_task

resources:
jobs:
foo__bar: # Note: the resource has double underscore to check that TF provider can use such names
name: test-job-basic-{{.unique_id}}
tasks:
- task_key: ${var.task__key}
new_cluster:
num_workers: 1
spark_version: "{{.spark_version}}"
node_type_id: "{{.node_type_id}}"
spark_python_task:
python_file: ./hello_world.py
foo:
name: test-job-basic-ref-{{.unique_id}}
tasks:
- task_key: job_task
run_job_task:
job_id: ${resources.jobs.foo__bar.id}
1 change: 1 addition & 0 deletions integration/bundle/bundles/basic_with_variables/template/hello_world.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
print("Hello World!")
4 changes: 4 additions & 0 deletions integration/bundle/testdata/basic_with_variables/bundle_deploy.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Uploading bundle files to /Workspace/Users/$USERNAME/.bundle/$UNIQUE_PRJ/files...
Deploying resources...
Updating deployment state...
Deployment complete!
7 changes: 7 additions & 0 deletions integration/bundle/testdata/basic_with_variables/bundle_validate.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Name: basic
Target: default
Workspace:
User: $USERNAME
Path: /Workspace/Users/$USERNAME/.bundle/$UNIQUE_PRJ

Validation OK!
6 changes: 5 additions & 1 deletion libs/dyn/dynvar/ref.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
package dynvar

import (
"fmt"
"regexp"

"github.com/databricks/cli/libs/dyn"
)

var re = regexp.MustCompile(`\$\{([a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\[[0-9]+\])*)*(\[[0-9]+\])*)\}`)
var (
baseVarDef = `[a-zA-Z]+([-_]*[a-zA-Z0-9]+)*`
re = regexp.MustCompile(fmt.Sprintf(`\$\{(%s(\.%s(\[[0-9]+\])*)*(\[[0-9]+\])*)\}`, baseVarDef, baseVarDef))
Copy link
Copy Markdown
Contributor

@pietern pietern Jan 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you check if the second (\[[0-9]+\])* is actually needed?

It looks like a repetition of the previous pattern.

Not blocking.

Copy link
Copy Markdown
Contributor

@pietern pietern Jan 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, the pattern requires you to not have a - or _ at the end.

We can make this more broad and use [a-zA-Z]+[-_a-zA-Z0-9]*.

)

// ref represents a variable reference.
// It is a string [dyn.Value] contained in a larger [dyn.Value].
Expand Down
12 changes: 7 additions & 5 deletions libs/dyn/dynvar/ref_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,13 @@ func TestNewRefNoString(t *testing.T) {

func TestNewRefValidPattern(t *testing.T) {
for in, refs := range map[string][]string{
"${hello_world.world_world}": {"hello_world.world_world"},
"${helloworld.world-world}": {"helloworld.world-world"},
"${hello-world.world-world}": {"hello-world.world-world"},
"${hello_world.world_world}": {"hello_world.world_world"},
"${helloworld.world-world}": {"helloworld.world-world"},
"${hello-world.world-world}": {"hello-world.world-world"},
"${hello_world.world__world}": {"hello_world.world__world"},
"${hello_world.world--world}": {"hello_world.world--world"},
"${hello_world.world-_world}": {"hello_world.world-_world"},
"${hello_world.world_-world}": {"hello_world.world_-world"},
} {
ref, ok := newRef(dyn.V(in))
require.True(t, ok, "should match valid pattern: %s", in)
Expand All @@ -36,8 +40,6 @@ func TestNewRefInvalidPattern(t *testing.T) {
"${_-_._-_.id}", // cannot use _- in sequence
"${0helloworld.world-world}", // interpolated first section shouldn't start with number
"${helloworld.9world-world}", // interpolated second section shouldn't start with number
"${a-a.a-_a-a.id}", // fails because of -_ in the second segment
Copy link
Copy Markdown
Contributor

@denik denik Jan 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this pattern "-_" supported? I don't see it in tests.

Copy link
Copy Markdown
Contributor Author

@andrewnester andrewnester Jan 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@denik yes, it is supported and the test case is here https://github.com/databricks/cli/pull/2203/files#diff-17c69a46b43fd7c1f660dd95fb007b3e00e33068c5b666226aa545f592ce34ebR24

"${a-a.a--a-a.id}", // fails because of -- in the second segment
}
for _, v := range invalid {
_, ok := newRef(dyn.V(v))
Expand Down