大家好~我是米洛

我正在从0到1打造一个开源的接口测试平台, 也在编写一套与之对应的教程,希望大家多多支持。

欢迎关注我的公众号米洛的测开日记,获取最新文章教程!

回顾

书接上回,我们找准了一款看似不错的邮件模板,但由于数据都是死的,所以我们需要获取测试报告产生的数据,并渲染HTML模板

这节我们就来彻彻底底完善这块功能。

效果图

这次数据已经真实,而且有定时任务直接跑了发送出来,相当靠谱

测试平台系列(88) 完成邮件通知功能(附赠精美邮件模板) - 图1

编写邮件模块

由于之前yagmail不是太好用,所以我们需要改写send_msg方法,由于比较简单,我就直接上代码了。

不过在此之前呢,我们需要先去配置文件里面加上一个字段:

测试平台系列(88) 完成邮件通知功能(附赠精美邮件模板) - 图2

其实smtplib提供了From的选项,我本来想叫Pity自动化测试平台,但是那样的话邮件死活发不出去,遂放弃。

  1. @staticmethod
  2. def send_msg(subject, content, attachment=None, *receiver):
  3. configuration = SystemConfiguration.get_config()
  4. data = configuration.get("email")
  5. sender = data.get("sender")
  6. to = data.get("to")
  7. message = MIMEText(content, 'html', 'utf-8')
  8. message['From'] = sender
  9. message['To'] = Header(to, 'utf-8')
  10. message['Subject'] = Header(subject, 'utf-8')
  11. try:
  12. smtp = smtplib.SMTP()
  13. smtp.connect(data.get("host"))
  14. # 我们用set_debuglevel(1)就可以打印出和SMTP服务器交互的所有信息。
  15. smtp.set_debuglevel(1)
  16. smtp.login(sender, data.get("password"))
  17. smtp.sendmail(sender, list(receiver), message.as_string())
  18. except Exception as e:
  19. raise Exception(f"发送测试报告邮件失败: {e}")

新的send_msg方法很简单,在保持参数一致的情况下,代码量比yagmail多了很多。

大概思路就是先封装MIMETEXT,并设置为html模式,接着把收件人发件人主题以及内容等数据都放入其中,最后通过sendmail发送邮件。

改造run_test_plan方法

  • 添加执行人参数

目前我们的测试计划还不支持手动执行,一方面为了适配手动执行,一方面为了在邮件体现执行人信息,所以我们在run_test_plan加上执行人这个参数:

测试平台系列(88) 完成邮件通知功能(附赠精美邮件模板) - 图3

执行人默认是0,也就是CPU(小时候打小霸王的时候的感觉)

  • 改写run_multiple方法
    run_multiple这个方法是我们测试计划执行的核心方法,由于我们测试计划是支持多环境的,并且一个测试环境对应一份测试报告。
    我们在执行完一个测试计划可能出现多个报告链接,每个环境也有自己的通过率这些数据。
    所以我们需要记录一个map,里面存放env => 测试结果的映射,最终返回。
    由于我们是异步执行,所以我们在外部设定一个map,当做参数传递进去,由于引用传递的原理,函数执行完毕,我们的map也更新好了。

测试平台系列(88) 完成邮件通知功能(附赠精美邮件模板) - 图4

顺理成章的,run_multiple方法里面也需要改造,它应该接收新的map参数,但为了不影响原先的功能,所以它可传可不传。

下面是获取执行人姓名的操作:

测试平台系列(88) 完成邮件通知功能(附赠精美邮件模板) - 图5

接着是run_multiple在返回之前的改造:

测试平台系列(88) 完成邮件通知功能(附赠精美邮件模板) - 图6

测试平台系列(88) 完成邮件通知功能(附赠精美邮件模板) - 图7

生成真实html

上述操作都是为了获取测试报告需要的数据,获取了之后我们还得利用jinja2渲染html。

