使用Extent report美化單元測試框架TestNG的報告

jUnit是Java領域事實上的單元測試框架標準，但是TestNG也有其特點，所以在單元測試或者自動化測試裡面也佔有一席之地，從google趨勢上看，大體是3:1：

前面的文章我們提到，Allure作為開源的測試報告框架，原生提供了對TestNG的支持；Extent report作為另外一款常用報告框架，也通過適配器（extentreports-testng-adapter）的形式提供了TestNG的支持，注意，沒有jUnit哦：）下面的文章會覆蓋如下幾個點：

• 從github上fork源碼並修改、打包、部署到nexus私服
• extentreports-testng-adapter在TestNG的使用

源碼修改

前面的文章 我們提到，默認的Extent report生成之後使用的css鏈接地址在國內無法訪問，我們需要設定使用github的地址。同樣的，extentreports-testng-adapter需要做同樣的修訂。

• 打開extentreports-testng-adapter的github地址https://github.com/extent-framework/extentreports-testng-adapter並登陸github
• 點擊右上的fork按鈕把項目fork到你的命名空間下。多說幾句，在github工作模式中，提供了fork功能供非項目組成員修改源代碼的方法，然後提pull request即可合併到原項目，從而省去了項目的負責人管理和維護項目成員的麻煩，同時，方便了讓更多的開發者修改貢獻源代碼
• 然後在本地的IDE，比如idea或者eclipse將fork出的項目克隆到本地
• 找到com.aventstack.extentreports.service.ExtentService的第200行，我們增加使用GITHUB的CDN：

html.config().setResourceCDN(ResourceCDN.EXTENTREPORTS);

• 為了和原版本進行區分，修改pom.xml的version為1.0.3.X

<version>1.0.3.X/<version>

• 如果我們打的包還需要給其他人使用，那麼最好將包上傳到私服，參看

<distributionmanagement>
 <repository>
 nexus-releases
 
 http://192.168.10.32:8081/repository/maven-releases/
 
 /<repository>
 <snapshotrepository>
 nexus-snapshots
 
 http://192.168.10.32:8081/repository/maven-snapshots/
 
 /<snapshotrepository>
/<distributionmanagement> 

• 在idea中點擊deploy進行部署到私服：

與TestNG的配合使用

下面我們看看如何與TestNG配合使用。

首先修改pom增加依賴：

<dependency>
 <groupid>com.aventstack/<groupid>
 <artifactid>extentreports-testng-adapter/<artifactid>
 <version>1.0.3.X/<version>
/<dependency>

注意裡面的版本是我們修改後的1.0.3.X。

接著在TestNG的class上或者suite上增加註解Listeners。Extent提供了4個listener：

ExtentITestListenerClassAdapter (ITestListener)
ExtentITestListenerAdapter (ITestListener)
ExtentIReporterSuiteClassListenerAdapter (IReporter)
ExtentIReporterSuiteListenerAdapter (IReporter)

這四種監聽器的區別如下：

監聽器 報告結構 生成策略

ExtentITestListenerClassAdapter Class 每執行完一個Test更新一次報告

Test

ExtentITestListenerAdapter Test 每執行完一個Test更新一次報告

ExtentIReporterSuiteClassListenerAdapter Suite 每執行完一個suite更新一次報告

Class

Test

ExtentIReporterSuiteListenerAdapter Suite 每執行完一個suite更新一次報告

Test

可能大家有些疑惑，沒關係，後面我們來幾個具體的示例。

然後我們在@Test註解裡，給groups屬性按如下格式增加Extent report的屬性：

tagName: 會賦值給category

t:another-tagName, tag:another-tagName: 會賦值給category

a:authorName, author:authorName: 會賦值給作者

d:deviceName, device:deviceName: 會賦值給設備

比如我們的具體示例：

@Test(groups={"interface", "t:sanity", "a:TestExpert", "d:windows"})
public void testGet(){
try {
Unirest.get("http://www.facebook.com").asString().getBody();
} catch (Exception e) {
Assert.fail(e.getMessage(), e);
}
}
@Test(groups={"interface", "a:TestExpert001", "d:windows"})
public void testGet2(){
try {
Unirest.get("http://www.baidu.com").asString().getBody();
} catch (Exception e) {
Assert.fail(e.getMessage(), e);
}
}

並新建一個suite.xml：

<suite>
 <test>
 <classes>
 <class>
 /<classes>
 /<test>
/<suite>

運行之前，我們需要在classpath裡面創建extent.properties文件，用於指定生成的報告類型和位置：

extent.reporter.html.start=true
extent.reporter.html.out=test-output/HtmlReport/ExtentHtml.html

其他配置信息可以參考http://extentreports.com/docs/versions/4/java/extentservice.html

下面我們執行此TestNG的用例，完成之後即可在test-output/HtmlReport裡面看到生成的報告：

同時我們在左面看到根據類別、作者、缺陷進行的分類顯示：

很便捷，有麼有。

下面我們把listener更改為ExtentITestListenerAdapter，注意看，默認的層級為@Test而不是class了：

再更改為ExtentIReporterSuiteClassListenerAdapter，可以看到按suite - class - test級別進行展示：

最後更改為ExtentIReporterSuiteListenerAdapter，可以看到按suite - test級別進行展示：

總結

extentreports-testng-adapter是Extent為TestNG提供的原生支持，能夠非常方便、快捷的生成一個基於TestNG的測試報告，非常好用。作為自動化測試的編寫人員和測試框架的開發者，最好掌握。