创建项目引入依赖

一、创建maven项目
二、引入依赖

  1.  <dependencies>
  2.     <!-- https://mvnrepository.com/artifact/com.alibaba/fastjson -->
  3.     <dependency>
  4.         <groupId>com.alibaba</groupId>
  5.         <artifactId>fastjson</artifactId>
  6.         <version>1.2.47</version>
  7.     </dependency>
  9.     <dependency>
  10.         <groupId>com.squareup.okhttp3</groupId>
  11.         <artifactId>okhttp</artifactId>
  12.         <version>3.10.0</version>
  13.     </dependency>
  14.     <!-- https://mvnrepository.com/artifact/com.squareup.okhttp3/logging-interceptor  日志拦截器-->
  15.     <dependency>
  16.         <groupId>com.squareup.okhttp3</groupId>
  17.         <artifactId>logging-interceptor</artifactId>
  18.         <version>3.10.0</version>
  19.     </dependency>
  21.     <!-- https://mvnrepository.com/artifact/org.testng/testng -->
  22.     <dependency>
  23.         <groupId>org.testng</groupId>
  24.         <artifactId>testng</artifactId>
  25.         <version>6.14.2</version>
  26.         <!--<scope>test</scope>-->
  27.         <!--作用范围，默认是test。验证部分被抽象，不仅test作用域需使用-->
  28.     </dependency>
  30.     <!-- https://mvnrepository.com/artifact/com.aventstack/extentreports -->
  31.     <dependency>
  32.         <groupId>com.aventstack</groupId>
  33.         <artifactId>extentreports</artifactId>
  34.         <version>3.1.5</version>
  35.         <scope>provided</scope>
  36.     </dependency>
  38.     <!-- https://mvnrepository.com/artifact/com.vimalselvam/testng-extentsreport -->
  39.     <dependency>
  40.         <groupId>com.vimalselvam</groupId>
  41.         <artifactId>testng-extentsreport</artifactId>
  42.         <version>1.3.1</version>
  43.     </dependency>
  45.     <dependency>
  46.         <groupId>com.squareup.retrofit2</groupId>
  47.         <artifactId>retrofit</artifactId>
  48.         <version>2.4.0</version>
  49.     </dependency>
  50.     <!-- https://mvnrepository.com/artifact/com.squareup.retrofit2/converter-gson 对象转换器-->
  51.     <dependency>
  52.         <groupId>com.squareup.retrofit2</groupId>
  53.         <artifactId>converter-gson</artifactId>
  54.         <version>2.3.0</version>
  55.     </dependency>
  56. </dependencies>
  58.     <!--为了maven打包编译时后台一直输出警告信息。导致构建失败-->
  59.     <properties>
  60.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  61.         <xmlFileName></xmlFileName>
  62.     </properties>

多环境切换配置

三、配置多环境切换
配置pom.xml文件的 build节点

  1. <build>
  2.    <resources>
  3.        <resource>
  4.            <directory>src/main/resources</directory>
  5.            <filtering>true</filtering>
  6.            <!--扫描替换参数的文件路径-->
  7.        </resource>
  8.    </resources>
  9.    <filters>
  10.        <filter>src/main/filters/filter-${env}.properties</filter>
  11.        <!--环境过滤器的配置方式，回头需要在该路径下建立对应文件-->
  12.    </filters>
  13.    <plugins>
  14.        <plugin>
  15.            <!--该插件是解决命令下执行mvn test指定testng xxx.xml 文件 的配置-->
  16.            <groupId>org.apache.maven.plugins</groupId>
  17.            <artifactId>maven-surefire-plugin</artifactId>
  18.            <version>2.22.0</version>
  19.            <configuration>
  20.                <!--为了解决在jenkins maven执行test 报告乱码问题，编码格式设置为UTF-8-->
  21.                <argLine>-Dfile.encoding=UTF-8</argLine>
  22.                <encoding>UTF-8</encoding>
  23.                <!--动态指定执行的xml文件。${project.basedir}项目目录，${xmlFileName}maven文件-->
  24.                <suiteXmlFiles>
  25.                    <suiteXmlFile>${project.basedir}/target/classes/testNg/${xmlFileName}</suiteXmlFile>
  26.                    <!--在IEDA上运行maven test命令时，可打开该注释使用完整测试集合-->
  27.                    <!--<suiteXmlFile>${project.basedir}/target/classes/testNg/api/APICollection-TestSuite.xml</suiteXmlFile>-->
  28.                </suiteXmlFiles>
  29.            </configuration>
  30.        </plugin>
  31.        <plugin>
  32.            <groupId>org.apache.maven.plugins</groupId>
  33.            <artifactId>maven-compiler-plugin</artifactId>
  34.            <configuration>
  35.                <encoding>UTF-8</encoding>
  36.                <source>8</source>
  37.                <target>8</target>
  38.            </configuration>
  39.        </plugin>
  40.    </plugins>
  41. </build>

