自动化测试-ExtendReport测试报告(一):maven+testng+ExtendReport的简单实现

采用maven+testng+ExtendReport框架。

关于在eclipse中搭建maven环境请自主配置。

1.新建maven项目,引入jar包如下:


    org.testng
    testng
    6.10


    com.aventstack
    extentreports
    3.1.1

2.新建监听器类,继承testNg的IReporter。代码是百度出来的,代码如下:

import com.aventstack.extentreports.ExtentReports;
import com.aventstack.extentreports.ExtentTest;
import com.aventstack.extentreports.ResourceCDN;
import com.aventstack.extentreports.Status;
import com.aventstack.extentreports.model.TestAttribute;
import com.aventstack.extentreports.reporter.ExtentHtmlReporter;
import com.aventstack.extentreports.reporter.configuration.ChartLocation;
import com.aventstack.extentreports.reporter.configuration.Theme;
import org.testng.*;
import org.testng.xml.XmlSuite;

import java.io.File;
import java.util.*;

public class ExtentTestNGIReporterListener1 implements IReporter {
	//生成的路径以及文件名
    private static final String OUTPUT_FOLDER = "test-output/";
    private static final String FILE_NAME = "index1.html";

    private ExtentReports extent;

    @Override
    public void generateReport(List xmlSuites, List suites, String outputDirectory) {
        init();
        boolean createSuiteNode = false;
        if(suites.size()>1){
            createSuiteNode=true;
        }
        for (ISuite suite : suites) {
            Map result = suite.getResults();
          //如果suite里面没有任何用例,直接跳过,不在报告里生成
            if(result.size()==0){
                continue;
            }
          //统计suite下的成功、失败、跳过的总用例数
            int suiteFailSize=0;
            int suitePassSize=0;
            int suiteSkipSize=0;
            ExtentTest suiteTest=null;
            //存在多个suite的情况下,在报告中将同一个一个suite的测试结果归为一类,创建一级节点
            if(createSuiteNode){
                suiteTest = extent.createTest(suite.getName()).assignCategory(suite.getName());
            }
            boolean createSuiteResultNode = false;
            if(result.size()>1){
                createSuiteResultNode=true;
            }
            for (ISuiteResult r : result.values()) {
                ExtentTest resultNode;
                ITestContext context = r.getTestContext();
                if(createSuiteResultNode){
                	//没有创建suite的情况下,将在SuiteResult的创建为一级节点,否则创建为suite的一个子节点。
                    if( null == suiteTest){
                        resultNode = extent.createTest(r.getTestContext().getName());
                    }else{
                        resultNode = suiteTest.createNode(r.getTestContext().getName());
                    }
                }else{
                    resultNode = suiteTest;
                }
                if(resultNode != null){
                    resultNode.getModel().setName(suite.getName()+" : "+r.getTestContext().getName());
                    if(resultNode.getModel().hasCategory()){
                        resultNode.assignCategory(r.getTestContext().getName());
                    }else{
                        resultNode.assignCategory(suite.getName(),r.getTestContext().getName());
                    }
                    resultNode.getModel().setStartTime(r.getTestContext().getStartDate());
                    resultNode.getModel().setEndTime(r.getTestContext().getEndDate());
                  //统计SuiteResult下的数据
                    int passSize = r.getTestContext().getPassedTests().size();
                    int failSize = r.getTestContext().getFailedTests().size();
                    int skipSize = r.getTestContext().getSkippedTests().size();
                    suitePassSize += passSize;
                    suiteFailSize += failSize;
                    suiteSkipSize += skipSize;
                    if(failSize>0){
                        resultNode.getModel().setStatus(Status.FAIL);
                    }
                    resultNode.getModel().setDescription(String.format("Pass: %s ; Fail: %s ; Skip: %s ;",passSize,failSize,skipSize));
                }
                buildTestNodes(resultNode,context.getFailedTests(), Status.FAIL);
                buildTestNodes(resultNode,context.getSkippedTests(), Status.SKIP);
                buildTestNodes(resultNode,context.getPassedTests(), Status.PASS);
            }
            if(suiteTest!= null){
                suiteTest.getModel().setDescription(String.format("Pass: %s ; Fail: %s ; Skip: %s ;",suitePassSize,suiteFailSize,suiteSkipSize));
                if(suiteFailSize>0){
                    suiteTest.getModel().setStatus(Status.FAIL);
                }
            }

        }
//        for (String s : Reporter.getOutput()) {
//            extent.setTestRunnerOutput(s);
//        }

        extent.flush();
    }

