Update all 'bundle generate' commands to output paths with forward slash (#4528)

denik · web-flow · commit 7554bd6c319b · 2026-02-17T13:18:35.000+01:00
## Changes
- Update all places in cmd/bundle/generate to output paths with forward
slashes.
- Replace %q used in a dashboard for paths with %s for consistency with
the rest.
- Update AGENTS.md with this instruction.

## Why
This makes test output stable across OSes. This is a convention we
already use in other places.

## Tests
Updated output of existing tests and removed unnecessary Repls entry for
fixing the slash.
diff --git a/AGENTS.md b/AGENTS.md
@@ -206,6 +206,8 @@ import "github.com/databricks/cli/libs/cmdio"
 cmdio.LogString(ctx, "...")
 ```
 
+Always output file path with forward slashes, even on Windows, so that acceptance test output is stable between OSes. Use filepath.ToSlash for this.
+
 # Specific File Guides
 
 ## databricks_template_schema.json
diff --git a/acceptance/bundle/deployment/bind/job/generate-and-bind/test.toml b/acceptance/bundle/deployment/bind/job/generate-and-bind/test.toml
@@ -15,7 +15,3 @@ Ignore = [
 # C:/Program Files/Git/Users/$username/UNIQUE_NAME before passing it to the CLI
 # Setting this environment variable prevents that conversion on windows.
 MSYS_NO_PATHCONV = "1"
-
-[[Repls]]
-Old = '\\'
-New = '/'
diff --git a/acceptance/bundle/generate/app_subfolders/test.toml b/acceptance/bundle/generate/app_subfolders/test.toml
@@ -35,7 +35,3 @@ Pattern = "GET /api/2.0/workspace/export"
 Response.Body = '''
 print("Hello, World!")
 '''
-
-[[Repls]]
-Old = '\\'
-New = '/'
diff --git a/acceptance/bundle/generate/auto-bind/test.toml b/acceptance/bundle/generate/auto-bind/test.toml
@@ -20,7 +20,3 @@ Ignore = [
 # C:/Program Files/Git/Users/$username/UNIQUE_NAME before passing it to the CLI
 # Setting this environment variable prevents that conversion on windows.
 MSYS_NO_PATHCONV = "1"
-
-[[Repls]]
-Old = '\\'
-New = '/'
diff --git a/acceptance/bundle/generate/dashboard-inplace/output.txt b/acceptance/bundle/generate/dashboard-inplace/output.txt
@@ -26,7 +26,7 @@ Deployment complete!
 
 === update the dashboard file using bundle generate
 >>> [CLI] bundle generate dashboard --resource test_dashboard --force
-Writing dashboard to "dash.lvdash.json"
+Writing dashboard to dash.lvdash.json
 
 >>> cat dash.lvdash.json
 {
diff --git a/acceptance/bundle/generate/dashboard/output.txt b/acceptance/bundle/generate/dashboard/output.txt
@@ -2,5 +2,5 @@
 >>> [CLI] workspace mkdirs /Workspace/test-[UNIQUE_NAME]
 
 >>> [CLI] bundle generate dashboard --existing-id [DASHBOARD_ID] --dashboard-dir out/dashboard --resource-dir out/resource
-Writing dashboard to "out/dashboard/test_dashboard.lvdash.json"
-Writing configuration to "out/resource/test_dashboard.dashboard.yml"
+Writing dashboard to out/dashboard/test_dashboard.lvdash.json
+Writing configuration to out/resource/test_dashboard.dashboard.yml
diff --git a/acceptance/bundle/generate/dashboard/test.toml b/acceptance/bundle/generate/dashboard/test.toml
@@ -1,7 +1,3 @@
-[[Repls]]
-Old = '\\\\'
-New = '/'
-
 [[Repls]]
 Old = "[0-9a-f]{32}"
 New = "[DASHBOARD_ID]"
diff --git a/acceptance/bundle/generate/dashboard_existing_path_nominal/output.txt b/acceptance/bundle/generate/dashboard_existing_path_nominal/output.txt
@@ -1,4 +1,4 @@
 
 >>> [CLI] bundle generate dashboard --existing-path /path/to/dashboard --dashboard-dir out/dashboard --resource-dir out/resource
-Writing dashboard to "out/dashboard/this_is_a_test_dashboard.lvdash.json"
-Writing configuration to "out/resource/this_is_a_test_dashboard.dashboard.yml"
+Writing dashboard to out/dashboard/this_is_a_test_dashboard.lvdash.json
+Writing configuration to out/resource/this_is_a_test_dashboard.dashboard.yml
diff --git a/acceptance/bundle/generate/dashboard_existing_path_nominal/test.toml b/acceptance/bundle/generate/dashboard_existing_path_nominal/test.toml
@@ -1,7 +1,3 @@
-[[Repls]]
-Old = '\\\\'
-New = '/'
-
 [[Server]]
 Pattern = "GET /api/2.0/workspace/get-status"
 Response.Body = '''
diff --git a/acceptance/bundle/generate/lakeflow_pipelines/test.toml b/acceptance/bundle/generate/lakeflow_pipelines/test.toml
@@ -4,10 +4,6 @@ Response.Body = '''
 print("Hello, World!")
 '''
 
-[[Repls]]
-Old = '\\'
-New = '/'
-
 [[Server]]
 Pattern = "GET /api/2.0/workspace/list"
 Response.Body = '''
diff --git a/acceptance/bundle/resources/dashboards/generate_inplace/output.txt b/acceptance/bundle/resources/dashboards/generate_inplace/output.txt
@@ -27,7 +27,7 @@ Exit code: 1
 }
 
 >>> [CLI] bundle generate dashboard --resource already_exists --force
-Writing dashboard to "dashboard.lvdash.json"
+Writing dashboard to dashboard.lvdash.json
 
 >>> cat dashboard.lvdash.json
 {}
diff --git a/bundle/generate/downloader.go b/bundle/generate/downloader.go
@@ -228,10 +228,10 @@ func (n *Downloader) FlushToDisk(ctx context.Context, force bool) error {
 		info, err := os.Stat(targetPath)
 		if err == nil {
 			if info.IsDir() {
-				return fmt.Errorf("%s is a directory", targetPath)
+				return fmt.Errorf("%s is a directory", filepath.ToSlash(targetPath))
 			}
 			if !force {
-				return fmt.Errorf("%s already exists. Use --force to overwrite", targetPath)
+				return fmt.Errorf("%s already exists. Use --force to overwrite", filepath.ToSlash(targetPath))
 			}
 		}
 	}
@@ -261,7 +261,7 @@ func (n *Downloader) FlushToDisk(ctx context.Context, force bool) error {
 				return err
 			}
 
-			cmdio.LogString(errCtx, "File successfully saved to "+targetPath)
+			cmdio.LogString(errCtx, "File successfully saved to "+filepath.ToSlash(targetPath))
 			return reader.Close()
 		})
 	}
diff --git a/cmd/bundle/generate/alert.go b/cmd/bundle/generate/alert.go
@@ -132,7 +132,7 @@ After generation, you can deploy this alert to other targets using:
 
 		// Check if file exists and force flag
 		if _, err := os.Stat(alertPath); err == nil && !force {
-			return fmt.Errorf("%s already exists. Use --force to overwrite", alertPath)
+			return fmt.Errorf("%s already exists. Use --force to overwrite", filepath.ToSlash(alertPath))
 		}
 
 		// Write alert definition file
@@ -170,8 +170,8 @@ After generation, you can deploy this alert to other targets using:
 			return err
 		}
 
-		cmdio.LogString(ctx, "Alert configuration successfully saved to "+configPath)
-		cmdio.LogString(ctx, "Serialized alert definition to "+alertPath)
+		cmdio.LogString(ctx, "Alert configuration successfully saved to "+filepath.ToSlash(configPath))
+		cmdio.LogString(ctx, "Serialized alert definition to "+filepath.ToSlash(alertPath))
 
 		return nil
 	}
diff --git a/cmd/bundle/generate/dashboard.go b/cmd/bundle/generate/dashboard.go
@@ -191,14 +191,14 @@ func (d *dashboard) saveSerializedDashboard(ctx context.Context, b *bundle.Bundl
 	info, err := os.Stat(filename)
 	if err == nil {
 		if info.IsDir() {
-			return fmt.Errorf("%s is a directory", rel)
+			return fmt.Errorf("%s is a directory", filepath.ToSlash(rel))
 		}
 		if !d.force {
-			return fmt.Errorf("%s already exists. Use --force to overwrite", rel)
+			return fmt.Errorf("%s already exists. Use --force to overwrite", filepath.ToSlash(rel))
 		}
 	}
 
-	cmdio.LogString(ctx, fmt.Sprintf("Writing dashboard to %q", rel))
+	cmdio.LogString(ctx, "Writing dashboard to "+filepath.ToSlash(rel))
 	return os.WriteFile(filename, data, 0o644)
 }
 
@@ -242,7 +242,7 @@ func (d *dashboard) saveConfiguration(ctx context.Context, b *bundle.Bundle, das
 		rel = resourcePath
 	}
 
-	cmdio.LogString(ctx, fmt.Sprintf("Writing configuration to %q", rel))
+	cmdio.LogString(ctx, "Writing configuration to "+filepath.ToSlash(rel))
 	err = saver.SaveAsYAML(result, resourcePath, d.force)
 	if err != nil {
 		return err
diff --git a/cmd/bundle/generate/job.go b/cmd/bundle/generate/job.go
@@ -145,7 +145,7 @@ After generation, you can deploy this job to other targets using:
 			return err
 		}
 
-		cmdio.LogString(ctx, "Job configuration successfully saved to "+filename)
+		cmdio.LogString(ctx, "Job configuration successfully saved to "+filepath.ToSlash(filename))
 
 		if bind {
 			return deployment.BindResource(cmd, jobKey, strconv.FormatInt(jobId, 10), true, false, true)
diff --git a/cmd/bundle/generate/pipeline.go b/cmd/bundle/generate/pipeline.go
@@ -149,7 +149,7 @@ like catalogs, schemas, and compute configurations per target.`,
 			return err
 		}
 
-		cmdio.LogString(ctx, "Pipeline configuration successfully saved to "+filename)
+		cmdio.LogString(ctx, "Pipeline configuration successfully saved to "+filepath.ToSlash(filename))
 
 		if bind {
 			return deployment.BindResource(cmd, pipelineKey, pipelineId, true, false, true)

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ Deployment complete!`
`26`	`26`
`27`	`27`	`=== update the dashboard file using bundle generate`
`28`	`28`	`>>> [CLI] bundle generate dashboard --resource test_dashboard --force`
`29`		`-Writing dashboard to "dash.lvdash.json"`
	`29`	`+Writing dashboard to dash.lvdash.json`
`30`	`30`
`31`	`31`	`>>> cat dash.lvdash.json`
`32`	`32`	`{`