Validate that either source_code_path or git_source is set for apps (#4632)

## Changes
Validate that either source_code_path or git_source is set for apps

## Why
Previously, we always required setting the `source_code_path` field.
Now, with the introduction of the git_source field, this isn't required
anymore, and one of the two fields can only be set

## Tests
Added an acceptance test

<!-- 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: andrewnester

NEXT_CHANGELOG.md

@@ -5,6 +5,7 @@
 ### CLI
 
 ### Bundles
+* Validate that either source_code_path or git_source is set for apps ([#4632](https://github.com/databricks/cli/pull/4632))
 
 ### Dependency updates
 

acceptance/bundle/apps/git_source/databricks.yml.tmpl

@@ -15,4 +15,3 @@ resources:
       git_source:
         branch: main
         source_code_path: internal/testdata/simple-app
-      source_code_path: ./app

acceptance/bundle/validate/empty_resources/empty_dict/output.txt

@@ -146,14 +146,10 @@ Warning: required field "name" is not set
   at resources.apps.rname
   in databricks.yml:6:12
 
-Warning: required field "source_code_path" is not set
-  at resources.apps.rname
-  in databricks.yml:6:12
-
-Error: Missing app source code path
+Error: Missing app source code path or git source
   in databricks.yml:6:12
 
-app resource 'rname' is missing required source_code_path field
+app resource 'rname' should have either source_code_path or git_source field
 
 {
   "apps": {

acceptance/bundle/validate/empty_resources/with_grants/output.txt

@@ -183,14 +183,10 @@ Warning: required field "name" is not set
   at resources.apps.rname
   in databricks.yml:7:7
 
-Warning: required field "source_code_path" is not set
-  at resources.apps.rname
-  in databricks.yml:7:7
-
-Error: Missing app source code path
+Error: Missing app source code path or git source
   in databricks.yml:7:7
 
-app resource 'rname' is missing required source_code_path field
+app resource 'rname' should have either source_code_path or git_source field
 
 {
   "apps": {

acceptance/bundle/validate/empty_resources/with_permissions/output.txt

@@ -162,14 +162,10 @@ Warning: required field "name" is not set
   at resources.apps.rname
   in databricks.yml:7:7
 
-Warning: required field "source_code_path" is not set
-  at resources.apps.rname
-  in databricks.yml:7:7
-
-Error: Missing app source code path
+Error: Missing app source code path or git source
   in databricks.yml:7:7
 
-app resource 'rname' is missing required source_code_path field
+app resource 'rname' should have either source_code_path or git_source field
 
 {
   "apps": {

bundle/apps/validate.go

@@ -15,11 +15,21 @@ func (v *validate) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagnostics
 	usedSourceCodePaths := make(map[string]string)
 
 	for key, app := range b.Config.Resources.Apps {
-		if app.SourceCodePath == "" {
+		if app.SourceCodePath == "" && app.GitSource == nil {
 			diags = append(diags, diag.Diagnostic{
 				Severity:  diag.Error,
-				Summary:   "Missing app source code path",
-				Detail:    fmt.Sprintf("app resource '%s' is missing required source_code_path field", key),
+				Summary:   "Missing app source code path or git source",
+				Detail:    fmt.Sprintf("app resource '%s' should have either source_code_path or git_source field", key),
+				Locations: b.Config.GetLocations("resources.apps." + key),
+			})
+			continue
+		}
+
+		if app.SourceCodePath != "" && app.GitSource != nil {
+			diags = append(diags, diag.Diagnostic{
+				Severity:  diag.Error,
+				Summary:   "Both source_code_path and git_source fields are set",
+				Detail:    fmt.Sprintf("app resource '%s' should have either source_code_path or git_source field, not both", key),
 				Locations: b.Config.GetLocations("resources.apps." + key),
 			})
 			continue

bundle/apps/validate_test.go

@@ -55,3 +55,39 @@ func TestAppsValidateSameSourcePath(t *testing.T) {
 	require.Equal(t, "Duplicate app source code path", diags[0].Summary)
 	require.Contains(t, diags[0].Detail, "has the same source code path as app resource")
 }
+
+func TestAppsValidateBothSourceCodePathAndGitSource(t *testing.T) {
+	tmpDir := t.TempDir()
+	testutil.Touch(t, tmpDir, "app1", "app.py")
+
+	b := &bundle.Bundle{
+		BundleRootPath: tmpDir,
+		SyncRootPath:   tmpDir,
+		SyncRoot:       vfs.MustNew(tmpDir),
+		Config: config.Root{
+			Workspace: config.Workspace{
+				FilePath: "/foo/bar/",
+			},
+			Resources: config.Resources{
+				Apps: map[string]*resources.App{
+					"app1": {
+						App: apps.App{
+							Name: "app1",
+						},
+						SourceCodePath: "./app1",
+						GitSource: &apps.GitSource{
+							Branch: "main",
+						},
+					},
+				},
+			},
+		},
+	}
+
+	bundletest.SetLocation(b, ".", []dyn.Location{{File: filepath.Join(tmpDir, "databricks.yml")}})
+
+	diags := bundle.ApplySeq(context.Background(), b, mutator.TranslatePaths(), Validate())
+	require.Len(t, diags, 1)
+	require.Equal(t, "Both source_code_path and git_source fields are set", diags[0].Summary)
+	require.Contains(t, diags[0].Detail, "should have either source_code_path or git_source field, not both")
+}

bundle/config/resources/apps.go

@@ -39,7 +39,7 @@ type App struct {
 
 	// SourceCodePath is a required field used by DABs to point to Databricks app source code
 	// on local disk and to the corresponding workspace path during app deployment.
-	SourceCodePath string `json:"source_code_path"`
+	SourceCodePath string `json:"source_code_path,omitempty"`
 
 	// Config represents inline app.yaml configuration for the app.
 	// When specified, this configuration is written to an app.yaml file in the source code path during deployment.