Jenkins+Reportng 测试报告显示失败用例截图

ゝ一世哀愁。 2022-06-07 08:21 237阅读 0赞

前言：由于reportng生成的测试报告里没有失败的用例截图，现在想自己修改reportng，加上截图等功能。这里详细的总结一遍实现过程  
主要参考博客：  
[https://testerhome.com/topics/3594][https_testerhome.com_topics_3594]  
[http://tech.it168.com/a2013/0906/1530/000001530755\_all.shtml][http_tech.it168.com_a2013_0906_1530_000001530755_all.shtml]  
\#一、IDEA导入reportng源码  
1、下载reportng源码，地址：[https://github.com/dwdyer/reportng][https_github.com_dwdyer_reportng]  
![这里写图片描述][SouthEast]

2、将源码zip包解压

3、在IDEA里点击file-new-Project from Existing Sources…  
![这里写图片描述][SouthEast 1]

4、选择解压后的文件，然后一直下一步打开，打开后目录如下：  
![这里写图片描述][SouthEast 2]

\#二、修改代码  
1、reportng.properties 增加报表Log Info和Screen Shot列（列名最好用英文，用中文会乱码，我还未解决）  
在该文件最后加如下代码

log=Log Info
    screenshot=Screen Shot

2、results.html.vm 修改结果的html，如下图：  
![这里写图片描述][SouthEast 3]

代码如下：

#if ($failedTests.size() > 0)
      <table class="resultsTable">
        <tr><th colspan="6" class="header failed">$messages.getString("failedTests")</th></tr>
      #foreach ($testClass in $failedTests.keySet())
          <tr>
              <td colspan="1" class="group">$testClass.name</td>
              <td colspan="1" class="group">$messages.getString("duration")</td>
              <td colspan="1" class="group">$messages.getString("log")</td>
              <td colspan="1" class="group">$messages.getString("screenshot")</td>
          </tr>
        #set ($classResults = $failedTests.get($testClass))
        #parse ("org/uncommons/reportng/templates/html/class-results.html.vm")
      #end
      </table>
    #end

3、class-results.html.vm 修改具体的内容显示  
a、修改代码，在\#\#Show logger output for the test里加一句，去除带有img标签的字符串：

$utils.removeImage($line)<br />

如下图：  
![这里写图片描述][SouthEast 4]

b、最后加这段代码，提取含有img标签的字符串：

<td class="screenshot">
          #set ($output = $utils.getTestOutput($testResult))
          #if ($output.size() > 0)
              <div class="screenshotimage">
                #foreach( $line in $output )
                  #if ($meta.shouldEscapeOutput())
                    $utils.escapeHTMLString($line)<br />
                  #else
                    $utils.getImageString($line)<br />
                  #end
                #end
              </div>
          #end
        </td>

4、ReportNGUtils.java 新增两个方法：

public String getImageString(String s)
        {
            String regex = "(<img(.*?)/>)";
            Pattern pattern = Pattern.compile(regex);
            Matcher matcher = pattern.matcher(s);
            while (matcher.find()) {
                String group = matcher.group(1);
                return group;
            }
            return "";
        }
    
    
        public String removeImage(String s)
        {
            return  s.replaceAll("<img(.*?)/>","");
        }

5、TestResultComparator.java 默认的ReportNG的报告中，是以字母序对执行的方法进行排序的，修改方法以执行先后顺序来进行排序

public int compare(ITestResult result1, ITestResult result2)
        {
            int longresult2 = 0;
            if (result1.getStartMillis() < result2.getStartMillis()) {
                longresult2 = -1;
            } else {
                longresult2 = 1;
            }
    
            return longresult2;
        }

\#三、重新打jar包  
1、点击File-Project Structure…打开Project Structure弹窗

2、选中Artifacts，点击“+”，选择JAR-From modules with dependencies…  
![这里写图片描述][SouthEast 5]

3、在打开的Create JAR from Modules弹窗，点击"ok"  
![这里写图片描述][SouthEast 6]

4、在Output directory设置jar包导出目录，如图：  
![这里写图片描述][SouthEast 7]

5、点击“Output Layout”处的“+”选择“Directory Content”  
![这里写图片描述][SouthEast 8]

6、选择“resources”文件，这样才能把resources文件也打进jar包  
![这里写图片描述][SouthEast 9]

7、最后，点击Build-Build Artifacts, 然后双击reportng.jar,如下图：  
![这里写图片描述][SouthEast 10]

8、此时jar包已打好，如下图：  
![这里写图片描述][SouthEast 11]

9、reportng.jar包下载：[https://download.csdn.net/download/galen2016/10828038][https_download.csdn.net_download_galen2016_10828038]

\#四、使用最新的jar包  
1、把生成的jar包替换掉本地maven仓库下的reportng.jar,一般是这个目录：

.m2\repository\org\uncommons\reportng\1.1.4

2、我重写了TestngListener的onTestFialure方法，添加显示截图的功能。使用了reportng的Reporter.log()方法输出失败用例截图地址，当用例失败时就显示截图。  
代码如下：

public class TestngListener extends TestListenerAdapter  {
    	
    	public static WebDriver driver;
    	
    	public void onTestFailure(ITestResult tr) {
    		
    		super.onTestFailure(tr);
    		try {
    			takeScreenShot(tr);
    			showScreenShot(tr);
    		} catch (IOException e) {
    			// TODO 自动生成的 catch 块
    			e.printStackTrace();
    		}
    	}
    	
    	/**
    	 * Jenkings显示失败截图
    	 * @param result
    	 */
    	public void showScreenShot(ITestResult result) {
    			//jenkins工作目录对应项目的截图路径
    	        String filePath = "http://192.168.22.35:8080/jenkins/job/ZXKJAutoTest/ws/FailureScreenShot"; 
    	        Reporter.log("<img src='"+filePath+"/"+result.getName()+".png' hight='300' width='500'/>");
    	}
    	
    	/**
    	 * 获取用例失败截图
    	 * @param tr
    	 * @throws IOException
    	 */
    	public void takeScreenShot(ITestResult tr) throws IOException{
    		SimpleDateFormat smf = new SimpleDateFormat("MMddHHmmss") ;
    		String curTime = smf.format(new java.util.Date());
    //		String fileName = tr.getName()+"_"+curTime+".png";
    		String fileName = tr.getName()+".png";
    		File srcFile = ((TakesScreenshot)driver).getScreenshotAs(OutputType.FILE);
    		FileUtils.copyFile(srcFile, new File("FailureScreenShot/"+fileName));
    	}

3、在testng.xml里添加：

4、在pom.xml里的maven-surefire-plugin添加配置，如下图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dhbGVuMjAxNg_size_16_color_FFFFFF_t_70]  
代码：

<systemPropertyVariables>
              <org.uncommons.reportng.escape-output>false</org.uncommons.reportng.escape-output>
     </systemPropertyVariables>

5、测试用例类加上Listeners注解，并把driver赋值给TestngListener，如下图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dhbGVuMjAxNg_size_16_color_FFFFFF_t_70 1]  
6、最后在Jenkins构建后生成的报告如下：  
![这里写图片描述][SouthEast 12]

[https_testerhome.com_topics_3594]: https://testerhome.com/topics/3594
[http_tech.it168.com_a2013_0906_1530_000001530755_all.shtml]: http://tech.it168.com/a2013/0906/1530/000001530755_all.shtml
[https_github.com_dwdyer_reportng]: https://github.com/dwdyer/reportng
[SouthEast]: /images/20220607/9c7cb8caa4574a2eba567d3d16cf7d8c.png
[SouthEast 1]: /images/20220607/136b9f92184c4646b4d4ef876ab7c7e2.png
[SouthEast 2]: /images/20220607/872acbb188bc4dc18435f284e6ab509d.png
[SouthEast 3]: /images/20220607/f7356d89a0c04e38903228e28203b031.png
[SouthEast 4]: /images/20220607/4deb2f563e8848508b1ce0dbbf6cb4e3.png
[SouthEast 5]: /images/20220607/0d75f751737e44748df770d04a132b7b.png
[SouthEast 6]: /images/20220607/e9b8eda714864b24a66ba49c1a11deff.png
[SouthEast 7]: /images/20220607/c9d241bad4834ce8a785bce814aceb90.png
[SouthEast 8]: /images/20220607/524ead8148f244f5ab8449c0022ab9d8.png
[SouthEast 9]: /images/20220607/2636f501647f4184a4a85b66b43c8567.png
[SouthEast 10]: /images/20220607/01e2fb65991f44d4ad82c082aaf1400f.png
[SouthEast 11]: /images/20220607/eff4d1d73b5d45928ad87b5f2611f240.png
[https_download.csdn.net_download_galen2016_10828038]: https://download.csdn.net/download/galen2016/10828038
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dhbGVuMjAxNg_size_16_color_FFFFFF_t_70]: /images/20220607/7ee5ba64a97f48959135f5debfdc09f8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2dhbGVuMjAxNg_size_16_color_FFFFFF_t_70 1]: /images/20220607/723927b5825a4433af56d3ee1d357c4d.png
[SouthEast 12]: /images/20220607/39f3ff3b83e64de69e98de9ded78b8f3.png