这里我放上原生html:

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>
  5. 测试报告
  6. </title>
  7. </head>
  8. <body>
  9. <div>
  10. <includetail>
  11. <div align="center">
  12. <div class="open_email" style="margin-left: 8px; margin-top: 8px; margin-bottom: 8px; margin-right: 8px;">
  13. <div>
  14. <br>
  15. <span class="genEmailContent">
  16. <div id="cTMail-Wrap"
  17. style="word-break: break-all;box-sizing:border-box;text-align:center;min-width:320px; max-width:660px; border:1px solid #f6f6f6; background-color:#f7f8fa; margin:auto; padding:20px 0 30px; font-family:'helvetica neue',PingFangSC-Light,arial,'hiragino sans gb','microsoft yahei ui','microsoft yahei',simsun,sans-serif">
  18. <div class="main-content" style="">
  19. <table style="width:100%;font-weight:300;margin-bottom:10px;border-collapse:collapse">
  20. <tbody>
  21. <tr style="font-weight:300">
  22. <td style="width:3%;max-width:30px;"></td>
  23. <td style="max-width:600px;">
  24. <div id="cTMail-logo" style="width:92px; height:25px;">
  25. <a href="">
  26. <img border="0" src="https://gitee.com/woodywrx/picture/raw/master/2021-11-24/1637761462006-image.png"
  27. style="width:36px; height:36px;display:block">
  28. </a>
  29. </div>
  30. <p style="height:2px;background-color: #00a4ff;border: 0;font-size:0;padding:0;width:100%;margin-top:20px;"></p>
  31. <div id="cTMail-inner" style="background-color:#fff; padding:23px 0 20px;box-shadow: 0px 1px 1px 0px rgba(122, 55, 55, 0.2);text-align:left;">
  32. <table style="width:100%;font-weight:300;margin-bottom:10px;border-collapse:collapse;text-align:left;">
  33. <tbody>
  34. <tr style="font-weight:300">
  35. <td style="width:3.2%;max-width:30px;"></td>
  36. <td style="max-width:480px;text-align:left;">
  37. <h1 id="cTMail-title" style="font-size: 20px; line-height: 36px; margin: 0px 0px 22px;">
  38. <strong>{{ env }}</strong>】测试计划 【<strong>{{ plan_name }}</strong>】执行结果: <strong>{{plan_result}} </strong>
  39. </h1>
  40. <p id="cTMail-userName" style="font-size:14px;color:#333; line-height:24px; margin:0;">
  41. 尊敬的pity用户,您好!
  42. </p>
  43. <p class="cTMail-content" style="line-height: 24px; margin: 6px 0px 0px; overflow-wrap: break-word; word-break: break-all;">
  44. <span style="color: rgb(51, 51, 51); font-size: 14px;">
  45. 本次测试计划共执行用例<strong>{{ total }}</strong>条。
  46. </span>
  47. </p>
  48. <p class="cTMail-content" style="line-height: 24px; margin: 6px 0px 0px; overflow-wrap: break-word; word-break: break-all;">
  49. <span style="color: rgb(51, 51, 51); font-size: 14px;">
  50. <strong>{{ executor }}</strong>于{{ start_time }}开始执行,共耗时{{cost}}秒。
  51. </span>
  52. </p>
  53. <p class="cTMail-content" style="line-height: 24px; margin: 6px 0px 0px; overflow-wrap: break-word; word-break: break-all;">
  54. <span style="color: rgb(51, 51, 51); font-size: 14px;">
  55. 成功数量 <strong style="color: #67C23A">{{ success }}</strong>
  56. </span>
  57. </p>
  58. <p class="cTMail-content" style="line-height: 24px; margin: 6px 0px 0px; overflow-wrap: break-word; word-break: break-all;">
  59. <span style="color: rgb(51, 51, 51); font-size: 14px;">
  60. 失败数量 <strong style="color: #F56C6C">{{ failed }}</strong>
  61. </span>
  62. </p>
  63. <p class="cTMail-content" style="line-height: 24px; margin: 6px 0px 0px; overflow-wrap: break-word; word-break: break-all;">
  64. <span style="color: rgb(51, 51, 51); font-size: 14px;">
  65. 出错数量 <strong style="color: #E6A23C">{{ error }}</strong>
  66. </span>
  67. </p>
  68. <p class="cTMail-content" style="line-height: 24px; margin: 6px 0px 0px; overflow-wrap: break-word; word-break: break-all;">
  69. <span style="color: rgb(51, 51, 51); font-size: 14px;">
  70. 跳过数量 <strong style="color: #409EFF">{{ skip }}</strong>
  71. </span>
  72. </p>
  73. <p class="cTMail-content" style="line-height: 24px; margin: 6px 0px 0px; overflow-wrap: break-word; word-break: break-all;">
  74. <span style="color: rgb(51, 51, 51); font-size: 14px;">查看详细测试报告,可点击下方链接。
  75. <span style="font-weight: bold;">如有打扰,请您谅解。</span>
  76. </span>
  77. </p>
  78. <p class="cTMail-content"
  79. style="font-size: 14px; color: rgb(51, 51, 51); line-height: 24px; margin: 6px 0px 0px; word-wrap: break-word; word-break: break-all;">
  80. <a id="cTMail-btn" href="{{report_url}}" title=""
  81. style="font-size: 16px; line-height: 45px; display: block; background-color: rgb(0, 164, 255); color: rgb(255, 255, 255); text-align: center; text-decoration: none; margin-top: 20px; border-radius: 3px;">
  82. 点击此处查看完整报告
  83. </a>
  84. </p>
  85. <p class="cTMail-content" style="line-height: 24px; margin: 6px 0px 0px; overflow-wrap: break-word; word-break: break-all;">
  86. <span style="color: rgb(51, 51, 51); font-size: 14px;">
  87. <br>
  88. 无法正常显示?请复制以下链接至浏览器打开:
  89. <br>
  90. <a href="{{report_url}}" title=""
  91. style="color: rgb(0, 164, 255); text-decoration: none; word-break: break-all; overflow-wrap: normal; font-size: 14px;">
  92. 这里是测试报告链接
  93. </a>
  94. </span>
  95. </p>
  96. </td>
  97. <td style="width:3.2%;max-width:30px;"></td>
  98. </tr>
  99. </tbody>
  100. </table>
  101. </div>
  102. <div id="cTMail-copy" style="text-align:center; font-size:12px; line-height:18px; color:#999">
  103. <table style="width:100%;font-weight:300;margin-bottom:10px;border-collapse:collapse">
  104. <tbody>
  105. <tr style="font-weight:300">
  106. <td style="width:3.2%;max-width:30px;"></td>
  107. <td style="max-width:540px;">
  108. <p style="text-align:center; margin:20px auto 14px auto;font-size:12px;color:#999;">
  109. 此邮件由pity自动发出,请勿回复。
  110. </p>
  111. <p id="cTMail-rights" style="max-width: 100%; margin:auto;font-size:12px;color:#999;text-align:center;line-height:22px;">
  112. <img border="0" src="https://gitee.com/woodywrx/picture/raw/master/2021-8-7/1628267097936-qrcode_for_gh_554fe7a74955_258.jpg"
  113. style="width:84px; height:84px; margin:0 auto;">
  114. <br>
  115. 关注测试开发坑货,了解pity更多内容
  116. <br>
  117. </p>
  118. </td>
  119. <td style="width:3.2%;max-width:30px;"></td>
  120. </tr>
  121. </tbody>
  122. </table>
  123. </div>
  124. </td>
  125. <td style="width:3%;max-width:30px;"></td>
  126. </tr>
  127. </tbody>
  128. </table>
  129. </div>
  130. </div>
  131. </span>
  132. </div>
  133. </div>
  134. </div>
  135. </includetail>
  136. </div>
  137. </body>
  138. </html>

上述代码在pity/templates/report.html文件内。

接着编写渲染html的方法:

测试平台系列(88) 完成邮件通知功能(附赠精美邮件模板) - 图8

其中kwargs是传递对应的参数给html。

之前也说过一个邮件对应一个地址,所以send_msg调用的地方也得跟着修改。

测试平台系列(88) 完成邮件通知功能(附赠精美邮件模板) - 图9

至此,我们的邮件推送功能就全部完成了。

测试平台系列(88) 完成邮件通知功能(附赠精美邮件模板) - 图10

今天的内容就到这里了,咱们下期见。