Skip to content

Cover resource_path and all occurrences in workspace prefix rewrite #5507

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

Open
simonfaltum wants to merge 1 commit into
base: main
Choose a base branch
from
+71 −27
Open

Cover resource_path and all occurrences in workspace prefix rewrite #5507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
60 changes: 37 additions & 23 deletions bundle/config/mutator/rewrite_workspace_prefix.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,24 @@ func (m *rewriteWorkspacePrefix) Name() string {

func (m *rewriteWorkspacePrefix) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagnostics {
diags := diag.Diagnostics{}
paths := map[string]string{
"/Workspace/${workspace.root_path}": "${workspace.root_path}",
"/Workspace${workspace.root_path}": "${workspace.root_path}",
"/Workspace/${workspace.file_path}": "${workspace.file_path}",
"/Workspace${workspace.file_path}": "${workspace.file_path}",
"/Workspace/${workspace.artifact_path}": "${workspace.artifact_path}",
"/Workspace${workspace.artifact_path}": "${workspace.artifact_path}",
"/Workspace/${workspace.state_path}": "${workspace.state_path}",
"/Workspace${workspace.state_path}": "${workspace.state_path}",
// The patterns must cover every path that PrependWorkspacePrefix prefixes,
// otherwise interpolation produces a doubled "/Workspace/Workspace/..." path.
// A slice (not a map) keeps the rewrite and warning order deterministic when
// multiple patterns occur in the same string.
paths := []struct {
pattern string
replacement string
}{
{"/Workspace/${workspace.root_path}", "${workspace.root_path}"},
{"/Workspace${workspace.root_path}", "${workspace.root_path}"},
{"/Workspace/${workspace.file_path}", "${workspace.file_path}"},
{"/Workspace${workspace.file_path}", "${workspace.file_path}"},
{"/Workspace/${workspace.artifact_path}", "${workspace.artifact_path}"},
{"/Workspace${workspace.artifact_path}", "${workspace.artifact_path}"},
{"/Workspace/${workspace.state_path}", "${workspace.state_path}"},
{"/Workspace${workspace.state_path}", "${workspace.state_path}"},
{"/Workspace/${workspace.resource_path}", "${workspace.resource_path}"},
{"/Workspace${workspace.resource_path}", "${workspace.resource_path}"},
}

err := b.Config.Mutate(func(root dyn.Value) (dyn.Value, error) {
Expand All @@ -44,23 +53,28 @@ func (m *rewriteWorkspacePrefix) Apply(ctx context.Context, b *bundle.Bundle) di
return v, nil
}

for path, replacePath := range paths {
if strings.Contains(vv, path) {
newPath := strings.Replace(vv, path, replacePath, 1)
diags = append(diags, diag.Diagnostic{
Severity: diag.Warning,
Summary: fmt.Sprintf("substring %q found in %q. Please update this to %q.", path, vv, newPath),
Detail: "For more information, please refer to: https://docs.databricks.com/en/release-notes/dev-tools/bundles.html#workspace-paths",
Locations: v.Locations(),
Paths: []dyn.Path{p},
})

// Remove the workspace prefix from the string.
return dyn.NewValue(newPath, v.Locations()), nil
newPath := vv
for _, rewrite := range paths {
if !strings.Contains(newPath, rewrite.pattern) {
continue
}

newPath = strings.ReplaceAll(newPath, rewrite.pattern, rewrite.replacement)
diags = append(diags, diag.Diagnostic{
Severity: diag.Warning,
Summary: fmt.Sprintf("substring %q found in %q. Please update this to %q.", rewrite.pattern, vv, newPath),
Detail: "For more information, please refer to: https://docs.databricks.com/en/release-notes/dev-tools/bundles.html#workspace-paths",
Locations: v.Locations(),
Paths: []dyn.Path{p},
})
}

if newPath == vv {
return v, nil
}

return v, nil
// Remove the workspace prefix from the string.
return dyn.NewValue(newPath, v.Locations()), nil
})
})
if err != nil {
Expand Down
38 changes: 34 additions & 4 deletions bundle/config/mutator/rewrite_workspace_prefix_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ func TestNoWorkspacePrefixUsed(t *testing.T) {
ArtifactPath: "/Workspace/Users/test/artifacts",
FilePath: "/Workspace/Users/test/files",
StatePath: "/Workspace/Users/test/state",
ResourcePath: "/Workspace/Users/test/resources",
},

Resources: config.Resources{
Expand Down Expand Up @@ -52,6 +53,25 @@ func TestNoWorkspacePrefixUsed(t *testing.T) {
},
},
},
{
NotebookTask: &jobs.NotebookTask{
NotebookPath: "/Workspace/${workspace.resource_path}/notebook3",
},
Libraries: []compute.Library{
{
Jar: "/Workspace${workspace.resource_path}/jar3.jar",
},
},
},
{
SparkPythonTask: &jobs.SparkPythonTask{
PythonFile: "${workspace.file_path}/file2.py",
Parameters: []string{
"--input=/Workspace/${workspace.file_path}/in.txt --output=/Workspace/${workspace.file_path}/out.txt",
"--cp=/Workspace/${workspace.root_path}/lib.jar:/Workspace${workspace.artifact_path}/dep.jar",
},
},
},
},
},
},
Expand All @@ -61,12 +81,17 @@ func TestNoWorkspacePrefixUsed(t *testing.T) {
}

