Do not use app config section in test templates and generated app configuration (#2599)

## Changes
Do not use app config section in test templates and generated app
configuration

## Why
We're suggesting to use `app.yml` files in app root instead of `config`
section for apps

## Tests
Existing test pass

```
 go test ./integration/bundle/ -update -run "TestDeployBundleWithApp"
ok      github.com/databricks/cli/integration/bundle    402.649s
```

Author: andrewnester

NEXT_CHANGELOG.md

@@ -10,6 +10,7 @@
 ### CLI
 
 ### Bundles
+* Do not use app config section in test templates and generated app configuration ([#2599](https://github.com/databricks/cli/pull/2599))
 * Do not exit early when checking incompatible tasks for specified DBR ([#2692](https://github.com/databricks/cli/pull/2692))
 * Removed include/exclude flags support from bundle sync command ([#2718](https://github.com/databricks/cli/pull/2718))
 * Do not clean up Python artifacts dist and build folder in "bundle validate", do it in "bundle deploy". This reverts the behaviour introduced in 0.245.0 ([#2722](https://github.com/databricks/cli/pull/2722))

bundle/config/generate/app.go

@@ -6,12 +6,7 @@ import (
 	"github.com/databricks/databricks-sdk-go/service/apps"
 )
 
-func ConvertAppToValue(app *apps.App, sourceCodePath string, appConfig map[string]any) (dyn.Value, error) {
-	ac, err := convert.FromTyped(appConfig, dyn.NilValue)
-	if err != nil {
-		return dyn.NilValue, err
-	}
-
+func ConvertAppToValue(app *apps.App, sourceCodePath string) (dyn.Value, error) {
 	ar, err := convert.FromTyped(app.Resources, dyn.NilValue)
 	if err != nil {
 		return dyn.NilValue, err
@@ -25,10 +20,6 @@ func ConvertAppToValue(app *apps.App, sourceCodePath string, appConfig map[strin
 		"source_code_path": dyn.NewValue(sourceCodePath, []dyn.Location{{Line: 3}}),
 	}
 
-	if ac.Kind() != dyn.KindNil {
-		dv["config"] = ac.WithLocations([]dyn.Location{{Line: 4}})
-	}
-
 	if ar.Kind() != dyn.KindNil {
 		dv["resources"] = ar.WithLocations([]dyn.Location{{Line: 5}})
 	}

bundle/tests/apps/databricks.yml

@@ -1,25 +1,17 @@
 package generate
 
 import (
-	"context"
-	"errors"
 	"fmt"
-	"io"
-	"io/fs"
 	"path/filepath"
 
 	"github.com/databricks/cli/bundle/config/generate"
 	"github.com/databricks/cli/cmd/root"
 	"github.com/databricks/cli/libs/cmdio"
 	"github.com/databricks/cli/libs/dyn"
 	"github.com/databricks/cli/libs/dyn/yamlsaver"
-	"github.com/databricks/cli/libs/filer"
 	"github.com/databricks/cli/libs/textutil"
-	"github.com/databricks/databricks-sdk-go"
 	"github.com/databricks/databricks-sdk-go/service/apps"
 	"github.com/spf13/cobra"
-
-	"gopkg.in/yaml.v3"
 )
 
 func NewGenerateAppCommand() *cobra.Command {
@@ -62,18 +54,13 @@ func NewGenerateAppCommand() *cobra.Command {
 			return err
 		}
 
-		appConfig, err := getAppConfig(ctx, app, w)
-		if err != nil {
-			return fmt.Errorf("failed to get app config: %w", err)
-		}
-
 		// Making sure the source code path is relative to the config directory.
 		rel, err := filepath.Rel(configDir, sourceDir)
 		if err != nil {
 			return err
 		}
 
-		v, err := generate.ConvertAppToValue(app, filepath.ToSlash(rel), appConfig)
+		v, err := generate.ConvertAppToValue(app, filepath.ToSlash(rel))
 		if err != nil {
 			return err
 		}
@@ -91,12 +78,6 @@ func NewGenerateAppCommand() *cobra.Command {
 			}),
 		}
 
-		// If there are app.yaml or app.yml files in the source code path, they will be downloaded but we don't want to include them in the bundle.
-		// We include this configuration inline, so we need to remove these files.
-		for _, configFile := range []string{"app.yml", "app.yaml"} {
-			delete(downloader.files, filepath.Join(sourceDir, configFile))
-		}
-
 		err = downloader.FlushToDisk(ctx, force)
 		if err != nil {
 			return err
@@ -116,42 +97,3 @@ func NewGenerateAppCommand() *cobra.Command {
 
 	return cmd
 }
-
-func getAppConfig(ctx context.Context, app *apps.App, w *databricks.WorkspaceClient) (map[string]any, error) {
-	sourceCodePath := app.DefaultSourceCodePath
-
-	f, err := filer.NewWorkspaceFilesClient(w, sourceCodePath)
-	if err != nil {
-		return nil, err
-	}
-
-	// The app config is stored in app.yml or app.yaml file in the source code path.
-	configFileNames := []string{"app.yml", "app.yaml"}
-	for _, configFile := range configFileNames {
-		r, err := f.Read(ctx, configFile)
-		if err != nil {
-			if errors.Is(err, fs.ErrNotExist) {
-				continue
-			}
-			return nil, err
-		}
-		defer r.Close()
-
-		cmdio.LogString(ctx, "Reading app configuration from "+configFile)
-		content, err := io.ReadAll(r)
-		if err != nil {
-			return nil, err
-		}
-
-		var appConfig map[string]any
-		err = yaml.Unmarshal(content, &appConfig)
-		if err != nil {
-			cmdio.LogString(ctx, fmt.Sprintf("Failed to parse app configuration:\n%s\nerr: %v", string(content), err))
-			return nil, nil
-		}
-
-		return appConfig, nil
-	}
-
-	return nil, nil
-}

bundle/tests/apps_test.go

@@ -87,36 +87,17 @@ func TestDeployBundleWithApp(t *testing.T) {
 	data, err := io.ReadAll(reader)
 	require.NoError(t, err)
 
-	job, err := wt.W.Jobs.GetBySettingsName(ctx, "test-job-with-cluster-"+uniqueId)
-	require.NoError(t, err)
-
 	content := string(data)
-	require.Contains(t, content, fmt.Sprintf(`command:
+	// Replace windows line endings with unix line endings
+	content = testutil.ReplaceWindowsLineEndings(content)
+	require.Contains(t, content, `command:
   - flask
   - --app
   - app
   - run
 env:
   - name: JOB_ID
-    value: "%d"`, job.JobId))
-
-	// Redeploy bundle with changed config env for app and confirm it's updated in app.yaml
-	deployBundleWithArgs(t, ctx, root, `--var="env_var_name=ANOTHER_JOB_ID"`, "--force-lock", "--auto-approve")
-	reader, err = wt.W.Workspace.Download(ctx, pathToAppYml)
-	require.NoError(t, err)
-
-	data, err = io.ReadAll(reader)
-	require.NoError(t, err)
-
-	content = string(data)
-	require.Contains(t, content, fmt.Sprintf(`command:
-  - flask
-  - --app
-  - app
-  - run
-env:
-  - name: ANOTHER_JOB_ID
-    value: "%d"`, job.JobId))
+    valueFrom: "app-job"`)
 
 	if testing.Short() {
 		t.Log("Skip the app run in short mode")

cmd/bundle/generate/app.go

@@ -0,0 +1,8 @@
+command:
+  - flask
+  - --app
+  - app
+  - run
+env:
+  - name: JOB_ID
+    valueFrom: "app-job"

integration/bundle/apps_test.go

@@ -14,16 +14,6 @@ resources:
       name: "{{.app_id}}"
       description: "App which manages job created by this bundle"
       source_code_path: ./app
-      config:
-        command:
-          - flask
-          - --app
-          - app
-          - run
-        env:
-          - name: ${var.env_var_name}
-            value: ${resources.jobs.foo.id}
-
       resources:
         - name: "app-job"
           description: "A job for app to be able to work with"

integration/bundle/bundles/apps/template/app/app.yml

@@ -2,7 +2,3 @@ Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/$UNIQUE_PRJ/files.
 Deploying resources...
 Updating deployment state...
 Deployment complete!
-Warning: App config section detected
-
-remove 'config' from app resource 'test_app' section and use app.yml file in the root of this app instead
-

integration/bundle/bundles/apps/template/databricks.yml.tmpl

@@ -1,11 +1,7 @@
-Warning: App config section detected
-
-remove 'config' from app resource 'test_app' section and use app.yml file in the root of this app instead
-
 Name: basic
 Target: default
 Workspace:
   User: [USERNAME]
   Path: /Workspace/Users/[USERNAME]/.bundle/$UNIQUE_PRJ
 
-Found 1 warning
+Validation OK!