四、在pom.xml文件配置Properties环境，多环境配置参数切换。

  1.     <profiles>
  2.         <!-- 开发环境，默认激活 -->
  3.         <profile>
  4.             <id>dev</id>
  5.             <properties>
  6.                 <env>dev</env>
  7.             </properties>
  8.         </profile>
  10.         <!-- 生产环境 -->
  11.         <profile>
  12.             <id>product</id>
  13.             <properties>
  14.                 <env>product</env>
  15.             </properties>
  16.         </profile>
  18.         <!-- 测试环境 -->
  19.         <profile>
  20.             <id>debug</id>
  21.             <properties>
  22.                 <env>debug</env>
  23.             </properties>
  24.             <activation>
  25.                 <activeByDefault>true</activeByDefault><!--默认启用的是dev环境配置-->
  26.             </activation>
  27.         </profile>
  28.     </profiles>

五、在src/resource下创建env.properties文件，该文件记录的信息是跟环境切换相关的参数。

  1. #Environment
  2. Environment=${Environment}
  5. douban.host=${douban.host}

六、在src/main/filters/下创建filter-debug.properties、filter-dev.properties、filter-product.properties用户记录环境信息参数，模板如下

  1. #Environment
  3. Environment=Debug
  5. douban.host=https://movie.douban.com/

配置testNG

七、在src/resources/下创建testNg目录，存放测试集合的目录，为了能够让所有接口统一运行测试，需建立一个所有的测试集合。
APICollection-TestSuite.xml

  1. <!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd" >
  3.     <suite name="接口测试集合" verbose="1" preserve-order="true">
  4. <!--    自定义参数，用于报告展示-->
  5.     <parameter name="report.config" value="src/main/resources/config/report/extent-config.xml"/>
  6.     <parameter name="system.info" value="reporter.config.MySystemInfo"/>
  8. <!--    执行的测试用例文件-->
  9.     <suite-files>
  10.         <suite-file path="search/search-TestSuite.xml"/>
  11.     </suite-files>
  13. <!--    报告监听器配置-->
  14.     <listeners>
  15.         <listener class-name="reporter.listener.MyExtentTestNgFormatter"/>
  16.     </listeners>
  17. </suite>

search-TestSuite.xml

  1. <!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd" >
  3. <suite name="search_tags-搜索分类-电影首页测试集合" verbose="1" preserve-order="true">
  4.     <parameter name="report.config" value="src/main/resources/config/report/extent-config.xml"/>
  5.     <parameter name="system.info" value="reporter.config.MySystemInfo"/>
  7.     <test name="0100.搜索分类-电影首页-正常场景" preserve-order="true">
  8.         <classes>
  9.             <class name="com.jxq.douban.SearchTagsTest">
  10.                 <methods>
  11.                     <include name="testcase1"/>
  12.                 </methods>
  13.             </class>
  14.         </classes>
  15.     </test>
  17.     <test name="0100.搜索分类-TV首页-正常场景" preserve-order="true">
  18.         <classes>
  19.             <class name="com.jxq.douban.SearchTagsTest">
  20.                 <methods>
  21.                     <include name="testcase2"/>
  22.                 </methods>
  23.             </class>
  24.         </classes>
  25.     </test>
  27.     <listeners>
  28.         <listener class-name="reporter.listener.MyExtentTestNgFormatter"/>
  29.     </listeners>
  30. </suite>

配置ExtentReports

