Normalize golden files

coder · ammario · Apr 7, 2023 · Mar 30, 2023 · Mar 30, 2023 · Mar 30, 2023
commit abc92d9f30732c49ca02539caf4ec0fa1cb9c924
diff --git a/cli/root_test.go b/cli/root_test.go
@@ -107,20 +107,7 @@ ExtractCommandPathsLoop:
 				actual = bytes.ReplaceAll(actual, []byte(k), []byte(v))
 			}
 
-			// Replace any timestamps with a placeholder.
-			actual = timestampRegex.ReplaceAll(actual, []byte("[timestamp]"))
-
-			homeDir, err := os.UserHomeDir()
-			require.NoError(t, err)
-
-			configDir := config.DefaultDir()
-			actual = bytes.ReplaceAll(actual, []byte(configDir), []byte("~/.config/coderv2"))
-
-			actual = bytes.ReplaceAll(actual, []byte(codersdk.DefaultCacheDir()), []byte("[cache dir]"))
-
-			// The home directory changes depending on the test environment.
-			actual = bytes.ReplaceAll(actual, []byte(homeDir), []byte("~"))
-
+			actual = normalizeGoldenFile(t, actual)
 			goldenPath := filepath.Join("testdata", strings.Replace(tt.name, " ", "_", -1)+".golden")
 			if *updateGoldenFiles {
 				t.Logf("update golden file for: %q: %s", tt.name, goldenPath)
@@ -131,19 +118,7 @@ ExtractCommandPathsLoop:
 			expected, err := os.ReadFile(goldenPath)
 			require.NoError(t, err, "read golden file, run \"make update-golden-files\" and commit the changes")
 
-			// Normalize files to tolerate different operating systems.
-			for _, r := range []struct {
-				old string
-				new string
-			}{
-				{"\r\n", "\n"},
-				{`~\.cache\coder`, "~/.cache/coder"},
-				{`C:\Users\RUNNER~1\AppData\Local\Temp`, "/tmp"},
-				{os.TempDir(), "/tmp"},
-			} {
-				expected = bytes.ReplaceAll(expected, []byte(r.old), []byte(r.new))
-				actual = bytes.ReplaceAll(actual, []byte(r.old), []byte(r.new))
-			}
+			expected = normalizeGoldenFile(t, expected)
 			require.Equal(
 				t, string(expected), string(actual),
 				"golden file mismatch: %s, run \"make update-golden-files\", verify and commit the changes",
@@ -153,6 +128,37 @@ ExtractCommandPathsLoop:
 	}
 }
 
+// normalizeGoldenFiles 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.
+func normalizeGoldenFile(t *testing.T, byt []byte) []byte {
+	// Replace any timestamps with a placeholder.
+	byt = timestampRegex.ReplaceAll(byt, []byte("[timestamp]"))
+
+	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("~"))
+	for _, r := range []struct {
+		old string
+		new string
+	}{
+		{"\r\n", "\n"},
+		{`~\.cache\coder`, "~/.cache/coder"},
+		{`C:\Users\RUNNER~1\AppData\Local\Temp`, "/tmp"},
+		{os.TempDir(), "/tmp"},
+	} {
+		byt = bytes.ReplaceAll(byt, []byte(r.old), []byte(r.new))
+	}
+	return byt
+}
+
 func extractVisibleCommandPaths(cmdPath []string, cmds []*clibase.Cmd) [][]string {
 	var cmdPaths [][]string
 	for _, c := range cmds {

diff --git a/cli/server_test.go b/cli/server_test.go
@@ -1569,6 +1569,7 @@ func TestServerYAMLConfig(t *testing.T) {
 
 	goldenPath := filepath.Join("testdata", "server-config.yaml.golden")
 
+	wantByt = normalizeGoldenFile(t, wantByt)
 	if *updateGoldenFiles {
 		require.NoError(t, os.WriteFile(goldenPath, wantByt, 0o600))
 		return

diff --git a/cli/testdata/coder_--help.golden b/cli/testdata/coder_--help.golden
@@ -47,6 +47,9 @@ Coder v0.0.0-devel — A tool for provisioning self-hosted development environme
 Global options are applied to all commands. They can be set using environment
 variables or flags.
 
+      --debug-options bool
+          Print all options, how they're set, then exit.
+
       --global-config string, $CODER_CONFIG_DIR (default: ~/.config/coderv2)
           Path to the global `coder` config directory.
 

diff --git a/cli/testdata/server-config.yaml.golden b/cli/testdata/server-config.yaml.golden
@@ -255,8 +255,8 @@ updateCheck: false
 enableSwagger: false
 # The directory to cache temporary files. If unspecified and $CACHE_DIRECTORY is
 # set, it will be used for compatibility with systemd. (default:
-# /home/coder/.cache/coder, type: string)
-cacheDir: /home/coder/.cache/coder
+# [cache dir], type: string)
+cacheDir: [cache dir]
 # Controls whether data will be stored in an in-memory database. (default:
 # <unset>, type: bool)
 inMemoryDatabase: false