Add source_linked_deployment & git_folder_path to metadata.json (#3719)

## Changes
Add two new fields to `metadata.json`:
- `config.presets.source_linked_deployment`
- `extra.git_folder_path`

## Why
To support Lakeflow integration with DABs

## Tests
Added unit tests

<!-- If your PR needs to be included in the release notes for next
release,
add a separate entry in NEXT_CHANGELOG.md as part of your PR. -->

Author: rclarey

acceptance/bundle/deploy/jobs/check-metadata/output.txt

@@ -57,8 +57,12 @@ Deployment complete!
           "relative_path": "databricks.yml"
         }
       }
+    },
+    "presets": {
+      "source_linked_deployment": false
     }
-  }
+  },
+  "extra": {}
 }
 === Check that metadata contains created job ids
 >>> cat metadata.json

bundle/deploy/metadata/compute.go

@@ -3,6 +3,7 @@ package metadata
 import (
 	"context"
 	"path/filepath"
+	"strings"
 
 	"github.com/databricks/cli/bundle"
 	"github.com/databricks/cli/bundle/config"
@@ -83,6 +84,13 @@ func (m *compute) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagnostics
 	// In source-linked deployment files are not copied and resources use source files, therefore we use sync path as file path in metadata
 	if config.IsExplicitlyEnabled(b.Config.Presets.SourceLinkedDeployment) {
 		b.Metadata.Config.Workspace.FilePath = b.SyncRootPath
+		b.Metadata.Config.Presets.SourceLinkedDeployment = true
 	}
+
+	// Set the git folder path for deployments from the workspace
+	if b.WorktreeRoot != nil && strings.HasPrefix(b.WorktreeRoot.Native(), "/Workspace/") {
+		b.Metadata.Extra.GitFolderPath = b.WorktreeRoot.Native()
+	}
+
 	return nil
 }

bundle/deploy/metadata/compute_test.go

@@ -2,6 +2,7 @@ package metadata
 
 import (
 	"context"
+	"runtime"
 	"testing"
 
 	"github.com/databricks/cli/bundle"
@@ -10,6 +11,7 @@ import (
 	"github.com/databricks/cli/bundle/internal/bundletest"
 	"github.com/databricks/cli/bundle/metadata"
 	"github.com/databricks/cli/libs/dyn"
+	"github.com/databricks/cli/libs/vfs"
 	"github.com/databricks/databricks-sdk-go/service/jobs"
 	"github.com/databricks/databricks-sdk-go/service/pipelines"
 	"github.com/stretchr/testify/assert"
@@ -136,4 +138,24 @@ func TestComputeMetadataMutatorSourceLinked(t *testing.T) {
 	require.NoError(t, diags.Error())
 
 	assert.Equal(t, syncRootPath, b.Metadata.Config.Workspace.FilePath)
+	assert.True(t, b.Metadata.Config.Presets.SourceLinkedDeployment)
+}
+
+func TestComputeMetadataMutatorGitFolderPath(t *testing.T) {
+	// The native path of the worktree root on Windows will never match the /Workspace prefix,
+	// so `GitFolderPath` will never be set and this test will never pass
+	if runtime.GOOS == "windows" {
+		t.Skip("this test is not applicable on Windows")
+	}
+	gitFolderPath := "/Workspace/Users/[email protected]/git_folder"
+	path := vfs.MustNew(gitFolderPath)
+	b := &bundle.Bundle{
+		Config:       config.Root{},
+		WorktreeRoot: path,
+	}
+
+	diags := bundle.Apply(context.Background(), b, Compute())
+	require.NoError(t, diags.Error())
+
+	assert.Equal(t, gitFolderPath, b.Metadata.Extra.GitFolderPath)
 }

bundle/metadata/metadata.go

@@ -27,10 +27,19 @@ type Resources struct {
 	Pipelines map[string]*Resource `json:"pipelines,omitempty"`
 }
 
+type Presets struct {
+	SourceLinkedDeployment bool `json:"source_linked_deployment"`
+}
+
 type Config struct {
 	Bundle    Bundle    `json:"bundle,omitempty"`
 	Workspace Workspace `json:"workspace,omitempty"`
 	Resources Resources `json:"resources,omitempty"`
+	Presets   Presets   `json:"presets,omitempty"`
+}
+
+type Extra struct {
+	GitFolderPath string `json:"git_folder_path,omitempty"`
 }
 
 // Metadata about the bundle deployment. This is the interface Databricks services
@@ -43,4 +52,6 @@ type Metadata struct {
 	Version int `json:"version"`
 
 	Config Config `json:"config"`
+	// Fields that don't map 1-to-1 with the bundle configuration schema
+	Extra Extra `json:"extra"`
 }