八、强制重写ExtentTestNgFormatter类
强制重写EExtentTestNgFormatter类主要是以下两点原因：
①、为了能够在报告中展示更多状态类型的测试结果，例如：成功、失败、警告、跳过等测试状态结果。 ②、因为不支持cdn.rawgit.com访问，故替css访问方式。
在src/main/java/reporter/listener路径下创建MyExtentTestNgFormatter.java

  1. package reporter.listener;
  3. import com.aventstack.extentreports.ExtentReports;
  4. import com.aventstack.extentreports.ExtentTest;
  5. import com.aventstack.extentreports.ResourceCDN;
  6. import com.aventstack.extentreports.reporter.ExtentHtmlReporter;
  7. import com.google.common.base.Preconditions;
  8. import com.google.common.base.Strings;
  9. import com.vimalselvam.testng.EmailReporter;
  10. import com.vimalselvam.testng.NodeName;
  11. import com.vimalselvam.testng.SystemInfo;
  12. import com.vimalselvam.testng.listener.ExtentTestNgFormatter;
  13. import org.testng.*;
  14. import org.testng.xml.XmlSuite;
  16. import java.io.File;
  17. import java.io.IOException;
  18. import java.util.ArrayList;
  19. import java.util.List;
  20. import java.util.Map;
  22. public class MyExtentTestNgFormatter extends ExtentTestNgFormatter {
  23.     private static final String REPORTER_ATTR = "extentTestNgReporter";
  24.     private static final String SUITE_ATTR = "extentTestNgSuite";
  25.     private ExtentReports reporter;
  26.     private List<String> testRunnerOutput;
  27.     private Map<String, String> systemInfo;
  28.     private ExtentHtmlReporter htmlReporter;
  30.     private static ExtentTestNgFormatter instance;
  32.     public MyExtentTestNgFormatter() {
  33.         setInstance(this);
  34.         testRunnerOutput = new ArrayList<>();
  35.         String reportPathStr = System.getProperty("reportPath");
  36.         File reportPath;
  38.         try {
  39.             reportPath = new File(reportPathStr);
  40.         } catch (NullPointerException e) {
  41.             reportPath = new File(TestNG.DEFAULT_OUTPUTDIR);
  42.         }
  44.         if (!reportPath.exists()) {
  45.             if (!reportPath.mkdirs()) {
  46.                 throw new RuntimeException("Failed to create output run directory");
  47.             }
  48.         }
  50.         File reportFile = new File(reportPath, "report.html");
  51.         File emailReportFile = new File(reportPath, "emailable-report.html");
  53.         htmlReporter = new ExtentHtmlReporter(reportFile);
  54.         EmailReporter emailReporter = new EmailReporter(emailReportFile);
  55.         reporter = new ExtentReports();
  56. // 如果cdn.rawgit.com访问不了，可以设置为：ResourceCDN.EXTENTREPORTS或者ResourceCDN.GITHUB
  57.         htmlReporter.config().setResourceCDN(ResourceCDN.EXTENTREPORTS);
  58.         reporter.attachReporter(htmlReporter, emailReporter);
  59.     }
  61.     /**
  62.      * Gets the instance of the {@link ExtentTestNgFormatter}
  63.      *
  64.      * @return The instance of the {@link ExtentTestNgFormatter}
  65.      */
  66.     public static ExtentTestNgFormatter getInstance() {
  67.         return instance;
  68.     }
  70.     private static void setInstance(ExtentTestNgFormatter formatter) {
  71.         instance = formatter;
  72.     }
  74.     /**
  75.      * Gets the system information map
  76.      *
  77.      * @return The system information map
  78.      */
  79.     public Map<String, String> getSystemInfo() {
  80.         return systemInfo;
  81.     }
  83.     /**
  84.      * Sets the system information
  85.      *
  86.      * @param systemInfo The system information map
  87.      */
  88.     public void setSystemInfo(Map<String, String> systemInfo) {
  89.         this.systemInfo = systemInfo;
  90.     }
  92.     public void onStart(ISuite iSuite) {
  93.         if (iSuite.getXmlSuite().getTests().size() > 0) {
  94.             ExtentTest suite = reporter.createTest(iSuite.getName());
  95.             String configFile = iSuite.getParameter("report.config");
  97.             if (!Strings.isNullOrEmpty(configFile)) {
  98.                 htmlReporter.loadXMLConfig(configFile);
  99.             }
  101.             String systemInfoCustomImplName = iSuite.getParameter("system.info");
  102.             if (!Strings.isNullOrEmpty(systemInfoCustomImplName)) {
  103.                 generateSystemInfo(systemInfoCustomImplName);
  104.             }
  106.             iSuite.setAttribute(REPORTER_ATTR, reporter);
  107.             iSuite.setAttribute(SUITE_ATTR, suite);
  108.         }
  109.     }
  111.     private void generateSystemInfo(String systemInfoCustomImplName) {
  112.         try {
  113.             Class<?> systemInfoCustomImplClazz = Class.forName(systemInfoCustomImplName);
  114.             if (!SystemInfo.class.isAssignableFrom(systemInfoCustomImplClazz)) {
  115.                 throw new IllegalArgumentException("The given system.info class name <" + systemInfoCustomImplName +
  116.                         "> should implement the interface <" + SystemInfo.class.getName() + ">");
  117.             }
  119.             SystemInfo t = (SystemInfo) systemInfoCustomImplClazz.newInstance();
  120.             setSystemInfo(t.getSystemInfo());
  121.         } catch (ClassNotFoundException | InstantiationException | IllegalAccessException e) {
  122.             throw new IllegalStateException(e);
  123.         }
  124.     }
  126.     public void onFinish(ISuite iSuite) {
  127.     }
  130.     public void onTestStart(ITestResult iTestResult) {
  131.         MyReporter.setTestName(iTestResult.getName());
  132.     }
  134.     public void onTestSuccess(ITestResult iTestResult) {
  136.     }
  138.     public void onTestFailure(ITestResult iTestResult) {
  140.     }
  142.     public void onTestSkipped(ITestResult iTestResult) {
  144.     }
  146.     public void onTestFailedButWithinSuccessPercentage(ITestResult iTestResult) {
  148.     }
  150.     public void onStart(ITestContext iTestContext) {
  151.         ISuite iSuite = iTestContext.getSuite();
  152.         ExtentTest suite = (ExtentTest) iSuite.getAttribute(SUITE_ATTR);
  153.         ExtentTest testContext = suite.createNode(iTestContext.getName());
  154. // 自定义报告
  155. // 将MyReporter.report静态引用赋值为testContext。
  156. // testContext是@Test每个测试用例时需要的。report.log可以跟随具体的测试用例。另请查阅源码。
  157.         MyReporter.report = testContext;
  158.         iTestContext.setAttribute("testContext", testContext);
  159.     }
  161.     public void onFinish(ITestContext iTestContext) {
  162.         ExtentTest testContext = (ExtentTest) iTestContext.getAttribute("testContext");
  163.         if (iTestContext.getFailedTests().size() > 0) {
  164.             testContext.fail("Failed");
  165.         } else if (iTestContext.getSkippedTests().size() > 0) {
  166.             testContext.skip("Skipped");
  167.         } else {
  168.             testContext.pass("Passed");
  169.         }
  170.     }
  172.     public void beforeInvocation(IInvokedMethod iInvokedMethod, ITestResult iTestResult) {
  173.         if (iInvokedMethod.isTestMethod()) {
  174.             ITestContext iTestContext = iTestResult.getTestContext();
  175.             ExtentTest testContext = (ExtentTest) iTestContext.getAttribute("testContext");
  176.             ExtentTest test = testContext.createNode(iTestResult.getName(), iInvokedMethod.getTestMethod().getDescription());
  177.             iTestResult.setAttribute("test", test);
  178.         }
  179.     }
  181.     public void afterInvocation(IInvokedMethod iInvokedMethod, ITestResult iTestResult) {
  182.         if (iInvokedMethod.isTestMethod()) {
  183.             ExtentTest test = (ExtentTest) iTestResult.getAttribute("test");
  184.             List<String> logs = Reporter.getOutput(iTestResult);
  185.             for (String log : logs) {
  186.                 test.info(log);
  187.             }
  189.             int status = iTestResult.getStatus();
  190.             if (ITestResult.SUCCESS == status) {
  191.                 test.pass("Passed");
  192.             } else if (ITestResult.FAILURE == status) {
  193.                 test.fail(iTestResult.getThrowable());
  194.             } else {
  195.                 test.skip("Skipped");
  196.             }
  198.             for (String group : iInvokedMethod.getTestMethod().getGroups()) {
  199.                 test.assignCategory(group);
  200.             }
  201.         }
  202.     }
  204.     /**
  205.      * Adds a screen shot image file to the report. This method should be used only in the configuration method
  206.      * and the {@link ITestResult} is the mandatory parameter
  207.      *
  208.      * @param iTestResult The {@link ITestResult} object
  209.      * @param filePath    The image file path
  210.      * @throws IOException {@link IOException}
  211.      */
  212.     public void addScreenCaptureFromPath(ITestResult iTestResult, String filePath) throws IOException {
  213.         ExtentTest test = (ExtentTest) iTestResult.getAttribute("test");
  214.         test.addScreenCaptureFromPath(filePath);
  215.     }
  217.     /**
  218.      * Adds a screen shot image file to the report. This method should be used only in the
  219.      * {@link org.testng.annotations.Test} annotated method
  220.      *
  221.      * @param filePath The image file path
  222.      * @throws IOException {@link IOException}
  223.      */
  224.     public void addScreenCaptureFromPath(String filePath) throws IOException {
  225.         ITestResult iTestResult = Reporter.getCurrentTestResult();
  226.         Preconditions.checkState(iTestResult != null);
  227.         ExtentTest test = (ExtentTest) iTestResult.getAttribute("test");
  228.         test.addScreenCaptureFromPath(filePath);
  229.     }
  231.     /**
  232.      * Sets the test runner output
  233.      *
  234.      * @param message The message to be logged
  235.      */
  236.     public void setTestRunnerOutput(String message) {
  237.         testRunnerOutput.add(message);
  238.     }
  240.     public void generateReport(List<XmlSuite> list, List<ISuite> list1, String s) {
  241.         if (getSystemInfo() != null) {
  242.             for (Map.Entry<String, String> entry : getSystemInfo().entrySet()) {
  243.                 reporter.setSystemInfo(entry.getKey(), entry.getValue());
  244.             }
  245.         }
  246.         reporter.setTestRunnerOutput(testRunnerOutput);
  247.         reporter.flush();
  248.     }
  250.     /**
  251.      * Adds the new node to the test. The node name should have been set already using {@link NodeName}
  252.      */
  253.     public void addNewNodeToTest() {
  254.         addNewNodeToTest(NodeName.getNodeName());
  255.     }
  257.     /**
  258.      * Adds the new node to the test with the given node name.
  259.      *
  260.      * @param nodeName The name of the node to be created
  261.      */
  262.     public void addNewNodeToTest(String nodeName) {
  263.         addNewNode("test", nodeName);
  264.     }
  266.     /**
  267.      * Adds a new node to the suite. The node name should have been set already using {@link NodeName}
  268.      */
  269.     public void addNewNodeToSuite() {
  270.         addNewNodeToSuite(NodeName.getNodeName());
  271.     }
  273.     /**
  274.      * Adds a new node to the suite with the given node name
  275.      *
  276.      * @param nodeName The name of the node to be created
  277.      */
  278.     public void addNewNodeToSuite(String nodeName) {
  279.         addNewNode(SUITE_ATTR, nodeName);
  280.     }
  282.     private void addNewNode(String parent, String nodeName) {
  283.         ITestResult result = Reporter.getCurrentTestResult();
  284.         Preconditions.checkState(result != null);
  285.         ExtentTest parentNode = (ExtentTest) result.getAttribute(parent);
  286.         ExtentTest childNode = parentNode.createNode(nodeName);
  287.         result.setAttribute(nodeName, childNode);
  288.     }
  290.     /**
  291.      * Adds a info log message to the node. The node name should have been set already using {@link NodeName}
  292.      *
  293.      * @param logMessage The log message string
  294.      */
  295.     public void addInfoLogToNode(String logMessage) {
  296.         addInfoLogToNode(logMessage, NodeName.getNodeName());
  297.     }
  299.     /**
  300.      * Adds a info log message to the node
  301.      *
  302.      * @param logMessage The log message string
  303.      * @param nodeName   The name of the node
  304.      */
  305.     public void addInfoLogToNode(String logMessage, String nodeName) {
  306.         ITestResult result = Reporter.getCurrentTestResult();
  307.         Preconditions.checkState(result != null);
  308.         ExtentTest test = (ExtentTest) result.getAttribute(nodeName);
  309.         test.info(logMessage);
  310.     }
  312.     /**
  313.      * Marks the node as failed. The node name should have been set already using {@link NodeName}
  314.      *
  315.      * @param t The {@link Throwable} object
  316.      */
  317.     public void failTheNode(Throwable t) {
  318.         failTheNode(NodeName.getNodeName(), t);
  319.     }
  321.     /**
  322.      * Marks the given node as failed
  323.      *
  324.      * @param nodeName The name of the node
  325.      * @param t        The {@link Throwable} object
  326.      */
  327.     public void failTheNode(String nodeName, Throwable t) {
  328.         ITestResult result = Reporter.getCurrentTestResult();
  329.         Preconditions.checkState(result != null);
  330.         ExtentTest test = (ExtentTest) result.getAttribute(nodeName);
  331.         test.fail(t);
  332.     }
  334.     /**
  335.      * Marks the node as failed. The node name should have been set already using {@link NodeName}
  336.      *
  337.      * @param logMessage The message to be logged
  338.      */
  339.     public void failTheNode(String logMessage) {
  340.         failTheNode(NodeName.getNodeName(), logMessage);
  341.     }
  343.     /**
  344.      * Marks the given node as failed
  345.      *
  346.      * @param nodeName   The name of the node
  347.      * @param logMessage The message to be logged
  348.      */
  349.     public void failTheNode(String nodeName, String logMessage) {
  350.         ITestResult result = Reporter.getCurrentTestResult();
  351.         Preconditions.checkState(result != null);
  352.         ExtentTest test = (ExtentTest) result.getAttribute(nodeName);
  353.         test.fail(logMessage);
  354.     }
  355. }

