本文介绍了如何使用TestNG框架生成测试报告，重点对比了TestNG自带的测试报告和ExtentReports的美观性和功能，包括如何配置POM依赖，创建测试类和自定义测试报告生成器，以及在测试套件中集成监听器。
自动化测试之测试报告
我们常见的TestNG框架的测试报告
- TestNG自带的测试报告
- 界面太丑，不友好
- 界面太丑，不友好
- ReportNg测试报告
- 相对TestNG多了一些颜色，相对更漂亮一些
- 相对TestNG多了一些颜色，相对更漂亮一些
- ExtentReport测试报告(我们使用)
- 功能更强大，页面更漂亮
- 官网地址
- 本款软件为部分功能收费，但是大部分功能是免费提供给开发者的
- 功能更强大，页面更漂亮
ExtentReport配置和使用
-
引入pom包依赖
-
我们此处引入extentreports 3.x的版本，因为4.0的版本去掉了DNS以及部分老版本的功能，重新设计设计了部分新的api，此处我们直接使用3.x的版本即可
<dependency> <groupId>com.aventstack</groupId> <artifactId>extentreports</artifactId> <version>3.1.5</version> </dependency> -
我们创建一个测试类：
TestMethodsDemo.javapackage com.tester.extend.demo; import org.testng.Assert; import org.testng.Reporter; import org.testng.annotations.Test; /** * @version v1.0 * @ProjectName: AutoTest * @ClassName: TestMethodsDemo * @Description: TODO(我们的测试类) * @User: sun * @Author: frosty0804@gmail.com * @Date: 2019/6/3 19:36 */ public class TestMethodsDemo { @Test public void test() { 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("这个是我们自己抛出的异常"); } } -
我们直接把我们想要的公共类直接复制进来：
ExtentTestNGReporterListener.javapackage com.tester.extend.demo; 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 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); // 设置静态文件的DNS // 解决不翻墙不能获取报告的css文件的问题 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<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(); } if(name.length()>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<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(); } }-
在此文件中我们要设置我们的DNS ，负责我们导出的报告中就会有个css样式文件加载失败
htmlReporter.config().setResourceCDN(ResourceCDN.EXTENTREPORTS);
-
-
然后我们编写我们的测试文件的配置文件：
testng.xml<?xml version="1.0" encoding="UTF-8" ?> <suite name="这是我自己的接口测试套件"> <test name="这些事测试模块"> <classes> <class name="com.tester.extend.demo.TestMethodsDemo"> <method> <include name="test1"/> <include name="test2"/> <include name="test3"/> <include name="logDemo"/> </method> </class> </classes> </test> <!-- 监听器 --> <listeners> <!-- <listener class-name="com.vimalselvam.testng.listener.ExtentTestNgFormatter" />--> <!-- <listener class-name="com.tester.extend.demo.ExtentTestNGReporterListenerOld"/>--> <listener class-name="com.tester.extend.demo.ExtentTestNGReporterListener"/> </listeners> </suite> -
此处我们直接运行xml文件，即可在自己项目的根目录找到test-uotput目录，双击打开并运行
index.html文件
254
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
