接口自動化測試,生成一份簡潔漂亮的測試報告,不僅可以讓閱讀者心情大好,而且可以提高閱讀效率。
TestNG有自帶的測試報告、網上也有使用ReportNG插件生成testng報告,但是效果差強人意,這裏介紹使用ExtentReport測試報告框架生成漂亮的測試報告。
extentreports官網
入門程序
引入依賴
<!-- pom.xml -->
<dependency>
<groupId>com.relevantcodes</groupId>
<artifactId>extentreports</artifactId>
<version>2.41.1</version>
</dependency>
<dependency>
<groupId>com.vimalselvam</groupId>
<artifactId>testng-extentsreport</artifactId>
<version>1.3.1</version>
</dependency>
<dependency>
<groupId>com.aventstack</groupId>
<artifactId>extentreports</artifactId>
<version>3.0.6</version>
</dependency>
import org.testng.Assert;
import org.testng.Reporter;
import org.testng.annotations.Test;
public class TestMethodsDemo {
@Test
public void test1(){
Assert.assertEquals(1, 2);
}
@Test
public void test2(){
Assert.assertEquals(2,2);
}
@Test
public void test3(){
Assert.assertEquals("bbb", "bbb");
}
@Test
public void logDemo(){
Reporter.log("這是我們自己寫的日誌");
throw new RuntimeException("運行時異常");
}
}
testng.xml
<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd" >
<suite name="我們自己的接口測試套件">
<test name="這些是測試模塊">
<classes>
<class name="com.tester.extend.demo.TestMethodsDemo">
<methods>
<include name="test1"/>
<include name="test2"/>
<include name="test3"/>
<include name="logDemo"/>
</methods>
</class>
</classes>
</test>
<listeners>
<listener class-name="com.vimalselvam.testng.listener.ExtentTestNgFormatter"/>
</listeners>
</suite>
運行testng.xml,生成測試報告
使用瀏覽器查看生成的test-output/emailable-report.html
使用瀏覽器查看生成的test-output/report.html,發現界面奇醜無比,查看html源碼發現,是css樣式無法加載導致的。
解決css無法加載
**方法1:**把css下載到本地,把生成報告對應的靜態資源地址改成本地。
**方法2:**重寫ExtentTestNgFormatter.java文件,在初始化方法中添加,修改cdn爲ResourceCDN.EXTENTREPORTS
htmlReporter.config().setResourceCDN(ResourceCDN.EXTENTREPORTS);
ExtentTestNGIReporterListener.java
詳細代碼如下
package 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 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
//重點:怎麼樣解決cdn.rawgit.com訪問不了的情況
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();
}
}
修改testng.xml中的監聽器爲
<listeners>
<!-- <listener class-name="com.vimalselvam.testng.listener.ExtentTestNgFormatter"/>-->
<listener class-name="com.tester.extend.demo.ExtentTestNGIReporterListener"></listener>
</listeners>
再次運行testng.xml,生成報告後,test-output/index.html,得到正常css樣式的報告。
網上看到些比較詳細的文章,分享給大家
測試報告ExtentReport改進
ExtentReports 測試報告框架簡單總結介紹
ExtentReports 官方說明文檔翻譯