Jmeter实现接口测试

Posted 2023-03-09

参考技术A

利用Jmeter做接口测试怎么做呢？过程真的是超级简单。

明白了原理以后，把零碎的知识点填充进去就可以了。所以在学习的过程中，不管学什么，我一直都强调的是要循序渐进，和明白原理和逻辑。这篇文章就来介绍一下如何利用Jmeter做接口测试的流程，主要针对的是功能测试。暂不涉及到自动化测试和性能测试的内容。

一把来说，主要的步骤都大差不差。

第一步：通过分析API文档和需求文档提取接口清单 。

也就是说，接口测试工作人员工作的开始就是从API文档和需求文档开始的。所以进入公司的第一件事情就是要拿到API文档和需求文档来了解，来看，来分析。从其中提取接口清单的话，主要是因为API文档中有很多冗余，不必要的信息。这些信息可能对于开发人员是有用的，但是对于我们测试人员是没有用的，所以要去除冗余，提取关键信息。

那么怎么提取呢？方法也很简单，从功能模块和方法模块对API文档中的内容进行提炼，提炼的关键是接口三要素：url+方法+参数+返回值。我的建议是可以先将所有的url提取出来，基本上一个url就是对应一个接口的，这样一条线把整体拎起来，就感觉混乱的局面清晰多了。

当然工作中，有的时候我们是可以直接拿到接口清单的，因为清单这个事情一个团队做一份就好了，并不是说要每个人都做一份。但是我们自己得会，得有这个能力。之前看到过一个面试题，问的是，如果没有API文档，怎么做接口测试？

其实问的就是如果没有API文档，应该怎么提取接口清单的问题。很简单，根据需求文档和原型图来提取。有的公司不正规，确实是没有API文档的。或者有的公司API文档写的不规范，那提取的时候，就很考验测试人员的经验和能力了。所以如果能找到遵循restful风格写的优秀API文档，那就好了，提取的时候很方便。

第二步：针对接口清单，做单接口测试和关联接口测试。

在实际测试过程中，单接口测试和关联接口测试的时间是不一样的，这涉及到业务逻辑测试和功能点测试等。但是在测试的时候，他们的逻辑和方法是类似的。

当然这里主要介绍的是单接口测试，因为单接口测试时会考虑各种可能的情况，而关联接口测试一般是建立在单接口没有问题的前提下的。换个角度来说，就相当于是两个层次，单接口测试是基础，而关联接口测试是拔高。

那么具体应该怎么做呢？比如我们这里已经选定而来某一个接口来测试。

首先，根据选定的接口来搭建测试框架 。

接口不是什么大不了的事情，无非就是url、方法、参数、返回数据这四块。这样就意味着，一个接口的框架是固定的，只不过每次传输的数据和返回的数据可能会不一样而已。所以我们要做的第一步就是搭建测试框架。

那么怎么搭建呢？这里就要用到从API文档中整理出来的接口清单和Jmeter了。从接口清单里，可以拿到当下接口的url+方法+参数+预期返回数据。这就是我们搭建测试框架的依据。接下来用Jmeter搭建。

首先需要打开Jmeter，然后基于测试计划，创建线程组，基于线程组创建HTTP请求。考虑到单接口测试，一个框架，要测试N多个数据，而且后面的接口可能也要用到同样的ip地址、同样的content-type，所以一般会先创建一个HTTP请求默认值，将一些可能会重复用到的信息填进去，比如说端口号、协议之类的。如有必要还需要添加HTTP信息头管理器，放一些user-agent、content-type等内容。

好的，有了这两个基础就可以来创建HTTP请求。在新的请求里，已经填写的端口号呀、ip地址呀之类的就无需填写了，只需要填写方法之类的即可。那么搭建框架在哪里搭建呢？一般会考虑para或者body里。比如说，要提交一段json格式的数据，那么就要用body（消息体）来提交，如下图所示。

将从接口清单里拿到的json数据填写到消息体数据里，然后将需要不断传入的数据进行参数化设置，那搭建测试框架就算是完成了。接下来只需要把数据一条一条传入进行测试即可。

