go-smtp-mockをSMTPのモックサーバにして単体テストする

package example

import (
	// ... 省略 ...
	smtpmock "github.com/mocktools/go-smtp-mock/v2"
)

func TestExampleMailSendHandler(t *testing.T) {
	// ... 省略（DBセットアップ、DBコネクション初期化など） ...

	// SMTPのモックサーバの初期化
	testSMTPServer := smtpmock.New(smtpmock.ConfigurationAttr{})

	// テスト終了後にSMTPサーバ停止
	t.Cleanup(func() {
		if err := testSMTPServer.Stop(); err != nil {
			t.Log(err)
		}
	})

    // SMTPサーバ起動
	if err := testSMTPServer.Start(); err != nil {
		t.Fatal(err)
	}

	tests := []struct {
		name      string
		inputFile string
		wantMail  string
	}{
		{
			name:       "メール送信が1件あり、xxx業務の依頼を行う",
			inputFile:  "... 省略 ...",
			wantMail:   "testdata/want_mail_01.html",
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			// ... 省略（DBへ事前データ登録など） ...

			h := NewExampleMailSendHandler(db, MailConfig{
				Host: "localhost",
				Port: testSMTPServer.PortNumber(),
			})

			if err := h.SendMail(context.Background()); err != nil {
				t.Errorf("SendMail() error = %v", err)
			}

			// ... 省略（DBに対するデータ検証など） ...

			msgs := testSMTPServer.MessagesAndPurge()
			if len(msgs) == 0 {
				t.Fatalf("no messages received")
			} else if len(msgs) > 1 {
				t.Errorf("multiple mail messages received: %v", msgs)
			}

			want := testonly.MustReadFile(tt.wantMail)
			if diff := cmp.Diff(string(want), msgs[0].MsgRequest()); diff != "" {
				t.Errorf("SendMail() mailMsgRequestHeader mismatch (-want +got):\n%s", diff)
			}
		})
	}
}

// SMTPのモックサーバの初期化
testSMTPServer := smtpmock.New(smtpmock.ConfigurationAttr{})

// テスト終了後にSMTPサーバ停止
t.Cleanup(func() {
	if err := testSMTPServer.Stop(); err != nil {
		t.Log(err)
	}
})

   // SMTPサーバ起動
if err := testSMTPServer.Start(); err != nil {
	t.Fatal(err)
}

import (
	// ... 省略 ...
	"net/smtp"
)

func (h ExampleMailSendHandler)SendMain(ctx context.Context, targetID string) error {
	// ... 省略 ...

    // ユーザ名、パスワード認証
    auth := smtp.PlainAuth("", h.SMTPUsername, h.SMTPPassword, h.SMTPHost)

	// net/smtpパッケージを用いてメール送信    
	if err := smtp.SendMail(h.SMTPEndpoint(), auth, fromAddrs, toAddrs, []byte(msg)); err != nil {
		return fmt.Errorf("smtp send mail: %w", err) // ★go-smtp-mockは認証に非対応なので失敗する
	}
 
 	// ... 省略 ...
    return nil
}

func (h ExampleMailSendHandler) SMTPAuth() smtp.Auth {
	if c.Username != "" && c.Password != "" {
		// デプロイメント環境で利用する場合は、ユーザ名・パスワード認証を用いる
		return smtp.PlainAuth("", c.Username, c.Password, c.Host)
	}
	// 🚨go-mock-smtpが認証をサポートしていない🚨
    // 🚨そこでUsername, Passwordが空の場合はnilを返し、認証無しでメールを送信させる🚨
	return nil
}

server := smtpmock.New(smtpmock.ConfigurationAttr{
  LogToStdout:       true,
  LogServerActivity: true,
})