这段时间因为疫情比较空闲,就顺便玩了下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();
}
}
有不懂的同学,欢迎留言,我看到会及时回复,觉得不错的话,就点个赞吧。