那么如何把数据进行传入呢？

其实我们在下面的这篇文章里已经介绍了，传入数据的方法有四种，但主要使用的还是csv data set config 和函数。做功能接口测试，用csv就足够了。那么具体怎么用呢？

星空下：软件接口测试工具Jmeter使用核心详解12 赞同 · 0 评论文章

基于当前的线程组或者请求创建CSV数据文件配置组件。如果这份数据只有这一个请求会用，那么就基于请求创建即可。如果这份数据会被这个线程组里的多个请求使用，那么就基于线程组创建。

创建了以后就需要填入文件了呢？可是文件在哪里呢？这个时候就要稍微停一下jmeter的操作，先去针对当前接口设计测试用例并形成有关文档了。有关于功能接口测试的用例设计，我们之后会专门用一篇文章来介绍，这里先带过。这是因为设计测试用例是做测试过程中最核心的一步。

在测试用例设计完之后，可以将其保存在一个txt文档里，采用utf-8编码，保存到Jmeter脚本的同一父目录下。然后按照上面那篇文章里的设置方法进行设置即可，注意路径可以采用相对路径，便于数据文件的拷贝和使用。

csv组件设置好以后，数据源有了，变量名有了，变量名的赋值也有了，接下来就只剩引用参数就可以了。在测试框架里需要引用参数的地方引用，引用的格式是$参数名。到这里，针对于某一个接口的测试工作就准备完成了。

然后在Jmeter里面添加查看结果树组件，执行请求，依次查看结果 。看一看返回的数据和我们的预期结果是否一致，不一致，那可能就是一个bug。

做一个小小的总结吧，用jmeter做功能接口测试，其实很简单的。逻辑和原理都是类似的，如果遇到新的项目，可能说会用一些新的组件而已，那百度一下几分钟的事情。在学习软件测试的时候，最重要的就是不要怂，不要看起来说怎么要学的东子这么杂这么多，只要能够拎出其中的线索和主干，然后把一些零碎的点给组装上去，就会感觉，哇，忽然之间，好有条理。

基于jmeter+ant实现的接口自动化测试

jmeter+ANT接口自动化测试框架

项目说明

• 本框架是一套基于jmeter+Ant+Excel+Python而设计的数据驱动接口自动化测试框架，jmeter 作为执行器，Ant 作为构建工具，进行构建测试，本框架无需你使用代码编写用例，测试用例存储在csv中，在csv中可以进行接口用例编写，接口断言，用例运行控制。

技术栈

• jmeter
• Ant
• Python

环境部署

1、安装JDK

2、安装Jmeter

3、安装 ANT

• 1、解压apache-ant-1.10.5-bin.zip到任意目录，比如 E:apache-ant-1.10.5
• 2、windows中配置ANT环境变量，如下为我的配置

---

ANT_HOME    E:apache-ant-1.10.5
Path        E:apache-ant-1.10.5in
CLASSPATH   E:apache-ant-1.10.5lib

• 3、ANT安装验证
  验证安装结果，命令行输入ant -v ，出现版本信息则安装成功，如图
  

4、ANT与Jmeter集成

• 1、配置库文件
  将jmeterextras目录下的ant-jmeter-1.1.1.jar 文件拷贝到ant安装目录下的lib文件夹中，如图
  

• 2、配置ANT与Jmeter的配置文件
  新建ant的编译文件，命名为 build.xml，其内容如下：

---

<?xml version="1.0" encoding="UTF-8"?>

<project name="ant-jmeter-test" default="run" basedir=".">
    <tstamp>
        <format property="time" pattern="yyyy_MM_dd_HH_mm" />
    </tstamp>
    <!-- 需要改成自己本地的 项目路径根 目录，即jmeter安装文件所在的目录-->  
    <property name="project.home" value=".." />
    <!-- 需要改成自己本地的 Jmeter 目录-->  
    <property name="jmeter.home" value="${project.home}apache-jmeter-3.2" />
    <!-- jmeter生成jtl格式的结果报告的路径--> 
    <property name="jmeter.result.jtl.dir" value="${project.home}
