ExtentReport测试报告内添加错误截图

最新推荐文章于 2024-08-13 10:17:47 发布
最新推荐文章于 2024-08-13 10:17:47 发布
阅读量1.1k 收藏 7
点赞数 1
分类专栏： java Selenium
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_45731111/article/details/106730481
版权

文章目录

一、简述

使用java（selenium）做自动化测试，使用testNg框架进行管理。但是生成的测试报告不够美观。网上都用ExtentTestNGIReport代替testNg中的报告。因为是UI自动化，所以需要进行截图了。这里完成了截图放进测试报告中，方便查看。效果图如下，点击图片可进行放大。
在这里插入图片描述

二、实现过程

1.ExtentTestNGIReport配置jar包（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>

2.截图方法

（1）截图方法使用的是TestListenerAdapter中的用例失败截图方式，需要改写下。代码如下：

package com.Extent;

import com.aventstack.extentreports.ExtentReporter;
import org.openqa.selenium.Capabilities;
import org.openqa.selenium.OutputType;
import org.openqa.selenium.TakesScreenshot;
import org.openqa.selenium.WebDriver;
import org.testng.ITestResult;
import org.testng.TestListenerAdapter;
import org.apache.commons.io.FileUtils;
import java.io.File;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;

public class TestngListener extends TestListenerAdapter {

    public static WebDriver driver;