    private void init() {
    	  //文件夹不存在的话进行创建
        File reportDir= new File(OUTPUT_FOLDER);
        if(!reportDir.exists()&& !reportDir .isDirectory()){
            reportDir.mkdir();
        }
        ExtentHtmlReporter htmlReporter = new ExtentHtmlReporter(OUTPUT_FOLDER + FILE_NAME);
        
        htmlReporter.config().setResourceCDN(ResourceCDN.EXTENTREPORTS);

        htmlReporter.config().setDocumentTitle("api自动化测试报告");
        htmlReporter.config().setReportName("api自动化测试报告");
        htmlReporter.config().setChartVisibilityOnOpen(true);
        htmlReporter.config().setTestViewChartLocation(ChartLocation.TOP);
        htmlReporter.config().setTheme(Theme.STANDARD);
        htmlReporter.config().setCSS(".node.level-1  ul{ display:none;} .node.level-1.active ul{display:block;}");
        extent = new ExtentReports();
        extent.attachReporter(htmlReporter);
        extent.setReportUsesManualConfiguration(true);
    }

    private void buildTestNodes(ExtentTest extenttest, IResultMap tests, Status status) {
    	//存在父节点时,获取父节点的标签
        String[] categories=new String[0];
        if(extenttest != null ){
            List categoryList = extenttest.getModel().getCategoryContext().getAll();
            categories = new String[categoryList.size()];
            for(int index=0;index 0) {
        	//调整用例排序,按时间排序
            Set treeSet = new TreeSet(new Comparator() {
                @Override
                public int compare(ITestResult o1, ITestResult o2) {
                    return o1.getStartMillis()0){
                    if(name.length()>50){
                        name= name.substring(0,49)+"...";
                    }
                }else{
                    name = result.getMethod().getMethodName();
                }
                if(extenttest==null){
                    test = extent.createTest(name);
                }else{
                	 //作为子节点进行创建时,设置同父节点的标签一致,便于报告检索。
                    test = extenttest.createNode(name).assignCategory(categories);
                }
                //test.getModel().setDescription(description.toString());
                //test = extent.createTest(result.getMethod().getMethodName());
                for (String group : result.getMethod().getGroups())
                    test.assignCategory(group);

                List outputList = Reporter.getOutput(result);
                for(String output:outputList){
                	//将用例的log输出报告中
                    test.debug(output);
                }
                if (result.getThrowable() != null) {
                    test.log(status, result.getThrowable());
                }
                else {
                    test.log(status, "Test " + status.toString().toLowerCase() + "ed");
                }

                test.getModel().setStartTime(getTime(result.getStartMillis()));
                test.getModel().setEndTime(getTime(result.getEndMillis()));
            }
        }
    }

    private Date getTime(long millis) {
        Calendar calendar = Calendar.getInstance();
        calendar.setTimeInMillis(millis);
        return calendar.getTime();
    }
}

3.新建测试类test1和test2,代码如下

import org.testng.Assert;
import org.testng.Reporter;
import org.testng.annotations.Test;

public class Test1 {
	 	@Test
	    public void test1(){
	        Assert.assertEquals(1,2);
	    }

	    @Test
	    public void test2(){
	        Assert.assertEquals(1,1);
	    }

	    @Test
	    public void test3(){
	        Assert.assertEquals("aaa","aaa");
	    }

	    @Test
	    public void logDemo(){
	        Reporter.log("自己定义的异常־");
	        throw new RuntimeException("自己抛出的异常");

	    }

}
import org.testng.Assert;
import org.testng.annotations.Test;

public class Test2 {
	 @Test
	    public void test21(){
	        Assert.assertEquals(1,1);
	    }
}

4.配置testng的xml文件,右击项目名-new-other-xml

为了验证监听器关于多个suite的处理,由于一个xml只能有一个suite标签,所以此处新建了三个testng的配置文件,分别为testNg2.xml、testNg3.xml、testNg_zong.xml,其中testNg2.xml、testNg3.xml是针对测试类test1和test2进行配置,testNg_zong.xml是对多个suite的管理

自动化测试-ExtendReport测试报告(一):maven+testng+ExtendReport的简单实现_第1张图片

5.配置文件代码如下:请注意class name标签的值,是根据自己所建项目的测试类的包名。(具体可参考xml文件配置基础)

testNg2.xml如下:





    
        
            
                
                    
                    
                    
                    

                

            

        

    
    
   
    





testNg3.xml如下:




    
        
            
                
                    
                

            

        

    
    
   
    

testNg_zong.xml如下:






  
        
        

        
        

  
   
    	
      

至此,demo完成,项目结构如下:

自动化测试-ExtendReport测试报告(一):maven+testng+ExtendReport的简单实现_第2张图片

6.运行xml文件,右击testNg_zong.xml,run as-testNG suite。查看运行结果

自动化测试-ExtendReport测试报告(一):maven+testng+ExtendReport的简单实现_第3张图片

 

自动化测试-ExtendReport测试报告(一):maven+testng+ExtendReport的简单实现_第4张图片

7.在本项目的workspace下找到 test-output文件夹,使用浏览器打开index1.xml,查看报告

自动化测试-ExtendReport测试报告(一):maven+testng+ExtendReport的简单实现_第5张图片

 以上为demo全部。以下为此次demo踩到的坑。有的也是匪夷所思。

1.由于百度到的监听器代码使用到了@override注释,在新建监听器类后,代码一直提示xxx方法must Extend a superclss。

百度得到的答案是jdk版本问题,jdk1.5和jdk1.6之后版本对于父类的继承有发生变化(具体原因自行百度)。

解决方法保证编译环境和所引用的jdk统一为最新版本。

右击项目,properties-build path,查看引用的jre版本,如不是最新的,delete原来的jre,点击add library-JRE System Library-next-Finish,然后点击apply,完成后如下:

自动化测试-ExtendReport测试报告(一):maven+testng+ExtendReport的简单实现_第6张图片

在点击 Java Compiler,修改完成后如下:

自动化测试-ExtendReport测试报告(一):maven+testng+ExtendReport的简单实现_第7张图片

 以上步骤完成后,如果仍然有某方法必须继承一个超级父类,则查看eclipse底部视图-makers

自动化测试-ExtendReport测试报告(一):maven+testng+ExtendReport的简单实现_第8张图片

此处会有相应提示,点击自动会自动修改。如果还是不行,就只能....另取它法了。

2.运行结束后,在result of running suites窗口会出现汉字乱码。

解决方法在eclipse安装路径下找到eclipse.ini文件,最后一行添加代码:-Dfile.encoding=UTF-8

 然后关闭eclipse,重新启动,运行项目,查看,文字正常。

但是会导致原来eclipse使用gbk做的汉字注释或其他汉字出现乱码,也没办法。所以最好eclipse安装会就修改默认变化为utf-8。

3.运行代码,打开生成的报告,始终都是testng自带的报告样式。

各种方法查看监听器代码,各种修改。最后修改了监听器代码中创建文件时的文件名,再次打开对应的HTML即可。

自动化测试-ExtendReport测试报告(一):maven+testng+ExtendReport的简单实现_第9张图片

 个人猜测,是因为名称冲突,testng默认为index.html,优先级高,所以先生成了testng的报告。以后还是避免关键字。

 

 

你可能感兴趣的:(自动化)