eportjtl" />
    <!-- jmeter生成html格式的结果报告的路径-->
    <property name="jmeter.result.html.dir" value="${project.home}
eporthtml" />
    <!-- 生成的报告的前缀-->  
    <property name="ReportName" value="TestReport" />
    <property name="jmeter.result.jtlName" value="${jmeter.result.jtl.dir}/${ReportName}_${time}.jtl" />
    <property name="jmeter.result.all_htmlName" value="${jmeter.result.html.dir}/All_Report/All${ReportName}_${time}.html" />
    <property name="jmeter.result.detail_htmlName" value="${jmeter.result.html.dir}/Detail_Report/Detail${ReportName}_${time}.html" />  
    
    <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="${project.home}jmeter_Code" includes="*.jmx" />

             <property name="jmeter.save.saveservice.output_format" value="xml"/>
        </jmeter>
    </target>
    
     <path id="xslt.classpath">
        <fileset dir="${jmeter.home}/lib" includes="xalan*.jar"/>
        <fileset dir="${jmeter.home}/lib" includes="serializer*.jar"/>
     </path>
        
    <target name="report">
        <tstamp> <format property="report.datestamp" pattern="yyyy/MM/dd HH:mm" /></tstamp>    
        <xslt               
              classpathref="xslt.classpath"
              force="true"
              
              in="${jmeter.result.jtlName}"
              out="${jmeter.result.all_htmlName}"
              style="${jmeter.home}/extras/jmeter-results-detail-report_21.xsl" />  
        
        <xslt               
              classpathref="xslt.classpath"
              force="true"
              
              in="${jmeter.result.jtlName}"
              out="${jmeter.result.detail_htmlName}"
              style="${jmeter.home}/extras/jmeter.results.shanhe.me.xsl" />     
        
        <!-- 因为上面生成报告的时候，不会将相关的图片也一起拷贝至目标目录，所以，需要手动拷贝 --> 
        <copy todir="${jmeter.result.html.dir}/All_Report">
            <fileset dir="${jmeter.home}/extras">
                <include name="collapse.png" />
                <include name="expand.png" />
            </fileset>
        </copy>
    </target>    
    
</project>

• 按实际情况修改build.xml文件，相关说明如下
  
  

• 3、配置jmeter.properties
  • 配置jmeter报告输出格式为xml。在jmeter根目录下apache-jmeter-3.2injmeter.properties文件中修改 jmeter.save.saveservice.output_format=csv 为 jmeter.save.saveservice.output_format=xml，并去掉前面的注释符号#，如图所示
    

框架代码与用例设计及相关说明

1、用例设计

• 测试用例保存在csv文件中，如图所示
  

2、脚本代码说明

• 测试计划中定义用户变量，以供后面的脚本使用，如图
  

• 循环控制器设置永远循环，如图
  

• 循环控制器下新增CSV Data Set ConFig控件，循环读取用例文件中的测试用例，如图
  

• Allow quoted data?：是否允许带双引号的数据

1. 此项实际是控制csv文件中的双引号是否为有效字符；
2. 如果数据带有双引号且此项设置TRUE，则会自动去掉数据中的引号使能够正常读取数据，且即使引号之间的内容包含有分隔符时，仍作为一个整体而不进行分隔；
3. 如果数据带有引号且此项设置为FALSE，则读取数据报错；
4. 如果希望双引号字段中间再包含双引号，则需要加两个双引号来代表单个双引号。
5. 比如此项设置为true时，"2,3"-->2,3；"4""5"-->4"5

• Sharing mode：共享模式

1. All threads：针对所有线程组的所有线程，每个线程取值不一样，依次取csv文件中的下一行。即不管是单个线程组还是多个线程组，每个线程都是依次取下一行。
2. Current thread group：当前线程组。以线程组为单位，每个线程组内的线程都会从第1行开始取值并依次往下进行取值。
3. Current thread：当前线程。每个线程都会从第1行开始取值并依次往下进行取值，在同一次循环中所有的线程取值一样。

