Add default-bare template and bundle generate --init-bare

.nextchanges/bundles/bundle-generate-init-bare.md

@@ -0,0 +1 @@
+* Add the `default-bare` template to `databricks bundle init` and the `--init-bare` flag to `databricks bundle generate`, which creates that bare bundle in the current directory when there is no `databricks.yml` yet. ([#7355](https://github.com/databricks/cli/pull/7355))

acceptance/bundle/generate/init_bare_rejected_flags/out.test.toml

@@ -0,0 +1,2 @@
+Cloud = false
+EnvMatrix.DMS = ["", "true"]

acceptance/bundle/generate/init_bare_rejected_flags/output.txt

@@ -0,0 +1,22 @@
+
+>>> errcode [CLI] bundle generate job --existing-job-id 1234
+Error: no databricks.yml found in this directory or any parent; run `databricks bundle init default-bare` first or re-run with --init-bare
+
+Exit code: 1
+
+>>> errcode [CLI] bundle generate job --existing-job-id 1234 --init-bare --bind
+Error: --bind requires an existing bundle and cannot be combined with --init-bare
+
+Exit code: 1
+
+>>> errcode [CLI] bundle generate dashboard --resource my_dashboard --init-bare
+Error: --resource requires an existing bundle and cannot be combined with --init-bare
+
+Exit code: 1
+
+>>> errcode [CLI] bundle generate genie-space --resource my_space --watch --init-bare
+Error: --resource requires an existing bundle and cannot be combined with --init-bare
+
+Exit code: 1
+
+>>> find.py databricks.yml --expect 0

acceptance/bundle/generate/init_bare_rejected_flags/script

@@ -0,0 +1,9 @@
+# There is no databricks.yml here. Without --init-bare generate points at it.
+trace errcode $CLI bundle generate job --existing-job-id 1234
+
+# Flags that need an existing bundle are rejected before anything is written.
+trace errcode $CLI bundle generate job --existing-job-id 1234 --init-bare --bind
+trace errcode $CLI bundle generate dashboard --resource my_dashboard --init-bare
+trace errcode $CLI bundle generate genie-space --resource my_space --watch --init-bare
+
+trace find.py 'databricks.yml' --expect 0

acceptance/bundle/generate/job_init_bare/out.test.toml

@@ -0,0 +1,2 @@
+Cloud = false
+EnvMatrix.DMS = ["", "true"]

acceptance/bundle/generate/job_init_bare/output.txt

@@ -0,0 +1,47 @@
+
+>>> [CLI] bundle generate job --existing-job-id 1234 --key out --init-bare
+No databricks.yml found. Initializing a bare bundle skeleton.
+Welcome to the bare Declarative Automation Bundle template!
+
+This template creates the smallest bundle skeleton, meant for importing existing resources with `databricks bundle generate`.
+
+Your workspace at [DATABRICKS_URL] is used for initialization.
+
+✨ Your bare bundle has been created.
+
+Add generated resources under `resources/` and supporting code under `src/`.
+File successfully saved to src/outnotebook.py
+Job configuration successfully saved to resources/out.job.yml
+
+>>> find.py ^(resources|src)/
+resources/.gitkeep
+resources/out.job.yml
+src/.gitkeep
+src/outnotebook.py
+
+>>> cat databricks.yml
+# This is a Declarative Automation Bundle definition for my_project.
+# See https://docs.databricks.com/dev-tools/bundles/index.html for documentation.
+bundle:
+  name: my_project
+  uuid: [UUID]
+
+include:
+  - resources/*.yml
+
+targets:
+  dev:
+    default: true
+    mode: development
+    workspace:
+      host: [DATABRICKS_URL]
+
+>>> cat resources/out.job.yml
+resources:
+  jobs:
+    out:
+      name: gitjob
+      tasks:
+        - task_key: test_task
+          notebook_task:
+            notebook_path: ../src/outnotebook.py

acceptance/bundle/generate/job_init_bare/script

@@ -0,0 +1,13 @@
+# The bundle takes its name from the directory it is created in.
+mkdir my_project
+cd my_project
+
+# There is no databricks.yml here; --init-bare creates the bare bundle first.
+trace $CLI bundle generate job --existing-job-id 1234 --key out --init-bare
+
+trace find.py '^(resources|src)/'
+trace cat databricks.yml
+trace cat resources/out.job.yml
+
+cd ..
+rm -r my_project

acceptance/bundle/generate/job_init_bare/test.toml

@@ -0,0 +1,35 @@
+[[Server]]
+Pattern = "GET /api/2.2/jobs/get"
+Response.Body = '''
+{
+    "job_id": 11223344,
+    "settings": {
+        "name": "gitjob",
+        "tasks": [
+            {
+                "task_key": "test_task",
+                "notebook_task": {
+                    "notebook_path": "/Workspace/Users/tester@databricks.com/outnotebook"
+                }
+            }
+        ]
+    }
+}
+'''
+
+[[Server]]
+Pattern = "GET /api/2.0/workspace/get-status"
+Response.Body = '''
+{
+    "path": "/Workspace/Users/tester@databricks.com/outnotebook",
+    "object_type": "NOTEBOOK",
+    "language": "PYTHON",
+    "repos_export_format": "SOURCE"
+}
+'''
+
+[[Server]]
+Pattern = "GET /api/2.0/workspace/export"
+Response.Body = '''
+print("Hello, World!")
+'''

acceptance/bundle/help/bundle-generate-dashboard/output.txt

@@ -47,6 +47,7 @@ Flags:
 
 Global Flags:
       --debug            enable debug logging
+      --init-bare        create a bare bundle in the current directory if there is no databricks.yml yet
       --key string       resource key to use for the generated configuration
   -o, --output type      output type: text or json (default text)
   -p, --profile string   ~/.databrickscfg profile

acceptance/bundle/help/bundle-generate-job/output.txt

@@ -38,6 +38,7 @@ Flags:
 
 Global Flags:
       --debug            enable debug logging
+      --init-bare        create a bare bundle in the current directory if there is no databricks.yml yet
       --key string       resource key to use for the generated configuration
   -o, --output type      output type: text or json (default text)
   -p, --profile string   ~/.databrickscfg profile

acceptance/bundle/help/bundle-generate-pipeline/output.txt

@@ -36,6 +36,7 @@ Flags:
 
 Global Flags:
       --debug            enable debug logging
+      --init-bare        create a bare bundle in the current directory if there is no databricks.yml yet
       --key string       resource key to use for the generated configuration
   -o, --output type      output type: text or json (default text)
   -p, --profile string   ~/.databrickscfg profile

acceptance/bundle/help/bundle-generate/output.txt

@@ -8,6 +8,7 @@ Common patterns:
   databricks bundle generate dashboard --existing-path /my-dashboard --key sales_dash
   databricks bundle generate dashboard --resource my_dashboard --watch --force  # Keep local copy in sync. Useful for development.
   databricks bundle generate dashboard --resource my_dashboard --force # Do a one-time sync.
+  databricks bundle generate job --existing-job-id 123 --init-bare  # Start a new bundle from an existing job.
 
 Migration workflows:
 
@@ -22,6 +23,7 @@ Migration workflows:
 
 Use --key to specify the resource name in your bundle configuration.
 Use --bind to automatically bind the generated resource to the existing workspace resource.
+Use --init-bare to create a bare bundle in the current directory when there is no databricks.yml yet.
 
 Usage:
   databricks bundle generate [command]
@@ -36,6 +38,7 @@ Available Commands:
 
 Flags:
   -h, --help         help for generate
+      --init-bare    create a bare bundle in the current directory if there is no databricks.yml yet
       --key string   resource key to use for the generated configuration
 
 Global Flags:

acceptance/bundle/help/bundle-init/output.txt

@@ -6,6 +6,7 @@ TEMPLATE_PATH optionally specifies which template to use. It can be one of the f
 - default-python: The default Python template for Notebooks and Lakeflow
 - default-sql: The default SQL template for .sql files that run with Databricks SQL
 - default-minimal: The minimal template, for advanced users
+- default-bare: The bare template for importing existing resources
 - default-scala: The default Scala template for JAR jobs
 - lakeflow-integrations: The template for Lakeflow integrations
 - dbt-sql: The dbt SQL template (databricks.com/blog/delivering-cost-effective-data-real-time-dbt-and-databricks)

acceptance/bundle/templates/default-bare/minimal/input.json

@@ -0,0 +1,3 @@
+{
+    "project_name": "my_bare_bundle"
+}

acceptance/bundle/templates/default-bare/minimal/out.test.toml

@@ -0,0 +1,2 @@
+Cloud = false
+EnvMatrix.DMS = [""]

acceptance/bundle/templates/default-bare/minimal/output.txt

@@ -0,0 +1,30 @@
+
+>>> [CLI] bundle init default-bare --config-file ./input.json --output-dir output -o json
+Welcome to the bare Declarative Automation Bundle template!
+
+This template creates the smallest bundle skeleton, meant for importing existing resources with `databricks bundle generate`.
+
+Your workspace at [DATABRICKS_URL] is used for initialization.
+
+✨ Your bare bundle has been created.
+
+Add generated resources under `resources/` and supporting code under `src/`.
+{
+  "outputs": [
+    ".gitignore",
+    "README.md",
+    "databricks.yml",
+    "resources/.gitkeep",
+    "src/.gitkeep"
+  ]
+}
+
+>>> [CLI] bundle validate -t dev
+Name: my_bare_bundle
+Target: dev
+Workspace:
+  Host: [DATABRICKS_URL]
+  User: [USERNAME]
+  Path: /Workspace/Users/[USERNAME]/.bundle/my_bare_bundle/dev
+
+Validation OK!

acceptance/bundle/templates/default-bare/minimal/output/README.md

@@ -0,0 +1,6 @@
+# my_bare_bundle
+
+This is a bare Declarative Automation Bundle skeleton.
+
+- Put generated bundle resource definitions in `resources/`
+- Put notebooks, scripts, and other source files in `src/`

acceptance/bundle/templates/default-bare/minimal/output/databricks.yml

@@ -0,0 +1,15 @@
+# This is a Declarative Automation Bundle definition for my_bare_bundle.
+# See https://docs.databricks.com/dev-tools/bundles/index.html for documentation.
+bundle:
+  name: my_bare_bundle
+  uuid: [UUID]
+
+include:
+  - resources/*.yml
+
+targets:
+  dev:
+    default: true
+    mode: development
+    workspace:
+      host: [DATABRICKS_URL]

acceptance/bundle/templates/default-bare/minimal/output/out.gitignore

@@ -0,0 +1,3 @@
+.databricks/
+.venv/
+dist/

acceptance/bundle/templates/default-bare/minimal/script

@@ -0,0 +1,15 @@
+trace $CLI bundle init default-bare --config-file ./input.json --output-dir output -o json
+
+cd output
+
+# Verify that empty directories are preserved
+[ -d "src" ] || exit 1
+[ -d "resources" ] || exit 1
+
+trace $CLI bundle validate -t dev
+
+# Do not affect this repository's git behaviour #2318
+mv .gitignore out.gitignore
+rm -r .databricks
+
+cd ..

cmd/bundle/generate.go

@@ -7,6 +7,7 @@ import (
 
 func newGenerateCommand() *cobra.Command {
 	var key string
+	var initBare bool
 
 	cmd := &cobra.Command{
 		Use:   "generate",
@@ -19,6 +20,7 @@ Common patterns:
   databricks bundle generate dashboard --existing-path /my-dashboard --key sales_dash
   databricks bundle generate dashboard --resource my_dashboard --watch --force  # Keep local copy in sync. Useful for development.
   databricks bundle generate dashboard --resource my_dashboard --force # Do a one-time sync.
+  databricks bundle generate job --existing-job-id 123 --init-bare  # Start a new bundle from an existing job.
 
 Migration workflows:
 
@@ -32,7 +34,8 @@ Migration workflows:
     2. Deploy: databricks bundle deploy
 
 Use --key to specify the resource name in your bundle configuration.
-Use --bind to automatically bind the generated resource to the existing workspace resource.`,
+Use --bind to automatically bind the generated resource to the existing workspace resource.
+Use --init-bare to create a bare bundle in the current directory when there is no databricks.yml yet.`,
 	}
 
 	cmd.AddCommand(generate.NewGenerateJobCommand())
@@ -42,5 +45,6 @@ Use --bind to automatically bind the generated resource to the existing workspac
 	cmd.AddCommand(generate.NewGenerateAppCommand())
 	cmd.AddCommand(generate.NewGenerateGenieSpaceCommand())
 	cmd.PersistentFlags().StringVar(&key, "key", "", `resource key to use for the generated configuration`)
+	cmd.PersistentFlags().BoolVar(&initBare, "init-bare", false, `create a bare bundle in the current directory if there is no databricks.yml yet`)
 	return cmd
 }

cmd/bundle/generate/alert.go

@@ -10,11 +10,9 @@ import (
 	"path/filepath"
 
 	"github.com/databricks/cli/bundle/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/logdiag"
 	"github.com/databricks/cli/libs/textutil"
 	"github.com/databricks/databricks-sdk-go/apierr"
 	"github.com/databricks/databricks-sdk-go/service/sql"
@@ -62,13 +60,11 @@ After generation, you can deploy this alert to other targets using:
 	cmd.Flags().BoolVarP(&force, "force", "f", false, `force overwrite existing files in the output directory`)
 
 	cmd.RunE = func(cmd *cobra.Command, args []string) error {
-		ctx := logdiag.InitContext(cmd.Context())
-		cmd.SetContext(ctx)
-
-		b := root.MustConfigureBundle(cmd)
-		if b == nil || logdiag.HasError(ctx) {
-			return root.ErrAlreadyPrinted
+		b, err := configureBundle(cmd)
+		if err != nil {
+			return err
 		}
+		ctx := cmd.Context()
 
 		w := b.WorkspaceClient(ctx)
 

cmd/bundle/generate/app.go

@@ -6,11 +6,9 @@ import (
 
 	"github.com/databricks/cli/bundle/generate"
 	"github.com/databricks/cli/cmd/bundle/deployment"
-	"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/logdiag"
 	"github.com/databricks/cli/libs/textutil"
 	"github.com/databricks/databricks-sdk-go/service/apps"
 	"github.com/spf13/cobra"
@@ -62,13 +60,11 @@ per target environment.`,
 	cmd.Flags().MarkHidden("bind")
 
 	cmd.RunE = func(cmd *cobra.Command, args []string) error {
-		ctx := logdiag.InitContext(cmd.Context())
-		cmd.SetContext(ctx)
-
-		b := root.MustConfigureBundle(cmd)
-		if b == nil || logdiag.HasError(ctx) {
-			return root.ErrAlreadyPrinted
+		b, err := configureBundle(cmd, "bind")
+		if err != nil {
+			return err
 		}
+		ctx := cmd.Context()
 
 		w := b.WorkspaceClient(ctx)
 		cmdio.LogString(ctx, fmt.Sprintf("Loading app '%s' configuration", appName))

cmd/bundle/generate/dashboard.go

@@ -400,13 +400,11 @@ func (d *dashboard) runForExisting(ctx context.Context, b *bundle.Bundle) {
 }
 
 func (d *dashboard) RunE(cmd *cobra.Command, args []string) error {
-	ctx := logdiag.InitContext(cmd.Context())
-	cmd.SetContext(ctx)
-
-	b := root.MustConfigureBundle(cmd)
-	if b == nil || logdiag.HasError(ctx) {
-		return root.ErrAlreadyPrinted
+	b, err := configureBundle(cmd, "bind", "resource", "watch")
+	if err != nil {
+		return err
 	}
+	ctx := cmd.Context()
 
 	d.initialize(ctx, b)
 	if logdiag.HasError(ctx) {