通用技术 Jenkins+Jmeter+Ant 接口持续集成

zero · June 16, 2016 · Last by liupeng replied at August 06, 2019 · 2950 hits

前言

其实这个方案，我在本论坛已经看到不少于 2 篇的实现文档，我为什么还要写这篇，其一，为了给自己一个总结，其二，在部署过程中遇到过一些坑，在这分享出来，也希望能给需要的人一个参考。方案很久之前都弄好了，只是才分享出来，也因为比较懒，写文档总是明日复明日。。。顺便吐槽一下，用 onenote 做笔记转成 markdown 发上来成本好高啊

为什么要用 Jmeter 做接口测试

当选择这套方案的时候，很多人会问，为什么选择 Jmeter 做 Case 管理？为什么不自己写框架？说实话，自己写框架有很大优势，比如易于拓展，易于定制。Testhome 上也有很多很牛逼的框架，看着就让人流口水的。很多大公司都是自己写的框架，有 WEB 界面（我对界面有偏爱），有简洁的 Case 编写方式，有很好用的录制方法…以至于我曾经也尝试写过一个（Java+Testng 执行 +Xml 管理 Case），但是过程很坎坷，遇到了很多坑（技术积累不足是很重要的一方面）。例如编写 Case 的时候调试很麻烦，后续拓展需要不断维护（不断封装新的参数获取方法）等等。所以，最终选择了它，大家可以自己尝试体会下。

Jmeter 做接口测试的优势

Jmeter 支持录制，工具有 Gui 界面，入手相对简单。
Gui 便于调试，本地调试通过上传，管理容易。
维护成本很小，Jmeter 功能比较全面，不会让自己陷入不停的维护框架的坑。
Jmeter Case 是基于 xml 的（虽然后缀是 jmx 格式），执行结果也可以导出 xml 格式（结果为 jtl 后缀）

Jmeter 做接口测试的缺陷：

单条 Case 执行依赖本地
Jmeter 编写 Case 有一定学习成本
拓展性稍差，Case 基于 xml 格式管理，后续如果想要自己编写平台，导出这些 Case 是个不小的工作量

Jmeter+Jenkins+Ant 实施方案的适用范围

小型公司或小团队，大公司有自己的平台，后续需求也多，还是自己写一套吧。
测试团队较小，没有专门的测试开发部门支持。
编程不是很牛逼的，如果你很厉害，自己能搞定所有前端，后台，自己搞比较好。
需要立刻出活的，不想将有限的精力放到后期维护当中的

Jmeter 相关插件安装：

插件安装：

Jmeter 的插件安装很简单，只需要下载对应插件解压即可。

下载地址：http://jmeter-plugins.org/downloads/all/
下载后解压放入：apache-jmeter-2.12\lib\ext\目录下
重启 jmeter ps：数据库链接驱动如果需要需要专门下载，例如 mysql 需要 jdbc 的 jar 包，地址：http://dev.mysql.com/downloads/file/?id=462850

用例生成与导出：

Jmeter 的用例格式为 jmx 文件，实际为 xml 格式，感兴趣可以学习下自己定制生成想要的 jmx 文件。

生成原则：

每个功能模块为一个独立的 jmx 文件。增加可维护性。（尽量不要将一个 jmx 文件放入太多功能，后期维护成本会很高。）
模块的私有变量保存在模块中，多模块共有的（例如服务器 ip 端口等）可以考虑存在单独的文件中读取。
接口测试不要放太多线程，毕竟不是做压力测试，意义也不大。
导出方法：
编写测试用例
文件——保存为——确定：

Jmeter 配置文件修改：

为什么要修改配置文件

jmeter 执行结果文件默认保存的不是 xml 格式，无法转化成 html 格式
jmeter 执行结果文件默认有很多执行数据是不保存的，而测试报告需要这些数据
配置文件路径 ${jmeterhome}/bin/jmeter.profile
配置文件修改内容：修改 jtl 文件格式：

去掉注释（#），修改 csv 为 xml
添加 jtl 文件结果参数：

根据想要保存的参数修改，若不会可参照后文第三方模板网址给出的参数修改。
修改后别忘记去掉注释（#）

Jenkins 相关插件介绍与配置：

Jenkins 插件安装方法本文不做介绍，感兴趣的可以查资料学习下。

Jmeter 插件：Performance plugin

功能：用来展示 jmeter 执行结果
配置截图：
配置说明：
Report files：配置 jtl 文件路径，相对路径与绝对路径均可，图为相对路径
其他选项：配置失败比例显示图形等参数，按需配置 ## Ant 插件：Ant Plugin
功能：用来执行 Ant
配置截图：

配置说明：
Ant Plugin 可以在构建步骤中添加，直接执行构建
另外一种方式就添加 shenll 脚本（windows 下添加 dos 脚本）执行构建，截图中就是这样操作
相比用插件构建，命令行构建有以下优缺点：
1. 需要在服务器中直接安装 ant 并配置环境变量，确保 jenkins 可以直接执行 ant 命令
2. 如果 Jenkins 是放在 tomcat 容器中，需要在 tomcat 中配置环境变量，否则会报找不到 Ant 命令，具体配置如下： 编辑catalina.sh文件，加入环境变量，否则jenkins会报找不到Ant错误 #See the license for the…… JAVA_HOME=/usr/lib/jvm/jdk1.8.0_31 Export JENKINS_HOME="/root/.jenkins"
3. 灵活性更强，可以直接指定 Ant 的执行参数 ## Svn 插件：Subversion Plug-in
功能：版本管理，按需使用
配置截图：
配置说明：
Reponsitory URL：填写仓库 url 地址
Add 按钮：添加 svn 的用户名密码
其他选项：按需配置