• 添加执行控制器，筛选测试用例执行，如下，可执行所有用例、可执行其中某部分用例、也可按用例的优先级执行测试用例。
  

• 根据调用方法选择请求方式
  通过if选择器区分GET与POST方法的请求，配置http请求，如图
  
• Post请求的配置方式 ：post请求参数放在body data中
  
• 响应结果配置如图
  

• Get 请求的配置方式：get请求的参数配置url后面，如图
  

• 结合Python发送测试报告到邮箱

---

#encoding=utf-8

import time
import smtplib
import email
from email.mime.text import MIMEText
from email.mime.multipart import MIMEMultipart
import sys
import os.path 
reload(sys)
sys.setdefaultencoding('utf-8')

#收件箱，如果是list请以逗号分隔
mailto_list=['[e-mail]','[e-mail]']
#发件箱
mail_host="smtp.126.com"
mail_user="XXXXtest"
mail_pass="XXXXXX"
mail_postfix="126.com"

def send_mail(attfile1, attfile2):

    today = time.strftime('%Y-%m-%d',time.localtime(time.time()))
    detailTime = time.strftime('%H:%M:%S',time.localtime(time.time()))
    todaytime = today + ' 00:00:00'
    selectres = todaytime
    send_header = "[demo项目][线上环境][自动化用例测试报告]- ".encode("utf-8") + today +" "+detailTime
    me= mail_user+"@"+mail_postfix
    msg = MIMEMultipart()
    msg['Subject'] = send_header
    msg['From'] = me
    msg['To'] = ";".join(mailto_list)
    
    #正文
    fp = open(attfile1,"r")
    content1 = fp.read()
    fp.close()
    
    content2 = '<html><h3>测试结果及更多详情请查看邮件附件【All_Report.html】和【Detail_Report.html】!!!</h3></html>'
    
    msg.attach(MIMEText(content1 + content2, 'html', 'utf-8'))

    #总体报告目录
    att1 = MIMEText(open(attfile1, 'rb').read(), 'base64', 'gb2312')
    att1["Content-Type"] = 'application/octet-stream'
    att1["Content-Disposition"] = 'attachment; filename="All_Report.html"'
    msg.attach(att1)

    #详细报告目录
    att2 = MIMEText(open(attfile2, 'rb').read(), 'base64', 'gb2312')
    att2["Content-Type"] = 'application/octet-stream'
    att2["Content-Disposition"] = 'attachment; filename="Detail_Report.html"'
    msg.attach(att2)

    try:
        server = smtplib.SMTP()
        server.connect(mail_host)
        server.ehlo()
        server.starttls()
        server.login(mail_user,mail_pass)
        server.sendmail(me, mailto_list, msg.as_string())
        server.quit()
        return True
    except Exception, e:
        print str(e)
        return False

#======查找测试报告目录，找到最新生成的测试报告文件====
def new_report(testreport):
    result_dir = testreport
    #获取该目录下的所有文件，将文件存到列表lists里
    lists=os.listdir(result_dir)
    #重新按时间先后对目录下（列表lists里）的文件进行排列，最新文件排末尾
    lists.sort(key=lambda fn: os.path.getmtime(result_dir+""+fn))
    #找到最新生成的文件，并加上路径，lists(-1)倒数第一个
    file_new = os.path.join(result_dir,lists[-1])
    return file_new

if __name__ == '__main__':
    
    report_dir1 = "../report/html/Detail_Report"   #详细报告目录
    report_dir2 = "../report/html/All_Report"   #总体报告目录

    #找到生成的最新的测试报告
    file_new1 = new_report(report_dir1)
    file_new2 = new_report(report_dir2)
    print(file_new2)

    if send_mail(file_new2, file_new1):
        print u"测试报告邮件发送成功！"
    else:  
        print u"测试报告邮件发送失败！"

3、执行测试，查看结果

• build配置文件放在与测试脚本同目录下
  

• 执行测试

1. 命令行cd到build.xml文件所在目录，输入 ant run ，执行测试，如图
   
2. 看到build successful 则说明构建测试成功

• 测试报告

1. 概要报告如下
   
2. 详细报告如下