同级目录再创建MyReporter.java，然后注意MyExtentTestNgFormatter.java中使用MyReporter的自定义部分

  1. public class MyReporter {
  2.         public static ExtentTest report;
  3.     }

导入MyExtentTestNgFormatter监听类

  1. <listeners>
  2.         <listener class-name="reporter.Listener.MyExtentTestNgFormatter"/>
  3. </listeners>

九、修改测试报告生成目录（可选），默认生成在test-output/文件夹下，名为report.html、emailable-report.html。

  1.     public MyExtentTestNgFormatter() {
  2.         setInstance(this);
  3.         testRunnerOutput = new ArrayList<>();
  4.         // reportPath报告路径
  5.         String reportPathStr = System.getProperty("reportPath");
  6.         File reportPath;
  8.         try {
  9.             reportPath = new File(reportPathStr);
  10.         } catch (NullPointerException e) {
  11.             reportPath = new File(TestNG.DEFAULT_OUTPUTDIR);
  12.         }
  14.         if (!reportPath.exists()) {
  15.             if (!reportPath.mkdirs()) {
  16.                 throw new RuntimeException("Failed to create output run directory");
  17.             }
  18.         }
  19.         // 报告名report.html
  20.         File reportFile = new File(reportPath, "report.html");
  21.         // 邮件报告名emailable-report.html
  22.         File emailReportFile = new File(reportPath, "emailable-report.html");
  24.         htmlReporter = new ExtentHtmlReporter(reportFile);
  25.         EmailReporter emailReporter = new EmailReporter(emailReportFile);
  26.         reporter = new ExtentReports();
  27.         reporter.attachReporter(htmlReporter, emailReporter);
  28.     }

