Selenium+Java+Maven（05）：配置Jenkins实现测试报告邮件发送

悠悠 2023-02-13 11:49 105阅读 0赞

在上一章：[Selenium+Java+Maven（04）：利用Jenkins实现自动化持续集成][Selenium_Java_Maven_04_Jenkins]  
里我们讲完了如何通过Jenkins中的**windows batch command**运行本地Maven项目，并生成测试报告。  
这一章我们继续讲Maven自动化项目 “自动发送测试报告邮件” ，以及 “定时触发构建”的配置。  
Come On！

我们分为三大点来进行：  
一、**在Jenkins中生成自动化测试报告**  
二、**自动化测试报告邮件及附件发送**  
三、**在Jenkins中配置定时自动构建**

--------------------

## 一、在Jenkins里生成自动化测试报告 ##

### 11. **安装依赖插件** ###

我们需要下载 **htmlpublisher.hpi** 和 **testng-plugin.hpi** 这两个Jenkins插件。  
可以在这个网站里下载：[Jenkins插件下载][Jenkins]。  
下载完成后，我们在jenkins的系统管理里，打开插件管理：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70]  
进入后点 “高级-上传插件-选择文件上传“ 然后把刚刚下载好的俩插件都上传上去就行。然后可以重启一下Jenkins。  
重启方式：使用管理员身份打开命令行，在其中敲入 *net stop Jenkins*，回车，然后再敲入*net start Jenkins*，等到屏幕上显示启动服务完毕即可。

### 1.2. **配置构建后操作** ###

打开我们的Jenkins工程，点击左侧的 “配置”  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 1]  
点击“构建后操作”，然后选择“添加构建后操作”，把下图中被我拿红框圈起来的一个个添加上：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 2]  
我们依次讲一下如何配置：  
**Publish HTML Reports**：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 3]  
我们只要在第一行里填写自己的Selenium工程目录下的html文件存放路径即可，看看图中我填写的，相信你能懂~

**Publish TestNG Results**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 4]  
和上面的差不多，填写testng-results.xml文件的存放路径。注意斜杠的方向，是“ / ”这个。

点击保存。然后不妨再重启一下子。  
此时我们回到Jenkins工程主页，点击左侧的立即构建，构建完成之后我们便可点击左侧的“HTML Reports”查看测试报告了（不构建是看不到的哈，这里需要注意）：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 5]  
报告的外观就和我们在Selenium工程里设置的一样：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 6]  
同时我们还可以在Jenkins工程页面左侧看到 “TestNG Results” 按钮，在右侧我们可以看到次构建的执行结果的变化趋势Trend：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 7]  
完成了以上步骤之后，便说明我们已经能够获取到自动化测试报告了。  
接下来是我们的 “测试报告邮件发送及自动构建” 配置，来客官往下走：

--------------------

## 二、自动化测试报告邮件发送及自动构建 ##

### 2.1. Jenkins邮件发送功能配置 ###

Jenkins的邮件发送功能配置，在我的这篇博客：[Jenkins（03）：配置Jenkins自动发送邮件][Jenkins_03_Jenkins] 中写的很详细，这里就不赘述啦。

博主在这里码一个我修改过的，个人认为比较简洁美观的模板，
    可以复制粘贴到 **Editable Email Notification** 的 **Default Content** 栏里，也可以自己做优化修改，代码如下：

