ExtentReports测试报告框架学习笔记(一）
2020-09-03 本文已影响0人
明小五
参考文档：https://testerhome.com/topics/9994 -----被翻译的官方文档
https://blog.csdn.net/fanjint/article/details/82627734
一、先上图，生成的报告如下图：
image.png
二、总结：
1、 生成的报告简洁美观，html方便jenkins集成发邮件。
2、只支持java和.net，比allure report要少很多，可定制性和内容展示比allure report少。
3、使用TestNg的Report监听器，不嵌入具体执行代码，仅需在配置文件中新增监听器即可。
4、报告文件生成路径为test-output/index.html。（可在代码中修改）
5、一个suite且一个test配置的情况下，会将执行的用例(method)作为一级节点生成报告。一个suite且多个test配置的情况下，会将每个test配置作为一级节点，执行用例(method)为对应的子节点。
6、多个suite的情况下，将suite作为一级节点，test配置为二级节点，执行用例(method)为对应的三级节点。（如果suite下只有一个test配置，则不会生成二级节点，直接把执行的用例(method)生成在第二节点中）。
7、代码中使用Report.log("xxx")会将log展示在报告中对应的执行用例(method)中。
8、自动将suite以及test配置的名字作为执行用例(method)的标签。如果用例(method)有参数，则会将调用参数的toString()方法作为用例(method)的名字在报告中显示。
三、基本使用
1、初始化
// 初始化HtmlReporter
ExtentHtmlReporter htmlReporter = new ExtentHtmlReporter("extent.html");
// 创建ExtentReports对象
ExtentReports extent = new ExtentReports();
//为了成功生成测试信息，需要启动并建立 Reporter (测试报告相关信息）和 ExtentReports 的关联。如果启动Reporter失败或未关联至ExtentReports类，在创建测试用例或将测试执行结果上传时，将提示 IllegalStateException 错误。
// 将HtmlReporter关联ExtentReports对象
extent.attachReporter(htmlReporter);
// 将所有Reporter都关联ExtentReports对象
extent.attachReporter(htmlReporter, extentxReporter, emailReporter, logger);
//创建test
ExtentTest test = extent.createTest("MyTest");
2、追加测试结果
htmlReporter.setAppendExisting(true);
3、创建事件记录
//事件记录
test.log(Status.INFO,"log is INFO"); //按info、skip、error、debug等级别选择记录
test.info("This step shows usage of info(details)"); //
//成功，显示pass
test.pass("pass");
//失败，在测试案例和日志中关联截屏
test.fail("details", MediaEntityBuilder.createScreenCaptureFromPath("screenshot.png").build());
test.addScreenCaptureFromPath("screenshot.png");
4、配置报告
// 打开报表时使图表可见
htmlReporter.config().setChartVisibilityOnOpen(true);
// 设置静态文件的DNS，解决cdn.rawgit.com访问不了的情况，可以设置为：ResourceCDN.EXTENTREPORTS 或ResourceCDN.GITHUB
htmlReporter.config().setResourceCDN(ResourceCDN.EXTENTREPORTS);
// 自动屏幕截图管理（仅限专业版）
htmlReporter.config().setAutoCreateRelativePathMedia(true);
// 设置report title
htmlReporter.config().setDocumentTitle("aventstack - ExtentReports");
// 设置编码格式为 UTF-8
htmlReporter.config().setEncoding("UTF-8");
// 协议 (http, https)
htmlReporter.config().setProtocol(Protocol.HTTPS);
// 报表或内部版本名称
htmlReporter.config().setReportName("Build-1224");
// 图表位置-顶部、底部
htmlReporter.config().setTestViewChartLocation(ChartLocation.BOTTOM);
// 主题-标准，深色
htmlReporter.config().setTheme(Theme.STANDARD);
// 设置时间戳格式
htmlReporter.config().setTimeStampFormat("mm/dd/yyyy hh:mm:ss a");
// 添加自定义css
htmlreporter.config().setCSS("css-string");
// 添加自定义javascript
htmlreporter.config().setJS("js-string");
tips：
官方提供了3种和testng集成示例 ：
1.直接在@BeforeSuite和@BeforeClass进行初始化
2.自己实现testng的ITestListener接口
3.自己实现testng的IReporter接口。
具体用那一种可以自行选择，我这边用的是第3种。
四、代码
pom.xml：
<dependency>
<groupId>com.aventstack</groupId>
<artifactId>extentreports</artifactId>
<version>3.0.6</version>
</dependency>
创建TestNg的Report监听器:
package util;
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 ExtentTestNGIReporterListener 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);
}
}
}
// 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);
// 设置静态文件的DNS
htmlReporter.config().setResourceCDN(ResourceCDN.EXTENTREPORTS);
htmlReporter.config().setDocumentTitle("自动化测试报告");
htmlReporter.config().setReportName("DmallMax的自动化测试报告");
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();
}
}
testdemo：
package test;
import org.testng.Assert;
import org.testng.Reporter;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Optional;
import org.testng.annotations.Parameters;
import org.testng.annotations.Test;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
public class TestngDemo {
@Test(expectedExceptions = ArithmeticException.class, expectedExceptionsMessageRegExp = ".*zero")
public void Test1() {
System.out.println("这是1 Test1!");
int c = 1 / 0;
Assert.assertEquals("1", "1");
}
@Test
@Parameters(value = "param2")
public void Test2(@Optional("Tom")String str) {
System.out.println("这是 Test2! "+ str);
Assert.assertEquals("1", "2");
}
@Test
public void Test3(){
System.out.println("这是 Test3!");
}
@Test
public void Test4(){
Reporter.log("测试测试log打印，这是我们自己写的日志");
throw new RuntimeException("这是我自己的运行时异常");
}
@DataProvider(name = "createData")
public Iterator<Object[]> createData(){
List<Object[]> dataProvider = new ArrayList<Object[]>();
for (int i=0;i<2;i++){
String[] s = {String.format("我是第（%s）个参数",i)};
dataProvider.add(s);
}
return dataProvider.iterator();
}
@Test(dataProvider = "createData")
public void dataProviderTest(String s){
//输出log会在报告中提现
Reporter.log("获取到参数："+s,true);
Assert.assertTrue(s.length()>2," 成功？失败？");
}
}
testng.xml设置:
image.png
testng1.xml:
<?xml version="1.0" encoding="UTF-8" ?>
<suite name="suite1下有多个test">
<test name="TestUtil中的Test1和Test2">
<classes>
<class name="test.TestngDemo"/>
<methods>
<include name="Test1"/>
<include name="Test2"/>
</methods>
</classes>
</test>
<test name="TestUtil中的Test3">
<classes>
<class name="test.TestngDemo"/>
<methods>
<include name="Test3"/>
</methods>
</classes>
</test>
<listeners>
<listener class-name="util.ExtentTestNGIReporterListener"/>
</listeners>
</suite>
testng2.xml:
<?xml version="1.0" encoding="UTF-8" ?>
<suite name="这是Suite2的测试套件">
<test name="这些是测试模块">
<classes>
<class name="test.TestngDemo"/>
<methods>
<include name="dataProviderTest"/>
<include name="Test4"/>
</methods>
</classes>
</test>
<listeners>
<listener class-name="util.ExtentTestNGIReporterListener"/>
</listeners>
</suite>
All_testng_Suite.xml:
<?xml version="1.0" encoding="UTF-8" ?>
<suite name="总的接口测试套件">
<suite-files>
<suite-file path="testng1.xml"/>
<suite-file path="testng2.xml"/>
</suite-files>
<listeners>
<listener class-name="util.ExtentTestNGIReporterListener"/>
</listeners>
</suite>
执行All_testng_Suite.xml，生成的报告为第一张图的样式。