十、report.log增加状态、耗时记录等

  1. // 根据状态不同添加报告。型如警告
  2. public class MyInterceptor implements Interceptor {
  4.     @Override
  5.     public Response intercept(Chain chain) throws IOException {
  6.         Request request = chain.request();
  7.         Response response = chain.proceed(request);
  8.         long time = response.receivedResponseAtMillis() - response.sentRequestAtMillis();
  9.         if (time > 100) {
  10.             MyReporter.report.log(Status.WARNING, MyReporter.getTestName() + " 接口耗时：" + time);
  11.         }
  12.         return response;
  13.     }
  14. }

十一、配置报告信息
extent reporters支持报告的配置，目前支持的配置内容有title、主题等。
在src/resources/目录下添加 config/report/extent-config.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <extentreports>
  3.     <configuration>
  4.         <timeStampFormat>yyyy-MM-dd HH:mm:ss</timeStampFormat>
  5.         <!-- report theme -->
  6.         <!-- standard, dark -->
  7.         <theme>dark</theme>
  9.         <!-- document encoding -->
  10.         <!-- defaults to UTF-8 -->
  11.         <encoding>UTF-8</encoding>
  13.         <!-- protocol for script and stylesheets -->
  14.         <!-- defaults to https -->
  15.         <protocol>https</protocol>
  17.         <!-- title of the document -->
  18.         <documentTitle>QA-接口自动化测试报告</documentTitle>
  20.         <!-- report name - displayed at top-nav -->
  21.         <reportName>QA-接口自动化测试报告</reportName>
  23.         <!-- report headline - displayed at top-nav, after reportHeadline -->
  24.         <reportHeadline>接口自动化测试报告</reportHeadline>
  26.         <!-- global date format override -->
  27.         <!-- defaults to yyyy-MM-dd -->
  28.         <dateFormat>yyyy-MM-dd</dateFormat>
  30.         <!-- global time format override -->
  31.         <!-- defaults to HH:mm:ss -->
  32.         <timeFormat>HH:mm:ss</timeFormat>
  34.         <!-- custom javascript -->
  35.         <scripts>
  36.             <![CDATA[
  37.         $(document).ready(function() {
  39.         });
  40.       ]]>
  41.         </scripts>
  43.         <!-- custom styles -->
  44.         <styles>
  45.             <![CDATA[
  47.       ]]>
  48.         </styles>
  49.     </configuration>
  50. </extentreports>

