业务功能中包含邮件发送,怎么测试?
前言
網站開發中,經常碰到需要發送郵件的場景。
比如,重置用戶密碼,需要執行下列流程:
用戶在重置頁面輸入郵箱地址
進入郵箱,使用獲得的重置鏈接打開重置頁面
輸入新密碼
一般來說,重置鏈接都需要包含一個token值,用于保證當前重置操作是正確的來源,如下圖:
問題
為了將上面的業務實現,示例代碼如下:
[ApiController] [Route("[controller]")] public?class?ResetController?:?ControllerBase {private?readonly?Dictionary<string,string>?_cache=?new?Dictionary<string,?string>();[HttpGet]public?void?Get([FromQuery]?string?email){var?token?=?Guid.NewGuid().ToString("N");_cache.Add(token,?email);//發送郵件,smtpServer、from來源于配置using?(var?smtpClient?=?new?SmtpClient(smtpServer,25)){smtpClient.Send(from,?email,?"重置密碼",?token);}}[HttpPost]public?string?Post(string?token,?string?newPassword){var?email?=?_cache[token];//重置密碼邏輯return?email;} }可以發現,如果要拿到token,我們必須獲得郵件內容。
怎么辦?
當然,有很多種解決方案,比如從緩存獲取token,但是那樣會與業務內部實現強耦合。
在這里,我們用Smtp4dev去真實的獲得郵件。
Smtp4dev
Smtp4dev(https://github.com/rnwood/smtp4dev)用于開發和測試的虛擬SMTP電子郵件服務器。可以讓你在測試應用程序時,無需向真實客戶發送郵件,也無需使用特殊配置設置復雜的真實電子郵件服務器。
安裝非常簡單,直接執行下列命令:
dotnet?tool?install?-g?Rnwood.Smtp4dev然后執行下列命令運行Smtp4dev:
smtp4dev?--urls=https://localhost:9000?--db=d:\codes\smtp4dev.db--urls 管理頁面訪問地址
--db 郵件存儲Sqlite數據庫,后面測試會用到
smtp4dev對應的SMTP服務器地址為localhost:25。
測試用例
測試用例代碼很簡單:
[Fact] public?void?Test1() {var?controller?=?new?ResetController();var?email?=?"user_"+Guid.NewGuid().ToString("N")?+?"@localhost";controller.Get(email);var?token?=?GetToken(email);var?result?=?controller.Post(token,"111");Assert.Equal(email,?result); }GetToken將從郵件中獲取token。
獲取郵件
雖然smtp4dev提供了API來獲取郵件,但是我們這里使用更簡單的方式,直接從數據庫讀取郵件。
首先,創建DbContext:
public?class?Smtp4devContext?:?DbContext {public?DbSet<Message>?Messages?{?get;?set;?}protected?override?void?OnConfiguring(DbContextOptionsBuilder?optionsBuilder){optionsBuilder.UseSqlite(@"DataSource=d:\codes\smtp4dev.db");} }public?class?Message {?public?string?Id?{?get;?set;?}public?string?To?{?get;?set;?}public?string?ReceivedDate?{?get;?set;?}public?string?Data?{?get;?set;?} }然后,獲取指定收件人的最新郵件:
private?static?Message?GetMessage(string?email) {return?new?Smtp4devContext().Messages.Where(p?=>?p.To?==?email).OrderByDescending(p?=>?p.ReceivedDate).First(); }最后,從郵件的Data屬性中分析出token:
private?string?GetToken(string?email) {var?message?=?GetMessage(email);var?lines?=?message.Data.Split("\r\n",?StringSplitOptions.RemoveEmptyEntries);return?lines.Last(); }運行測試,成功!
結論
如果你在開發和測試時需要發送郵件,試試Smtp4dev吧!
如果你覺得這篇文章對你有所啟發,請關注我的個人公眾號”My IO“,記住我!
總結
以上是生活随笔為你收集整理的业务功能中包含邮件发送,怎么测试?的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: C# WPF DataGrid获取单元格
- 下一篇: 2021年全球知名开源项目大更新