Html 展示插件：HTML Publisher plugin
功能：html 报告展示
配置截图：
配置说明：
HTML directory to archive:填写生成 html 文件的路径
index page[s]:填写展示报告的主页
其他选项：按需填写
原理说明：
本插件并不会自己产生 html 文件，而是通过 xslt 转化 xml 生成的报告
xslt 可以自己在服务器中安装，也可以通过通过 Ant 配置文件指定 jar 包，本文就是通过 Ant 指定 jmeter 内部集成的 jar 包
生成的 html 文件并不是在 jenkins 中默认的报告路径展示，而是会复制到 ${jenkinshome}/jobs/projectname/htmlreports/HTML_REPORT
目录下
每次只能展示最新版本的 html 报告，也就是说上一次编译的 html 报告会被覆盖
因为 jenkins 安全性的问题，默认加载出来的报告是无 css 的，通过以下配置解决：
HTML Publisher Plugin 插件在新的 Jenkins 版本中会导致打开的网页中无法加载 CSS 以及无法点击按钮的情况，由于 CSP 导致，可在 Jenkins 控制台中执行：System.setProperty("hudson.model.DirectoryBrowserSupport.CSP", "")
以解决此问题。其他由于 CSP 原因导致的 html 插件也可用此方法解决

Git 插件：

功能：版本管理，按需使用
配置截图：
配置说明：
Reponsitory URL：仓库地址
Add 添加 git 的账号
使用技巧：在只能通过 http 连接，需要每次输入账号密码的情况下，可以按如下配置，配置后即可按照填写账号密码权限获取内容。
```
cd /root
vim .netrc
```
添加配置如下：
```
machine git服务器路径
login git账号
password git密码
```
Jenkins 项目总体配置：
服务器环境与依赖
Jdk：安装并配置环境变量
Ant：安装并配置环境变量
Jmeter：安装并添加需要的插件
其他：
Jmeter+Ant，需要将 ${jmeterhome}/extras/ant-jmeter-1.1.1.jar 文件拷贝到 ${anthome}/lib 目录下，否则编译会报错
Jmeter 如需链接数据库，需添加 jdbc 插件
如果不引入 jmeter 中的 xslt，需要手动安装该软件
Jenkins 项目配置：
jenkins 的工作路径，同样的 jar 包都可能会生成不同的路径。
jenkins——系统设置——高级

Ant 相关使用：

Ant 的具体使用方法本文不详细介绍，感兴趣可以自己阅读相关资料学习一下。

定制集成 Ant 配置文件：

<?xml version="1.0" encoding="UTF-8"?>
 
<project name="ant-jmeter-test" default="run" basedir=".">
    <!-- 需要改成自己本地的 Jmeter 目录-->  
    <property name="jmeter.home" value="/home/apache-jmeter-2.13" />
    <!-- jmeter生成jtl格式的结果报告的路径--> 
    <property name="jmeter.result.jtl.dir" value="/root/.jenkins/jobs/ApiTest/workspace/report/jtl" />
    <!-- jmeter生成html格式的结果报告的路径-->
    <property name="jmeter.result.html.dir" value="/root/.jenkins/jobs/ApiTest/workspace/report/html" />
    <!-- 生成的报告的前缀-->  
    <property name="ReportName" value="TestReport" />
    <property name="jmeter.result.jtlName" value="${jmeter.result.jtl.dir}/report.jtl" />
    <property name="jmeter.result.htmlName" value="${jmeter.result.html.dir}/index.html" />        
<property name="lib.dir" value="${jmeter.home}/lib"/>
 
<path id="xslt.classpath">
        <fileset dir="${lib.dir}" includes="xalan*.jar"/>
        <fileset dir="${lib.dir}" includes="serializer*.jar"/>
    </path>
 
 
    <target name="run">
        <antcall target="test" />
        <antcall target="report" />
    </target>

    <target name="test">
        <taskdef name="jmeter" classname="org.programmerplanet.ant.taskdefs.jmeter.JMeterTask" />
        <jmeter jmeterhome="${jmeter.home}" resultlog="${jmeter.result.jtlName}">
             <!-- 声明要运行的脚本。"*.jmx"指包含此目录下的所有jmeter脚本-->
            <testplans dir="/root/.jenkins/jobs/ApiTest/workspace/jmx" includes="*.jmx" />
 
<property name="jmeter.save.saveservice.output_format" value="xml"/>
 
        </jmeter>
    </target>
            
    <target name="report">
        <xslt classpathref="xslt.classpath"
  force="true"
  in="${jmeter.result.jtlName}"
              out="${jmeter.result.htmlName}"
              style="${jmeter.home}/extras/jmeter-results-lyz.xsl">
            <!-- 因为上面生成报告的时候，不会将相关的图片也一起拷贝至目标目录，所以，需要手动拷贝 --> 
</xslt>
        <copy todir="${jmeter.result.html.dir}">
            <fileset dir="${jmeter.home}/extras">
                <include name="collapse.png" />
                <include name="expand.png" />
            </fileset>
        </copy>
    </target>
</project>