diags := bundle.Apply(t.Context(), b, RewriteWorkspacePrefix())
require.Len(t, diags, 3)
require.Len(t, diags, 8)

expectedErrors := map[string]bool{
`substring "/Workspace/${workspace.root_path}" found in "/Workspace/${workspace.root_path}/file1.py". Please update this to "${workspace.root_path}/file1.py".`: true,
`substring "/Workspace${workspace.file_path}" found in "/Workspace${workspace.file_path}/notebook1". Please update this to "${workspace.file_path}/notebook1".`: true,
`substring "/Workspace/${workspace.artifact_path}" found in "/Workspace/${workspace.artifact_path}/jar1.jar". Please update this to "${workspace.artifact_path}/jar1.jar".`: true,
`substring "/Workspace/${workspace.root_path}" found in "/Workspace/${workspace.root_path}/file1.py". Please update this to "${workspace.root_path}/file1.py".`: true,
`substring "/Workspace${workspace.file_path}" found in "/Workspace${workspace.file_path}/notebook1". Please update this to "${workspace.file_path}/notebook1".`: true,
`substring "/Workspace/${workspace.artifact_path}" found in "/Workspace/${workspace.artifact_path}/jar1.jar". Please update this to "${workspace.artifact_path}/jar1.jar".`: true,
`substring "/Workspace/${workspace.resource_path}" found in "/Workspace/${workspace.resource_path}/notebook3". Please update this to "${workspace.resource_path}/notebook3".`: true,
`substring "/Workspace${workspace.resource_path}" found in "/Workspace${workspace.resource_path}/jar3.jar". Please update this to "${workspace.resource_path}/jar3.jar".`: true,
`substring "/Workspace/${workspace.file_path}" found in "--input=/Workspace/${workspace.file_path}/in.txt --output=/Workspace/${workspace.file_path}/out.txt". Please update this to "--input=${workspace.file_path}/in.txt --output=${workspace.file_path}/out.txt".`: true,
`substring "/Workspace/${workspace.root_path}" found in "--cp=/Workspace/${workspace.root_path}/lib.jar:/Workspace${workspace.artifact_path}/dep.jar". Please update this to "--cp=${workspace.root_path}/lib.jar:/Workspace${workspace.artifact_path}/dep.jar".`: true,
`substring "/Workspace${workspace.artifact_path}" found in "--cp=/Workspace/${workspace.root_path}/lib.jar:/Workspace${workspace.artifact_path}/dep.jar". Please update this to "--cp=${workspace.root_path}/lib.jar:${workspace.artifact_path}/dep.jar".`: true,
}

for _, d := range diags {
Expand All @@ -80,4 +105,9 @@ func TestNoWorkspacePrefixUsed(t *testing.T) {
require.Equal(t, "${workspace.artifact_path}/jar1.jar", b.Config.Resources.Jobs["test_job"].JobSettings.Tasks[1].Libraries[0].Jar)
require.Equal(t, "${workspace.file_path}/notebook2", b.Config.Resources.Jobs["test_job"].Tasks[2].NotebookTask.NotebookPath)
require.Equal(t, "${workspace.artifact_path}/jar2.jar", b.Config.Resources.Jobs["test_job"].JobSettings.Tasks[2].Libraries[0].Jar)
require.Equal(t, "${workspace.resource_path}/notebook3", b.Config.Resources.Jobs["test_job"].Tasks[3].NotebookTask.NotebookPath)
require.Equal(t, "${workspace.resource_path}/jar3.jar", b.Config.Resources.Jobs["test_job"].JobSettings.Tasks[3].Libraries[0].Jar)
require.Equal(t, "${workspace.file_path}/file2.py", b.Config.Resources.Jobs["test_job"].Tasks[4].SparkPythonTask.PythonFile)
require.Equal(t, "--input=${workspace.file_path}/in.txt --output=${workspace.file_path}/out.txt", b.Config.Resources.Jobs["test_job"].Tasks[4].SparkPythonTask.Parameters[0])
require.Equal(t, "--cp=${workspace.root_path}/lib.jar:${workspace.artifact_path}/dep.jar", b.Config.Resources.Jobs["test_job"].Tasks[4].SparkPythonTask.Parameters[1])
}
Loading