Source-linked deployments for bundles in the workspace

bundle/config/mutator/apply_presets.go

@@ -9,6 +9,7 @@ import (
 
 	"github.com/databricks/cli/bundle"
 	"github.com/databricks/cli/bundle/config"
+	"github.com/databricks/cli/libs/dbr"
 	"github.com/databricks/cli/libs/diag"
 	"github.com/databricks/cli/libs/dyn"
 	"github.com/databricks/cli/libs/textutil"
@@ -221,6 +222,15 @@ func (m *applyPresets) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagnos
  dashboard.DisplayName = prefix + dashboard.DisplayName
 	}
 
+	if config.IsExplicitlyEnabled((b.Config.Presets.SourceLinkedDeployment)) {
+ isDatabricksWorkspace := dbr.RunsOnRuntime(ctx) && strings.HasPrefix(b.SyncRootPath, "/Workspace/")
+ if !isDatabricksWorkspace {
+ disabled := false
+ b.Config.Presets.SourceLinkedDeployment = &disabled
+ diags = diags.Extend(diag.Warningf("source-linked deployment is available only in the Databricks Workspace"))
+ }
+	}
+
 	return diags
 }
 

bundle/config/mutator/apply_presets_test.go

@@ -2,12 +2,14 @@ package mutator_test
 
 import (
 	"context"
+	"runtime"
 	"testing"
 
 	"github.com/databricks/cli/bundle"
 	"github.com/databricks/cli/bundle/config"
 	"github.com/databricks/cli/bundle/config/mutator"
 	"github.com/databricks/cli/bundle/config/resources"
+	"github.com/databricks/cli/libs/dbr"
 	"github.com/databricks/databricks-sdk-go/service/catalog"
 	"github.com/databricks/databricks-sdk-go/service/jobs"
 	"github.com/stretchr/testify/require"
@@ -364,3 +366,86 @@ func TestApplyPresetsResourceNotDefined(t *testing.T) {
  })
 	}
 }
+
+func TestApplyPresetsSourceLinkedDeployment(t *testing.T) {
+	if runtime.GOOS == "windows" {
+ t.Skip("this test is not applicable on Windows because source-linked mode works only in the Databricks Workspace")
+	}
+
+	testContext := context.Background()
+	enabled := true
+	disabled := false
+	workspacePath := "/Workspace/user.name@company.com"
+
+	tests := []struct {
+ bundlePath string
+ ctx context.Context
+ name string
+ initialValue *bool
+ expectedValue *bool
+ expectedWarning string
+	}{
+ {
+ name: "preset enabled, bundle in Workspace, databricks runtime",
+ bundlePath: workspacePath,
+ ctx: dbr.MockRuntime(testContext, true),
+ initialValue: &enabled,
+ expectedValue: &enabled,
+ },
+ {
+ name: "preset enabled, bundle not in Workspace, databricks runtime",
+ bundlePath: "/Users/user.name@company.com",
+ ctx: dbr.MockRuntime(testContext, true),
+ initialValue: &enabled,
+ expectedValue: &disabled,
+ expectedWarning: "source-linked deployment is available only in the Databricks Workspace",
+ },
+ {
+ name: "preset enabled, bundle in Workspace, not databricks runtime",
+ bundlePath: workspacePath,
+ ctx: dbr.MockRuntime(testContext, false),
+ initialValue: &enabled,
+ expectedValue: &disabled,
+ expectedWarning: "source-linked deployment is available only in the Databricks Workspace",
+ },
+ {
+ name: "preset disabled, bundle in Workspace, databricks runtime",
+ bundlePath: workspacePath,
+ ctx: dbr.MockRuntime(testContext, true),
+ initialValue: &disabled,
+ expectedValue: &disabled,
+ },
+ {
+ name: "preset nil, bundle in Workspace, databricks runtime",
+ bundlePath: workspacePath,
+ ctx: dbr.MockRuntime(testContext, true),
+ initialValue: nil,
+ expectedValue: nil,
+ },
+	}
+
+	for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ b := &bundle.Bundle{
+ SyncRootPath: tt.bundlePath,
+ Config: config.Root{
+ Presets: config.Presets{
+ SourceLinkedDeployment: tt.initialValue,
+ },
+ },
+ }
+
+ diags := bundle.Apply(tt.ctx, b, mutator.ApplyPresets())
+ if diags.HasError() {
+ t.Fatalf("unexpected error: %v", diags)
+ }
+
+ if tt.expectedWarning != "" {
+ require.Equal(t, tt.expectedWarning, diags[0].Summary)
+ }
+
+ require.Equal(t, tt.expectedValue, b.Config.Presets.SourceLinkedDeployment)
+ })
+	}
+
+}

bundle/config/mutator/process_target_mode.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/databricks/cli/bundle"
 	"github.com/databricks/cli/bundle/config"
