chore(coderd/notifications): improve failed test feedback

SasSwart · SasSwart · commit adffe60de5c2 · 2024-10-05T16:24:21.000Z
diff --git a/coderd/notifications/notifications_test.go b/coderd/notifications/notifications_test.go
@@ -960,13 +960,15 @@ func TestNotificationTemplates_Golden(t *testing.T) {
 				return
 			}
 
+			hint := "run \"DB=ci make update-golden-files\" and commit the changes"
+
 			wantBody, err := os.ReadFile(bodyGoldenFile)
-			require.NoError(t, err, "open golden file, run \"DB=ci make update-golden-files\" and commit the changes")
+			require.NoError(t, err, fmt.Sprintf("missing golden notification body file. %s", hint))
 			wantTitle, err := os.ReadFile(titleGoldenFile)
-			require.NoError(t, err, "open golden file, run \"DB=ci make update-golden-files\" and commit the changes")
+			require.NoError(t, err, fmt.Sprintf("missing golden notification title file. %s", hint))
 
-			require.Equal(t, string(wantBody), body, "body should be equal")
-			require.Equal(t, string(wantTitle), title, "title should be equal")
+			require.Equal(t, string(wantBody), body, "rendered template body does not match golden file. If this is expected, %s", hint)
+			require.Equal(t, string(wantTitle), title, "rendered template title does not match golden file. If this is expected, %s", hint)
 		})
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -960,13 +960,15 @@ func TestNotificationTemplates_Golden(t *testing.T) {`
`960`	`960`	`return`
`961`	`961`	`}`
`962`	`962`
	`963`	`+ hint := "run \"DB=ci make update-golden-files\" and commit the changes"`
	`964`	`+`
`963`	`965`	`wantBody, err := os.ReadFile(bodyGoldenFile)`
`964`		`- require.NoError(t, err, "open golden file, run \"DB=ci make update-golden-files\" and commit the changes")`
	`966`	`+ require.NoError(t, err, fmt.Sprintf("missing golden notification body file. %s", hint))`
`965`	`967`	`wantTitle, err := os.ReadFile(titleGoldenFile)`
`966`		`- require.NoError(t, err, "open golden file, run \"DB=ci make update-golden-files\" and commit the changes")`
	`968`	`+ require.NoError(t, err, fmt.Sprintf("missing golden notification title file. %s", hint))`
`967`	`969`
`968`		`- require.Equal(t, string(wantBody), body, "body should be equal")`
`969`		`- require.Equal(t, string(wantTitle), title, "title should be equal")`
	`970`	`+ require.Equal(t, string(wantBody), body, "rendered template body does not match golden file. If this is expected, %s", hint)`
	`971`	`+ require.Equal(t, string(wantTitle), title, "rendered template title does not match golden file. If this is expected, %s", hint)`
`970`	`972`	`})`
`971`	`973`	`}`
`972`	`974`	`}`