Function normalizeGoldenFile

cli/clitest/golden.go:198–234

normalizeGoldenFile replaces any strings that are system or timing dependent with a placeholder so that the golden files can be compared with a simple equality check.

(t *testing.T, byt []byte)

// with a placeholder so that the golden files can be compared with a simple
// equality check.
func normalizeGoldenFile(t *testing.T, byt []byte) []byte {
	// Replace any timestamps with a placeholder.
	byt = timestampRegex.ReplaceAll(byt, []byte(pad("[timestamp]", 20)))

	homeDir, err := os.UserHomeDir()
	require.NoError(t, err)

	configDir := config.DefaultDir()
	byt = bytes.ReplaceAll(byt, []byte(configDir), []byte("~/.config/coderv2"))

	byt = bytes.ReplaceAll(byt, []byte(codersdk.DefaultCacheDir()), []byte("[cache dir]"))

	// The home directory changes depending on the test environment.
	byt = bytes.ReplaceAll(byt, []byte(homeDir), []byte("~"))

	// Normalize the temp directory. os.TempDir() may include a trailing slash
	// (macOS) or not (Linux/Windows), and the temp directory may be followed by
	// more filepath elements with an OS-specific separator. We handle all cases
	// by replacing tempdir+separator first, then tempdir alone.
	tempDir := filepath.Clean(os.TempDir())
	byt = bytes.ReplaceAll(byt, []byte(tempDir+string(filepath.Separator)), []byte("/tmp/"))
	byt = bytes.ReplaceAll(byt, []byte(tempDir), []byte("/tmp"))
	// Clean up trailing slash when temp dir is used standalone (e.g., "/tmp/)" -> "/tmp)").
	byt = bytes.ReplaceAll(byt, []byte("/tmp/)"), []byte("/tmp)"))

	for _, r := range []struct {
		old string
		new string
	}{
		{"\r\n", "\n"},
		{`~\.cache\coder`, "~/.cache/coder"},
		{`C:\Users\RUNNER~1\AppData\Local\Temp`, "/tmp"},
	} {
		byt = bytes.ReplaceAll(byt, []byte(r.old), []byte(r.new))
	}
	return byt
}

func extractVisibleCommandPaths(cmdPath []string, cmds []*serpent.Command) [][]string {
	var cmdPaths [][]string