chore(coderd/notifications): expand golden file testing for notifications (#15032)

This PR aims to close https://github.com/coder/coder/issues/14913.

It expands the golden files for the notifier to include the entire
payload serialised as JSON.

coderd/notifications/dispatch/smtp_test.go

@@ -2,11 +2,8 @@ package dispatch_test
 
 import (
 	"bytes"
-	"crypto/tls"
-	_ "embed"
 	"fmt"
 	"log"
-	"net"
 	"sync"
 	"testing"
 
@@ -22,6 +19,7 @@ import (
 	"github.com/coder/serpent"
 
 	"github.com/coder/coder/v2/coderd/notifications/dispatch"
+	"github.com/coder/coder/v2/coderd/notifications/dispatch/smtptest"
 	"github.com/coder/coder/v2/coderd/notifications/types"
 	"github.com/coder/coder/v2/codersdk"
 	"github.com/coder/coder/v2/testutil"
@@ -47,9 +45,9 @@ func TestSMTP(t *testing.T) {
 		subject = "This is the subject"
 		body    = "This is the body"
 
-		caFile   = "fixtures/ca.crt"
-		certFile = "fixtures/server.crt"
-		keyFile  = "fixtures/server.key"
+		caFile   = "smtptest/fixtures/ca.crt"
+		certFile = "smtptest/fixtures/server.crt"
+		keyFile  = "smtptest/fixtures/server.key"
 	)
 
 	logger := slogtest.Make(t, &slogtest.Options{IgnoreErrors: true, IgnoredErrorIs: []error{}}).Leveled(slog.LevelDebug)
@@ -125,7 +123,7 @@ func TestSMTP(t *testing.T) {
 
 				Auth: codersdk.NotificationsEmailAuthConfig{
 					Username:     username,
-					PasswordFile: "fixtures/password.txt",
+					PasswordFile: "smtptest/fixtures/password.txt",
 				},
 			},
 			toAddrs:          []string{to},
@@ -341,14 +339,14 @@ func TestSMTP(t *testing.T) {
 			cfg: codersdk.NotificationsEmailConfig{
 				TLS: codersdk.NotificationsEmailTLSConfig{
 					CAFile:   caFile,
-					CertFile: "fixtures/nope.cert",
+					CertFile: "smtptest/fixtures/nope.cert",
 					KeyFile:  keyFile,
 				},
 			},
 			// not using full error message here since it differs on *nix and Windows:
 			// *nix: no such file or directory
 			// Windows: The system cannot find the file specified.
-			expectedErr: "open fixtures/nope.cert:",
+			expectedErr: "open smtptest/fixtures/nope.cert:",
 			retryable:   true,
 		},
 		{
@@ -358,13 +356,13 @@ func TestSMTP(t *testing.T) {
 				TLS: codersdk.NotificationsEmailTLSConfig{
 					CAFile:   caFile,
 					CertFile: certFile,
-					KeyFile:  "fixtures/nope.key",
+					KeyFile:  "smtptest/fixtures/nope.key",
 				},
 			},
 			// not using full error message here since it differs on *nix and Windows:
 			// *nix: no such file or directory
 			// Windows: The system cannot find the file specified.
-			expectedErr: "open fixtures/nope.key:",
+			expectedErr: "open smtptest/fixtures/nope.key:",
 			retryable:   true,
 		},
 		/**
@@ -417,7 +415,7 @@ func TestSMTP(t *testing.T) {
 
 			tc.cfg.ForceTLS = serpent.Bool(tc.useTLS)
 
-			backend := NewBackend(Config{
+			backend := smtptest.NewBackend(smtptest.Config{
 				AuthMechanisms: tc.authMechs,
 
 				AcceptedIdentity: tc.cfg.Auth.Identity.String(),
@@ -428,7 +426,7 @@ func TestSMTP(t *testing.T) {
 			})
 
 			// Create a mock SMTP server which conditionally listens for plain or TLS connections.
-			srv, listen, err := createMockSMTPServer(backend, tc.useTLS)
+			srv, listen, err := smtptest.CreateMockSMTPServer(backend, tc.useTLS)
 			require.NoError(t, err)
 			t.Cleanup(func() {
 				// We expect that the server has already been closed in the test
@@ -460,7 +458,7 @@ func TestSMTP(t *testing.T) {
 
 			// Wait for the server to become pingable.
 			require.Eventually(t, func() bool {
-				cl, err := pingClient(listen, tc.useTLS, tc.cfg.TLS.StartTLS.Value())
+				cl, err := smtptest.PingClient(listen, tc.useTLS, tc.cfg.TLS.StartTLS.Value())
 				if err != nil {
 					t.Logf("smtp not yet dialable: %s", err)
 					return false
@@ -522,19 +520,3 @@ func TestSMTP(t *testing.T) {
 		})
 	}
 }
-
-func pingClient(listen net.Listener, useTLS bool, startTLS bool) (*smtp.Client, error) {
-	tlsCfg := &tls.Config{
-		// nolint:gosec // It's a test.
-		InsecureSkipVerify: true,
-	}
-
-	switch {
-	case useTLS:
-		return smtp.DialTLS(listen.Addr().String(), tlsCfg)
-	case startTLS:
-		return smtp.DialStartTLS(listen.Addr().String(), tlsCfg)
-	default:
-		return smtp.Dial(listen.Addr().String())
-	}
-}

coderd/notifications/dispatch/smtptest/server.go

@@ -1,4 +1,4 @@
-package dispatch_test
+package smtptest
 
 import (
 	"crypto/tls"
@@ -162,7 +162,7 @@ func (*Session) Reset() {}
 func (*Session) Logout() error { return nil }
 
 // nolint:revive // Yes, useTLS is a control flag.
-func createMockSMTPServer(be *Backend, useTLS bool) (*smtp.Server, net.Listener, error) {
+func CreateMockSMTPServer(be *Backend, useTLS bool) (*smtp.Server, net.Listener, error) {
 	// nolint:gosec
 	tlsCfg := &tls.Config{
 		GetCertificate: readCert,
@@ -203,3 +203,19 @@ func readCert(_ *tls.ClientHelloInfo) (*tls.Certificate, error) {
 
 	return &crt, nil
 }
+
+func PingClient(listen net.Listener, useTLS bool, startTLS bool) (*smtp.Client, error) {
+	tlsCfg := &tls.Config{
+		// nolint:gosec // It's a test.
+		InsecureSkipVerify: true,
+	}
+
+	switch {
+	case useTLS:
+		return smtp.DialTLS(listen.Addr().String(), tlsCfg)
+	case startTLS:
+		return smtp.DialStartTLS(listen.Addr().String(), tlsCfg)
+	default:
+		return smtp.Dial(listen.Addr().String())
+	}
+}