<!DOCTYPE html>
    <html lang="en">
    
    <head>
      <meta charset="UTF-8">
      <title>${ENV, var="JOB_NAME"}-第${BUILD_NUMBER}次构建日志</title>
    </head>
    
    <body>
    	<style>
    	  * {
    	    padding: 0;
    	    margin: 0;
    	    box-sizing: border-box;
    	  }
    	
    	  html,
    	  body {
    	    height: 100%;
    	  }
    	
    	  body {
    	    width: 800px;
    	    font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Helvetica, "PingFang SC", "Hiragino Sans GB", "Microsoft YaHei", SimSun, sans-serif;
    	    font-size: 14px;
    	    color: #1F2D3D;
    	    padding: 10px;
    	  }
    	
    	  h1,
    	  h2 {
    	    padding: 10px 0;
    	  }
    	  h2 {
    	    margin-top: 20px;/* 上下间距 */
    	  }
    	
    	  table {
    	    background: #f5f5f5;
    	    border-collapse: collapse;
    	    box-shadow: inset 0 1px 0 #fff;
    	    font-size: 12px;
    	    line-height: 24px;
    	    text-align: left;
    	  }
    	
    	  th {
    	    background: linear-gradient(#777, #444);
    	    border-left: 1px solid #555;
    	    border-right: 1px solid #777;
    	    border-top: 1px solid #555;
    	    border-bottom: 1px solid #333;
    	    box-shadow: inset 0 1px 0 #999;
    	    color: #fff;
    	    font-weight: bold;
    	    padding: 10px 15px;
    	    position: relative;
    	    text-shadow: 0 1px 0 #000;
    	  }
    	
    	  th:after {
    	    background: linear-gradient(rgba(255, 255, 255, 0), rgba(255, 255, 255, .08));
    	    content: '';
    	    display: block;
    	    height: 25%;
    	    left: 0;
    	    margin: 1px 0 0 0;
    	    position: absolute;
    	    top: 25%;
    	    width: 100%;
    	  }
    	
    	  th:last-child {
    	    box-shadow: inset -1px 1px 0 #999;
    	  }
    	
    	  td {
    	    border-right: 1px solid #fff;
    	    border-left: 1px solid #e8e8e8;
    	    border-top: 1px solid #fff;
    	    border-bottom: 1px solid #e8e8e8;
    	    padding: 10px 15px;
    	    position: relative;
    	    transition: all 300ms;
    	  }
    	
    	  td:first-child {
    	    box-shadow: inset 1px 0 0 #fff;
    	  }
    
    
    	  tr:last-of-type td:first-child {
    	    box-shadow: inset 1px -1px 0 #fff;
    	  }
    	
    	  tr:last-of-type td:last-child {
    	    box-shadow: inset 1px -1px 0 #fff;
    	  }
    	
    	
    	  li {
    	    list-style: none;
    	    padding: 6px 0;
    	  }
    	
    	  li > span {
    	    margin-right: 6px;
    	  }
    	
    	  li > a {
    	    color: #58B7FF;
    	  }
    	
    	  .tip {
    	    color: #bbb;
    	    padding: 10px 0;
    	  }
    
    	</style>
    	
      <h1 style="color: #0000E3;">构建结果 - ${BUILD_STATUS}</h1>
      <span style="color: #bbb;padding: 10px 0;">(本邮件是程序自动下发的，请勿回复，谢谢！！)</span>
      <h2>Test Summary:</h2>
      <table>
        <thead>
          <tr>
            <th bgcolor="#555555" align="center">Tests</th>
            <th bgcolor="#555555" align="center">用例总数</th>
            <th bgcolor="#555555" align="center">通过个数</th>
    				<th bgcolor="#555555" align="center">失败个数</th>
          </tr>
        </thead>
        <tbody>
    			<tr>
            <td align="center">数目</td>
            <td style="color: black;" align="center">${TEST_COUNTS}</td>
            <td style="color: mediumseagreen" border-right: 1px solid #e8e8e8;box-shadow: inset -1px 0 1 #fff; align="center">${TEST_COUNTS,var="pass"}</td>
    				<td style="color: #FF4949;" align="center">${TEST_COUNTS,var="fail"}</td>
          </tr>
        </tbody>
      </table>
    
      <br>
      <h2>Failed Cases:</h2>
      <p class="failed">${FAILED_TESTS}</p>
    
    </body>
    
    </html>
    
    （源码来自网络，有删改）

这样子配置完成后，我们再点击立即构建，便可以让指定的用户收到一封测试报告邮件了，我这里又做了点小修改，还没有优化的太好，目前是这样，大家可以自行优化配色及展示项：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 8]

### 2.2. 为邮件增加测试报告附件 ###

完成以上操作后我们已经实现了自动化测试代码的自动化构建，发送邮件，并且可以在邮件中展示我们的测试结果。但里面只显示了“有无失败用例，失败用例个数”等信息，说实话还是不够直观。我们最好可以将测试报告作为附件添加在邮件当中，方便下载查看。

原理：在Jenkins中使用windows 的cmd命令将生成的测试结果报告打包为.rar文件，然后随邮件进行发送。
    
    我们打开Jenkins中的对应工程，点击左侧的“配置”，在弹出的新页面中点击上方的“构建”：
    然后点击“增加构建步骤”，在其中选择“执行Windows批处理命令”，或者英文叫做“Execute Windows batch command”。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 9]  
添加成功后，我们在其中写入如下代码：

