TestNG+Maven+ExtentReports在Jenkins中的測試報告出坑記(一)：樣式不生效及解決方案

這段時間因爲疫情比較空閒，就順便玩了下Extent報表，結果遇到了四個大坑，先說個人認爲花了最多時間去解決的一個坑：報告沒有樣式效果，非常醜陋。

於是想辦法解決這個問題，在網上搜了下，都是說通過在代碼加上這一句：

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

如果還不行，或者改爲這樣：

htmlReporter.config().setResourceCDN(ResourceCDN.GITHUB);

該行代碼的意思是通過獲取ExtentReports網站或者Github網站上的css樣式文件來顯示出相應的樣式效果。該行代碼位於init方法內，具體添加位置如下圖紅色方框

加上這行代碼後，再去執行，但結果令人失望，還是同樣的結果。

於是想到了是不是Jenkins做了限制，百度一下，果然是這方面的原因：Jenkins的安全策略設置，默認的設置爲：

sandbox; default-src 'none'; img-src 'self'; style-src 'self';

具體規定是：

不允許JavaScript
 
不允許插件(對象/嵌入)
 
沒有內聯CSS或不允許引用自其他網站的CSS起作用
 
不允許顯示來自其他網站的圖片
 
不允許框架
 
不允許web字體
 
不允許XHR/AJAX等

在Jenkins的Jenkins Script Console(腳本命令行)裏設置如下:

System.setProperty("hudson.model.DirectoryBrowserSupport.CSP",  "")

然後點擊運行，然後再來刷新報告，真的可以了，但這種方法在Jenkins重啓後又失效了，我們需要它不能因爲Jenkins重啓而失效。

我們可以通過執行Groovy腳本的方式做到CSS樣式的正確顯示。具體步驟如下：

1.在Jenkins的系統管理-插件管理-可選插件進行查找，安裝Groovy插件(HTML Publisher plugin插件之前就應該已經下載並安裝好了，否則也無法看到醜陋的效果)
Jenkins不支持異類樣式CSS，在這裏Groovy插件是爲了解決HTML Publisher plugin在展示ExtentReports時不能正確顯示的問題。

安裝之後重啓Jenkins，就可以在系統管理-插件管理-已安裝選項查看到了

2.新建一個Maven類型的項目，並進行配置：

源碼管理可根據需要選擇svn或者git，在Build中正確配置好Maven設置

這裏的Root POM中填寫的路徑是相對於${workspace},也可以寫成絕對路徑：${workspace}\httpclient-testng-demo\pom.xml，這裏httpclient-testng-demo是對應的exclipse項目文件夾，需要改爲自己的項目文件夾名稱。

接下來在Post Steps中選擇構建步驟“Execute system Groovy script” ，選擇Groovy command，填入

System.setProperty("hudson.model.DirectoryBrowserSupport.CSP", "")，如下圖所示：

在構建後設置中選擇Publishe HTML reports，在HTML directory to archive中填寫生成的測試報告所在的文件夾，這裏需要填寫的就是在ExtentTestNGReporterListener.java文件中定義的文件夾路徑，Index page[s]填寫的也是ExtentTestNGReporterListener.java文件中定義的文件路徑，Report title中填寫的是報告標題，Include files保持默認即可。

解決問題之後，我又去掉這行代碼：htmlReporter.config().setResourceCDN(ResourceCDN.EXTENTREPORTS);，發現也是不行的，所以總結如下：

1.增加代碼行：htmlReporter.config().setResourceCDN(ResourceCDN.EXTENTREPORTS);

2.正確配置Groovy

最後效果如下：

最後附上ExtentTestNGReporterListener.java文件的源代碼：

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;
 
    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
        //解決cdn.rawgit.com訪問不了的情況
        htmlReporter.config().setResourceCDN(ResourceCDN.EXTENTREPORTS);
        htmlReporter.config().setDocumentTitle("自動化接口測試報告");
        htmlReporter.config().setReportName("自動化接口測試報告");  
        htmlReporter.config().setChartVisibilityOnOpen(true);
        htmlReporter.config().setTestViewChartLocation(ChartLocation.TOP);
        htmlReporter.config().setTheme(Theme.STANDARD);
        htmlReporter.config().setEncoding("UTF-8");
        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>() {
                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);
                }
                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();
    }
}

有不懂的同學，歡迎留言，我看到會及時回覆，覺得不錯的話，就點個贊吧。