+	"github.com/databricks/cli/libs/dbr"
 	"github.com/databricks/cli/libs/diag"
 	"github.com/databricks/cli/libs/dyn"
 	"github.com/databricks/cli/libs/iamutil"
@@ -57,6 +58,14 @@ func transformDevelopmentMode(ctx context.Context, b *bundle.Bundle) {
  t.TriggerPauseStatus = config.Paused
 	}
 
+	if !config.IsExplicitlyDisabled(t.SourceLinkedDeployment) {
+ isInWorkspace := strings.HasPrefix(b.SyncRootPath, "/Workspace/")
+ if isInWorkspace && dbr.RunsOnRuntime(ctx) {
+ enabled := true
+ t.SourceLinkedDeployment = &enabled
+ }
+	}
+
 	if !config.IsExplicitlyDisabled(t.PipelinesDevelopment) {
  enabled := true
  t.PipelinesDevelopment = &enabled

bundle/config/mutator/process_target_mode_test.go

@@ -3,14 +3,17 @@ package mutator
 import (
 	"context"
 	"reflect"
+	"runtime"
 	"strings"
 	"testing"
 
 	"github.com/databricks/cli/bundle"
 	"github.com/databricks/cli/bundle/config"
 	"github.com/databricks/cli/bundle/config/resources"
+	"github.com/databricks/cli/libs/dbr"
 	"github.com/databricks/cli/libs/diag"
 	"github.com/databricks/cli/libs/tags"
+	"github.com/databricks/cli/libs/vfs"
 	sdkconfig "github.com/databricks/databricks-sdk-go/config"
 	"github.com/databricks/databricks-sdk-go/service/catalog"
 	"github.com/databricks/databricks-sdk-go/service/compute"
@@ -133,6 +136,7 @@ func mockBundle(mode config.Mode) *bundle.Bundle {
  },
  },
  },
+ SyncRoot: vfs.MustNew("/Users/lennart.kats@databricks.com"),
  // Use AWS implementation for testing.
  Tagging: tags.ForCloud(&sdkconfig.Config{
  Host: "https://company.cloud.databricks.com",
@@ -515,3 +519,32 @@ func TestPipelinesDevelopmentDisabled(t *testing.T) {
 
 	assert.False(t, b.Config.Resources.Pipelines["pipeline1"].PipelineSpec.Development)
 }
+
+func TestSourceLinkedDeploymentEnabled(t *testing.T) {
+	b, diags := processSourceLinkedBundle(t, true)
+	require.NoError(t, diags.Error())
+	assert.True(t, *b.Config.Presets.SourceLinkedDeployment)
+}
+
+func TestSourceLinkedDeploymentDisabled(t *testing.T) {
+	b, diags := processSourceLinkedBundle(t, false)
+	require.NoError(t, diags.Error())
+	assert.False(t, *b.Config.Presets.SourceLinkedDeployment)
+}
+
+func processSourceLinkedBundle(t *testing.T, presetEnabled bool) (*bundle.Bundle, diag.Diagnostics) {
+	if runtime.GOOS == "windows" {
+ t.Skip("this test is not applicable on Windows because source-linked mode works only in the Databricks Workspace")
+	}
+
+	b := mockBundle(config.Development)
+
+	workspacePath := "/Workspace/lennart@company.com/"
+	b.SyncRootPath = workspacePath
+	b.Config.Presets.SourceLinkedDeployment = &presetEnabled
+
+	ctx := dbr.MockRuntime(context.Background(), true)
+	m := bundle.Seq(ProcessTargetMode(), ApplyPresets())
+	diags := bundle.Apply(ctx, b, m)
+	return b, diags
+}

bundle/config/mutator/translate_paths.go

@@ -11,6 +11,7 @@ import (
 	"strings"
 
 	"github.com/databricks/cli/bundle"
+	"github.com/databricks/cli/bundle/config"
 	"github.com/databricks/cli/libs/diag"
 	"github.com/databricks/cli/libs/dyn"
 	"github.com/databricks/cli/libs/notebook"
@@ -103,8 +104,13 @@ func (t *translateContext) rewritePath(
  return fmt.Errorf("path %s is not contained in sync root path", localPath)
 	}
 
-	// Prefix remote path with its remote root path.
-	remotePath := path.Join(t.b.Config.Workspace.FilePath, filepath.ToSlash(localRelPath))
+	var workspacePath string
+	if config.IsExplicitlyEnabled(t.b.Config.Presets.SourceLinkedDeployment) {
+ workspacePath = t.b.SyncRootPath
+	} else {
+ workspacePath = t.b.Config.Workspace.FilePath
+	}
+	remotePath := path.Join(workspacePath, filepath.ToSlash(localRelPath))
 
 	// Convert local path into workspace path via specified function.
 	interp, err := fn(*p, localPath, localRelPath, remotePath)