美文网首页Java接口学习之旅
ExtentReport基本配置——挖坑、填坑

ExtentReport基本配置——挖坑、填坑

作者: 飞翼_U | 来源:发表于2018-07-27 17:52 被阅读1419次

    这个地方太坑了,一个问题排查了好久,真是耽误我的美好时间啊。。。

    使用这个是因为它漂亮。

    1.首先。编写java源代码如下:

    package com.tester.extend.demo;
    
    
    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(1,1);
        }
    
        @Test
        public  void test3(){
            Assert.assertEquals("aaa","aaa");
        }
    
        @Test
        public void logDemo(){
            Reporter.log("这是我自己写的日志");
            throw new RuntimeException("这是我自己运行时候的异常");
        }
    }
    
    

    源码里面设置了断言和一些日志。

    2.接下来,是在pom文件里面引入生成报告所需要的依赖。
    因为我的Meaven没有提前下载好这些包,所以我在写的时候并没有像老师演示的那么顺利。

    <dependencies>
    
            <dependency>
                <groupId>com.releavantcodes</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>
            <dependency>
                <groupId>org.testng</groupId>
                <artifactId>testng</artifactId>
                <version>6.10</version>
            </dependency>
    
        </dependencies>
    

    因为是手写的,不是自动补齐的,导致这里埋下了一个坑。

    3.接下来,是编写配置文件 testng.xml。

    <?xml version="1.0" encoding="UTF-8" ?>
    <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>
    
            </classes>
    
        </test>
    
        <listeners>
            <listener class-name="com.vimalselvam.testng.listener.ExtentTestNgFormatter"/>
        </listeners>
    
    
    </suite>
    
    

    其中的以下部分是用来监听生成测试报告的。

       <listeners>
            <listener class-name="com.vimalselvam.testng.listener.ExtentTestNgFormatter"/>
        </listeners>
    

    但是,当我写的时候发现也不会自动补齐,写完后还是红色的,报了cannot resolve class or package vimaslevam 然后我去看项目引用的jar包,发现是红色的波浪线,其实就是包没有引用进来。


    上面是填坑分割线。
    想法一:估计是IEDA自带的编辑器下载的Meaven没有下载到我所需要的包,要不我自己下载一个替换掉自带的吧。
    于是,我到官网下载了一个 apache-maven-3.5.4 替换了原有的Meaven。

    然后把项目里面的有波浪线的jar包删了,使用 如下按钮重新加载: image.png

    加载了半天还是和原来一样,于是我去本地保存jar报的地方去看了一下,下载的jar包后缀都是 .update.我百度了一下说是jar包下载失败才会这样。

    想法二:我又想为啥下载失败了呢,我去Meaven官网手动下载了对应的jar包放到原本的位置了,但是还是没啥鸟用。

    于是乎,我去检查我写的pom文件里面的 dependency 发现我有的单词拼错了,真是要哭了,拼错了代表路径不对肯定是下载不到啊。于是改了正确的拼写,把本地的包也改了正确的拼写就对了。就看到 红色变绿色了。高兴。。

    然后,运行 testng.xml这个配置,又报错: image.png

    哎,继续填。

    百度说缺少 guava 的包,于是去Meaven目录下,发现是有这个jar的,只是没有引用到项目里面来,引用进来再运行就ok了。 image.png 已经生成测试报告 image.png 报告加载还有点问题,点击右键查看源码,可以看到样式加载不到: image.png

    老师在 com.tester.extend.demo 的包下面 写了1个监听类,代码如下,说是不用记,一辈子就用到1次。。。如下:

    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里面配置监听器的位置,把原来的注释掉。
    <listener class-name="com.tester.extend.demo.ExtentTestNGIReporterListener"/>

    再次运行,报告即可访问。 image.png

    <完!>

    相关文章

      网友评论

        本文标题:ExtentReport基本配置——挖坑、填坑

        本文链接:https://www.haomeiwen.com/subject/zvnfmftx.html