JAVA生成extentreport测试报告

通过testng.xml生成extentreport测试报告

一、说明：

使用TestNg的Report监听器，不嵌入具体执行代码，仅需在配置文件中新增监听器即可。
报告文件生成路径为test-output/index.html。（可在代码中修改）
一个suite且一个test配置的情况下，会将执行的用例(method)作为一级节点生成报告。
一个suite且多个test配置的情况下，会将每个test配置作为一级节点，执行用例(method)为对应的子节点
多个suite的情况下，将suite作为一级节点，test配置为二级节点，执行用例(method)为对应的三级节点。（如果suite下只有一个test配置，则不会生成二级节点，直接把执行的用例(method)生成在第二节点中）
代码中使用Report.log(“xxx”)会将log展示在报告中对应的执行用例(method)中。
自动将suite以及test配置的名字作为执行用例(method)的标签。
如果用例(method)有参数，则会将调用参数的toString()方法作为用例(method)的名字在报告中显示。
已经对执行用例进行按时间排序。（但是多个suite按时间的排序不知道咋处理，求指教。）
二、pom.xml引入包

<dependency>
   <groupId>com.aventstack</groupId>
   <artifactId>extentreports</artifactId>
  <version>3.0.3</version>
</dependency>

三、新建testng.xml，添加监听器路径，可以根据需要编写测试用例

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd">
 
<!-- 执行测试用例，此文件捕获整个测试XML -->
<suite name="managertest" verbose="1">
	<listeners>
		<!-- class-name的值填写为时间创建的监听器的路径 -->
		<listener class-name="com.qa.report.ExtentTestngReporterListener"></listener>
	</listeners>
	
	<test name="管理端app接口项目测试">
		<classes>
			<class name="manager.loginReport">
				<methods>
					<include name="login"></include>
				</methods>		
			</class>
		</classes>
	</test>
</suite>

四、新建包report，新建ExtentTestngReporterListener类

package com.qa.report;

import java.io.File;
import java.util.Calendar;
import java.util.Comparator;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import org.testng.IReporter;
import org.testng.IResultMap;
import org.testng.ISuite;
import org.testng.ISuiteResult;
import org.testng.ITestContext;
import org.testng.ITestResult;
import org.testng.Reporter;
import org.testng.xml.XmlSuite;
import com.aventstack.extentreports.ExtentTest;
import com.aventstack.extentreports.ExtentReports;
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;

public class ExtentTestngReporterListener implements IReporter{
//生成的路径以及文件名
private static final String OUTPUT_FOLDER = “test-output/”;
private static final String FILE_NAME=“index.html”;
private ExtentReports extent;

   @Override
    public void generateReport(List<XmlSuite>  xmlSuites, List<ISuite> suites, String outputDirectory) {
        init();
        boolean createSuiteNode = false;
        if(suites.size()>1){
            createSuiteNode=true;
        }
        for (ISuite suite : suites) {
            Map<String, ISuiteResult> 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);
	                }
	            }
	 
	        }
	 
	        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().setDocumentTitle("api自动化测试报告");
	        htmlReporter.config().setReportName("api自动化测试报告");
	 
	        htmlReporter.config().setChartVisibilityOnOpen(true);
	        htmlReporter.config().setTestViewChartLocation(ChartLocation.TOP);
	        // htmlReporter.config().setTheme(Theme.STANDARD);
	        htmlReporter.config().setResourceCDN(ResourceCDN.EXTENTREPORTS);
	        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<TestAttribute> categoryList = extenttest.getModel().getCategoryContext().getAll();
	            categories = new String[categoryList.size()];
	            for(int index=0;index<categoryList.size();index++){
	                categories[index] = categoryList.get(index).getName();
	            }
	        }
	 
	        ExtentTest test;
	 
	        if (tests.size() > 0) {
	            //调整用例排序，按时间排序
	            Set<ITestResult> treeSet = new TreeSet<ITestResult>(new Comparator<ITestResult>() {
	                @Override
	                public int compare(ITestResult o1, ITestResult o2) {
	                    return o1.getStartMillis()<o2.getStartMillis()?-1:1;
	                }
	            });
	            treeSet.addAll(tests.getAllResults());
	            for (ITestResult result : treeSet) {
	                Object[] parameters = result.getParameters();
	                String name="";
	                //如果有参数，则使用参数的toString组合代替报告中的name
//	                for(Object param:parameters){
//	                    name+=param.toString();
//	                }
	                //如果有参数只取第一个参数作test-name
	                for(int i=0;i<parameters.length;i++){
	                    name = parameters[0].toString();
	                }
	 
	                if(name.length()>0){
	                    if(name.length()>100){
	                        name= name.substring(0,100)+"...";
	                    }
	                }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<String> 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();
	    }
	
}

五、编写测试类

package manager;
 
import static org.testng.Assert.assertEquals;
 
import java.io.IOException;
import java.util.Map;
 
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.util.EntityUtils;
import org.apache.log4j.Logger;
import org.testng.Reporter;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;
 
import com.qa.base.BaseApi;
import com.qa.parameters.Manager;
import com.qa.restclient.RestClient;
import com.qa.utils.ReadExcel;
import com.qa.utils.fatjson.FastjsonUtils;
 
public class loginReport extends BaseApi{
	private final static Logger log=Logger.getLogger(loginReport.class);
	
	@DataProvider(name="post")
	public Object[][] logData() throws IOException{
		return ReadExcel.readExData(testCaseExcel, 1);
	}
	
	@Test(dataProvider="post")
	public void login(String url,String partnerCode,String account, String loginPwd) throws Exception{
	
		Manager m=new Manager(account,loginPwd,partnerCode);
		Map<String, String> mr=FastjsonUtils.toMap(FastjsonUtils.toJson(m));
		CloseableHttpResponse closeableHttpResponse=RestClient.postForm(hostManager+url, mr, null);
		
		String reString=EntityUtils.toString(closeableHttpResponse.getEntity());
		Reporter.log("响应字符串***********："+reString);
		int statusCode=RestClient.getStatusCode(closeableHttpResponse);
		assertEquals(statusCode, 200);
		Reporter.log("状态码***********："+statusCode,true);	
		Reporter.log("接口地址： "+url);
	}
}

六、查看测试报告