    @Override
    public  void onTestFailure(ITestResult tr) {
        super.onTestFailure(tr);
        //用例失败后进行截图
        try {
            takeScreenShot(tr);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }


    public  String takeScreenShot(ITestResult tr) throws IOException{
        SimpleDateFormat smf = new SimpleDateFormat("MMddHHmmss") ;
        String curTime = smf.format(new java.util.Date());
        String fileName = tr.getName()+"_"+curTime+".png";
        File srcFile = ((TakesScreenshot)driver).getScreenshotAs(OutputType.FILE);
        //把截图拷贝到自定义的目录
        String currentPath = System.getProperty("user.dir");
        String imgfile = currentPath+"\\test-output\\"+fileName;
        FileUtils.copyFile(srcFile, new File(imgfile));
        return  "..\\test-output\\"+fileName;
        /**
		 * 注意截图存放路径先不要随意修改，否则会影响报告中图片的显示。
		 * 当然如果你会调试，可以自定义设置。
		 */

    }

}

（2）重要：driver

测试用例中的driver传入的截图方法中。dr是你自己的driver驱动，此处一定要填写。在这里插入图片描述

（3）xml配置文件中添加监听该类，运行xml文件后，可以看到用例失败的截图生成在test-output文件夹下，成功后再进行下一步。


<listeners>

<listener class-name="com.Extent.TestngListener"/>

</listeners>

在这里插入图片描述

3.在测试报告中引入图片文件

重写ExtentTestNgFormatter类，在这个类中可以放图片的文件路径，进行在测试报告中展示。思路就是图片的路径放进这个类的方法中。修改的地方如图所示
在这里插入图片描述
代码如下：

package com.Extent;
import com.aventstack.extentreports.ExtentReports;
import com.aventstack.extentreports.ExtentTest;
import com.aventstack.extentreports.ResourceCDN;
import com.aventstack.extentreports.reporter.ExtentHtmlReporter;
import com.google.common.base.Preconditions;
import com.google.common.base.Strings;
import com.vimalselvam.testng.EmailReporter;
import com.vimalselvam.testng.NodeName;
import com.vimalselvam.testng.SystemInfo;
import com.vimalselvam.testng.listener.ExtentTestNgFormatter;
import org.testng.*;
import org.testng.xml.XmlSuite;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class MyExtentTestNgFormatter extends ExtentTestNgFormatter {
    private static final String REPORTER_ATTR = "extentTestNgReporter";
    private static final String SUITE_ATTR = "extentTestNgSuite";
    private ExtentReports reporter;
    private List<String> testRunnerOutput;
    private Map<String, String> systemInfo;
    private ExtentHtmlReporter htmlReporter;

    private static ExtentTestNgFormatter instance;

    public MyExtentTestNgFormatter() {
        setInstance(this);
        testRunnerOutput = new ArrayList<>();
        // reportPath 报告路径
        String reportPathStr = System.getProperty("reportPath");
        File reportPath;

        try {
            reportPath = new File(reportPathStr);
        } catch (NullPointerException e) {
            reportPath = new File(TestNG.DEFAULT_OUTPUTDIR);
        }

        if (!reportPath.exists()) {
            if (!reportPath.mkdirs()) {
                throw new RuntimeException("Failed to create output run directory");
            }
        }
        //  报告名report.html
        File reportFile = new File(reportPath, "report.html");
        // 邮件报告名emailable-report.html
        File emailReportFile = new File(reportPath, "emailable-report.html");

        htmlReporter = new ExtentHtmlReporter(reportFile);
        EmailReporter emailReporter = new EmailReporter(emailReportFile);
        reporter = new ExtentReports();
        htmlReporter.config().setResourceCDN(ResourceCDN.EXTENTREPORTS);
        htmlReporter.config().setDocumentTitle("UI自动化测试报告");
        htmlReporter.config().setReportName("UI自动化测试报告");
        reporter.attachReporter(htmlReporter, emailReporter);
    }


    public static ExtentTestNgFormatter getInstance() {
        return instance;
    }

    private static void setInstance(ExtentTestNgFormatter formatter) {
        instance = formatter;
    }

    public Map<String, String> getSystemInfo() {

        return systemInfo;
    }


    public void setSystemInfo(Map<String, String> systemInfo) {
        this.systemInfo = systemInfo;
    }

    public void onStart(ISuite iSuite) {
        if (iSuite.getXmlSuite().getTests().size() > 0) {
            ExtentTest suite = reporter.createTest(iSuite.getName());
            String configFile = iSuite.getParameter("report.config");

            if (!Strings.isNullOrEmpty(configFile)) {
                htmlReporter.loadXMLConfig(configFile);
            }

            String systemInfoCustomImplName = iSuite.getParameter("system.info");
            if (!Strings.isNullOrEmpty(systemInfoCustomImplName)) {
                generateSystemInfo(systemInfoCustomImplName);
            }

            iSuite.setAttribute(REPORTER_ATTR, reporter);
            iSuite.setAttribute(SUITE_ATTR, suite);
        }
    }

    private void generateSystemInfo(String systemInfoCustomImplName) {
        try {
            Class<?> systemInfoCustomImplClazz = Class.forName(systemInfoCustomImplName);
            if (!SystemInfo.class.isAssignableFrom(systemInfoCustomImplClazz)) {
                throw new IllegalArgumentException("The given system.info class name <" + systemInfoCustomImplName +
                        "> should implement the interface <" + SystemInfo.class.getName() + ">");
            }

            SystemInfo t = (SystemInfo) systemInfoCustomImplClazz.newInstance();
            setSystemInfo(t.getSystemInfo());
        } catch (ClassNotFoundException | InstantiationException | IllegalAccessException e) {
            throw new IllegalStateException(e);
        }
    }

    public void onFinish(ISuite iSuite) {
    }


    public void onTestStart(ITestResult iTestResult) {
    }

    public void onTestSuccess(ITestResult iTestResult) {

    }

    public void onTestFailure(ITestResult iTestResult) {

    }

    public void onTestSkipped(ITestResult iTestResult) {

    }

    public void onTestFailedButWithinSuccessPercentage(ITestResult iTestResult) {

    }

    public void onStart(ITestContext iTestContext) {
        ISuite iSuite = iTestContext.getSuite();
        ExtentTest suite = (ExtentTest) iSuite.getAttribute(SUITE_ATTR);
        ExtentTest testContext = suite.createNode(iTestContext.getName());
        iTestContext.setAttribute("testContext", testContext);
    }

    public void onFinish(ITestContext iTestContext) {
        ExtentTest testContext = (ExtentTest) iTestContext.getAttribute("testContext");
        if (iTestContext.getFailedTests().size() > 0) {
            testContext.fail("Failed");
        } else if (iTestContext.getSkippedTests().size() > 0) {
            testContext.skip("Skipped");
        } else {
            testContext.pass("Passed");
        }
    }

    public void beforeInvocation(IInvokedMethod iInvokedMethod, ITestResult iTestResult) {
        if (iInvokedMethod.isTestMethod()) {
            ITestContext iTestContext = iTestResult.getTestContext();
            ExtentTest testContext = (ExtentTest) iTestContext.getAttribute("testContext");
            ExtentTest test = testContext.createNode(iTestResult.getName(), iInvokedMethod.getTestMethod().getDescription());
            iTestResult.setAttribute("test", test);
        }
    }

    public void afterInvocation(IInvokedMethod iInvokedMethod, ITestResult iTestResult) {
        if (iInvokedMethod.isTestMethod()) {
            ExtentTest test = (ExtentTest) iTestResult.getAttribute("test");
            List<String> logs = Reporter.getOutput(iTestResult);
            for (String log : logs) {
                test.info(log);
            }

            int status = iTestResult.getStatus();
            if (ITestResult.SUCCESS == status) {
                test.pass("Passed");
            } else if (ITestResult.FAILURE == status) {
                test.fail(iTestResult.getThrowable());
                ITestResult tr = Reporter.getCurrentTestResult();
                //测试用例错误的时候，截图，把截图放进报告里面。
                try {
                    TestngListener testngListener = new TestngListener();
//                    testngListener.onTestFailure(tr);
                    test.addScreenCaptureFromPath(testngListener.takeScreenShot(tr));
                }catch (IOException e){
                    e.printStackTrace();
                }

            } else {
                test.skip("Skipped");
            }

            for (String group : iInvokedMethod.getTestMethod().getGroups()) {
                test.assignCategory(group);
            }
        }
    }

    public void addScreenCaptureFromPath(ITestResult iTestResult, String filePath) throws IOException {
        ExtentTest test = (ExtentTest) iTestResult.getAttribute("test");
        test.addScreenCaptureFromPath(filePath);
    }


    public void addScreenCaptureFromPath(String filePath) throws IOException {
        ITestResult iTestResult = Reporter.getCurrentTestResult();
        Preconditions.checkState(iTestResult != null);
        ExtentTest test = (ExtentTest) iTestResult.getAttribute("test");
        test.addScreenCaptureFromPath(filePath);
    }

    public void setTestRunnerOutput(String message) {
        testRunnerOutput.add(message);
    }

    public void generateReport(List<XmlSuite> list, List<ISuite> list1, String s) {
        if (getSystemInfo() != null) {
            for (Map.Entry<String, String> entry : getSystemInfo().entrySet()) {
                reporter.setSystemInfo(entry.getKey(), entry.getValue());
            }
        }
        reporter.setTestRunnerOutput(testRunnerOutput);
        reporter.flush();
    }


    public void addNewNodeToTest() {
        addNewNodeToTest(NodeName.getNodeName());
    }


    public void addNewNodeToTest(String nodeName) {
        addNewNode("test", nodeName);
    }

    public void addNewNodeToSuite() {
        addNewNodeToSuite(NodeName.getNodeName());
    }


    public void addNewNodeToSuite(String nodeName) {
        addNewNode(SUITE_ATTR, nodeName);
    }

    private void addNewNode(String parent, String nodeName) {
        ITestResult result = Reporter.getCurrentTestResult();
        Preconditions.checkState(result != null);
        ExtentTest parentNode = (ExtentTest) result.getAttribute(parent);
        ExtentTest childNode = parentNode.createNode(nodeName);
        result.setAttribute(nodeName, childNode);
    }


    public void addInfoLogToNode(String logMessage) {
        addInfoLogToNode(logMessage, NodeName.getNodeName());
    }

    public void addInfoLogToNode(String logMessage, String nodeName) {
        ITestResult result = Reporter.getCurrentTestResult();
        Preconditions.checkState(result != null);
        ExtentTest test = (ExtentTest) result.getAttribute(nodeName);
        test.info(logMessage);
    }


    public void failTheNode(Throwable t) {
        failTheNode(NodeName.getNodeName(), t);
    }


    public void failTheNode(String nodeName, Throwable t) {
        ITestResult result = Reporter.getCurrentTestResult();
        Preconditions.checkState(result != null);
        ExtentTest test = (ExtentTest) result.getAttribute(nodeName);
        test.fail(t);
    }


    public void failTheNode(String logMessage) {
        failTheNode(NodeName.getNodeName(), logMessage);
    }

    public void failTheNode(String nodeName, String logMessage) {
        ITestResult result = Reporter.getCurrentTestResult();
        Preconditions.checkState(result != null);
        ExtentTest test = (ExtentTest) result.getAttribute(nodeName);
        test.fail(logMessage);
    }
}

4.xml配置文件中添加监听该类

监听新写的类,注意执行xml文件启动用例。否则不会有截图和报告产生。

<listeners>
    <!--<listener class-name="com.Extent.TestngListener"/>-->
    <listener class-name="com.Extent.MyExtentTestNgFormatter"/>
</listeners>

我的TestngListener类 和MyExtentTestNgFormatter类存在的位置。在report.html中可以看到错误用例的截图。
在这里插入图片描述

解忧源码铺
关注
专栏目录
如何在ExtentReports添加错误的截图，美化测试报告
qq_39774230的博客
02-27 1709
如何在ExtentReports添加错误的截图 1.首先感谢https://www.jianshu.com/p/31a013bec5a5，虽然他做的是接口的自动化，我做的是UI自动化，但是在extenreports的配置文件上我借用了这位大神的。 先放一张我的效果图吧 ExtentReports是一个非常好的测试报告框架，自己在网上找了很久想把失败之后的截图加入测试报告中，后来查找ExtentR...
如何在extenreports添加错误的截图
retinder
08-18 1596
身为一个只会后端的测试人员，自动化出来的报告总是testng的默认报告。或者稍微美化一点的reportng的报告。在现在这个只看脸的世界，显然是还不够的。 推荐大家用一个新的报告框架，extentreport。如何跟testng集成，如何使用，大家可以参考[这里写链接内容](http://extentreports.com/)，或者直接在csdn里边搜索。各种教程，一抓一大把。这里不再赘述。这里是参
Appium移动端自动化测试-结合ExtentReports生成report 并且展示错误截图
hujyhfwfh2的博客
08-08 615
1：说明 shotScreenListener端采用setAttribute方法 设置截图图片的路径到属性中现 ExtentTestNGIReporterListener采用getAttribute方法获取属性 设置html页面的路径 2：代码实现与说明 2.1:shotScreenListener的脚本 shotScreenListener监听器中设置属性如下 方便在ExtentTest...
Java自动化测试框架-10 - TestNG之测试结果篇（详细教程）
最新发布
北京-宏哥的博客
08-13 1016
例如，如果要生成测试运行的PDF报告，则无需实时通知测试运行，因此您应该使用IReporter。”）的文本报告程序（如下所述），则ITestListener是您的最好的选择。在此示例中，我选择扩展TestListenerAdapter，该方法使用空方法实现ITestListener，因此我不必从我不感兴趣的接口中覆盖其他方法。当所有套件都已运行时，TestNG将调用此方法，您可以检查其参数以访问刚刚完成的运行中的所有信息。请注意，当您使用-listener时，TestNG将自动确定您要使用的侦听器的类型。
TestNG监听器实现失败自动截图、重跑、自定义html结果文件功能
passionboyxie的专栏
01-14 1595
使用Testng框架搭建自动测试框架，经常会需要增加失败自动截图，以及失败重跑功能，下面介绍一下不修改Testng的源码，通过监听器的方式来实现自动截图、重跑、自定义Html结果文件功能。 自动截图功能 1、新建一个Java类继承TestListenerAdapter 2、重写onTestFailure、onTestSkipped等方法，在这些方法中加入截图操作 3、在testng.x
Selenium高级 | 借助TestNG的Listener对失败用例截图
YOYO的博客
09-30 1013
在上一篇中给大家介绍了在单个线性java脚本中执行失败时截图的做法，见Selenium高级|单条用例执行失败截图主要目的是让大家先熟悉下Selenium截图时用到的相关的类。 但是在现实中，很多时候我们并不清楚哪个用例会失败，今天失败的是这个用例，明天失败的可能又是另外的一个用例了，那在这种情况下如何实现用例运行失败后自动截图呢？ 这个就要用到TestNG的Listener：ITestLis...
测试报告--ExtentReport的使用及解决CSS样式加载不出来的问题
Tetsuya
12-05 883
ExtentRport的配置使用 ExtentReport用于生成测试报告，外观炫酷，并且涵盖信息非常全面。 extentReport官网：http://extentreports.com/ 一、配置依赖 首先在pom文件配置extentReport依赖 <dependencies> <dependency> <groupId>com.relevantcodes</groupId> <art
Java自动化测试系列[v1.0.0][ZTestReport测试报告]
12-21
7. **报告生成**：`generateReport`方法是实现`IReporter`接口必需的方法，它接收TestNG的`xmlSuites`、`suites`和`outputDirectory`参数，遍历所有测试套件和结果，统计并生成报告。 **集成ZTestReport到自动化...
ExtentReport的使用及解决样式加载不到问题
u013291552的博客
11-25 2929
ExtentReport用于生成测试报告，外观炫酷，并且涵盖信息非常全面。我们来学习下它的使用 extentReport官网：http://extentreports.com/ 一、配置依赖 首先在pom文件配置extentReport依赖 二、示例代码 引入ExtentReport后我们来编写一个示例，这里需要用到testng的断言，会使用常用的assertEquals方法，简单的...
cuke6-extent-adapter-report:使用tentreports-cucumber6-adapter插件生成Cucumber-JVM版本6的范围报告
04-17
在生成的报告中，你可以看到详细的测试步骤、每个步骤的状态（如通过、失败、断言错误等）、每个场景的执行时间，以及任何捕获的异常信息和截图。这对于调试和问题排查非常有帮助。此外，ExtentReports还支持多级...
第二十三章Extent Reports -高级报告（ExtentReport的使用及解决CSS样式加载不出来的问题）
BossHAO的博客
07-28 1238
第二十三章Extent Reports -高级报告（ExtentReport的使用及解决CSS样式加载不出来的问题） 1.给 ExtentReport 添加样式等信息(解决CSS样式加载不出来的问题) package ExtentFactory; import java.io.File; import java.util.Date; import com.aventstack.extentreports.ExtentReports; import com.aventstack.extentreports
自动化测试报告浅谈之ExtentReports
公众号：【伤心的辣条】
09-10 1040
我们在进行自动化测试时，往往需要有相应的测试报告，比如junit,testng,reportng等等，有会有自带的测试报告，那为什么我要在这边提ExtentReports?首先，我们来看看其它几种测试报告是什么样子的 　 1、junit 2、testng 3、reportng 这些自带的报告不够美观，可读性差，这样的报告拿出去估计没人愿意看吧，当然我们只是谈以上几种报告，如果要得到非常美观的报告只能自己动手去做了，这就要有良好的编码功底。费话不多说我们再来看看今天要讲的ExtentReports，上图
ExtendReports集成testng，添加监听器
看最远的地方
08-03 1300
第一步：新建监听器 package com.tester.exten.demo; import com.aventstack.extentreports.ExtentReports; import com.aventstack.extentreports.ExtentTest; import com.aventstack.extentreports.ResourceCDN; import co...
【TestNG】ExtentReports 官方说明文档翻译
anndy_的专栏
04-24 1421
extentReports基本用法 Basic Usage 初始化 Initializing Report 为了成功生成测试信息，需要启动并建立 Reporter （测试报告相关信息）和 ExtentReports 的关联。如果启动Reporter失败或未关联至ExtentReports类，在创建测试用例或将测试执行结果上传时，将提示 IllegalStateException 错误。 初始化...
python运行结果怎么截图_python UI自动化生成BeautifulReport测试报告并保存截图
weixin_39760689的博客
12-08 1660
前面已经写过利用BeautifulReport生成测试报告，那么接下来讲讲如何在测试报告里面保存截图首先需要在测试用例中定义一个截图的方法：# 截图方法"""os.path.abspath:返回当前目录的绝对路径传入一个img_name,并存储到指定路径下"""def save_img(self, img_name):self.driver.get_screenshot_as_file('{}/{...
testng优化：失败重跑，extentReport+appium用例失败截图，测试报告发邮件
weixin_30338481的博客
05-21 532
生成的单html方便jenkins集成发邮件,= = 构建失败发邮件 参考：https://blog.csdn.net/galen2016/article/details/77975965 步骤： 　　1.安装Email Extension Plugin插件 　　2.系统管理--系统设置 　　　　--设置jenkins Location的邮箱，这里是管理员邮箱，要和发件人的邮箱...
Maven test集成TestNG + ExtentReports
简单随风的博客
06-02 552
TestNG + ExtentReports的基础使用可以查看《TestNG项目集成ExtentReports》，本篇主要讲解在maven项目的单元测试中，如何直接使用mvn test命令来驱动测试代码。 项目结构如下： 现在要做的是，使用 mvn test命令时，可以自动执行test.xml和test2.xml文件两个文件，并使用extentreport自动生成测试报告 POM dependencies部分就是testng和extentreport的依赖，在此不做拓展，主要讲解plugin pom &
ExtentTestNGIReporter测试报告实现
qq_39364584的博客
07-24 3340
pom.xml文件配置： &lt;dependencies&gt; &lt;dependency&gt; &lt;groupId&gt;com.relevantcodes&lt;/groupId&gt; &lt;artifactId&gt;extentreports&lt;/artifactId&gt; &l...
在Chrome上使用Selenium IDE插件
坐板凳上敲代码
02-20 3507
测试中主要使用chrome浏览器，所以找了一下在chrome上可以使用得slelenium IDE插件。 下载该插件可以访问 https://www.crx4chrome.com/crx/107238/ 不会下载得可以从我网盘获取： 链接：https://pan.baidu.com/s/1MM_twURHcUA4oWLLmGCAkw 提取码：5vwc 版本为：Version 3.13.0 ...
java如何把参数传给ExtentReport报告中进行展示
06-02
在Java中，可以使用ExtentReports库来生成易于阅读和理解的测试报告。要将参数传递给ExtentReport报告中进行展示，可以使用以下代码示例： ```java import com.aventstack.extentreports.ExtentReports; import com.aventstack.extentreports.ExtentTest; import com.aventstack.extentreports.Status; import com.aventstack.extentreports.reporter.ExtentHtmlReporter; public class TestClass { ExtentHtmlReporter htmlReporter; ExtentReports extent; ExtentTest test; @BeforeTest public void setUp() { htmlReporter = new ExtentHtmlReporter("test_report.html"); extent = new ExtentReports(); extent.attachReporter(htmlReporter); } @Test public void testMethod() { test = extent.createTest("Test Name", "Test Description"); String parameter = "parameter value"; test.log(Status.INFO, "Parameter: " + parameter); // perform test steps and add logs to the test object } @AfterTest public void tearDown() { extent.flush(); } } ``` 在这个示例中，我们首先创建了一个ExtentReports对象和一个ExtentHtmlReporter对象，然后在@BeforeTest注释方法中将它们连接在一起。在@Test注释的测试方法中，我们创建了一个ExtentTest对象，并使用test.log()方法将参数添加到报告中，同时在测试方法中执行测试步骤并添加日志。最后，在@AfterTest注释方法中，我们调用extent.flush()方法来生成测试报告。
评论 10
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值