注意在APICollection-TestSuite.xml中的parameter参数，使用时需传入
十二、配置系统信息
在src/main/java/reporter/config目录下创建MySystemInfo.java类，继承SystemInfo接口

  1. public class MySystemInfo implements SystemInfo {
  2.     @Override
  3.     public Map<String, String> getSystemInfo() {
  4.         InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream("env.properties");
  5.         Properties properties = new Properties();
  6.         Map<String, String> systemInfo = new HashMap<>();
  7.         try {
  8.             properties.load(inputStream);
  9.             systemInfo.put("environment", properties.getProperty("Environment"));
  10.             systemInfo.put("测试人员", "jxq");
  11.         } catch (IOException e) {
  12.             e.printStackTrace();
  13.         }
  14.         return systemInfo;
  15.     }
  16. }

注意在APICollection-TestSuite.xml中的parameter参数，使用时需传入

集成retrofit2.0

十三、在common下创建HttpBase
HttpBase类中提供了Retrofit基础，考虑到了日常控制台和测试报告上都需要看到对应请求信息，故此在HttpClient中默认加入了日志拦截器；日志拦截器的实现方法里，用Reportes.log记录到日志中。 并且，考虑到实际项目中每个Http请求都会有对应类似RequestHeader、RequestBody的加密签名等，预留了拦截器。 可在HttpBase构造方法时传入对应拦截器。 对应的拦截器可以通过实现接口Interceptor，做对应项目需求操作。

  1. public class HttpBase {
  2.     public static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
  3.     private Retrofit retrofit;
  4.     private String host;
  6.     /**
  7.      * 构造方法（1个参数）
  8.      * 只传Host
  9.      * 可以加入自定义拦截器 -超时判断
  10.      * 或者，默认没有使用拦截器。
  11.      *
  12.      * @param host 访问域名host
  13.      */
  14.     public HttpBase(String host) {
  15. //        可添加响应超时拦截器
  16.         Interceptor interceptor = new MyInterceptor();
  17.         init(host, interceptor);
  18. //        init(host, null);
  19.     }
  21.     /**
  22.      * 构造方法（2个参数）
  23.      * 只传Host，默认使用日志拦截器。
  24.      *
  25.      * @param host        访问域名host
  26.      * @param interceptor 自定义拦截器
  27.      */
  28.     public HttpBase(String host, Interceptor interceptor) {
  29.         init(host, interceptor);
  30.     }
  32.     /**
  33.      * 初始化方法
  34.      *
  35.      * @param host        访问域名host
  36.      * @param interceptor 自定义拦截器
  37.      */
  38.     private void init(String host, Interceptor interceptor) {
  39.         OkHttpClient.Builder client = getHttpClient(interceptor);
  40.         retrofit = new Retrofit.Builder()
  41.                 .baseUrl(host)
  42.                 .client(client.build())
  43.                 .addConverterFactory(RespVoConverterFactory.create())
  44.                 .build();
  45.     }
  47.     /**
  48.      * 获取HttpClient.Builder 方法。
  49.      * 默认添加了，基础日志拦截器
  50.      *
  51.      * @param interceptor 拦截器
  52.      * @return HttpClient.Builder对象
  53.      */
  54.     private OkHttpClient.Builder getHttpClient(Interceptor interceptor) {
  55.         HttpLoggingInterceptor logging = getHttpLoggingInterceptor();
  56.         OkHttpClient.Builder builder = new OkHttpClient.Builder()
  57.                 .connectTimeout(10, TimeUnit.SECONDS)
  58.                 .retryOnConnectionFailure(true);
  59.         if (interceptor != null) {
  60.             builder.addInterceptor(interceptor);
  61.         }
  62.         builder.addInterceptor(logging);
  63.         return builder;
  64.     }
  66.     /**
  67.      * 日志拦截器
  68.      *
  69.      * @return
  70.      */
  71.     private HttpLoggingInterceptor getHttpLoggingInterceptor() {
  72.         HttpLoggingInterceptor logging = new HttpLoggingInterceptor(new HttpLoggingInterceptor.Logger() {
  73.             @Override
  74.             public void log(String message) {
  75.                 Reporter.log("RetrofitLog--> " + message, true);
  76.             }
  77.         });
  78.         logging.setLevel(HttpLoggingInterceptor.Level.BODY);//Level中还有其他等级
  79.         return logging;
  80.     }
  82.     /**
  83.      * retrofit构建方法
  84.      *
  85.      * @param clazz 泛型类
  86.      * @param <T>   泛型类
  87.      * @return 泛型类
  88.      */
  89.     public <T> T create(Class<T> clazz) {
  90.         return retrofit.create(clazz);
  91.     }
  93.     public String getHost() {
  94.         return host;
  95.     }
  97.     public void setHost(String host) {
  98.         this.host = host;
  99.     }
  100. }