::将测试报告文件打包，使用mvn install运行时，测试报告存放路径为\target\surefire-reports\html\*
    cd \
    C:
    ::这里是你的winrar软件的安装路径
    cd C:\Dasym\Applications\winrar
    ::这一句相信通过你的聪明才智是可以理解的，需要按照你项目的实际路径来进行修改。不懂的话可以问我哈~
    C:\Dasym\Applications\winrar\WinRAR.exe a -r -s -m3 -o+ -ep1 C:\Dasym\CodeSpace\qualinktest_v3.1\target\自动化测试报告.zip  C:\Dasym\CodeSpace\qualinktest_v3.1\target\surefire-reports\html\*

--------------------

代码解释：  
首先使用cd命令切换到我们的winrar.exe软件存放目录，我的在C:\\Dasym\\Applications\\winrar目录下，大家可以根据自己的实际情况修改。  
然后我们启用WinRAR.exe这款软件，将我们的html测试报告存储路径下的所有文件打包，并且存放在工作空间下的target文件夹中。  
我的测试报告存储路径是C:\\Dasym\\CodeSpace\\qualinktest\_v3.1\\target\\surefire-reports\\html\*。  
Java工程的工作空间是C:\\Dasym\\CodeSpace\\qualinktest\_v3.1。所以有了上面的写法，大家可以按个人实际情况对应修改。  
中间的几个参数释义可以参考这位博主的文章：[使用rar在命令行(cmd)下打包目录][rar_cmd]。

设置完成后，我们往下找到**Editable Email Notification**，并且在它的附件添加框中输入如下路径：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 10]  
注：这里只能够填写相对路径，根目录就是我们Java工程的路径。  
假设我的根目录是E:\\Coding\\CodeSpace\\qualinkTestProd，那么打包好的测试报告文件路径就是E:\\Coding\\CodeSpace\\qualinkTestProd\\target\\自动化测试报告.rar。  
我们只要填写后面的 “target\\自动化测试报告.rar” 就可以。

完成后保存。

--------------------

此时再执行构建，我们就可以看到邮件中多出来了一个附件：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 11]  
就是我们刚刚打包的测试报告文件啦！下载到本地，双击其中的index.html文件，就可以看到详细的测试结果报告！  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 12]

结语： 从[Selenium+Java（04）：利用Jenkins实现自动化持续集成][Selenium_Java_Maven_04_Jenkins]至此，我们【Selenium++Maven+Jenkins实现本地项目的自动化构建、测试报告邮件及附件发送】的全套功能便已完整实现了。如有问题可以随时私信我。

最后我们再小讲一下Jenkins的自动定时构建配置：

## 三、在Jenkins中配置定时自动构建 ##

这个功能非常简单，直接在“构建触发器”栏目里填写cron格式的时间即可让其定时构建，或者我们也可以在“构建触发器”模块下进行一些定制化的设置，这个可以自行看一下，很好理解。我就不多写啦。我自己的配置如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 13]

Over

可以看出，Maven版的配置和Java Project版其实区别不大。
    主要就是报告的默认存放位置有所不同，一个是在test-output目录下（Java Project），
    一个是在target\surefire-reports\html目录下（Maven Project）；
    另一点就是执行代码时，Maven版会更便捷，直接短短的一句mvn test即可。

--------------------

软件测试工程师一只，也在不断的学习阶段，平时的小经验不定期分享。
    博主经验有限，若有不足，欢迎交流，共同改进~
    愿与同在CSDN的你共同进步。

[Selenium_Java_Maven_04_Jenkins]: https://blog.csdn.net/qq_36396763/article/details/106399497
[Jenkins]: http://updates.jenkins-ci.org/latest/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/2019070514425665.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/2019070515015612.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20190705160122287.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20200529101715203.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20200529101817555.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20190705160249144.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 6]: https://img-blog.csdnimg.cn/20200529101916132.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 7]: https://img-blog.csdnimg.cn/20190705162530544.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz,size_16,color_FFFFFF,t_70
[Jenkins_03_Jenkins]: https://blog.csdn.net/qq_36396763/article/details/89513957
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 8]: https://img-blog.csdnimg.cn/20190710153442173.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 9]: https://img-blog.csdnimg.cn/2020052910214174.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz,size_16,color_FFFFFF,t_70
[rar_cmd]: https://fireinwind.iteye.com/blog/699182
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 10]: https://img-blog.csdnimg.cn/20190711114810629.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 11]: https://img-blog.csdnimg.cn/20190711115031981.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 12]: https://img-blog.csdnimg.cn/20190711115134134.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz_size_16_color_FFFFFF_t_70 13]: https://img-blog.csdnimg.cn/20200529102759778.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2Mzk2NzYz,size_16,color_FFFFFF,t_70