具体步骤
Step-1：在pom.xml文件中添加 Maven 依赖包
<xml version="1.0" encoding="UTF-8"> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.ymm</groupId> <artifactId>driver</artifactId> <version>1.0-SNAPSHOT</version> <dependencies> <dependency> <groupId>io.appium</groupId> <artifactId>java-client</artifactId> <version>4.1.2</version> </dependency> <!--引入testng测试框架 https://mvnrepository.com/artifact/org.testng/testng --> <dependency> <groupId>org.testng</groupId> <artifactId>testng</artifactId> <version>6.14.3</version> <scope>compile</scope> </dependency> <!--引入extentreports相关包--> <dependency> <groupId>com.relevantcodes</groupId> <artifactId>extentreports</artifactId> <version>2.41.2</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.1.5</version> <scope>provided</scope> </dependency> <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> <version>2.3.23</version> </dependency> </dependencies> <!-- 指明testng.xml文件的位置: <suiteXmlFile>src/test/resources/testNGFilesFolder/${testNgFileName}.xml</suiteXmlFile> --> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> <version>2.19</version> <configuration> <suiteXmlFiles> <suiteXmlFile>testng.xml</suiteXmlFile>//该文件位于工程根目录时，直接填写名字，其它位置要加上路径。 </suiteXmlFiles> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <configuration> <source>7</source> <target>7</target> </configuration> </plugin> </plugins> </build> </project> |
Step-2：重写 ExtentTestNgFormatter 类
主要基于以下两项原因：
1.支持报告中展示更多状态类型的测试结果，例如：成功、失败、警告、跳过等。
2.因为不支持cdn.rawgit.com访问，故替css访问方式。
创建 MyExtentTestNgFormatter 类
下载 ExtentReportes 源码，找到 ExtentTestNgFormatter 类，Listener 目录下创建 MyExtentTestNgFormatter.java 类直接继承 ExtentTestNgFormatter 类。
页面乱或者乱码，解决CDN无法访问
构造方法加入
htmlReporter.config().setResourceCDN(ResourceCDN.EXTENTREPORTS);
具体代码如下：
package com.extentreport.listener; 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.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(); // 如果cdn.rawgit.com访问不了，可以设置为：ResourceCDN.EXTENTREPORTS或者ResourceCDN.GITHUB htmlReporter.config().setResourceCDN(ResourceCDN.EXTENTREPORTS); reporter.attachReporter(htmlReporter, emailReporter); } /** * Gets the instance of the {@link ExtentTestNgFormatter} * * @return The instance of the {@link ExtentTestNgFormatter} */ public static ExtentTestNgFormatter getInstance() { return instance; } private static void setInstance(ExtentTestNgFormatter formatter) { instance = formatter; } /** * Gets the system information map * * @return The system information map */ public Map<String, String> getSystemInfo() { return systemInfo; } /** * Sets the system information * * @param systemInfo The system information map */ 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) { MyReporter.setTestName(iTestResult.getName()); } 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()); // 自定义报告 // 将MyReporter.report 静态引用赋值为 testContext。 // testContext 是 @Test每个测试用例时需要的。report.log可以跟随具体的测试用例。另请查阅源码。 MyReporter.report = testContext; 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()); } else { test.skip("Skipped"); } for (String group : iInvokedMethod.getTestMethod().getGroups()) { test.assignCategory(group); } } } /** * Adds a screen shot image file to the report. This method should be used only in the configuration method * and the {@link ITestResult} is the mandatory parameter * * @param iTestResult The {@link ITestResult} object * @param filePath The image file path * @throws IOException {@link IOException} */ public void addScreenCaptureFromPath(ITestResult iTestResult, String filePath) throws IOException { ExtentTest test = (ExtentTest) iTestResult.getAttribute("test"); test.addScreenCaptureFromPath(filePath); } /** * Adds a screen shot image file to the report. This method should be used only in the * {@link org.testng.annotations.Test} annotated method * * @param filePath The image file path * @throws IOException {@link IOException} */ public void addScreenCaptureFromPath(String filePath) throws IOException { ITestResult iTestResult = Reporter.getCurrentTestResult(); Preconditions.checkState(iTestResult != null); ExtentTest test = (ExtentTest) iTestResult.getAttribute("test"); test.addScreenCaptureFromPath(filePath); } /** * Sets the test runner output * * @param message The message to be logged */ 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(); } /** * Adds the new node to the test. The node name should have been set already using {@link NodeName} */ public void addNewNodeToTest() { addNewNodeToTest(NodeName.getNodeName()); } /** * Adds the new node to the test with the given node name. * * @param nodeName The name of the node to be created */ public void addNewNodeToTest(String nodeName) { addNewNode("test", nodeName); } /** * Adds a new node to the suite. The node name should have been set already using {@link NodeName} */ public void addNewNodeToSuite() { addNewNodeToSuite(NodeName.getNodeName()); } /** * Adds a new node to the suite with the given node name * * @param nodeName The name of the node to be created */ 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); } /** * Adds a info log message to the node. The node name should have been set already using {@link NodeName} * * @param logMessage The log message string */ public void addInfoLogToNode(String logMessage) { addInfoLogToNode(logMessage, NodeName.getNodeName()); } /** * Adds a info log message to the node * * @param logMessage The log message string * @param nodeName The name of the node */ public void addInfoLogToNode(String logMessage, String nodeName) { ITestResult result = Reporter.getCurrentTestResult(); Preconditions.checkState(result != null); ExtentTest test = (ExtentTest) result.getAttribute(nodeName); test.info(logMessage); } /** * Marks the node as failed. The node name should have been set already using {@link NodeName} * * @param t The {@link Throwable} object */ public void failTheNode(Throwable t) { failTheNode(NodeName.getNodeName(), t); } /** * Marks the given node as failed * * @param nodeName The name of the node * @param t The {@link Throwable} object */ public void failTheNode(String nodeName, Throwable t) { ITestResult result = Reporter.getCurrentTestResult(); Preconditions.checkState(result != null); ExtentTest test = (ExtentTest) result.getAttribute(nodeName); test.fail(t); } /** * Marks the node as failed. The node name should have been set already using {@link NodeName} * * @param logMessage The message to be logged */ public void failTheNode(String logMessage) { failTheNode(NodeName.getNodeName(), logMessage); } /** * Marks the given node as failed * * @param nodeName The name of the node * @param logMessage The message to be logged */ public void failTheNode(String nodeName, String logMessage) { ITestResult result = Reporter.getCurrentTestResult(); Preconditions.checkState(result != null); ExtentTest test = (ExtentTest) result.getAttribute(nodeName); test.fail(logMessage); } } |
上文内容不用于商业目的，如涉及知识产权问题，请权利人联系博为峰小编(021-64471599-8017)，我们将立即处理。