同级目录再创建MyInterceptor.java

  1. public class MyInterceptor implements Interceptor {
  3.     @Override
  4.     public Response intercept(Chain chain) throws IOException {
  5.         Request request = chain.request();
  6.         Response response = chain.proceed(request);
  7.         long time = response.receivedResponseAtMillis() - response.sentRequestAtMillis();
  8.         if (time > 100) {
  9.             MyReporter.report.log(Status.WARNING, MyReporter.getTestName() + " 接口耗时：" + time);
  10.         }
  11.         return response;
  12.     }
  13. }

创建接口ISearch

  1. public interface ISearch {
  2.     @GET("j/search_tags")
  3.     Call<MovieResponseVO> searchTags(@Query("type") String type, @Query("source") String source);
  4. }

集成HttpBase的Http Api接口请求方法类
在Retrofit已经可以用4行的代码实现Http请求了

  1.         HttpBase httpBase = new HttpBase(host);
  2.         ISearch iSearch = httpBase.create(ISearch.class);
  3.         Call<MovieResponseVO> call = iSearch.searchTags(type, source);
  4.         Response<MovieResponseVO> response = call.execute();

上面的4行代码，每次都需要写也是挺麻烦的，所以抽出来，让编写测试用例验证更简洁点

  1. public class HttpSearch extends HttpBase {
  2.     private ISearch iSearch;
  4.     public HttpSearch(String host) {
  5.         super(host);
  6.         iSearch = super.create(ISearch.class);
  7.     }
  9.     public Response<MovieResponseVO> searchTags(String type, String source) throws IOException {
  10.         Call<MovieResponseVO> call = iSearch.searchTags(type, source);
  11.         return call.execute();
  12.     }
  14. //    同模块下，新增的接口可添加到这里。
  15. //    public Response<MovieResponseVO> searchTags(String type, String source) throws IOException {
  16. //        Call<MovieResponseVO> call = iSearch.searchTags(type, source);
  17. //        return call.execute();
  18. //    }
  19. }

JsonSchema验证基础响应体（响应为JSON格式可用）

pom.xml 依赖引入

  1.       <!--json schema start-->
  2.       <!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-core -->
  3.       <dependency>
  4.           <groupId>com.fasterxml.jackson.core</groupId>
  5.           <artifactId>jackson-core</artifactId>
  6.           <version>2.9.6</version>
  7.       </dependency>
  9.       <!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind -->
  10.       <dependency>
  11.           <groupId>com.fasterxml.jackson.core</groupId>
  12.           <artifactId>jackson-databind</artifactId>
  13.           <version>2.9.6</version>
  14.       </dependency>
  16.       <dependency>
  17.           <groupId>com.github.fge</groupId>
  18.           <artifactId>json-schema-validator</artifactId>
  19.           <version>2.2.6</version>
  20.       </dependency>
  21.       <!--json schema end-->

