fix(exp/golden): normalize line breaks to ensure tests pass on windows (

#365)

exp/golden/golden.go

@@ -4,6 +4,7 @@ import (
 	"flag"
 	"os"
 	"path/filepath"
+	"runtime"
 	"strconv"
 	"strings"
 	"testing"
@@ -40,7 +41,8 @@ func RequireEqual(tb testing.TB, out []byte) {
 		tb.Fatal(err)
 	}
 
-	goldenStr := escapeSeqs(string(goldenBts))
+	goldenStr := normalizeWindowsLineBreaks(string(goldenBts))
+	goldenStr = escapeSeqs(goldenStr)
 	outStr := escapeSeqs(string(out))
 
 	diff := udiff.Unified("golden", "run", goldenStr, outStr)
@@ -69,3 +71,12 @@ func escapeSeqs(in string) string {
 	}
 	return strings.Join(s, "\n")
 }
+
+// normalizeWindowsLineBreaks replaces all \r\n with \n.
+// This is needed because Git for Windows checks out with \r\n by default.
+func normalizeWindowsLineBreaks(str string) string {
+	if runtime.GOOS == "windows" {
+		return strings.ReplaceAll(str, "\r\n", "\n")
+	}
+	return str
+}

exp/golden/golden_test.go

@@ -3,19 +3,16 @@ package golden
 import "testing"
 
 func TestRequireEqualUpdate(t *testing.T) {
-	enableUpdate(t)
+	*update = true
 	RequireEqual(t, []byte("test"))
 }
 
 func TestRequireEqualNoUpdate(t *testing.T) {
+	*update = false
 	RequireEqual(t, []byte("test"))
 }
 
-func enableUpdate(tb testing.TB) {
-	tb.Helper()
-	previous := update
-	*update = true
-	tb.Cleanup(func() {
-		update = previous
-	})
+func TestRequireWithLineBreaks(t *testing.T) {
+	*update = false
+	RequireEqual(t, []byte("foo\nbar\nbaz\n"))
 }

exp/golden/testdata/TestRequireWithLineBreaks.golden

@@ -0,0 +1,3 @@
+foo
+bar
+baz