简单抽象JsonSchemaUtils工具类

  1. /**
  2. * JsonSchema工具类
  3. */
  4. public class JsonSchemaUtils {
  5.   /**
  6.    * 从指定路径读取Schema信息
  7.    *
  8.    * @param filePath Schema路径
  9.    * @return JsonNode型Schema
  10.    * @throws IOException 抛出IO异常
  11.    */
  12.   private static JsonNode readJSONfile(String filePath) throws IOException {
  13.       InputStream stream = JsonSchemaUtils.class.getClassLoader().getResourceAsStream(filePath);
  14.       return new JsonNodeReader().fromInputStream(stream);
  15.   }
  17.   /**
  18.    * 将Json的String型转JsonNode类型
  19.    *
  20.    * @param str 需要转换的Json String对象
  21.    * @return 转换JsonNode对象
  22.    * @throws IOException 抛出IO异常
  23.    */
  24.   private static JsonNode readJSONStr(String str) throws IOException {
  25.       return new ObjectMapper().readTree(str);
  26.   }
  28.   /**
  29.    * 将需要验证的JsonNode 与 JsonSchema标准对象 进行比较
  30.    *
  31.    * @param schema schema标准对象
  32.    * @param data   需要比对的Schema对象
  33.    */
  34.   private static void assertJsonSchema(JsonNode schema, JsonNode data) {
  35.       ProcessingReport report = JsonSchemaFactory.byDefault().getValidator().validateUnchecked(schema, data);
  36.       if (!report.isSuccess()) {
  37.           for (ProcessingMessage aReport : report) {
  38.               Reporter.log(aReport.getMessage(), true);
  39.           }
  40.       }
  41.       Assert.assertTrue(report.isSuccess());
  42.   }
  44.   /**
  45.    * 将需要验证的response 与 JsonSchema标准对象 进行比较
  46.    *
  47.    * @param schemaPath JsonSchema标准的路径
  48.    * @param response   需要验证的response
  49.    * @throws IOException 抛出IO异常
  50.    */
  51.   public static void assertResponseJsonSchema(String schemaPath, String response) throws IOException {
  52.       JsonNode jsonSchema = readJSONfile(schemaPath);
  53.       JsonNode responseJN = readJSONStr(response);
  54.       assertJsonSchema(jsonSchema, responseJN);
  55.   }
  56. }

这里已经将最后抽成简单方法供使用，只需传入schemaPath路劲、以及需要验证的对象。
Http响应体保存到本地

  • ①、可以通过客户端抓包获取得到Http响应体、或者开发接口定义文档 等方式，得到最后Http响应体的Json对象。(注意：响应体内容尽量全面，这样在验证时也可以尽可能验证)
  • ②、将请求响应体通过 https://jsonschema.net/ ，在线验证得到JsonSchema信息。

  • ③、根据接口响应需求，做基础验证配置。例如，这里将tags字段认为是必须存在的参数。 完整Schema约束文件如下，并将此文件保存到resources目录对应模块下。

    1. {
    2. "$id": "http://example.com/example.json",
    3. "type": "object",
    4. "properties": {
    5.   "tags": {
    6.     "$id": "/properties/tags",
    7.     "type": "array",
    8.     "items": {
    9.       "$id": "/properties/tags/items",
    10.       "type": "string",
    11.       "title": "The 0th Schema ",
    12.       "default": "",
    13.       "examples": [
    14.         "热门",
    15.         "最新"
    16.       ]
    17.     }
    18.   }
    19. },
    20. "required": [
    21.   "tags" 
    22. ]
    23. }

    TestCase测试用例编写

    1. public class SearchTagsTest {
    2.   private static Properties properties;
    3.   private static HttpSearch implSearch;
    4.   private static String SCHEMA_PATH = "parameters/search/schema/SearchTagsMovie.json";
    6.   @BeforeSuite
    7.   public void beforeSuite() throws IOException {
    8.       InputStream stream = this.getClass().getClassLoader().getResourceAsStream("env.properties");
    9.       properties = new Properties();
    10.       properties.load(stream);
    11.       String host = properties.getProperty("douban.host");
    12.       implSearch = new HttpSearch(host);
    13.       stream = this.getClass().getClassLoader().getResourceAsStream("parameters/search/SearchTagsParams.properties");
    14.       properties.load(stream);
    15.       stream = this.getClass().getClassLoader().getResourceAsStream("");
    16.       stream.close();
    17.   }
    19.   @Test
    20.   public void testcase1() throws IOException {
    21.       String type = properties.getProperty("testcase1.req.type");
    22.       String source = properties.getProperty("testcase1.req.source");
    23.       Response<MovieResponseVO> response = implSearch.searchTags(type, source);
    24.       MovieResponseVO body = response.body();
    25.       Assert.assertNotNull(body, "response.body()");
    26. //        响应返回内容想通过schema标准校验
    27.       JsonSchemaUtils.assertResponseJsonSchema(SCHEMA_PATH, JSONObject.toJSONString(body));
    28. //        再Json化成对象
    29.       Assert.assertNotNull(body.getTags(), "tags");
    30.   }
    32.   @Test
    33.   public void testcase2() throws IOException {
    34.       String type = properties.getProperty("testcase2.req.type");
    35.       String source = properties.getProperty("testcase2.req.source");
    36.       Response<MovieResponseVO> response = implSearch.searchTags(type, source);
    37.       MovieResponseVO body = response.body();
    38.       Assert.assertNotNull(body, "response.body()");
    39.       JsonSchemaUtils.assertResponseJsonSchema(SCHEMA_PATH, JSONObject.toJSONString(body));
    40.       Assert.assertNotNull(body.getTags(), "tags");
    41.   }
    42. }

    至此，TestNg测试用例部分全部完成。